全国协议5人面授小班,企业级独立开发考核,转业者的IT软件工程师基地 登录/注册 | 如何报名
当前位置: 前端开发   >  TypeScript 编译选项
admin · 更新于 2021-08-06

1. 解释

我们通过编译选项 --watch 为例,在当前目录创建 main.ts 文件,写入内容:

enum Season {
  Spring,
  Summer,
  Autumn,
  Winter}
代码块
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

在命令行执行:

tsc main.ts --watch
代码块
  • 1

编译选项 --watch 使编译器在监视模式下运行,会监视输出文件,在它们改变时重新编译。

2. 编译选项

选项类型默认值描述
–allowJsbooleanfalse允许编译 JavaScript 文件
–allowSyntheticDefaultImportsbooleanfalse允许从没有设置默认导出的模块中默认导入
–allowUnreachableCodebooleanfalse不报告执行不到的代码错误
–allowUnusedLabelsbooleanfalse不报告未使用的标签错误
–alwaysStrictbooleanfalse以严格模式解析并为每个源文件生成 "use strict" 语句
--baseUrlstring解析非相对模块名的基准目录
–charsetstring“utf8”输入文件的字符集
–checkJsbooleanfalse在 .js 文件中报告错误,与 --allowJs 配合使用
–declaration
-d
booleanfalse生成相应的 .d.ts 文件
–declarationDirstring生成声明文件的输出路径
–diagnosticsbooleanfalse显示诊断信息
–disableSizeLimitbooleanfalse禁用 JavaScript 工程体积大小的限制
–emitBOMbooleanfalse在输出文件的开头加入BOM头(UTF-8 Byte Order Mark)
–emitDecoratorMetadata[1]booleanfalse给源码里的装饰器声明加上设计类型元数据。查看 issue #2577 了解更多信息。
–experimentalDecorators[1]booleanfalse启用实验性的ES装饰器
–extendedDiagnosticsbooleanfalse显示详细的诊断信息
–forceConsistentCasingInFileNamesbooleanfalse禁止对同一个文件的不一致的引用
–help
-h
打印帮助信息
–importHelpersstring从 tslib 导入辅助工具函数(比如 __extends, __rest等)
–inlineSourceMapbooleanfalse生成单个 sourcemaps 文件,而不是将每 sourcemaps 生成不同的文件
–inlineSourcesbooleanfalse将代码与 sourcemaps 生成到一个文件中,要求同时设置了 --inlineSourceMap 或 --sourceMap 属性
--init初始化 TypeScript 项目并创建一个 tsconfig.json 文件
–isolatedModulesbooleanfalse将每个文件作为单独的模块(与 “ts.transpileModule” 类似)
–jsxstring“Preserve”在 .tsx 文件里支持 JSX: “React” 或 “Preserve”。
–jsxFactorystring“React.createElement”指定生成目标为 react JSX 时,使用的 JSX 工厂函数,比如 React.createElement 或 h
–libstring[]编译过程中需要引入的库文件的列表。
可能的值为:
► ES5
► ES6
► ES2015
► ES7
► ES2016
► ES2017
► ES2018
► ESNext
► ES5
► ES5
► ES5
► ES5
► ES5
► ES5
► DOM
► DOM.Iterable
► 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.Intl
► ES2017.SharedMemory
► ES2017.String
► ES2017.TypedArrays
► ES2018.Intl
► ES2018.Promise
► ES2018.RegExp
► ESNext.AsyncIterable
► ESNext.Array
► ESNext.Intl
► ESNext.Symbol

