Skip to content

Rename TSConfig option categories #42514

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.

Sign up for GitHub

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 14 commits into from
Jun 3, 2021
Merged

Rename TSConfig option categories #42514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
29a97f1
Update the category descriptions for the tsconfig options
orta Jan 27, 2021
f6c9c1b
Gets tests green
orta Jan 27, 2021
78d9bc6
Merge branch 'master' of https://github.com/microsoft/TypeScript into…
orta Feb 2, 2021
2f46c5f
Whitespace change
orta Feb 2, 2021
477ad4e
Merge master
orta Apr 28, 2021
58221fa
Drop command line options from --init
orta Apr 28, 2021
961e3c1
Go back to the old re-build baseline
orta Apr 28, 2021
b0fcc2f
Fix numbers
orta Apr 30, 2021
6d70cf4
Remove formatting options from --showconfig
orta May 3, 2021
7ac8789
Merge master
orta May 28, 2021
dbb891a
Dpon't show output formatting changes in showConfig
orta May 28, 2021
350d2e0
Update baselines
orta Jun 3, 2021
c82caad
Update baselines
orta Jun 3, 2021
7aee1e0
Update baselines
orta Jun 3, 2021
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
255 changes: 131 additions & 124 deletions src/compiler/commandLineParser.ts
View file
Open in desktop

Large diffs are not rendered by default.

86 changes: 58 additions & 28 deletions src/compiler/diagnosticMessages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4593,34 +4593,6 @@
"category": "Message",
"code": 6171
},
"Basic Options": {
"category": "Message",
"code": 6172
},
"Strict Type-Checking Options": {
"category": "Message",
"code": 6173
},
"Module Resolution Options": {
"category": "Message",
"code": 6174
},
"Source Map Options": {
"category": "Message",
"code": 6175
},
"Additional Checks": {
"category": "Message",
"code": 6176
},
"Experimental Options": {
"category": "Message",
"code": 6177
},
"Advanced Options": {
"category": "Message",
"code": 6178
},
"Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'.": {
"category": "Message",
"code": 6179
Expand Down Expand Up @@ -4882,6 +4854,64 @@
"code": 6243
},

"Modules": {
"category": "Message",
"code": 6244
},
"File Management": {
"category": "Message",
"code": 6245
},
"Emit": {
"category": "Message",
"code": 6246
},
"JavaScript Support": {
"category": "Message",
"code": 6247
},
"Type Checking": {
"category": "Message",
"code": 6248
},
"Editor Support": {
"category": "Message",
"code": 6249
},
"Watch and Build Modes": {
"category": "Message",
"code": 6250
},
"Compiler Diagnostics": {
"category": "Message",
"code": 6251
},
"Interop Constraints": {
"category": "Message",
"code": 6252
},
"Backwards Compatibility": {
"category": "Message",
"code": 6253
},
"Language and Environment": {
"category": "Message",
"code": 6254
},
"Projects": {
"category": "Message",
"code": 6255
},
"Output Formatting": {
"category": "Message",
"code": 6256
},
"Completeness": {
"category": "Message",
"code": 6257
},


