Allow comments in tsconfig.json files #3
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
|
Thanks a lot @joshuacc I'll get this merged and released as soon as I get some time |
Previously, if your tsconfig.json file contained a comment (allowed by the TS compiler) the ts-import-types-cli would throw the following error: `ts-import-types-cli --project /myproject/tsconfig.json is not a tsconfig.json file` This is because the node `require` function can only parse valid (commentless) JSON. This PR swaps out the use of `require` in favor of directly reading the file contents, stripping all comments, and only then parsing it to confirm that it is valid JSON. Hopefully this will save other users some confusion!
joshuacc
force-pushed
the
allow-comments-in-tsconfig
branch
from
05436eb
to
2e4dabb
Compare
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.
Previously, if your tsconfig.json file contained a comment (allowed by the
TS compiler) the ts-import-types-cli would throw the following error:
ts-import-types-cli --project /myproject/tsconfig.json is not a tsconfig.json fileThis is because the node
requirefunction can only parse valid(commentless) JSON.
This PR swaps out the use of
requirein favor of directly readingthe file contents, stripping all comments, and only then parsing it
to confirm that it is valid JSON.
Hopefully this will save other users some confusion!