注意:如果 --lib 没有指定默认注入的库的列表。默认注入的库为:
► 针对于 --target ES5DOM,ES5,ScriptHost
► 针对于 --target ES6DOM,ES6,DOM.Iterable,ScriptHost
–listEmittedFilesbooleanfalse打印出编译后生成文件的名字
–listFilesbooleanfalse编译过程中打印文件名
–localestring(platform specific)显示错误信息时使用的语言,比如:en-us
–mapRootstring为调试器指定指定 sourcemap 文件的路径,而不是使用生成时的路径。当 .map 文件是在运行时指定的,并不同于 js 文件的地址时使用这个标记。指定的路径会嵌入到 sourceMap 里告诉调试器到哪里去找它们
–maxNodeModuleJsDepthnumber0node_modules 依赖的最大搜索深度并加载 JavaScript 文件,仅适用于 --allowJs
–module
-m
stringtarget === “ES6” ? “ES6” : “commonjs”指定生成哪个模块系统代码: “None”, “CommonJS”, “AMD”, “System”, “UMD”, "ES6"或 “ES2015”。
► 只有 "AMD"和 "System"能和 --outFile一起使用。
► "ES6"和 "ES2015"可使用在目标输出为 "ES5"或更低的情况下。
–moduleResolutionstringmodule === “AMD” or “System” or “ES6” ? “Classic” : “Node”决定如何处理模块。或者是 “Node” 对于 Node.js/io.js,或者是 “Classic”(默认)
–newLinestring(platform specific)当生成文件时指定行结束符: "crlf"(windows)或 "lf"(unix)
–noEmitbooleanfalse不生成输出文件
–noEmitHelpersbooleanfalse不在输出文件中生成用户自定义的帮助函数代码,如 __extends
–noEmitOnErrorbooleanfalse报错时不生成输出文件
–noErrorTruncationbooleanfalse不截短错误消息
–noFallthroughCasesInSwitchbooleanfalse报告 switch 语句的 fallthrough 错误。(即,不允许 switch 的 case 语句贯穿)
--noImplicitAnybooleanfalse在表达式和声明上有隐含的 any 类型时报错
–noImplicitReturnsbooleanfalse不是函数的所有返回路径都有返回值时报错
–noImplicitThisbooleanfalse当 this 表达式的值为 any 类型的时候,生成一个错误
–noImplicitUseStrictbooleanfalse模块输出中不包含 “use strict” 指令
–noLibbooleanfalse不包含默认的库文件( lib.d.ts )
–noResolvebooleanfalse不把 /// <reference``> 或模块导入的文件加到编译文件列表
–noStrictGenericChecksbooleanfalse禁用在函数类型里对泛型签名进行严格检查
–noUnusedLocalsbooleanfalse若有未使用的局部变量则抛错
–noUnusedParametersbooleanfalse若有未使用的参数则抛错
--outDirstring重定向输出目录
–outFilestring将输出文件合并为一个文件,合并的顺序是根据传入编译器的文件顺序和 ///<reference``> 和 import 的文件顺序决定的
–skipDefaultLibCheckbooleanfalse忽略库的默认声明文件的类型检查
–skipLibCheckbooleanfalse忽略所有的声明文件( *.d.ts )的类型检查
--sourceMapbooleanfalse生成相应的 .map 文件
–sourceRootstring指定 TypeScript 源文件的路径,以便调试器定位。当 TypeScript 文件的位置是在运行时指定时使用此标记, 路径信息会被加到 sourceMap 里
--strictbooleanfalse启用所有严格类型检查选项
–strictFunctionTypesbooleanfalse禁用函数参数双向协变检查
–strictPropertyInitializationbooleanfalse确保类的非 undefined 属性已经在构造函数里初始化。若要令此选项生效,需要同时启用 --strictNullChecks
--strictNullChecksbooleanfalse在严格的 null 检查模式下,null 和 undefined 值不包含在任何类型里,只允许用它们自己和 any 来赋值(有个例外, undefined 可以赋值到 void)
–stripInternal[1]booleanfalse不对具有 /** @internal */ JSDoc注解的代码生成代码
–suppressExcessPropertyErrors[1]booleanfalse阻止对对象字面量的额外属性检查
–suppressImplicitAnyIndexErrorsbooleanfalse阻止 --noImplicitAny 对缺少索引签名的索引对象报错。查看 issue #1232 了解详情。
--target <br> -tstring“ES3”指定ECMAScript目标版本 "ES3"(默认), "ES5", "ES6""ES2015", "ES2016", "ES2017" 或 "ESNext"

注意: "ESNext" 最新的生成目标列表为 ES proposed features
–traceResolutionbooleanfalse生成模块解析日志信息
–typesstring[]要包含的类型声明文件名列表
–typeRootsstring[]要包含的类型声明文件路径列表
--version <br> -v打印编译器版本号
–watch
-w
在监视模式下运行编译器。会监视输出文件,在它们改变时重新编译。监视文件和目录的具体实现可以通过环境变量进行配置
  • [1] 这些选项是试验性的

3. 小结

本小节梳理了 TypeScript 的众多编译选项,可以先通读一遍,大致了解有些什么功能,在项目中需要使用时再来查阅即可。


为什么选择汉码未来