What is the use of tsconfig.json file in TypeScript?

tsconfig.json 文件在 TypeScript 项目中充当一个非常重要的角色，它用来指导 TypeScript 编译器如何编译 TypeScript 代码。具体来说，tsconfig.json 文件包含了一系列编译选项和项目设置，使开发者能够配置如何将 TypeScript 代码转换成 JavaScript 代码。

主要用途

1. 指定编译器选项：

   • 比如，target 指定了编译后的 JavaScript 版本（例如 ES5, ES6/ES2015 等）。
   • module 指定了使用的模块系统（如 CommonJS, AMD, ES6 等）。
   • strict 开启所有严格类型检查选项，帮助写出更健壮的代码。
   • outDir 和 outFile 用于指定输出目录和文件。

2. 包含和排除文件：

   • include 和 exclude 数组用于指定编译器需要包含或排除的文件或目录。
   • files 属性可以直接列出要包含在编译中的文件列表。

3. 支持项目引用：

   • references 用于设置项目间的依赖，有助于管理大型项目中的多个子项目。

实际例子

假设您正在开发一个 Node.js 应用程序，您可能希望 TypeScript 编译为适合 Node.js 的 CommonJS 模块，并且目标为 ES2018。对于这样的场景，tsconfig.json 的配置可能如下所示：

json
{
  "compilerOptions": {
    "module": "commonjs",
    "target": "ES2018",
    "outDir": "./dist",
    "strict": true
  },
  "include": [
    "src/**/*"
  ]
}

在这个例子中：

• "module": "commonjs" 确保 TypeScript 文件被编译为 CommonJS 模块，这是 Node.js 默认支持的模块系统。
• "target": "ES2018" 表示生成的 JavaScript 代码将符合 ES2018 标准。
• "outDir": "./dist" 指定编译后的文件将被放置在项目根目录下的 dist 文件夹中。
• "strict": true 开启所有严格的类型检查，有助于在编写代码阶段捕捉到可能的错误。
• "include": ["src/**/*"] 指明只编译 src 目录下的所有文件。

通过这样的配置，您可以确保 TypeScript 项目的编译行为符合您的具体需求，并且使项目结构更加清晰和有序。