前言

当需要对项目中所有文件进行ts编译时，需要使用tsconfig.json进行配置
tsconfig.json是一个JSON文件，添加配置文件后，只需 tsc 命令即可完成对整个项目的编译

文件配置

以下是对tsconfig.json文件的配置介绍

一、配置选项：

1.1 include

定义希望被编译文件所在的目录默认值：["**/*"]

示例：

"include":["src/**/*", "tests/**/*"]

上述示例中，所有src目录和tests目录下的文件都会被编译

1.2 exclude

定义需要排除在外的目录默认值：["node_modules", "bower_components", "jspm_packages"]

示例：

"exclude": ["./src/hello/**/*"]

上述示例中，src下hello目录下的文件都不会被编译

1.3 extends

定义被继承的配置文件

示例：

"extends": "./configs/base"

上述示例中，当前配置文件中会自动包含config目录下base.json中的所有配置信息

1.4 files

指定被编译文件的列表，只有需要编译的文件少时才会用到

示例：

"files": [
    "core.ts",
    "sys.ts",
    "types.ts",
    "scanner.ts",
    "parser.ts",
    "utilities.ts",
    "binder.ts",
    "checker.ts",
    "tsc.ts"
  ]

列表中的文件都会被TS编译器所编译

二、编译器的选项（compilerOptions）：

编译选项是配置文件中非常重要也比较复杂的配置选项在compilerOptions中包含多个子选项，用来完成对编译的配置

2.1 target

设置ts代码编译的目标版本

可选值： ES3（默认）、ES5、ES6/ES2015、ES7/ES2016、ES2017、ES2018、ES2019、ES2020、ESNext

示例：

"compilerOptions": {
    "target": "ES6"
}

如上设置，我们所编写的ts代码将会被编译为ES6版本的js代码

2.2 lib

指定代码运行时所包含的库（宿主环境）

可选值： ES5、ES6/ES2015、ES7/ES2016、ES2017、ES2018、ES2019、ES2020、ESNext、DOM、WebWorker、ScriptHost ......

示例：

"compilerOptions": {
    "lib": ["ES6", "DOM"],
}

2.3 module

设置编译后代码使用的模块化系统

可选值： CommonJS、UMD、AMD、System、ES2020、ESNext、None

示例：

"compilerOptions": {
    "module": "CommonJS"
}

2.4 outDir

编译后文件的所在目录

默认情况下，编译后的js文件会和ts文件位于相同的目录，设置outDir后可以改变编译后文件的位置

示例：

"compilerOptions": {
    "outDir": "dist"
}

设置后编译后的js文件将会生成到dist目录

2.5 outFile

将所有的文件编译为一个js文件

默认会将所有的编写在全局作用域中的代码合并为一个js文件，如果module制定了None、System或AMD则会将模块一起合并到文件之中

示例：

"compilerOptions": {
    "outFile": "dist/app.js"
}

2.7 rootDir

指定代码的根目录，默认情况下编译后文件的目录结构会以最长的公共目录为根目录，通过rootDir可以手动指定根目录

示例：

"compilerOptions": {
    "rootDir": "./src"
}

2.8 allowJs

是否对js文件编译示例：

"compilerOptions": {
    "allowJs": true,
}

2.9 checkJs

是否对js文件进行检查

示例：

"compilerOptions": {
    "checkJs": true
}

2.10 removeComments

是否删除注释默认值：false

2.11 noEmit

不对代码进行编译默认值：false

2.12 sourceMap

是否生成sourceMap 默认值：false

三、严格检查

3.1 strict

启用所有的严格检查默认值: true 设置后相当于开启了所有的严格检查

3.2 alwaysStrict

总是以严格模式对代码进行编译

3.3 noImplicitAny

禁止隐式的any类型

3.4 noImplicitThis

禁止类型不明确的this

3.5 strictBindCallApply

严格检查bind、call和apply的参数列表

3.6 strictFunctionTypes

严格检查函数的类型

3.7 strictNullChecks

严格的空值检查

3.8 strictPropertyInitialization

严格检查属性是否初始化

TypeScript自动编译选项配置

前言