Vue.js 与 TypeScript（3）：tsconfig.json详细配置

TS代码是不能直接被编译的，如果要执行TypeScript代码，必须要将其转换编译成JavaScript代码，而编译的命令不管是直接tsc也好，还是之前用的ts-node也好，都是根据配置文件的规则进行编译。当初始化项目之后，就会存在一个配置文件，文件名：tsconfig.json，如果编译时没有这个配置文件，那么编译就会报错，编译失败。

1 编译范围

在TS中一共有三个字段代表编译范围，分别是："include"，"exclude"，"files"

1.1 files配置项

files配置项，它代表有哪些ts文件需要被编译，它的值类型为数组，里面存储的都是相对路径或绝对路径，它不支持匹配模式，具体示例如下：

{
	"files": [
        "./core.ts",
        "../sys.ts",
        "types.ts",
    ]
}

1.2 include配置项

include配置项，它的用法和files有点类似，主要也是用来描述有哪些ts文件需要被编译，区别是，它支持glob匹配模式，先看个具体的例子：

"include": ["env.d.ts", "src/**/*", "src/**/*.vue"]

glob匹配模式，一共有以下三种：

• * 匹配0或多个字符（不包括目录分隔符）
• ? 匹配一个任意字符（不包括目录分隔符）
• **/ 递归匹配任意子目录

拿例子中的"src/**/*"说明，就是src目录下任意文件夹下的任意.ts文件，再加上它是include，那么就是代表这个路径下的所有.ts文件都需要被编译。

1.3 exclude配置项

include配置项，它和Include的用法正好相反，它代表着，在其内的文件是排除在外，不被编译，除此之外的所有ts文件都会被编译，先看个例子：

"exclude": [
    "node_modules",
    "**/*.spec.ts"
]

用法和include类似，如果exclude和include以及files同时出现时遵循如下规则：

• include中的文件，可以被exclude过滤掉
• files中的文件，是不会被exclude给过滤掉的
• exclude存在默认值，node_modules，bower_components，jspm_packages和目录，这几个目录如果没有特殊指定，会被默认排除在外

2 compilerOptions配置项

compilerOptions配置项，这个对象中存储着所有TypeScript编译时的规则选项。

2.1 target

编译后的目标版本，我们知道JavaScript有很多版本，而不同的浏览器，不同的版本所支持JS版本也是不同的，比如：ES5，ES6什么的，最终打包的时候，我们肯定是期望是打包完的代码能最终运行到绝大多数浏览器上，那么这里我们可以填：

"compilerOptions": {
  	// 这里可以填很多，比如：'ES3' (default)，'ES2015'
    // , 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'
    // "target": "ES2019",      
}

2.2 module

编译后代码遵循的规范，众所周知，自从有了NodeJS之后，js代码不仅仅是在前端使用了，各种地方，各种环境都可以用到，那么不同的环境JS代码遵循的规范也是不一样的，比如，常见的规范有ES规范有：es规范，commonjs规范

"compilerOptions": {
  	// 这里可以填很多，比如：'none', 'commonjs', 'amd'
    //, 'system', 'umd', 'es2015', or 'ESNext'
    // "module": "es2015", 
}

2.3 removeComments

注释清空，默认为false，当值为true的时候，编译时会自动删除注释说明

"removeComments": true

2.4 strict

严格书写规范，这一块区域的内容代表Typescript的书写规范，这个属性建议不要改，否则TS就失去意义了。

"strict": true  // 可以理解成书写规范的总开关,
// "noImplicitAny": true,                 /* 是否必须写any类型， */
// "strictNullChecks": true,              /* 不强制验证null类型 */
// "strictFunctionTypes": true,           /* 不强制验证函数类型 */
// "strictBindCallApply": true,           
// "strictPropertyInitialization": true,  
// "noImplicitThis": true,               
// "alwaysStrict": true,                 

2.5 rootDir

入口文件，这个其实和编译范围的用法很接近，都是告诉TypeScript，从哪里开始编译。如果tsconfig.json中的rootDir如下所写。那么执行命令进行编译的时候，会将所有src目录下的所有.ts文件进行编译

"rootDir": "./src",      

2.6 outDir

和rootDir相对，并且是可以配合使用的，还是使用outDir的例子，默认情况下，所有被编译的.ts文件生成.js文件后都是在同目录下放置的，类似于Vue或者React进行打包的时候它会将文件生成在指定目录，比如：dist或者build之类的

"outDir": "./dist",      

2.7 incremental

增量编译，就是每一次执行编译的时候，会不会全文件重新编译一遍。如果是true，那么TypeScript会生成一个tsconfig.tsbuildInfo文件，这个文件会存储上次编译文件的所有信息，下次执行编译的时候，如果发现文件没有更改过，那么会跳过这次编译，只对修改的文件进行编译

"incremental": true,

2.8 allowJs

是否对JS文件也进行编译，我们知道.ts文件肯定会被编译的，但是如果想将JS文件也一起被编译那么这个值就可以放开

