-
Notifications
You must be signed in to change notification settings - Fork 1.5k
fix missing defaults in tsconfig documentation #3438
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
base: v2
Are you sure you want to change the base?
Conversation
@dynst please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
it only gets coerced to String in generateMarkdown.ts
https://www.typescriptlang.org/tsconfig/noEmitOnError.html
https://www.typescriptlang.org/tsconfig/allowUnusedLabels.html
https://www.typescriptlang.org/tsconfig/forceConsistentCasingInFileNames.html
https://www.typescriptlang.org/docs/handbook/compiler-options.html
noEmitOnError
was added in TS 1.4 but doesn't currently have a documented default; in fact most boolean options don't, because they mostly default tofalse
which doesn't show up.The only options with a documented default of simply
false
(instead of a conditional) are special cased:TypeScript-Website/packages/tsconfig-reference/scripts/tsconfig/generateJSON.ts
Lines 79 to 93 in c95f3eb
The defaultValue is statically typed to be a
string
here (inaccurately):TypeScript-Website/packages/tsconfig-reference/scripts/cli/generateJSON.ts
Line 43 in c95f3eb
TypeScript-Website/packages/tsconfig-reference/scripts/tsconfig/generateJSON.ts
Line 51 in c95f3eb
But many non-boolean options are also still missing the
defaultValue
field, though, even if sometimes their default is documented in their description.https://www.typescriptlang.org/tsconfig/#watch-excludeDirectories