-
-
Notifications
You must be signed in to change notification settings - Fork 939
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: remove comments in tsconfig.json #1811
Conversation
JSON doesn't support comments. One downstream impact of these comments is Snyk fails to parse the JSON file. https://jsoneditoronline.org/indepth/parse/json-comments/ for some details
Please note that tsconfig.json is officially written in jsonc
So comments are officially allowed, based on what TypeScript allows Theoretically we could remove these values anyway, but it might be that we would write other comments into this file anyway in a later phase for any reason So IMO the problem is not on our side but on |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## next #1811 +/- ##
=======================================
Coverage 99.63% 99.64%
=======================================
Files 2346 2347 +1
Lines 235735 235755 +20
Branches 1141 1230 +89
=======================================
+ Hits 234875 234908 +33
+ Misses 838 825 -13
Partials 22 22
|
That is new learning, jsonc. Thank you for the docs. I'll review so I have a better understanding. Agreed it is handy to have comments. And agree it is something Snyk should handle as Faker isn't the only thing Snyk fails to parse. I'll work with an AE at Snyk for it. |
I suggest explicitly setting or removing them. Even if comments are technically allowed, the one in question do not serve any purpose currently. |
I agree with @xDivisionByZerox 's reasoning here. Since @Shinigami92 added them in #651 I would like to hear his original intention with those lines and suggestions whether to enable or remove them. |
It's exactly what the PR title is intended to say: partially activate strict mode |
I created an issue for each of them:
IMO this PR is now obsolete, since we want to actually turn on those lines. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO we can still merge this as an appreciation towards @bdb2381 for pointing out those settings.
Since @Shinigami92 already started working on them I think this will only cause merge conflicts. I will close this, but thanks for bringing this to our attention. |
On the one side, we could merge it, on the other side, it is more or less irrelevant as we wont release something just for this right now and therefore it would take month(s) anyway to land in "prod" |
JSON doesn't support comments. This PR removes the comments.
One downstream impact of these comments is Snyk fails to parse the JSON file. https://jsoneditoronline.org/indepth/parse/json-comments/ for some details