Skip to content
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
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"@types/eslint": "7.29.0",
"assert": "2.0.0",
"rollup-plugin-typescript2": "0.36.0",
"typescript": "6.0.0-dev.20260213",
"typescript": "6.0.2",
"tslib": "^2.6.2",
"sharp": "0.34.5",
"webpack": "^5.105.3"
Expand Down
126 changes: 73 additions & 53 deletions packages/documentation/copy/en/project-config/Compiler Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,57 +63,66 @@ tsc app.ts util.ts --target esnext --outfile index.js
<p>Gives local information for help on the CLI.</p>
</td></tr>

<tr class='odd' name='init'>
<td><code>--init</code></td>
<tr class='odd' name='ignoreConfig'>
<td><code>--ignoreConfig</code></td>
<td><p><code>boolean</code></p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<p>Ignore the tsconfig found and build with commandline options and files.</p>
</td></tr>

<tr class='even' name='init'>
<td><code>--init</code></td>
<td><p><code>boolean</code></p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<p>Initializes a TypeScript project and creates a tsconfig.json file.</p>
</td></tr>

<tr class='even' name='listFilesOnly'>
<tr class='odd' name='listFilesOnly'>
<td><code>--listFilesOnly</code></td>
<td><p><code>boolean</code></p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>Print names of files that are part of the compilation and then stop processing.</p>
</td></tr>

<tr class='odd' name='locale'>
<tr class='even' name='locale'>
<td><code>--locale</code></td>
<td><p><code>string</code></p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>Set the language of the messaging from TypeScript. This does not affect emit.</p>
</td></tr>

<tr class='even' name='project'>
<tr class='odd' name='project'>
<td><code>--project</code></td>
<td><p><code>string</code></p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.</p>
</td></tr>

<tr class='odd' name='showConfig'>
<tr class='even' name='showConfig'>
<td><code>--showConfig</code></td>
<td><p><code>boolean</code></p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>Print the final configuration instead of building.</p>
</td></tr>

<tr class='even' name='version'>
<tr class='odd' name='version'>
<td><code>--version</code></td>
<td><p><code>boolean</code></p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>Print the compiler's version.</p>
</td></tr>

Expand Down Expand Up @@ -285,7 +294,7 @@ tsc app.ts util.ts --target esnext --outfile index.js
<td><code><a href='/tsconfig/#allowJs'>--allowJs</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>false</code></p>
<td><p><code>false</code>, unless <code>checkJs</code> is set</p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
Expand Down Expand Up @@ -783,7 +792,7 @@ tsc app.ts util.ts --target esnext --outfile index.js
<td><code><a href='/tsconfig/#libReplacement'>--libReplacement</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>true</code></p>
<td><p><code>false</code></p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
Expand Down Expand Up @@ -1067,7 +1076,7 @@ tsc app.ts util.ts --target esnext --outfile index.js
<td><code><a href='/tsconfig/#noUncheckedSideEffectImports'>--noUncheckedSideEffectImports</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>false</code></p>
<td><p><code>true</code></p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
Expand Down Expand Up @@ -1332,198 +1341,209 @@ tsc app.ts util.ts --target esnext --outfile index.js
<p>Specify the root path for debuggers to find the reference source code.</p>
</td></tr>

<tr class='even' name='stopBuildOnErrors'>
<tr class='even' name='stableTypeOrdering'>
<td><code><a href='/tsconfig/#stableTypeOrdering'>--stableTypeOrdering</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>false</code></p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<p>Ensure types are ordered stably and deterministically across compilations.</p>
</td></tr>

<tr class='odd' name='stopBuildOnErrors'>
<td><code><a href='/tsconfig/#stopBuildOnErrors'>--stopBuildOnErrors</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td></td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>Skip building downstream projects on error in upstream project.</p>
</td></tr>

<tr class='odd' name='strict'>
<tr class='even' name='strict'>
<td><code><a href='/tsconfig/#strict'>--strict</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>false</code></p>
<td><p><code>true</code></p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>Enable all strict type-checking options.</p>
</td></tr>

