tsconfig.json 编译器配置大全

一般来说,项目的 TS 编译器配置全部存储在项目根目录下的 tsconfig.json 文件中

当编译器启动时,首先会读取 tsconfig.json,以获取有关如何编译项目的说明(例如,要编译哪些源文件,在哪里存储输出等)
下面介绍常见 tsconfig compilerOptions 的编译选项:

1、target

用于指定编译之后的版本目录

"target": "es5",

2、module

用来指定要使用的模板标准,常见的有 Node.js 的 CommonJS、ES6 标准的 esnext、requireJS 的 AMD

"module": "commonjs",

3、lib

用于指定要包含在编译中的库文件,通过这些库文件,告诉 ts 编译器可以使用哪些功能
例如,指定 dom 的库文件,这个库文件会告诉编译器 dom api 的接口,当我们在 ts 代码中使用 dom 时(例如执行 document.getElementById("root") ),编译器就指定该如何进行检查。

"lib":[
  "es6",
  "dom"
],

4、allowJs

用来指定是否允许编译 JS 文件,默认 false, 即不编译 JS 文件

"allowJs": true,

5、checkJs

用来指定是否检查和报告 JS 文件中的错误,默认 false

"checkJs": true,

6、jsx

指定 jsx 代码用于的开发环境,preserve、react-native、react

"jsx": "preserve",

7、declaration

用来指定是否在编译的时候生成相的 d.ts 声明文件,如果设为 true, 编译每个 ts 文件之后会生成一个 js 文件和一个声明文件,但是 declaration 和 allowJs 不能同时设为 true

"declaration": true,

8、declarationMap

用来指定编译时是否生成. map 文件

"declarationMap": true,

9、socuceMap

用来指定编译时是否生成. map 文件

"sourceMap": true,

10、outFile

用于指定输出文件合并为一个文件,只有设置 module 的值为 amd 和 system 模块时才支持这个配置

"outFile": "./",

11、outDir

用来指定输出文件夹,值为一个文件夹路径字符串,输出的文件都将放置在这个文件夹

"outDir": "./",

12、rootDir

用来指定编译文件的根目录,编译器会在根目录查找入口文件

"rootDir": "./",

13、composite

是否编译构建引用项目

"composite": true,

14、removeComments

用于指定是否将编译后的文件注释删掉,设为 true 的话即删除注释,默认为 false

"removeComments": true,

15、noEmit

不生成编译文件

"noEmit": true,

16、importHelpers

指定是否引入 tslib 里的复制工具函数,默认为 false

"importHelpers": true,

17、downlevelIteration

当 target 为 "ES5" 或 "ES3" 时,为 "for-of" "spread" 和 "destructuring" 中的迭代器提供完全支持

"downlevelIteration": true,

18、isolatedModules

指定是否将每个文件作为单独的模块,默认为 true,不可以和 declaration 同时设定

"isolatedModules": true,

19、strict

用于指定是否启动所有类型检查,如果设为 true 这回同时开启下面这几个严格检查,默认为 false

"strict": true,

20、noImplicitAny

如果我们没有一些值设置明确类型,编译器会默认认为这个值为 any 类型,如果将 noImplicitAny 设为 true, 则如果没有设置明确的类型会报错,默认值为 false

"noImplicitAny": true,

21、strictNullChecks

当设为 true 时,null 和 undefined 值不能赋值给非这两种类型的值,别的类型的值也不能赋给他们,除了 any 类型,还有个例外就是 undefined 可以赋值给 void 类型

"strictNullChecks": true,

22、strictFunctionTypes

用来指定是否使用函数参数双向协变检查

"strictFunctionTypes": true,

23、strictBindCallApply

设为 true 后对 bind、call 和 apply 绑定的方法的参数的检测是严格检测

"strictBindCallApply": true,

24、strictPropertyInitialization

设为 true 后会检查类的非 undefined 属性是否已经在构造函数里初始化,如果要开启这项,需要同时开启 strictNullChecks, 默认为 false

"strictPropertyInitialization": true,

25、noImplicitThis

当 this 表达式的值为 any 类型的时候,生成一个错误

"noImplicitThis": true,

26、alwaysStrict

