阅读(34.3k) 书签赞(1) 我要纠错

TypeScript 编译选项

2022-05-31 14:54 更新

选项	类型	默认值	描述
`--allowJs`	`boolean`	`true`	允许编译javascript文件。
`--allowSyntheticDefaultImports`	`boolean`	`module === "system"`	允许从没有设置默认导出的模块中默认导入。这并不影响代码的显示，仅为了类型检查。
`--allowUnreachableCode`	`boolean`	`false`	不报告执行不到的代码错误。
`--allowUnusedLabels`	`boolean`	`false`	不报告未使用的标签错误。
`--baseUrl`	`string`		解析非相对模块名的基准目录。查看模块解析文档了解详情。
`--charset`	`string`	`"utf8"`	输入文件的字符集。
`--declaration` `-d`	`boolean`	`false`	生成相应的'.d.ts'文件。
`--declarationDir`	`string`		生成声明文件的输出路径。
`--diagnostics`	`boolean`	`false`	显示诊断信息。
`--disableSizeLimit`	`boolean`	`false`	禁用JavaScript工程体积大小的限制
`--emitBOM`	`boolean`	`false`	在输出文件的开头加入BOM头（UTF-8 Byte Order Mark）。
`--emitDecoratorMetadata`[1]	`boolean`	`false`	给源码里的装饰器声明加上设计类型元数据。查看issue #2577了解更多信息。
`--experimentalDecorators`[1]	`boolean`	`false`	实验性启用ES7装饰器支持。
`--forceConsistentCasingInFileNames`	`boolean`	`false`	不允许不一致包装引用相同的文件。
`--help` `-h`			打印帮助信息。
`--inlineSourceMap`	`boolean`	`false`	生成单个sourcemaps文件，而不是将每sourcemaps生成不同的文件。
`--inlineSources`	`boolean`	`false`	将代码与sourcemaps生成到一个文件中，要求同时设置了`--inlineSourceMap`或`--sourceMap`属性。
`--init`			初始化TypeScript项目并创建一个`tsconfig.json`文件。
`--isolatedModules`	`boolean`	`false`	无条件地给没有解析的文件生成imports。
`--jsx`	`string`	`"Preserve"`	在'.tsx'文件里支持JSX：'React' 或 'Preserve'。查看JSX。
`--lib`	`string[]`		编译过程中需要引入的库文件的列表。可能的值为： ► `es5` ► `es6` ► `es2015` ► `es7` ► `es2016` ► `es2017` `dom` `webworker` `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` 注意：如果`--lib`没有指定默认库。默认库是 ► For `--target ES5: dom,es5,scripthost` ► For `--target ES6: dom,es6,dom.iterable,scripthost`
`--listEmittedFiles`	`boolean`	`false`	打印出编译后生成文件的名字。
`--listFiles`	`boolean`	`false`	编译过程中打印文件名。
`--locale`	`string`	(platform specific)	显示错误信息时使用的语言，比如：en-us。
`--mapRoot`	`string`		为调试器指定指定sourcemap文件的路径，而不是使用生成时的路径。当`.map`文件是在运行时指定的，并不同于`js`文件的地址时使用这个标记。指定的路径会嵌入到`sourceMap`里告诉调试器到哪里去找它们。
`--maxNodeModuleJsDepth`	`number`	`0`	node_modules下的最大依赖深度搜索并加载JavaScript文件。仅适用于使用`--allowJs`。
`--module` `-m`	`string`	`target === 'ES6' ? 'ES6' : 'commonjs'`	指定生成哪个模块系统代码：'commonjs'，'amd'，'system'，或 'umd'或'es2015'。只有'amd'和'system'能和`--outFile`一起使用。当目标是ES5或以下的时候不能使用'es2015'。
`--moduleResolution`	`string`	`module === 'amd' \| 'system' \| 'ES6' ? 'classic' : 'node'`	决定如何处理模块。或者是'node'对于Node.js/io.js，或者是'classic'（默认）。查看模块解析文档了解详情。
`--newLine`	`string`	(platform specific)	当生成文件时指定行结束符：'CRLF'（dos）或 'LF' （unix）。
`--noEmit`	`boolean`	`false`	不生成输出文件。
`--noEmitHelpers`	`boolean`	`false`	不在输出文件中生成用户自定义的帮助函数代码，如`__extends`。
`--noEmitOnError`	`boolean`	`false`	报错时不生成输出文件。
`--noFallthroughCasesInSwitch`	`boolean`	`false`	报告switch语句的fallthrough错误。（即，不允许switch的case语句贯穿）
`--noImplicitAny`	`boolean`	`false`	在表达式和声明上有隐含的'any'类型时报错。
`--noImplicitReturns`	`boolean`	`false`	不是函数的所有返回路径都有返回值时报错。
`--noImplicitThis`	`boolean`	`false`	当`this`表达式的值为`any`类型的时候，生成一个错误。
`--noImplicitUseStrict`	`boolean`	`false`	模块输出中不包含'use strict'指令。
`--noLib`	`boolean`	`false`	不包含默认的库文件（lib.d.ts）。
`--noResolve`	`boolean`	`false`	不把/// <reference``>或模块导入的文件加到编译文件列表。
`--noUnusedLocals`	`boolean`	`false`	若有未使用的局部变量则抛错。
`--noUnusedParameters`	`boolean`	`false`	若有未使用的参数则抛错。
~~`--out`~~	`string`		弃用。使用 `--outFile` 代替。
`--outDir`	`string`		重定向输出目录。
`--outFile`	`string`		将输出文件合并为一个文件。合并的顺序是根据传入编译器的文件顺序和///<reference``>和`import`的文件顺序决定的。查看输出文件顺序文件了解详情。
`paths`[2]	`Object`		模块名到基于`baseUrl`的路径映射的列表。查看模块解析文档了解详情。
`--preserveConstEnums`	`boolean`	`false`	保留`const`和`enum`声明。查看const enums documentation了解详情。
`--pretty`[1]	`boolean`	`false`	给错误和消息设置样式，使用颜色和上下文。
`--project` `-p`	`string`		编译指定目录下的项目。这个目录应该包含一个`tsconfig.json`文件来管理编译。查看tsconfig.json文档了解更多信息。
`--reactNamespace`	`string`	`"React"`	当目标为生成'react' JSX时，指定`createElement`和`__spread`的调用对象
`--removeComments`	`boolean`	`false`	删除所有注释，除了以`/!*`开头的版权信息。
`--rootDir`	`string`	(common root directory is computed from the list of input files)	仅用来控制输出的目录结构`--outDir`。
`rootDirs`[2]	`string[]`		根（root）文件夹列表，联给了代表运行时表示工程结构的内容。查看模块解析文档了解详情。
`--skipLibCheck`	`boolean`	`false`	不检查默认库文件（`lib.d.ts`）的正确性。
`--skipDefaultLibCheck`	`boolean`	`false`	不检查用户定义的库文件（`*.d.ts`）的正确性。
`--sourceMap`	`boolean`	`false`	生成相应的'.map'文件。
`--sourceRoot`	`string`		指定TypeScript源文件的路径，以便调试器定位。当TypeScript文件的位置是在运行时指定时使用此标记。路径信息会被加到`sourceMap`里。
`--strictNullChecks`	`boolean`	`false`	在严格的`null`检查模式下，`null`和`undefined`值不包含在任何类型里，只允许用它们自己和`any`来赋值（有个例外，`undefined`可以赋值到`void`）。
`--stripInternal`[1]	`boolean`	`false`	不对具有`/** @internal */` JSDoc注解的代码生成代码。
`--suppressExcessPropertyErrors`[1]	`boolean`	`false`	阻止对对象字面量的额外属性检查。
`--suppressImplicitAnyIndexErrors`	`boolean`	`false`	阻止`--noImplicitAny`对缺少索引签名的索引对象报错。查看issue #1232了解详情。
`--target` `-t`	`string`	`"ES5"`	指定ECMAScript目标版本'ES3' (默认)，'ES5'，或'ES6'[1]
`--traceResolution`	`boolean`	`false`	生成模块解析日志信息
`--types`	`string[]`		要包含的类型声明文件名列表。
`--typeRoots`	`string[]`		要包含的类型声明文件路径列表。
`--version` `-v`			打印编译器版本号。
`--watch` `-w`			在监视模式下运行编译器。会监视输出文件，在它们改变时重新编译。

[1] 这些选项是试验性的。
[2] 这些选项只能在tsconfig.json里使用，不能在命令行使用。

TypeScript 编译选项

相关信息