<tr class='even' name='strictBindCallApply'>
<tr class='odd' name='strictBindCallApply'>
<td><code><a href='/tsconfig/#strictBindCallApply'>--strictBindCallApply</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>true</code> if <a href="#strict"><code>strict</code></a>; <code>false</code> otherwise.</p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>Check that the arguments for <code>bind</code>, <code>call</code>, and <code>apply</code> methods match the original function.</p>
</td></tr>

<tr class='odd' name='strictBuiltinIteratorReturn'>
<tr class='even' name='strictBuiltinIteratorReturn'>
<td><code><a href='/tsconfig/#strictBuiltinIteratorReturn'>--strictBuiltinIteratorReturn</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>true</code> if <a href="#strict"><code>strict</code></a>; <code>false</code> otherwise.</p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>Built-in iterators are instantiated with a TReturn type of undefined instead of any.</p>
</td></tr>

<tr class='even' name='strictFunctionTypes'>
<tr class='odd' name='strictFunctionTypes'>
<td><code><a href='/tsconfig/#strictFunctionTypes'>--strictFunctionTypes</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>true</code> if <a href="#strict"><code>strict</code></a>; <code>false</code> otherwise.</p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>When assigning functions, check to ensure parameters and the return values are subtype-compatible.</p>
</td></tr>

<tr class='odd' name='strictNullChecks'>
<tr class='even' name='strictNullChecks'>
<td><code><a href='/tsconfig/#strictNullChecks'>--strictNullChecks</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>true</code> if <a href="#strict"><code>strict</code></a>; <code>false</code> otherwise.</p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>When type checking, take into account <code>null</code> and <code>undefined</code>.</p>
</td></tr>

<tr class='even' name='strictPropertyInitialization'>
<tr class='odd' name='strictPropertyInitialization'>
<td><code><a href='/tsconfig/#strictPropertyInitialization'>--strictPropertyInitialization</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>true</code> if <a href="#strict"><code>strict</code></a>; <code>false</code> otherwise.</p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>Check for class properties that are declared but not set in the constructor.</p>
</td></tr>

<tr class='odd' name='stripInternal'>
<tr class='even' name='stripInternal'>
<td><code><a href='/tsconfig/#stripInternal'>--stripInternal</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>false</code></p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>Disable emitting declarations that have <code>@internal</code> in their JSDoc comments.</p>
</td></tr>

<tr class='even' name='suppressExcessPropertyErrors'>
<tr class='odd' name='suppressExcessPropertyErrors'>
<td><code><a href='/tsconfig/#suppressExcessPropertyErrors'>--suppressExcessPropertyErrors</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>false</code></p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>Disable reporting of excess property errors during the creation of object literals.</p>
</td></tr>

<tr class='odd' name='suppressImplicitAnyIndexErrors'>
<tr class='even' name='suppressImplicitAnyIndexErrors'>
<td><code><a href='/tsconfig/#suppressImplicitAnyIndexErrors'>--suppressImplicitAnyIndexErrors</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>false</code></p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>Suppress <a href="#noImplicitAny"><code>noImplicitAny</code></a> errors when indexing objects that lack index signatures.</p>
</td></tr>

<tr class='even' name='target'>
<tr class='odd' name='target'>
<td><code><a href='/tsconfig/#target'>--target</a></code></td>
<td><p><code>es3</code>, <code>es5</code>, <code>es6</code>/<code>es2015</code>, <code>es2016</code>, <code>es2017</code>, <code>es2018</code>, <code>es2019</code>, <code>es2020</code>, <code>es2021</code>, <code>es2022</code>, <code>es2023</code>, <code>es2024</code>, or <code>esnext</code></p>
<td><p><code>es3</code>, <code>es5</code>, <code>es6</code>/<code>es2015</code>, <code>es2016</code>, <code>es2017</code>, <code>es2018</code>, <code>es2019</code>, <code>es2020</code>, <code>es2021</code>, <code>es2022</code>, <code>es2023</code>, <code>es2024</code>, <code>es2025</code>, or <code>esnext</code></p>
</td>
<td><p><code>es2023</code> if <a href="#module"><code>module</code></a> is <code>node20</code>; <code>esnext</code> if <a href="#module"><code>module</code></a> is <code>nodenext</code>; <code>ES5</code> otherwise.</p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>Set the JavaScript language version for emitted JavaScript and include compatible library declarations.</p>
</td></tr>

