tsconfig.json · TypeScript中文网 (opens new window)
编译选项 · TypeScript中文网 (opens new window)
# compilerOptions
# target
设置ts代码编译的目标版本
可选值:ES3(默认)、ES5、ES6/ES2015、ES7/ES2016、ES2017、ES2018、ES2019、ES2020、ESNext
"compilerOptions": {
"target": "ES6"
}
如上设置,我们所编写的ts代码将会被编译为ES6版本的js代码
# lib
指定代码运行时所包含的库(宿主环境)
可选值: ES5、ES6/ES2015、ES7/ES2016、ES2017、ES2018、ES2019、ES2020、ESNext、DOM、WebWorker、ScriptHost ......
示例:
"compilerOptions": {
"target": "ES6",
"lib": ["ES6", "DOM"],
"outDir": "dist",
"outFile": "dist/aa.js"
}
# module
设置编译后代码使用的模块化系统
可选值:CommonJS、UMD、AMD、System、ES2020、ESNext、None
示例:
"compilerOptions": {
"module": "CommonJS"
}
# outDir
编译后文件的所在目录
默认情况下,编译后的js文件会和ts文件位于相同的目录,设置outDir后可以改变编译后文件的位置
示例:
"compilerOptions": {
"outDir": "dist"
}
设置后编译后的js文件将会生成到dist目录
# rootDir
指定代码的根目录,默认情况下编译后文件的目录结构会以最长的公共目录为根目录,通过rootDir可以手动指定根目录
示例:
"compilerOptions": {
"rootDir": "./src"
}
# allowJs
是否对js文件编译
# checkJs
是否对js文件进行检查
示例:
"compilerOptions": {
"allowJs": true,
"checkJs": true
}
# removeComments
是否删除注释 默认值:false
# 严格检查
strict
- 启用所有的严格检查,默认值为true,设置后相当于开启了所有的严格检查
alwaysStrict
- 总是以严格模式对代码进行编译
noImplicitAny
- 禁止隐式的any类型
noImplicitThis
- 禁止类型不明确的this
strictBindCallApply
- 严格检查bind、call和apply的参数列表
strictFunctionTypes
- 严格检查函数的类型
strictNullChecks
- 严格的空值检查
strictPropertyInitialization
- 严格检查属性是否初始化
额外检查
- noFallthroughCasesInSwitch
- 检查switch语句包含正确的break
- noImplicitReturns
- 检查函数没有隐式的返回值
- noUnusedLocals
- 检查未使用的局部变量
- noUnusedParameters
- 检查未使用的参数
- noFallthroughCasesInSwitch
高级
- allowUnreachableCode
- 检查不可达代码
- 可选值:
- true,忽略不可达代码
- false,不可达代码将引起错误
- noEmitOnError
- 有错误的情况下不进行编译
- 默认值:false
- allowUnreachableCode