Skip to content

tsc --init should generate tsconfig.json without commentsΒ #53746

Closed
@yukulele

Description

@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,
  }
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    DuplicateAn existing issue was already created

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions