chore: move @types deps to ts_config #469
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alexeagle
changed the title
Source code doesn't have to include any indication these 'ambient' types are required. However we can force users to be explicit in the tsconfig of which `@types` packages to include in compilation. This follows the locality principle, since the types weren't referenced in the sources, the deps dont belong on the ts_project.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is simpler for Gazelle to be able to generate, since it follows the locality principle:
tsconfig.jsoncontains data needed to generatets_configrule, and no ambients need to be listed onts_projectwhen thesrcsdidn't reference them.Also means Source code doesn't have to include any indication these 'ambient' types are required, as is typical in typescript.
To make this pattern more accessible, we'll also need to improve error messaging to suggest
compilerOptions.typesneeds to be explicit for all compilation units that use thattsconfig.jsonfile, possibly by offering to edit the file.