Skip to content

🤖 Sync option descriptions <- website #46465

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

Merged
merged 2 commits into from
Mar 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/compiler/commandLineParser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ namespace ts {
shortName: "i",
type: "boolean",
category: Diagnostics.Projects,
description: Diagnostics.Enable_incremental_compilation,
description: Diagnostics.Save_tsbuildinfo_files_to_allow_for_incremental_compilation_of_projects,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

transpileOptionValue: undefined,
defaultValueDescription: Diagnostics.false_unless_composite_is_set
},
Expand Down Expand Up @@ -695,7 +695,7 @@ namespace ts {
affectsSemanticDiagnostics: true,
strictFlag: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Type_catch_clause_variables_as_unknown_instead_of_any,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description: Diagnostics.Default_catch_clause_variables_as_unknown_instead_of_any,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

defaultValueDescription: false,
},
{
Expand All @@ -714,7 +714,7 @@ namespace ts {
type: "boolean",
affectsSemanticDiagnostics: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Enable_error_reporting_when_a_local_variables_aren_t_read,
description: Diagnostics.Enable_error_reporting_when_local_variables_aren_t_read,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

defaultValueDescription: false,
},
{
Expand Down Expand Up @@ -755,7 +755,7 @@ namespace ts {
type: "boolean",
affectsSemanticDiagnostics: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Include_undefined_in_index_signature_results,
description: Diagnostics.Add_undefined_to_a_type_when_accessed_using_an_index,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

defaultValueDescription: false,
},
{
Expand Down Expand Up @@ -1237,7 +1237,7 @@ namespace ts {
name: "plugin",
type: "object"
},
description: Diagnostics.List_of_language_service_plugins,
description: Diagnostics.Specify_a_list_of_language_service_plugins_to_include,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

category: Diagnostics.Editor_Support,

},
Expand Down
79 changes: 33 additions & 46 deletions src/compiler/diagnosticMessages.json
Original file line number Diff line number Diff line change
Expand Up @@ -4679,10 +4679,6 @@
"category": "Message",
"code": 6180
},
"List of language service plugins.": {
"category": "Message",
"code": 6181
},
"Scoped package detected, looking in '{0}'": {
"category": "Message",
"code": 6182
Expand Down Expand Up @@ -5114,7 +5110,7 @@
"category": "Message",
"code": 6364
},
"Delete the outputs of all projects": {
"Delete the outputs of all projects.": {
"category": "Message",
"code": 6365
},
Expand Down Expand Up @@ -5158,10 +5154,6 @@
"category": "Error",
"code": 6377
},
"Enable incremental compilation": {
"category": "Message",
"code": 6378
},
"Composite projects may not disable incremental compilation.": {
"category": "Error",
"code": 6379
Expand Down Expand Up @@ -5273,8 +5265,7 @@
"category": "Message",
"code": 6506
},

"Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.": {
"Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files.": {
"category": "Message",
"code": 6600
},
Expand All @@ -5298,7 +5289,7 @@
"category": "Message",
"code": 6605
},
"Have recompiles in projects that use `incremental` and `watch` mode assume that changes within a file will only affect files directly depending on it.": {
"Have recompiles in projects that use 'incremental' and 'watch' mode assume that changes within a file will only affect files directly depending on it.": {
"category": "Message",
"code": 6606
},
Expand Down Expand Up @@ -5350,7 +5341,7 @@
"category": "Message",
"code": 6619
},
"Disable preferring source files instead of declaration files when referencing composite projects": {
"Disable preferring source files instead of declaration files when referencing composite projects.": {
"category": "Message",
"code": 6620
},
Expand All @@ -5374,7 +5365,7 @@
"category": "Message",
"code": 6625
},
"Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.": {
"Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility.": {
"category": "Message",
"code": 6626
},
Expand Down Expand Up @@ -5414,7 +5405,7 @@
"category": "Message",
"code": 6635
},
"Build all projects, including those that appear to be up to date": {
"Build all projects, including those that appear to be up to date.": {
"category": "Message",
"code": 6636
},
Expand Down Expand Up @@ -5454,15 +5445,15 @@
"category": "Message",
"code": 6646
},
"Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'": {
"Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'.": {
"category": "Message",
"code": 6647
},
"Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.": {
"category": "Message",
"code": 6648
},
"Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.`": {
"Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'.": {
"category": "Message",
"code": 6649
},
Expand Down Expand Up @@ -5490,7 +5481,7 @@
"category": "Message",
"code": 6655
},
"Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.": {
"Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'.": {
"category": "Message",
"code": 6656
},
Expand All @@ -5510,7 +5501,7 @@
"category": "Message",
"code": 6660
},
"Disable generating custom helper functions like `__extends` in compiled output.": {
"Disable generating custom helper functions like '__extends' in compiled output.": {
"category": "Message",
"code": 6661
},
Expand All @@ -5526,7 +5517,7 @@
"category": "Message",
"code": 6664
},
"Enable error reporting for expressions and declarations with an implied `any` type..": {
"Enable error reporting for expressions and declarations with an implied 'any' type.": {
"category": "Message",
"code": 6665
},
Expand All @@ -5538,7 +5529,7 @@
"category": "Message",
"code": 6667
},
"Enable error reporting when `this` is given the type `any`.": {
"Enable error reporting when 'this' is given the type 'any'.": {
"category": "Message",
"code": 6668
},
Expand All @@ -5550,39 +5541,39 @@
"category": "Message",
"code": 6670
},
"Enforces using indexed accessors for keys declared using an indexed type": {
"Enforces using indexed accessors for keys declared using an indexed type.": {
"category": "Message",
"code": 6671
},
"Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.": {
"Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project.": {
"category": "Message",
"code": 6672
},
"Disable strict checking of generic signatures in function types.": {
"category": "Message",
"code": 6673
},
"Add `undefined` to a type when accessed using an index.": {
"Add 'undefined' to a type when accessed using an index.": {
"category": "Message",
"code": 6674
},
"Enable error reporting when a local variables aren't read.": {
"Enable error reporting when local variables aren't read.": {
"category": "Message",
"code": 6675
},
"Raise an error when a function parameter isn't read": {
"Raise an error when a function parameter isn't read.": {
"category": "Message",
"code": 6676
},
"Deprecated setting. Use `outFile` instead.": {
"Deprecated setting. Use 'outFile' instead.": {
"category": "Message",
"code": 6677
},
"Specify an output folder for all emitted files.": {
"category": "Message",
"code": 6678
},
"Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output.": {
"Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output.": {
"category": "Message",
"code": 6679
},
Expand All @@ -5594,23 +5585,23 @@
"category": "Message",
"code": 6681
},
"Disable erasing `const enum` declarations in generated code.": {
"Disable erasing 'const enum' declarations in generated code.": {
"category": "Message",
"code": 6682
},
"Disable resolving symlinks to their realpath. This correlates to the same flag in node.": {
"category": "Message",
"code": 6683
},
"Disable wiping the console in watch mode": {
"Disable wiping the console in watch mode.": {
"category": "Message",
"code": 6684
},
"Enable color and formatting in TypeScript's output to make compiler errors easier to read": {
"Enable color and formatting in TypeScript's output to make compiler errors easier to read.": {
"category": "Message",
"code": 6685
},
"Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.": {
"Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit.": {
"category": "Message",
"code": 6686
},
Expand All @@ -5622,7 +5613,7 @@
"category": "Message",
"code": 6688
},
"Enable importing .json files": {
"Enable importing .json files.": {
"category": "Message",
"code": 6689
},
Expand Down Expand Up @@ -5650,31 +5641,31 @@
"category": "Message",
"code": 6695
},
"Check that the arguments for `bind`, `call`, and `apply` methods match the original function.": {
"Check that the arguments for 'bind', 'call', and 'apply' methods match the original function.": {
"category": "Message",
"code": 6697
},
"When assigning functions, check to ensure parameters and the return values are subtype-compatible.": {
"category": "Message",
"code": 6698
},
"When type checking, take into account `null` and `undefined`.": {
"When type checking, take into account 'null' and 'undefined'.": {
"category": "Message",
"code": 6699
},
"Check for class properties that are declared but not set in the constructor.": {
"category": "Message",
"code": 6700
},
"Disable emitting declarations that have `@internal` in their JSDoc comments.": {
"Disable emitting declarations that have '@internal' in their JSDoc comments.": {
"category": "Message",
"code": 6701
},
"Disable reporting of excess property errors during the creation of object literals.": {
"category": "Message",
"code": 6702
},
"Suppress `noImplicitAny` errors when indexing objects that lack index signatures.": {
"Suppress 'noImplicitAny' errors when indexing objects that lack index signatures.": {
"category": "Message",
"code": 6703
},
Expand All @@ -5686,7 +5677,7 @@
"category": "Message",
"code": 6705
},
"Log paths used during the `moduleResolution` process.": {
"Log paths used during the 'moduleResolution' process.": {
"category": "Message",
"code": 6706
},
Expand All @@ -5698,7 +5689,7 @@
"category": "Message",
"code": 6709
},
"Specify multiple folders that act like `./node_modules/@types`.": {
"Specify multiple folders that act like './node_modules/@types'.": {
"category": "Message",
"code": 6710
},
Expand All @@ -5710,7 +5701,7 @@
"category": "Message",
"code": 6712
},
"Enable verbose logging": {
"Enable verbose logging.": {
"category": "Message",
"code": 6713
},
Expand All @@ -5722,19 +5713,15 @@
"category": "Message",
"code": 6715
},
"Include 'undefined' in index signature results": {
"category": "Message",
"code": 6716
},
"Require undeclared properties from index signatures to use element accesses.": {
"category": "Message",
"code": 6717
},
"Specify emit/checking behavior for imports that are only used for types": {
"Specify emit/checking behavior for imports that are only used for types.": {
"category": "Message",
"code": 6718
},
"Type catch clause variables as 'unknown' instead of 'any'.": {
"Default catch clause variables as 'unknown' instead of 'any'.": {
"category": "Message",
"code": 6803
},
Expand Down
Loading