<tr class='odd' name='traceResolution'>
<tr class='even' name='traceResolution'>
<td><code><a href='/tsconfig/#traceResolution'>--traceResolution</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>false</code></p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>Log paths used during the <a href="#moduleResolution"><code>moduleResolution</code></a> process.</p>
</td></tr>

<tr class='even' name='tsBuildInfoFile'>
<tr class='odd' name='tsBuildInfoFile'>
<td><code><a href='/tsconfig/#tsBuildInfoFile'>--tsBuildInfoFile</a></code></td>
<td><p><code>string</code></p>
</td>
<td><p><code>.tsbuildinfo</code></p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>The file to store <code>.tsbuildinfo</code> incremental build information in.</p>
</td></tr>

<tr class='odd' name='typeRoots'>
<tr class='even' name='typeRoots'>
<td><code><a href='/tsconfig/#typeRoots'>--typeRoots</a></code></td>
<td><p><code>list</code></p>
</td>
<td></td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>Specify multiple folders that act like <code>./node_modules/@types</code>.</p>
</td></tr>

<tr class='even' name='types'>
<tr class='odd' name='types'>
<td><code><a href='/tsconfig/#types'>--types</a></code></td>
<td><p><code>list</code></p>
</td>
<td></td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>Specify type package names to be included without being referenced in a source file.</p>
</td></tr>

<tr class='odd' name='useDefineForClassFields'>
<tr class='even' name='useDefineForClassFields'>
<td><code><a href='/tsconfig/#useDefineForClassFields'>--useDefineForClassFields</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>true</code> if <a href="#target"><code>target</code></a> is <code>ES2022</code> or higher, including <code>ESNext</code>; <code>false</code> otherwise.</p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>Emit ECMAScript-standard-compliant class fields.</p>
</td></tr>

<tr class='even' name='useUnknownInCatchVariables'>
<tr class='odd' name='useUnknownInCatchVariables'>
<td><code><a href='/tsconfig/#useUnknownInCatchVariables'>--useUnknownInCatchVariables</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>true</code> if <a href="#strict"><code>strict</code></a>; <code>false</code> otherwise.</p>
</td>
</tr>
<tr class="option-description even"><td colspan="3">
<tr class="option-description odd"><td colspan="3">
<p>Default catch clause variables as <code>unknown</code> instead of <code>any</code>.</p>
</td></tr>

<tr class='odd' name='verbatimModuleSyntax'>
<tr class='even' name='verbatimModuleSyntax'>
<td><code><a href='/tsconfig/#verbatimModuleSyntax'>--verbatimModuleSyntax</a></code></td>
<td><p><code>boolean</code></p>
</td>
<td><p><code>false</code></p>
</td>
</tr>
<tr class="option-description odd"><td colspan="3">
<tr class="option-description even"><td colspan="3">
<p>Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting.</p>
</td></tr>

Expand Down
2 changes: 2 additions & 0 deletions packages/tsconfig-reference/data/_types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export type CompilerOptionName =
| "project"
| "showConfig"
| "listFilesOnly"
| "ignoreConfig"
| "target"
| "module"
| "lib"
Expand Down Expand Up @@ -57,6 +58,7 @@ export type CompilerOptionName =
| "strictBindCallApply"
| "strictPropertyInitialization"
| "strictBuiltinIteratorReturn"
| "stableTypeOrdering"
| "noImplicitThis"
| "useUnknownInCatchVariables"
| "alwaysStrict"
Expand Down
2 changes: 1 addition & 1 deletion packages/tsconfig-reference/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"@types/json-schema": "^7.0.15",
"ts-node": "^10.9.2",
"typescript": "*",
"typescript-for-docs": "npm:typescript@5.9.3",
"typescript-for-docs": "npm:typescript@6.0.2",
"xml-js": "^1.6.11"
},
"type": "module"
Expand Down
1 change: 1 addition & 0 deletions packages/tsconfig-reference/scripts/schema/generateJSON.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ const okToSkip = [
"out",
"references",
"typeAcquisition",
"stableTypeOrdering",
];

filteredOptions.forEach((option) => {
Expand Down
Loading
Loading