TSConfig 全解（上）：构建相关配置-TypeScript入门指南

当前位置:　首页>> 技术小册>> TypeScript入门指南

TSConfig是TypeScript编译器的配置文件，用于指定编译器的行为和选项。在TypeScript项目中，TSConfig文件是必不可少的配置文件之一，它允许开发者在项目中定义编译器的行为，并且可以在不同的环境中共享配置，以便于项目的维护和管理。

在本文中，我将介绍一些与构建相关的TSConfig配置选项，结合代码示例进行讲解。

**1、compilerOptions**

compilerOptions是TSConfig文件中最重要的选项之一，它用于指定编译器的行为和选项。下面是一些常用的compilerOptions选项：

**2、target**

target选项用于指定编译的目标版本，即将TypeScript代码编译成哪个版本的JavaScript代码。常用的值有"es5"、"es6"、"es2015"等。例如：

```javascript
{
  "compilerOptions": {
    "target": "es6"
  }
}

```

**3、module**

module选项用于指定模块的生成方式。常用的值有"commonjs"、"amd"、"es6"等。例如：

```javascript
{
  "compilerOptions": {
    "module": "commonjs"
  }
}

```

**4、lib**

lib选项用于指定编译器可以使用的库文件，例如DOM、ES5、ES6等。默认情况下，编译器会根据target选项自动选择可用的库文件。例如：

```javascript
{
  "compilerOptions": {
    "lib": ["es6", "dom"]
  }
}

```

**5、outDir**

outDir选项用于指定编译输出的目录。例如：

```javascript
{
  "compilerOptions": {
    "outDir": "dist"
  }
}

```

**6、sourceMap**

sourceMap选项用于指定是否生成source map文件，以便于在调试时定位到源代码的位置。例如：

```javascript
{
  "compilerOptions": {
    "sourceMap": true
  }
}

```

**7、declaration**

declaration选项用于指定是否生成声明文件（.d.ts文件），用于在JavaScript项目中使用TypeScript库。例如：

```javascript
{
  "compilerOptions": {
    "declaration": true
  }
}

```

**8、strict**

strict选项用于启用TypeScript的严格类型检查。启用该选项后，编译器会对代码中的类型错误进行检查，并给出相应的警告或错误。例如：

```javascript
{
  "compilerOptions": {
    "strict": true
  }
}

```

**9、include和exclude**

include和exclude选项用于指定编译器编译的文件和目录。可以使用glob模式进行匹配。例如：

```javascript
{
  "include": ["src/**/*"],
  "exclude": ["node_modules"]
}

```

上面的配置将编译src目录及其子目录下的所有文件，但排除node_modules目录。

**10、files**

files选项用于指定编译器编译的文件列表。如果使用该选项，编译器只会编译指定的文件，而忽略其他文件。例如：

```javascript
{
  "files": [
    "src/index.ts",
    "src/utils.ts"
  ]
}

```

上面的配置将只编译index.ts和utils.ts这两个文件。

**11、extends**

extends选项用于继承其他TSConfig文件的配置。例如：

```javascript
{
  "extends": "./base.json",
  "compilerOptions": {
    "outDir": "dist"
  }
}

```

上面的配置将继承base.json文件中的配置，并添加outDir选项。

**小结**
TSConfig文件是TypeScript项目中的重要配置文件之一，它允许开发者指定编译器的行为和选项。本文介绍了一些与构建相关的TSConfig选项，包括compilerOptions、include和exclude、files和extends等。在实际项目中，根据项目的需求，开发者可以灵活地配置TSConfig文件，以达到最佳的编译效果。

该分类下的相关小册推荐：

剑指TypeScript

TypeScript 全面进阶指南

TypeScript开发实战