参考
了不起的 tsconfig.json 指南
tsconfig.json文件各字段吐血整理
一、简介
1. 什么是 tsconfig.json
TypeScript 使用 tsconfig.json 文件作为其配置文件，当一个目录中存在 tsconfig.json 文件，则认为该目录为 TypeScript 项目的根目录。
2. 为什么使用 tsconfig.json
通常我们可以使用 tsc 命令来编译少量 TypeScript 文件：
/*
参数介绍：
--outFile // 编译后生成的文件名称
--target // 指定ECMAScript目标版本
--module // 指定生成哪个模块系统代码
index.ts // 源文件
*/
$ tsc --outFile leo.js --target es3 --module amd index.ts
但如果实际开发的项目，很少是只有单个文件，当我们需要编译整个项目时，就可以使用 tsconfig.json 文件，将需要使用到的配置都写进 tsconfig.json 文件，这样就不用每次编译都手动输入配置，另外也方便团队协作开发。
3.初始化 tsconfig.json
在初始化操作，也有 2 种方式：
- 手动在项目根目录（或其他）创建 tsconfig.json 文件并填写配置；
- 通过 tsc --init 初始化 tsconfig.json 文件。
二、实例
1.learnTsconfig/src/index.ts
// 返回当前版本号
function getVersion(version:string = "1.0.0"): string{
return version;
}
console.log(getVersion("1.0.1"))
2.初始化 tsconfig.json 文件
在 learnTsconfig 根目录执行：
E:\ts\learnTsconfig>tsc --init
Created a new tsconfig.json with:
target: es2016
module: commonjs
strict: true
esModuleInterop: true
skipLibCheck: true
forceConsistentCasingInFileNames: true
You can learn more at https://aka.ms/tsconfig.json
3.常用配置
{
"compilerOptions": {
"target": "ES5", // 目标语言的版本
"module": "commonjs", // 指定生成代码的模板标准
"noImplicitAny": true, // 不允许隐式的 any 类型
"removeComments": true, // 删除注释
"preserveConstEnums": true, // 保留 const 和 enum 声明
"sourceMap": true // 生成目标文件的sourceMap文件
},
"files": [ // 指定待编译文件
"./src/index.ts"
]
}
files 配置项值是一个数组，用来指定了待编译文件，即入口文件。当入口文件依赖其他文件时，不需要将被依赖文件也指定到 files 中，因为编译器会自动将所有的依赖文件归纳为编译对象，即 index.ts 依赖 user.ts 时，不需要在 files 中指定 user.ts ， user.ts 会自动纳入待编译文件。
执行tsc命令，可以看到src文件下生成的js文件，可以使用node src/index.js命令执行。
三、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// 打印编译的文件(包括引用的声明文件)
1.延迟初始化 strictPropertyInitialization
参考
ts 更严格的类属性检查
Typescript 2.7 引入了一个新的控制严格性的标记 –strictPropertyInitialization, 这个参数在 tsconfig.ts 中来配置
开启方式：
"strictNullChecks": true
"strictPropertyInitialization": true
作用
- 使用这个标记会确保类的每个实例属性都会在构造函数里或使用属性初始化器赋值。
- 它会明确地进行从变量到类的实例属性的赋值检查
举例
class C {
foo: number;
bar = "hello";
baz: boolean;
constructor() {
this.foo = 42;
}
}
上述代码，首先编辑器会报错： 属性“baz”没有初始化表达式，且未在构造函数中明确赋值。ts(2564)。
其次在编译报错：error TS2564: Property 'baz' has no initializer and is not definitely assigned in the constructor.
两种都告诉开发者，应该给 baz 显示赋值，但是某种情况下，在初始化的时候我们并不想赋值，更期望是 undefined，而后再去赋值，此时 !: 就派上用场了。
在上述代码中 属性 baz 冒号之前加上 ! ,这样就不会报错了
class C {
foo: number;
bar = "hello";
baz!: boolean;
constructor() {
this.foo = 42;
}
}
四、eslint
参考
放弃 TSLint，使用 ESLint
TypeScript如何使用ESLint进行代码检测
1.放弃 TSLint
ESLint 支持 ECMAScript 和 JavaScript，而 TSLint 仅支持 TypeScript。因此，TSLint 官方已经于 2019 年放弃了 TSLint，转而呼吁开发者们使用 ESLint 作为替代。
https://palantir.github.io/tslint/
warning: TSLint has been deprecated as of 2019. Please see this issue for more details: Roadmap: TSLint → ESLint. typescript-eslint is now your best option for linting TypeScript.
2.实践
参考
ESLint 使用简介
先在VSCODE中安装eslint插件，并重启。新建一个Test.ts如下：
export class Test{
private a:number;
constructor(){
}
private fun1():void{
console.log(this.a);
}
}
现在，先使用eslint -v检查一下，如果没有安装，则需要进行全局安装：
npm i eslint -g
D:\ts\HelloWorld>eslint -v
v8.10.0
然后就可以使用eslint --init来初始化配置文件了：
D:\ts\HelloWorld>eslint --init
You can also run this command directly using 'npm init @eslint/config'.
Need to install the following packages:
@eslint/create-config
Ok to proceed? (y)
看来这里最新的版本初始化命令有所变化，可以参考前端代码规范化之create-react-app项目添加eslint
选了yes后，开始回答问题，注意红框处，问我们项目是不是在用TypeScript，这里选Yes，后面又提示安装ts-eslint相关内容。
D:\ts\HelloWorld>eslint src/Test.ts
D:\ts\HelloWorld\src\Test.ts
2:13 error Parsing error: Unexpected token a
✖ 1 problem (1 error, 0 warnings)
3.更复杂的配置
参考
在TypeScript项目中使用ESLint，看这篇就够了
VS Code下Eslint+Prettier+TypeScript一步到位（规范配置）
