TypeScript 配置文件

TypeScript是一种强类型的JavaScript超集，它通过类型检查和其他高级功能帮助开发者编写更健壮的代码。为了让TypeScript编译器（tsc）知道如何编译你的代码，你需要一个配置文件——tsconfig.json。这个文件定义了项目的根目录、编译选项以及需要包含的文件。

什么是 `tsconfig.json`？

tsconfig.json 是TypeScript项目的配置文件，通常位于项目的根目录中。它告诉TypeScript编译器如何编译你的代码，包括哪些文件需要编译、使用哪些编译选项以及输出目录等。

基本结构

一个最简单的 tsconfig.json 文件可能如下所示：

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

在这个配置中：

compilerOptions 定义了编译选项。
include 指定了需要编译的文件或目录。

关键配置选项

`compilerOptions`

compilerOptions 是 tsconfig.json 中最重要的部分，它定义了编译器的行为。以下是一些常用的选项：

target: 指定编译后的JavaScript目标版本。例如，es5、es6、es2015 等。
module: 指定模块系统。例如，commonjs、es6、amd 等。
strict: 启用所有严格类型检查选项。建议始终启用。
outDir: 指定编译后的输出目录。
rootDir: 指定源文件的根目录。
sourceMap: 生成 .map 文件，用于调试。

`include` 和 `exclude`

include: 指定需要编译的文件或目录。支持通配符，例如 src/**/* 表示 src 目录下的所有文件。
exclude: 指定不需要编译的文件或目录。默认排除 node_modules 和 bower_components。

`extends`

extends 允许你继承另一个配置文件。这对于在多个项目之间共享配置非常有用。

json
{
  "extends": "./base-config.json",
  "compilerOptions": {
    "outDir": "./dist"
  }
}

实际案例

假设你有一个简单的TypeScript项目，目录结构如下：

my-project/
├── src/
│   ├── index.ts
│   └── utils.ts
├── dist/
└── tsconfig.json

你的 tsconfig.json 文件可能如下：

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

在这个配置中：

target 设置为 es6，表示编译后的代码将使用ES6语法。
module 设置为 commonjs，表示使用CommonJS模块系统。
strict 设置为 true，启用所有严格类型检查。
outDir 设置为 ./dist，表示编译后的文件将输出到 dist 目录。
rootDir 设置为 ./src，表示源文件位于 src 目录。

总结

tsconfig.json 是TypeScript项目的核心配置文件，它定义了编译器的行为和项目的结构。通过合理配置 compilerOptions、include 和 exclude 等选项，你可以定制TypeScript的编译过程，使其更好地适应你的项目需求。

附加资源

练习

创建一个新的TypeScript项目，并配置 tsconfig.json 文件。
尝试不同的 compilerOptions，观察编译结果的变化。
使用 extends 选项继承一个基础配置文件，并添加自定义配置。

通过以上步骤，你将更深入地理解TypeScript配置文件的作用和配置方法。

什么是 tsconfig.json？​

基本结构​

关键配置选项​

compilerOptions​

include 和 exclude​

extends​

实际案例​

总结​

附加资源​

练习​