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

fix: resolve broken links in Compiler Options #1103

Merged
merged 1 commit into from
Sep 18, 2020
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Option | Type | Default
`--inlineSources` | `boolean` | `false` | Emit the source alongside the sourcemaps within a single file; requires `--inlineSourceMap` or `--sourceMap` to be set.
`--init` | | | Initializes a TypeScript project and creates a `tsconfig.json` file.
`--isolatedModules` | `boolean` | `false` | Perform additional checks to ensure that separate compilation (such as with [`transpileModule`](https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#a-simple-transform-function) or [@babel/plugin-transform-typescript](https://babeljs.io/docs/en/babel-plugin-transform-typescript)) would be safe.
`--jsx` | `string` | `"preserve"` | Support JSX in `.tsx` files: `"react"`, `"preserve"`, `"react-native"`. See [JSX](docs/handbook/jsx.html).
`--jsx` | `string` | `"preserve"` | Support JSX in `.tsx` files: `"react"`, `"preserve"`, `"react-native"`. See [JSX](/docs/handbook/jsx.html).
`--jsxFactory` | `string` | `"React.createElement"` | Specify the JSX factory function to use when targeting react JSX emit, e.g. `React.createElement` or `h`.
`--jsxFragmentFactory` | `string` | `"React.Fragment"` | Specify the JSX fragment factory function to use when targeting react JSX emit, e.g. `Fragment`.
`--keyofStringsOnly` | `boolean` | `false` | Resolve `keyof` to string valued property names only (no numbers or symbols).
Expand Down Expand Up @@ -95,7 +95,7 @@ Option | Type | Default
`--noUnusedParameters` | `boolean` | `false` | Report errors on unused parameters.
~~`--out`~~ | `string` | | DEPRECATED. Use `--outFile` instead.
`--outDir` | `string` | | Redirect output structure to the directory.
`--outFile` | `string` | | Concatenate and emit output to single file. The order of concatenation is determined by the list of files passed to the compiler on the command line along with triple-slash references and imports. See [output file order documentation](https://github.com/Microsoft/TypeScript/wiki/FAQ#how-do-i-control-file-ordering-in-combined-output---out-) for more details.
`--outFile` | `string` | | Concatenate and emit output to single file. The order of concatenation is determined by the list of files passed to the compiler on the command line along with triple-slash references and imports. See [output file order documentation](https://github.com/Microsoft/TypeScript/wiki/FAQ#how-do-i-control-file-ordering-in-combined-output---out) for more details.
`paths`<sup>[2]</sup> | `Object` | | List of path mapping entries for module names to locations relative to the `baseUrl`. See [Module Resolution documentation](/docs/handbook/module-resolution.html#path-mapping) for more details.
`--preserveConstEnums` | `boolean` | `false` | Do not erase const enum declarations in generated code. See [const enums documentation](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md#94-constant-enum-declarations) for more details.
`--preserveSymlinks` | `boolean` | `false` | Do not resolve symlinks to their real path; treat a symlinked file like a real one.
Expand All @@ -108,7 +108,7 @@ Option | Type | Default
`--rootDir` | `string` | *(common root directory is computed from the list of input files)* | Specifies the root directory of input files. Only use to control the output directory structure with `--outDir`.
`rootDirs`<sup>[2]</sup> | `string[]`| | List of <i>root</i> folders whose combined content represent the structure of the project at runtime. See [Module Resolution documentation](/docs/handbook/module-resolution.html#virtual-directories-with-rootdirs) for more details.
`--showConfig` | `boolean` | `false` | Rather than actually execute a build with the other input options and config files, show the final implied config file in the output.
`--skipDefaultLibCheck` | `boolean` | `false` | DEPRECATED. Use `--skipLibCheck` instead.<br/>Skip type checking of [default library declaration files](/docs/handbook/triple-slash-directives.htmld#-reference-no-default-libtrue).
`--skipDefaultLibCheck` | `boolean` | `false` | DEPRECATED. Use `--skipLibCheck` instead.<br/>Skip type checking of [default library declaration files](/docs/handbook/triple-slash-directives.html#-reference-no-default-libtrue).
`--skipLibCheck` | `boolean` | `false` | Skip type checking of all declaration files (`*.d.ts`).
`--sourceMap` | `boolean` | `false` | Generates corresponding `.map` file.
`--sourceRoot` | `string` | | Specifies the location where debugger should locate TypeScript files instead of source locations. Use this flag if the sources will be located at run-time in a different location than that at design-time. The location specified will be embedded in the sourceMap to direct the debugger where the source files will be located.
Expand Down