"allowJs": true, 

2.9 checkJs

这个字段代表的意思是，是否需要检测JS代码，比如有时候我们的JS代码语法用错了，或者保留字拼错了，那么此时，如果这个字段放开后，会检测代码是否合法，如果不合法那么就会报错

"checkJs": true,

2.10 noUnusedLocals

这个字段代表，如果定义了一个变量，没有在任何地方使用到，那么ts会提示警告，警告一下该变量没有在任何地方用到，字段配置如下

"noUnusedLocals": true,    

2.11 baseUrl

这个字段代表当前项目的根路径，设置后可以代表了当前项目的根路径进行了变更，默认是"./"，也就是当前目录。

3 其他详细配置

下面是详细的配置项参考说明：

"compilerOptions": {
  "incremental": true, // TS编译器在第一次编译之后会生成一个存储编译信息的文件，第二次编译会在第一次的基础上进行增量编译，可以提高编译的速度
  "tsBuildInfoFile": "./buildFile", // 增量编译文件的存储位置
  "diagnostics": true, // 打印诊断信息 
  "target": "ES5", // 目标语言的版本
  "module": "CommonJS", // 生成代码的模板标准
  "outFile": "./app.js", // 将多个相互依赖的文件生成一个文件，可以用在AMD模块中，即开启时应设置"module": "AMD",
  "lib": ["DOM", "ES2015", "ScriptHost", "ES2019.Array"], // TS需要引用的库，即声明文件，es5 默认引用dom、es5、scripthost,如需要使用es的高级版本特性，通常都需要配置，如es8的数组新特性需要引入"ES2019.Array",
  "allowJS": true, // 允许编译器编译JS，JSX文件
  "checkJs": true, // 允许在JS文件中报错，通常与allowJS一起使用
  "outDir": "./dist", // 指定输出目录
  "rootDir": "./", // 指定输出文件目录(用于输出)，用于控制输出目录结构
  "declaration": true, // 生成声明文件，开启后会自动生成声明文件
  "declarationDir": "./file", // 指定生成声明文件存放目录
  "emitDeclarationOnly": true, // 只生成声明文件，而不会生成js文件
  "sourceMap": true, // 生成目标文件的sourceMap文件
  "inlineSourceMap": true, // 生成目标文件的inline SourceMap，inline SourceMap会包含在生成的js文件中
  "declarationMap": true, // 为声明文件生成sourceMap
  "typeRoots": [], // 声明文件目录，默认时node_modules/@types
  "types": [], // 加载的声明文件包
  "removeComments":true, // 删除注释 
  "noEmit": true, // 不输出文件,即编译后不会生成任何js文件
  "noEmitOnError": true, // 发送错误时不输出任何文件
  "noEmitHelpers": true, // 不生成helper函数，减小体积，需要额外安装，常配合importHelpers一起使用
  "importHelpers": true, // 通过tslib引入helper函数，文件必须是模块
  "downlevelIteration": true, // 降级遍历器实现，如果目标源是es3/5，那么遍历器会有降级的实现
  "strict": true, // 开启所有严格的类型检查
  "alwaysStrict": true, // 在代码中注入'use strict'
  "noImplicitAny": true, // 不允许隐式的any类型
  "strictNullChecks": true, // 不允许把null、undefined赋值给其他类型的变量
  "strictFunctionTypes": true, // 不允许函数参数双向协变
  "strictPropertyInitialization": true, // 类的实例属性必须初始化
  "strictBindCallApply": true, // 严格的bind/call/apply检查
  "noImplicitThis": true, // 不允许this有隐式的any类型
  "noUnusedLocals": true, // 检查只声明、未使用的局部变量(只提示不报错)
  "noUnusedParameters": true, // 检查未使用的函数参数(只提示不报错)
  "noFallthroughCasesInSwitch": true, // 防止switch语句贯穿(即如果没有break语句后面不会执行)
  "noImplicitReturns": true, //每个分支都会有返回值
  "esModuleInterop": true, // 允许export=导出，由import from 导入
  "allowUmdGlobalAccess": true, // 允许在模块中全局变量的方式访问umd模块
  "moduleResolution": "node", // 模块解析策略，ts默认用node的解析策略，即相对的方式导入
  "baseUrl": "./", // 解析非相对模块的基地址，默认是当前目录
  "paths": { // 路径映射，相对于baseUrl
    // 如使用jq时不想使用默认版本，而需要手动指定版本，可进行如下配置
    "jquery": ["node_modules/jquery/dist/jquery.min.js"]
  },
  "rootDirs": ["src","out"], // 将多个目录放在一个虚拟目录下，用于运行时，即编译后引入文件的位置可能发生变化，这也设置可以虚拟src和out在同一个目录下，不用再去改变路径也不会报错
  "listEmittedFiles": true, // 打印输出文件
  "listFiles": true// 打印编译的文件(包括引用的声明文件)
}