Skip to content
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

Update descriptions for all compiler options #44409

Merged
merged 3 commits into from
Jun 15, 2021
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
188 changes: 94 additions & 94 deletions src/compiler/commandLineParser.ts

Large diffs are not rendered by default.

483 changes: 453 additions & 30 deletions src/compiler/diagnosticMessages.json

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -17,41 +17,41 @@ Examples: tsc hello.ts
Options:
-h, --help Print this message.
-w, --watch Watch input files.
--pretty Stylize errors and messages using color and context (experimental).
--pretty Enable color and formatting in output to make compiler errors easier to read
--all Show all compiler options.
-v, --version Print the compiler's version.
--init Initializes a TypeScript project and creates a tsconfig.json file.
-p FILE OR DIRECTORY, --project FILE OR DIRECTORY Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.
-b, --build Build one or more projects and their dependencies, if out of date
-t VERSION, --target VERSION Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'.
-m KIND, --module KIND Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'.
--lib Specify library files to be included in the compilation.
-t VERSION, --target VERSION Set the JavaScript language version for emitted JavaScript and include compatible library declarations.
-m KIND, --module KIND Specify what module code is generated.
--lib Specify a set of bundled library declaration files that describe the target runtime environment.
'es5' 'es6' 'es2015' 'es7' 'es2016' 'es2017' 'es2018' 'es2019' 'es2020' 'es2021' 'esnext' 'dom' 'dom.iterable' 'webworker' 'webworker.importscripts' 'webworker.iterable' 'scripthost' 'es2015.core' 'es2015.collection' 'es2015.generator' 'es2015.iterable' 'es2015.promise' 'es2015.proxy' 'es2015.reflect' 'es2015.symbol' 'es2015.symbol.wellknown' 'es2016.array.include' 'es2017.object' 'es2017.sharedmemory' 'es2017.string' 'es2017.intl' 'es2017.typedarrays' 'es2018.asyncgenerator' 'es2018.asynciterable' 'es2018.intl' 'es2018.promise' 'es2018.regexp' 'es2019.array' 'es2019.object' 'es2019.string' 'es2019.symbol' 'es2020.bigint' 'es2020.promise' 'es2020.sharedmemory' 'es2020.string' 'es2020.symbol.wellknown' 'es2020.intl' 'es2021.promise' 'es2021.string' 'es2021.weakref' 'esnext.array' 'esnext.symbol' 'esnext.asynciterable' 'esnext.intl' 'esnext.bigint' 'esnext.string' 'esnext.promise' 'esnext.weakref'
--allowJs Allow javascript files to be compiled.
--jsx KIND Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'.
-d, --declaration Generates corresponding '.d.ts' file.
--declarationMap Generates a sourcemap for each corresponding '.d.ts' file.
--sourceMap Generates corresponding '.map' file.
--outFile FILE Concatenate and emit output to single file.
--outDir DIRECTORY Redirect output structure to the directory.
--removeComments Do not emit comments to output.
--noEmit Do not emit outputs.
--allowJs Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.
--jsx KIND Specify what JSX code is generated.
-d, --declaration Generate .d.ts files from TypeScript and JavaScript files in your project.
--declarationMap Create sourcemaps for d.ts files.
--sourceMap Create source map files for emitted JavaScript files.
--outFile FILE 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.
--outDir DIRECTORY Specify an output folder for all emitted files.
--removeComments Disable emitting comments.
--noEmit Disable emitting file from a compilation.
--strict Enable all strict type-checking options.
--noImplicitAny Raise error on expressions and declarations with an implied 'any' type.
--strictNullChecks Enable strict null checks.
--strictFunctionTypes Enable strict checking of function types.
--strictBindCallApply Enable strict 'bind', 'call', and 'apply' methods on functions.
--strictPropertyInitialization Enable strict checking of property initialization in classes.
--noImplicitAny Enable error reporting for expressions and declarations with an implied `any` type..
--strictNullChecks When type checking, take into account `null` and `undefined`.
--strictFunctionTypes When assigning functions, check to ensure parameters and the return values are subtype-compatible.
--strictBindCallApply Check that the arguments for `bind`, `call`, and `apply` methods match the original function.
--strictPropertyInitialization Check for class properties that are declared but not set in the constructor.
--strictOptionalProperties Enable strict checking of optional properties.
--noImplicitThis Raise error on 'this' expressions with an implied 'any' type.
--noImplicitThis Enable error reporting when `this` is given the type `any`.
--useUnknownInCatchVariables Type catch clause variables as 'unknown' instead of 'any'.
--alwaysStrict Parse in strict mode and emit "use strict" for each source file.
--noUnusedLocals Report errors on unused locals.
--noUnusedParameters Report errors on unused parameters.
--noImplicitReturns Report error when not all code paths in function return a value.
--noFallthroughCasesInSwitch Report errors for fallthrough cases in switch statement.
--types Type declaration files to be included in compilation.
--esModuleInterop Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'.
--alwaysStrict Ensure 'use strict' is always emitted.
--noUnusedLocals Enable error reporting when a local variables aren't read.
--noUnusedParameters Raise an error when a function parameter isn't read
--noImplicitReturns Enable error reporting for codepaths that do not explicitly return in a function.
--noFallthroughCasesInSwitch Enable error reporting for fallthrough cases in switch statements.
--types Specify type package names to be included without being referenced in a source file.
--esModuleInterop Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.
@<file> Insert command line options and files from a file.
exitCode:: ExitStatus.DiagnosticsPresent_OutputsSkipped

Expand Down
Loading