tsc --init should generate tsconfig.json without comments

[yukulele]

Suggestion

🔍 Search Terms

• tsconfig comments tsc init

✅ 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

tsc --init creates a configuration file with all possible parameters commented with their descriptions.

• It is very difficult to read and use.
• Each time I start with the tedious task of deleting all these comments.

I think tsc --init should create a tsconfig.json file without comments.

Why?

• tsconfig.json is not the documentation.
• tsc --init give a link to the documentation (https://aka.ms/tsconfig) in the terminal.
• A modern editor is able to suggest possible options and display their descriptions and link to their documentation.

Expected tsconfig.json content after tsc --init:

{
  "compilerOptions": {
    "target": "es2016",
    "module": "commonjs",
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "strict": true,
    "skipLibCheck": true,
  }
}

[MartinJohns]

Duplicate of #46150.

[yukulele]

Duplicate of #46150.

I make the same observation as on this issue but it is not the same proposal.

[MartinJohns]

It's the same proposal, just a different solution to solve the problem. That usually does not warrant a new issue, it's better suited as a comment.

[typescript-bot]

This issue has been marked as a 'Duplicate' and has seen no recent activity. It has been automatically closed for house-keeping purposes.