microsoft / TypeScript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
https://www.typescriptlang.org
Apache License 2.0
101.08k stars 12.49k forks source link

Option to define an allow list for generating declaration/declarationMap #47111

Open zen0wu opened 2 years ago

zen0wu commented 2 years ago

Suggestion

πŸ” Search Terms

build mode, declarations, d.ts

βœ… Viability Checklist

My suggestion meets these guidelines:

⭐ Suggestion

It would be great tsconfig.json can expose a set of keys to say, "these are the only types that will be exported" from this module, and don't generate .d.ts for the rest.

πŸ“ƒ Motivating Example

When building under --build, TSC emits .d.ts for every single TS file in the module, but intuitively it only needs to generate declaration files for the ones that's cross module boundary (so that other modules when referencing it), which is likely a very small subset of types defined in the entire module.

πŸ’» Use Cases

We have this problem where trying to switch build mode, TSC generates huge type declarations for files who are not even referenced by other modules at all. The emit time is extremely high and incremental build is barely usable.

Sometimes it's not even possible to build-ify a project, if I have a module that,

export const thirdPartyLib = await import("3rd-party")

If this thirdPartyLib export a type that exposes an unimported type in its shape, we'll hit this error

error TS4023: Exported variable 'deps' has or is using name 'ElementsProps' from external module "node_modules/@stripe/react-stripe-js/dist/react-stripe" but cannot be named.

Concrete example: https://github.com/stripe/react-stripe-js/blob/master/src/components/Elements.tsx#L72

RyanCavanaugh commented 2 years ago

This is an interesting idea, especially since in principle we know if we're going to emit an import reference to a file whose declaration emit has been disabled

zen0wu commented 2 years ago

Right exactly, also this would probably reduce the emitter's job by a lot, and this change will only affect typescript, has no runtime behavior at all. Maybe we could even leverage the package.json new export map (https://github.com/jkrems/proposal-pkg-exports/)?

zen0wu commented 2 years ago

Bump this - given now the support for package.json export map is rolled out, seems a perfect time to add this feature on top.