tsconfig.json 配置清单

tsconfig.json 配置清单

基础结构

{
  "compilerOptions": {
    // 编译选项
  },
  "include": [
    // 指定需要编译的文件或目录
  ],
  "exclude": [
    // 指定不需要编译的文件或目录
  ],
  "extends": "./base-tsconfig.json",
  "files": [
    // 需要编译的具体文件
  ],
  "references": [
    // 用于 TypeScript 项目引用
  ]
}

compilerOptions 详细配置

按类别整理，每个配置项都附带解释和可能的值。

1. ECMAScript 版本、模块系统

2. 输出控制

3. 严格模式

4. 代码检查

5. ES 特性支持

6. 其他

7. include、exclude、files

{
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"],
  "files": ["index.ts", "types.d.ts"]
}

8. extends

{
  "extends": "./base-tsconfig.json"
}

9. references

{
  "references": [
    { "path": "./packages/core" },
    { "path": "./packages/utils" }
  ]
}

10. 示例

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "CommonJS",
    "strict": true,
    "outDir": "./dist",
    "rootDir": "./src",
    "sourceMap": true,
    "resolveJsonModule": true,
    "allowJs": true,
    "incremental": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}