指定始终以严格模式检查每个模块,并且在编译之后的 JS 文件中加入 "use strict" 字符串,用来告诉浏览器该 JS 为严格模式

"alwaysStrict": true,

27、noUnusedLocals

用于检查是否有定义了但是没有使用变量,对于这一点的检测,使用 ESLint 可以在你书写代码的时候做提示,你可以配合使用,他的默认值为 false

"noUnusedLocals": true,

28、noUnusedParameters

用于检测是否在函数中没有使用的参数

"noUnusedParameters": true,

29、noImplicitReturns

用于检查函数是否有返回值,设为 true 后,如果函数没有返回值则会提示,默认为 false

"noImplicitReturns": true,

30、noFallthroughCasesInSwitch

用于检查 switch 中是否有 case 没有使用 break 跳出 switch, 默认为 false

"noFallthroughCasesInSwitch": true,

31、moduleResolution

用于选择模块解析策略,有 "node" 和 "classic" 两种类型

"moduleResolution": "node",

32、baseUrl

用于设置解析非相对模块名称的基本目录,相对模块不会受到 baseUrl 的影响

"baseUrl": "./",

33、paths

用于设置模块名到基于 baseUrl 的路径映射

"paths": {
      "*":["./node_modules/@types", "./typings/*"]
    },

34、rootDirs

可以指定一个路径列表,在构建时编译器会将这个路径中的内容都放到一个文件夹中

"rootDirs": [],

35、typeRoots

用来指定声明文件或文件夹的路径列表,如果指定了此项,则只有在这里列出的声明文件才会被加载

"typeRoots": [],

36、types

用于指定需要包含的模块,只有在这里列出的模块的声明文件才会被加载

"types": [],

37、allowSyntheticDefaultImports

用来指定允许从没有默认导出的模块中默认导入

"allowSyntheticDefaultImports": true,

38、esModuleInterop

通过导入内容创建命名空间,实现 CommonJS 和 ES 模块之间的互操作性

"esModuleInterop": true,

不把符号链接解析为真实路径,具体可以了解下 webpack 和 node.js 的 symlink 相关知识

"preserveSymlinks": true,

40、sourceRoot

用于指定调试器应该找到 TypeScript 文件而不是源文件的位置,这个值会被写进. map 文件里

"sourceRoot": "",

41、mapRoot

用于指定调试器找到映射文件而非生成文件的位置,指定 map 文件的根路径,该选项会影响. map 文件中的 sources 属性

"mapRoot": "",

42、inlineSourceMap

指定是否将 map 文件内容和 js 文件编译在一个同一个 js 文件中,如果设为 true, 则 map 的内容会以 //#soureMappingURL = 开头,然后接 base64 字符串的形式插入在 js 文件底部

"inlineSourceMap": true,

43、inlineSources

用于指定是否进一步将 ts 文件的内容也包含到输出文件中

"inlineSources": true,

44、experimentalDecorators

用于指定是否启用实验性的装饰器特性

"experimentalDecorators": true,

45、emitDecoratorMetadata

用于指定是否为装上去提供元数据支持,关于元数据,也是 ES6 的新标准,可以通过 Reflect 提供的静态方法获取元数据,如果需要使用 Reflect 的一些方法,需要引用 ES2015.Reflect 这个库

"emitDecoratorMetadata": true,

46、include

指定要编译的路径列表

"include":[],

47、files

可以配置一个数组列表

"files":[],

48、exclude

表示要排除的,不编译的文件,它也可以指定一个列表,规则和 include 一样,可以是文件可以是文件夹,可以是相对路径或绝对路径,可以使用通配符

"exclude":[]

49、extends

可以通过指定一个其他的 tsconfig.json 文件路径,来继承这个配置文件里的配置,继承来的文件的配置会覆盖当前文件定义的配置

"extends":""

50、compileOnSave

如果设为 true, 在我们编辑了项目文件保存的时候,编辑器会根据 tsconfig.json 的配置更新重新生成文本,不过这个编辑器支持

"compileOnSave":true

51、references

一个对象数组,指定要引用的项目

"references":[]
posted @ 2021-05-11 22:05  Leophen  阅读(78)  评论(0编辑  收藏  举报