Add a shape to the TS config files

[orta]

Changes

Adds a JSDoc comment to add types to the config files with the TypeScript CRA templates

After:

Testing

Tested in my own CRA project, which I ported

Docs

Not needed

Question:

Do you want this on all the JS templates too? IMO it's good for everyone, but I'm obv biased ;)

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/pikapkg/snowpack/r7n10mnpt
✅ Preview: https://snowpack-git-typeconfig.pikapkg.vercel.app

[FredKSchott]

Love this! +1 for adding to the JS templates as well.

1 comment: SnowpackUserConfig is the proper typing for a user-provided config values, which is a deep partial of the "cleaned" SnowpackConfig type which has defaults applied.

[orta]

Cool, great point - updated to that type, and added to al the JS templates too

[FredKSchott]

Thanks! If you run yarn test -u in the root project directory, it will update snapshots and your tests should pass

[orta]

thanks!

[ljani]

SnowpackUserConfig is the proper typing for a user-provided config values

Is it, or have I misunderstood something? Please try the following example:

import type {SnowpackUserConfig} from "snowpack";

const config: SnowpackUserConfig = {
  mount: {
    "public": "/",
    "src": "/_dist_",
  },
  plugins: [
    "@snowpack/plugin-react-refresh",
    "@snowpack/plugin-dotenv",
    "@snowpack/plugin-typescript",
  ],
};

export default config;

I get a lot of errors:

snowpack-example.ts:6:5 - error TS2559: Type 'string' has no properties in common with type 'DeepPartial<MountEntry>'.

6     "src": "/_dist_",
      ~~~~~

  ../../node_modules/snowpack/lib/types/snowpack.d.ts:6:38
    6 export declare type DeepPartial<T> = {
                                           ~
    7     [P in keyof T]?: T[P] extends Array<infer U> ? Array<DeepPartial<U>> : T[P] extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : DeepPartial<T[P]>;
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    8 };
      ~
    The expected type comes from property 'src' which is declared here on type 'DeepPartial<Record<string, MountEntry>>'

snowpack-example.ts:9:5 - error TS2559: Type 'string' has no properties in common with type 'DeepPartial<SnowpackPlugin>'.

9     "@snowpack/plugin-react-refresh",
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

snowpack-example.ts:10:5 - error TS2559: Type 'string' has no properties in common with type 'DeepPartial<SnowpackPlugin>'.

10     "@snowpack/plugin-dotenv",
       ~~~~~~~~~~~~~~~~~~~~~~~~~

snowpack-example.ts:11:5 - error TS2559: Type 'string' has no properties in common with type 'DeepPartial<SnowpackPlugin>'.

11     "@snowpack/plugin-typescript",
       ~~~~~~~~~~~~

EDIT: Otherwise, supporting TypeScript in configuration is wonderful!

[FredKSchott]

Ah good catch, now that this is user-facing DeepPartial<SnowpackConfig> doesn't really cut it anymore. Improved these types in this PR: #1577