配置文件简析，更好使用Typescript

2023-09-15 22:55:48

Typescript 配置文件：tsconfig.json 的全面指南

什么是 tsconfig.json？

Typescript 配置文件 tsconfig.json 是一个 JSON 文件，它包含编译 Typescript 项目所需的所有配置信息。通过合理地配置 tsconfig.json 文件，可以更有效地编译 Typescript 代码，提高开发效率。

compilerOptions

compilerOptions 是 tsconfig.json 中包含的一组 Typescript 编译器选项，用于指定 Typescript 代码如何编译成 Javascript 代码。以下是一些常见的 compilerOptions 选项：

target : 指定编译目标版本，取值范围为 "ES3", "ES5", "ES6", "ES2015", "ES2016", "ES2017", "ES2018", "ES2019", "ES2020", "ESNEXT"。
module : 指定模块的类型，取值范围为 "none", "commonjs", "amd", "system", "umd", "esnext"。
lib : 指定编译时使用的库文件，取值范围为 "es5", "es6", "es2015", "es2016", "es2017", "es2018", "es2019", "es2020", "esnext"。
outDir : 指定编译后 Javascript 代码的输出目录。
rootDir : 指定 Typescript 源代码的根目录。
declaration : 指定是否生成声明文件，取值范围为 true 或 false。
noImplicitAny : 指定是否不允许隐式使用 any 类型，取值范围为 true 或 false。
strictNullChecks : 指定是否启用严格的空值检查，取值范围为 true 或 false。
removeComments : 指定是否从编译后的 Javascript 代码中删除注释，取值范围为 true 或 false。
preserveConstEnums : 指定是否保留编译后的 Javascript 代码中的常量枚举，取值范围为 true 或 false。
declarationDir : 指定生成声明文件的输出目录。
sourceMap : 指定是否生成源映射文件，取值范围为 true 或 false。
inlineSourceMap : 指定是否将源映射文件内联到编译后的 Javascript 代码中，取值范围为 true 或 false。
inlineSources : 指定是否将源代码内联到编译后的 Javascript 代码中，取值范围为 true 或 false。
outFile : 指定编译后的 Javascript 代码的输出文件。
allowJs : 指定是否允许编译 Javascript 文件，取值范围为 true 或 false。
jsx : 指定是否允许编译 JSX 代码，取值范围为 "preserve", "react", "react-native"。
reactNamespace : 指定 JSX 代码中使用的 React 命名空间，取值范围为 "React", "react"。
strict : 指定是否启用严格模式，取值范围为 true 或 false。
importHelpers : 指定是否启用导入帮助程序，取值范围为 true 或 false。
esModuleInterop : 指定是否启用 ES 模块互操作性，取值范围为 true 或 false。
experimentalDecorators : 指定是否启用实验性装饰器，取值范围为 true 或 false。
emitDecoratorMetadata : 指定是否在编译后的 Javascript 代码中生成装饰器元数据，取值范围为 true 或 false。
alwaysStrict : 指定是否总是启用严格模式，取值范围为 true 或 false。
noUnusedLocals : 指定是否禁止使用未使用的局部变量，取值范围为 true 或 false。
noUnusedParameters : 指定是否禁止使用未使用的参数，取值范围为 true 或 false。
noImplicitThis : 指定是否禁止使用隐式 this，取值范围为 true 或 false。
strictFunctionTypes : 指定是否启用严格的函数类型检查，取值范围为 true 或 false。
skipLibCheck : 指定是否跳过对库文件的检查，取值范围为 true 或 false。
noLib : 指定是否不使用库文件，取值范围为 true 或 false。
noEmit : 指定是否不生成编译后的 Javascript 代码，取值范围为 true 或 false。
incremental : 指定是否启用增量编译，取值范围为 true 或 false。
composite : 指定是否启用复合项目，取值范围为 true 或 false。

其他选项

除了 compilerOptions 之外，tsconfig.json 还可以包含其他选项，例如：

extends : 指定要继承的其他 tsconfig.json 文件。
include : 指定要编译的文件或目录。
exclude : 指定要排除的文件或目录。

代码示例

以下是一个 tsconfig.json 文件的示例：

{
  "compilerOptions": {
    "target": "ES2015",
    "module": "commonjs",
    "lib": ["es5", "dom"],
    "outDir": "./dist",
    "rootDir": "./src",
    "declaration": true,
    "noImplicitAny": true,
    "strictNullChecks": true,
    "removeComments": true,
    "sourceMap": true,
    "allowJs": true,
    "jsx": "react",
    "strict": true
  }
}