Skip to content

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

Description

@zen0wu

Suggestion

πŸ” Search Terms

build mode, declarations, d.ts

βœ… Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ 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

Activity

  1. RyanCavanaugh commented on Dec 13, 2021

    @RyanCavanaugh
    Member

    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

  2. zen0wu commented on Dec 20, 2021

    @zen0wu
    Author

    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/)?

  3. changed the title [-]Under build mode, only emit declaration in an allow list[/-] [+]Allow defining an allow list for generating declaration/declarationMap[/+] on Jan 2, 2022
  4. changed the title [-]Allow defining an allow list for generating declaration/declarationMap[/-] [+]Option to define an allow list for generating declaration/declarationMap[/+] on Jan 2, 2022
  5. zen0wu commented on Apr 10, 2022

    @zen0wu
    Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    In DiscussionNot yet reached consensusSuggestionAn idea for TypeScript

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions