tsconfig 指南 - 《TypeScript》

简介
使用tsconfig.json
- 初始化
- 指定编译目录
配置介绍
项目完整示例

TypeScript 使用 tsconfig.json 文件作为其配置文件，当一个目录中存在 tsconfig.json 文件，则认为该目录为 TypeScript 项目的根目录。

简介

这个tsconfig.json大体可以分为两个部分，
第一部分是编译的规则配置(compilerOptions)；
第二个部分是对哪些文件进行编译(files,include,exclude)；

最常用的结构代码如下:

{
    "compilerOptions": {},
    "files": [], 
    "include": [],
    "exclude": [] 
}

我们可以使用 tsc 命令来编译少量ts文件：
tsc是全局命令：

npm install -g typescript
npm install -g ts-node

/*
  参数介绍：
  --outFile // 编译后生成的文件名称
  --target  // 指定ECMAScript目标版本
  --module  // 指定生成哪个模块系统代码
  index.ts  // 源文件
*/
$ tsc --outFile leo.js --target es3 --module amd index.ts

但实际项目开发中，会同时编译很多ts文件，所以我们需要使用tsconfig.json配置文件，将需要的内容都配置好，就可以实现团队协作开发。

使用tsconfig.json

初始化

手动新加 tsconfig.json 文件；

使用命令 tsc —init 初始化；

指定编译目录

如果我们运行命令时不指定目录，默认从当前目录编译。
也可以为 tsc 命令指定参数 —project 或 -p，表示需要编译的目录，该目录需要包含一个tsconfig.json的文件；

/*
文件目录：
├─src/
│  ├─index.ts
│  └─tsconfig.json
├─package.json
*/
$ tsc --project src

注意，tsc 的命令行选项具有优先级，会覆盖 tsconfig.json 中的同名选项。

配置介绍

配置文件

{
"compilerOptions": {
 "target": "ES5",             // 目标语言的版本
 "module": "commonjs",        // 指定生成代码的模板标准
 "noImplicitAny": true,       // 不允许隐式的 any 类型
 "removeComments": true,      // 删除注释 
 "preserveConstEnums": true,  // 保留 const 和 enum 声明
 "sourceMap": true            // 生成目标文件的sourceMap文件
},
"files": [   // 指定待编译文件
 "./src/index.ts"  
]
}

files配置项是数组，里面的元素未待编译的文件，如果入口文件有其他依赖文件则不需要都添加进去。

compileOnSave

设置报错文件时，自动编译，单需要编译器支持

compileOptions

编译配置项，如果没有就执行默认项。

{
  // ...
  "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// 打印编译的文件(包括引用的声明文件)
  }
}

include

指定编译包含的文件或目录，支持 glob 通配符：

递归匹配任意子目录

{
// ...
"include": [
 // "scr" // 会编译src目录下的所有文件，包括子目录
 // "scr/*" // 只会编译scr一级目录下的文件
 "scr/*/*" // 只会编译scr二级目录下的文件
]
}

exclude

指定编译器需要排除的目录，规则同include。

extends

引入并继承其他配置。

references

指定工程引用依赖；
如果我们的项目在前端和后端node一起的，又只需要维护一个配置，但我们想灵活配置分别打包，就可以用这个；

{
 // ...
  "references": [ // 指定依赖的工程
     {"path": "./common"}
  ]
}

typeAcquisition

设置自动引入库类型定义文件（d.ts）相关；

enable：布尔类型，是否开启自动引入库类型定义文件(.d.ts)，默认为 false；
include：数组类型，允许自动引入的库名，如：[“jquery”, “lodash”]；

exculde：数组类型，排除的库名。

{
// ...
"typeAcquisition": {
 "enable": false,
 "exclude": ["jquery"],
 "include": ["jest"]
}
}

项目完整示例

{
"include": [
 "src/**/*",
 "packages/**/*",
 "typings/**/*.ts"
],
"compilerOptions": {
 "module": "CommonJS",
 "allowSyntheticDefaultImports": true,
 "moduleResolution": "node",
 "sourceMap": true,
 "pretty": true,
 "diagnostics": true,
 "baseUrl": "./",
 "target": "ES5",
 "jsx": "react",
 "lib": [
   "es6",
   "dom",
 ],
 "paths": {
   "@packages/*": ["packages/*"],
 },
 "forceConsistentCasingInFileNames": true,
 "noImplicitReturns": true,
 "noImplicitThis": true,
 "strictNullChecks": true,
 "suppressImplicitAnyIndexErrors": true,
 "noUnusedLocals": true,
 "noFallthroughCasesInSwitch": true,
 "noUnusedParameters": false,
 "esModuleInterop": true,
 "noImplicitAny": true,
 "experimentalDecorators": true,
 "emitDecoratorMetadata": true
},
"exclude": ["node_modules", "**/node_modules/*"]
}

其他分享文章【了不起的tsconfig.json 指南】