"Projects to reference": {
"category": "Message",
"code": 6300
Expand Down
2 changes: 1 addition & 1 deletion src/testRunner/unittests/config/commandLineParsing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ namespace ts {
name: "optionName",
type: type(),
isTSConfigOnly: true,
category: Diagnostics.Basic_Options,
category: Diagnostics.Backwards_Compatibility,
description: Diagnostics.Enable_project_compilation,
}
];
Expand Down
4 changes: 1 addition & 3 deletions tests/baselines/reference/showConfig/Shows tsconfig for single option/locale/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
{
"compilerOptions": {
"locale": "someString"
}
"compilerOptions": {}
Copy link
Member

Choose a reason for hiding this comment

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

Interesting that it was shown before and not now..

Copy link
Contributor Author

@orta orta Jan 28, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Yeah, locale used to be an Advanced Option which meant it would have passed that previous if check - but the flag only works on the CLI (and so it's not in the tsconfig reference for example), so I felt moving it into command line options was probably the right call

            name: "locale",
             type: "string",
-            category: Diagnostics.Advanced_Options,
+            category: Diagnostics.Command_line_Options,

Copy link
Member

Choose a reason for hiding this comment

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

It is not command line only option... it can be present in tsconfig ?

Copy link
Contributor Author

@orta orta May 28, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Just confirmed to make sure, tsc ignores locale in a tsconfig

❯ cat tsconfig.json
{
  "files": [
    "broke.ts"
  ],
  "compilerOptions": {
    "locale": "cs",
  }
}

❯ pnpm tsc
broke.ts:2:7 - error TS1134: Variable declaration expected.

2 const 123 = 123
        ~~~


Found 1 error.


❯ pnpm tsc --locale cs
broke.ts:2:7 - error TS1134: Očekává se deklarace proměnné.

2 const 123 = 123
        ~~~


Našla se 1 chyba.

and just in case it's a top level attribute:

❯ cat tsconfig.json
{
  "files": [
    "broke.ts"
  ],
  "locale": "cs",
}

❯ pnpm tsc
broke.ts:2:7 - error TS1134: Variable declaration expected.

2 const 123 = 123
        ~~~


Found 1 error.

It can be considered a bug? but the switch at least makes sense for how TS acts today

}
148 changes: 87 additions & 61 deletions tests/baselines/reference/tsConfig/Default initialized TSConfig/tsconfig.json
View file
Open in desktop

Large diffs are not rendered by default.

153 changes: 90 additions & 63 deletions tests/baselines/reference/tsConfig/Initialized TSConfig with advanced options/tsconfig.json
View file
Open in desktop

Large diffs are not rendered by default.

148 changes: 87 additions & 61 deletions ...reference/tsConfig/Initialized TSConfig with boolean value compiler options/tsconfig.json
View file
Open in desktop

Large diffs are not rendered by default.

148 changes: 87 additions & 61 deletions ...es/reference/tsConfig/Initialized TSConfig with enum value compiler options/tsconfig.json
View file
Open in desktop

Large diffs are not rendered by default.

148 changes: 87 additions & 61 deletions tests/baselines/reference/tsConfig/Initialized TSConfig with files options/tsconfig.json
View file
Open in desktop

Large diffs are not rendered by default.

148 changes: 87 additions & 61 deletions ...eference/tsConfig/Initialized TSConfig with incorrect compiler option value/tsconfig.json
View file
Open in desktop

Large diffs are not rendered by default.

148 changes: 87 additions & 61 deletions ...ines/reference/tsConfig/Initialized TSConfig with incorrect compiler option/tsconfig.json
View file
Open in desktop

Large diffs are not rendered by default.

148 changes: 87 additions & 61 deletions ...ce/tsConfig/Initialized TSConfig with list compiler options with enum value/tsconfig.json
View file
Open in desktop

Large diffs are not rendered by default.

148 changes: 87 additions & 61 deletions ...aselines/reference/tsConfig/Initialized TSConfig with list compiler options/tsconfig.json
View file
Open in desktop

Large diffs are not rendered by default.

153 changes: 89 additions & 64 deletions ...s/should-not-trigger-recompilation-because-of-program-emit/declarationDir-is-specified.js
View file
Open in desktop

Large diffs are not rendered by default.

153 changes: 89 additions & 64 deletions ...gger-recompilation-because-of-program-emit/when-outDir-and-declarationDir-is-specified.js
View file
Open in desktop

Large diffs are not rendered by default.

152 changes: 89 additions & 63 deletions ...ates/should-not-trigger-recompilation-because-of-program-emit/when-outDir-is-specified.js
View file
Open in desktop

Large diffs are not rendered by default.

152 changes: 89 additions & 63 deletions ...h/programUpdates/should-not-trigger-recompilation-because-of-program-emit/with-outFile.js
View file
Open in desktop

Large diffs are not rendered by default.

152 changes: 89 additions & 63 deletions ...ecause-of-program-emit/without-outDir-or-outFile-is-specified-with-declaration-enabled.js
View file
Open in desktop

Large diffs are not rendered by default.

152 changes: 89 additions & 63 deletions ...t-trigger-recompilation-because-of-program-emit/without-outDir-or-outFile-is-specified.js
View file
Open in desktop

Large diffs are not rendered by default.