Repository navigation
Allow comments in tsconfig.json #4987
Description
Activity
Tingan Ho (@tinganho) had a pull request for this. Tingan Ho (@tinganho) feel free to resubmit the comments PR.
I will do, just a little bit busy with other things right now.
Having comments in the configs would be very helpful, and JSON as a config format is an exception in not having them. It would also be nice to add support for trailing commas in the same way to make editing JSON less fiddly.
Reacted by Yiu👍
This would be very useful to document excludes for instancePRs are welcomed here.
- added a commit that references this issue
on Oct 29, 2015 thanks Sebastien A (@sarod)!
It would be great if this format followed the popular HOCON format
I realize this is merged, but its the most relevant ticket I found to mention it.
- locked and limited conversation to collaborators
on Jun 19, 2018
Comments don't seem to be allowed in the tsconfig.json file. See this article for why it is ok according to Douglas Crockford to add them to json config files.
I initially raised this issue with gulp-typescript as I'm trying to use that Gulp task in my ASP.NET 5 project to compile my .ts files to .js but I'm getting errors and the developer has pointed me here.
My goal is to add TypeScript support to ASP.NET MVC Boilerplate which provides an ASP.NET 5 project template with lots of helpful comments and features built in. I'm currently having to resort to a separate tsconfig.html file to write comments about the file. The comments include a little info about what the file is for, a useful link to the tsconfig.json documentation and a few reasons for the chosen default settings.
Many other similar json config files already support comments. Examples are: JSHint (.jshintrc file), JSCS (.jscsrc file), TSLint (tslint.json file). The first two do not use a file with a .json file extension which may have something to do with the use of comments.