TypeScript icon indicating copy to clipboard operation
TypeScript copied to clipboard

Please add default values to all properties in configuration reference

Open SetTrend opened this issue 3 years ago • 2 comments

Suggestion

Currently, the TypeScript configuration reference documentation page lacks the default values for some of the configuration properties. This may lead to confusion, cluttered configuration files and unexpected compilation results.

Please, add default values for all properties to the TypeScript configuration reference documentation page.

🔍 Search Terms

configuration default

✅ Viability Checklist

My suggestion meets these guidelines:

  • [X] This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • [X] This wouldn't change the runtime behavior of existing JavaScript code
  • [X] This could be implemented without emitting different JS based on the types of the expressions
  • [X] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • [X] This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

Please, add default values for all properties to the TypeScript configuration reference documentation page.

📃 Motivating Example

Currently, the TypeScript configuration reference documentation page lacks the default values for some of the configuration properties. This may lead to confusion, cluttered configuration files and unexpected compilation results.


/ref: #33211

SetTrend avatar Mar 26 '22 23:03 SetTrend

I've taken a crack at this. New to the whole contributing so sorry for the git pollution.

s-dehaan avatar Jul 10 '22 19:07 s-dehaan

I'm not confident about how the TSConfig reference page is built. Perhaps a commit hook or a linter step added to the pnpm run --filter=tsconfig-reference generate-json script would help, preventing commits or updates to the documentation if a description for default values is missing for any of the configuration parameters.

SetTrend avatar Jun 16 '25 08:06 SetTrend