了不起的tsconfig.json指南

在 TypeScript 开发中，tsconfig.json 是个不可或缺的配置文件，它是我们在 TS 项目中最常见的配置文件，那么你真的了解这个文件吗？它里面都有哪些优秀配置？如何配置一个合理的 tsconfig.json 文件？本文将全面带大家一起详细了解 tsconfig.json 的各项配置。

本文将从以下几个方面全面介绍 tsconfig.json 文件：

水平有限，欢迎各位大佬指点~~

一、tsconfig.json 简介

1. 什么是 tsconfig.json

TypeScript 使用 tsconfig.json 文件作为其配置文件，当一个目录中存在 tsconfig.json 文件，则认为该目录为 TypeScript 项目的根目录。

通常 tsconfig.json 文件主要包含两部分内容：指定待编译文件和定义编译选项。

从《TypeScript编译器的配置文件的JSON模式》可知，目前 tsconfig.json 文件有以下几个顶层属性：

  •  compileOnSave
  •  compilerOptions
  •  exclude
  •  extends
  •  files
  •  include
  •  references
  •  typeAcquisition

文章后面会详细介绍一些常用属性配置。

2. 为什么使用 tsconfig.json

通常我们可以使用 tsc 命令来编译少量 TypeScript 文件：

 
 
 
 
      
  
  
  
  1. /*  
    2.   
  
  
  
  2.   参数介绍：  
    3.   
  
  
  
  3.   --outFile // 编译后生成的文件名称  
    4.   
  
  
  
  4.   --target  // 指定ECMAScript目标版本  
    5.   
  
  
  
  5.   --module  // 指定生成哪个模块系统代码  
    6.   
  
  
  
  6.   index.ts  // 源文件  
    7.   
  
  
  
  7. */  
    8.   
  
  
  
  8. $ tsc --outFile leo.js --target es3 --module amd index.ts 
    9.

但如果实际开发的项目，很少是只有单个文件，当我们需要编译整个项目时，就可以使用 tsconfig.json 文件，将需要使用到的配置都写进 tsconfig.json 文件，这样就不用每次编译都手动输入配置，另外也方便团队协作开发。

二、使用 tsconfig.json

目前使用 tsconfig.json 有2种操作：

1. 初始化 tsconfig.json

在初始化操作，也有 2 种方式：

  1.  手动在项目根目录（或其他）创建 tsconfig.json 文件并填写配置；
  2.  通过 tsc --init 初始化 tsconfig.json 文件。

2. 指定需要编译的目录

在不指定输入文件的情况下执行 tsc 命令，默认从当前目录开始编译，编译所有 .ts 文件，并且从当前目录开始查找 tsconfig.json 文件，并逐级向上级目录搜索。

 
 
 
 
      
  
  
  
  1. $ tsc 
    2.

另外也可以为 tsc 命令指定参数 --project 或 -p 指定需要编译的目录，该目录需要包含一个 tsconfig.json 文件，如：

 
 
 
 
      
  
  
  
  1. /*  
    2.   
  
  
  
  2.   文件目录：  
    3.   
  
  
  
  3.   ├─src/  
    4.   
  
  
  
  4.   │  ├─index.ts  
    5.   
  
  
  
  5.   │  └─tsconfig.json  
    6.   
  
  
  
  6.   ├─package.json  
    7.   
  
  
  
  7. */  
    8.   
  
  
  
  8. $ tsc --project src 
    9.

注意，tsc 的命令行选项具有优先级，会覆盖 tsconfig.json 中的同名选项。

更多 tsc 编译选项，可查看《编译选项》章节。

三、使用示例

这个章节，我们将通过本地一个小项目 learnTsconfig 来学着实现一个简单配置。

当前开发环境：windows / node 10.15.1 / TypeScript3.9

1. 初始化 learnTsconfig 项目

执行下面命令：

 
 
 
 
      
  
  
  
  1. $ mkdir learnTsconfig  
    2.   
  
  
  
  2. $ cd .\learnTsconfig\  
    3.   
  
  
  
  3. $ mkdir src  
    4.   
  
  
  
  4. $ new-item index.ts 
    5.

并且我们为 index.ts 文件写一些简单代码：

 
 
 
 
      
  
  
  
  1. // 返回当前版本号  
    2.   
  
  
  
  2. function getVersion(version:string = "1.0.0"): string{  
    3.   
  
  
  
  3.     return version;  
    4.   
  
  
  
  4. }  
    5.   
  
  
  
  5. console.log(getVersion("1.0.1")) 
    6.

我们将获得这么一个目录结构：

 
 
 
 
      
  
  
  
  1. └─src/  
    2.   
  
  
  
  2.    └─index.ts 
    3.

2. 初始化 tsconfig.json 文件

在 learnTsconfig 根目录执行：

 
 
 
 
      
  
  
  
  1. $ tsc --init 
    2.

3. 修改 tsconfig.json 文件

我们设置几个常见配置项：

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.   "compilerOptions": {  
    3.   
  
  
  
  3.     "target": "ES5",             // 目标语言的版本  
    4.   
  
  
  
  4.     "module": "commonjs",        // 指定生成代码的模板标准  
    5.   
  
  
  
  5.     "noImplicitAny": true,       // 不允许隐式的 any 类型  
    6.   
  
  
  
  6.     "removeComments": true,      // 删除注释   
    7.   
  
  
  
  7.     "preserveConstEnums": true,  // 保留 const 和 enum 声明  
    8.   
  
  
  
  8.     "sourceMap": true            // 生成目标文件的sourceMap文件  
    9.   
  
  
  
  9.   },  
    10.   
  
  
  
  10.   "files": [   // 指定待编译文件  
    11.   
  
  
  
  11.     "./src/index.ts"    
    12.   
  
  
  
  12.   ]  
    13.   
  
  
  
  13. } 
    14.

其中需要注意一点：

 files 配置项值是一个数组，用来指定了待编译文件，即入口文件。

当入口文件依赖其他文件时，不需要将被依赖文件也指定到 files 中，因为编译器会自动将所有的依赖文件归纳为编译对象，即 index.ts 依赖 user.ts 时，不需要在 files 中指定 user.ts ， user.ts 会自动纳入待编译文件。

4. 执行编译

配置完成后，我们可以在命令行执行 tsc 命令，执行编译完成后，我们可以得到一个 index.js 文件和一个 index.js.map 文件，证明我们编译成功，其中 index.js 文件内容如下：

 
 
 
 
      
  
  
  
  1. function getVersion(version) {  
    2.   
  
  
  
  2.     if (version === void 0) { version = "1.0.0"; }  
    3.   
  
  
  
  3.     return version;  
    4.   
  
  
  
  4. }  
    5.   
  
  
  
  5. console.log(getVersion("1.0.1"));  
    6.   
  
  
  
  6. //# sourceMappingURL=index.js.map 
    7.

可以看出，tsconfig.json 中的 removeComments 配置生效了，将我们添加的注释代码移除了。

到这一步，就完成了这个简单的示例，接下来会基于这个示例代码，讲解《七、常见配置示例》。

四、tsconfig.json 文件结构介绍

1. 按顶层属性分类

在 tsconfig.json 文件中按照顶层属性，分为以下几类：

2. 按功能分类

五、tsconfig.json 配置介绍

1. compileOnSave

compileOnSave 属性作用是设置保存文件的时候自动编译，但需要编译器支持。

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.  // ...  
    3.   
  
  
  
  3.   "compileOnSave": false,  
    4.   
  
  
  
  4. } 
    5.

2. compilerOptions

compilerOptions 属性作用是配置编译选项。

若 compilerOptions 属性被忽略，则编译器会使用默认值，可以查看《官方完整的编译选项列表》。

编译选项配置非常繁杂，有很多配置，这里只列出常用的配置。

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.   // ...  
    3.   
  
  
  
  3.   "compilerOptions": {  
    4.   
  
  
  
  4.     "incremental": true, // TS编译器在第一次编译之后会生成一个存储编译信息的文件，第二次编译会在第一次的基础上进行增量编译，可以提高编译的速度  
    5.   
  
  
  
  5.     "tsBuildInfoFile": "./buildFile", // 增量编译文件的存储位置  
    6.   
  
  
  
  6.     "diagnostics": true, // 打印诊断信息   
    7.   
  
  
  
  7.     "target": "ES5", // 目标语言的版本 
    8.   
  
  
  
  8.     "module": "CommonJS", // 生成代码的模板标准  
    9.   
  
  
  
  9.     "outFile": "./app.js", // 将多个相互依赖的文件生成一个文件，可以用在AMD模块中，即开启时应设置"module": "AMD",  
    10.   
  
  
  
  10.     "lib": ["DOM", "ES2015", "ScriptHost", "ES2019.Array"], // TS需要引用的库，即声明文件，es5 默认引用dom、es5、scripthost,如需要使用es的高级版本特性，通常都需要配置，如es8的数组新特性需要引入"ES2019.Array", 
    11.   
  
  
  
  11.      "allowJS": true, // 允许编译器编译JS，JSX文件  
    12.   
  
  
  
  12.     "checkJs": true, // 允许在JS文件中报错，通常与allowJS一起使用  
    13.   
  
  
  
  13.     "outDir": "./dist", // 指定输出目录  
    14.   
  
  
  
  14.     "rootDir": "./", // 指定输出文件目录(用于输出)，用于控制输出目录结构  
    15.   
  
  
  
  15.     "declaration": true, // 生成声明文件，开启后会自动生成声明文件  
    16.   
  
  
  
  16.     "declarationDir": "./file", // 指定生成声明文件存放目录  
    17.   
  
  
  
  17.     "emitDeclarationOnly": true, // 只生成声明文件，而不会生成js文件  
    18.   
  
  
  
  18.     "sourceMap": true, // 生成目标文件的sourceMap文件 
    19.   
  
  
  
  19.      "inlineSourceMap": true, // 生成目标文件的inline SourceMap，inline SourceMap会包含在生成的js文件中  
    20.   
  
  
  
  20.     "declarationMap": true, // 为声明文件生成sourceMap  
    21.   
  
  
  
  21.     "typeRoots": [], // 声明文件目录，默认时node_modules/@types  
    22.   
  
  
  
  22.     "types": [], // 加载的声明文件包  
    23.   
  
  
  
  23.     "removeComments":true, // 删除注释   
    24.   
  
  
  
  24.     "noEmit": true, // 不输出文件,即编译后不会生成任何js文件  
    25.   
  
  
  
  25.     "noEmitOnError": true, // 发送错误时不输出任何文件  
    26.   
  
  
  
  26.     "noEmitHelpers": true, // 不生成helper函数，减小体积，需要额外安装，常配合importHelpers一起使用  
    27.   
  
  
  
  27.     "importHelpers": true, // 通过tslib引入helper函数，文件必须是模块  
    28.   
  
  
  
  28.     "downlevelIteration": true, // 降级遍历器实现，如果目标源是es3/5，那么遍历器会有降级的实现  
    29.   
  
  
  
  29.     "strict": true, // 开启所有严格的类型检查  
    30.   
  
  
  
  30.     "alwaysStrict": true, // 在代码中注入'use strict'  
    31.   
  
  
  
  31.     "noImplicitAny": true, // 不允许隐式的any类型  
    32.   
  
  
  
  32.     "strictNullChecks": true, // 不允许把null、undefined赋值给其他类型的变量  
    33.   
  
  
  
  33.     "strictFunctionTypes": true, // 不允许函数参数双向协变  
    34.   
  
  
  
  34.     "strictPropertyInitialization": true, // 类的实例属性必须初始化  
    35.   
  
  
  
  35.     "strictBindCallApply": true, // 严格的bind/call/apply检查  
    36.   
  
  
  
  36.     "noImplicitThis": true, // 不允许this有隐式的any类型  
    37.   
  
  
  
  37.     "noUnusedLocals": true, // 检查只声明、未使用的局部变量(只提示不报错)  
    38.   
  
  
  
  38.     "noUnusedParameters": true, // 检查未使用的函数参数(只提示不报错)  
    39.   
  
  
  
  39.     "noFallthroughCasesInSwitch": true, // 防止switch语句贯穿(即如果没有break语句后面不会执行)  
    40.   
  
  
  
  40.     "noImplicitReturns": true, //每个分支都会有返回值  
    41.   
  
  
  
  41.     "esModuleInterop": true, // 允许export=导出，由import from 导入  
    42.   
  
  
  
  42.     "allowUmdGlobalAccess": true, // 允许在模块中全局变量的方式访问umd模块  
    43.   
  
  
  
  43.     "moduleResolution": "node", // 模块解析策略，ts默认用node的解析策略，即相对的方式导入 
    44.   
  
  
  
  44.     "baseUrl": "./", // 解析非相对模块的基地址，默认是当前目录  
    45.   
  
  
  
  45.     "paths": { // 路径映射，相对于baseUrl  
    46.   
  
  
  
  46.       // 如使用jq时不想使用默认版本，而需要手动指定版本，可进行如下配置  
    47.   
  
  
  
  47.       "jquery": ["node_modules/jquery/dist/jquery.min.js"]  
    48.   
  
  
  
  48.     },  
    49.   
  
  
  
  49.     "rootDirs": ["src","out"], // 将多个目录放在一个虚拟目录下，用于运行时，即编译后引入文件的位置可能发生变化，这也设置可以虚拟src和out在同一个目录下，不用再去改变路径也不会报错  
    50.   
  
  
  
  50.     "listEmittedFiles": true, // 打印输出文件  
    51.   
  
  
  
  51.     "listFiles": true// 打印编译的文件(包括引用的声明文件)  
    52.   
  
  
  
  52.   } 
    53.   
  
  
  
  53.  } 
    54.

3. exclude

exclude 属性作用是指定编译器需要排除的文件或文件夹。

默认排除 node_modules 文件夹下文件。

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.  // ...  
    3.   
  
  
  
  3.   "exclude": [  
    4.   
  
  
  
  4.     "src/lib" // 排除src目录下的lib文件夹下的文件不会编译  
    5.   
  
  
  
  5.   ]  
    6.   
  
  
  
  6. } 
    7.

和 include 属性一样，支持 glob 通配符：

  •  * 匹配0或多个字符（不包括目录分隔符）
  •  ? 匹配一个任意字符（不包括目录分隔符）
  •  **/ 递归匹配任意子目录

4. extends

extends 属性作用是引入其他配置文件，继承配置。

默认包含当前目录和子目录下所有 TypeScript 文件。

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.  // ...  
    3.   
  
  
  
  3.   // 把基础配置抽离成tsconfig.base.json文件，然后引入  
    4.   
  
  
  
  4.  "extends": "./tsconfig.base.json" 
    5.   
  
  
  
  5.  } 
    6.

5. files

files 属性作用是指定需要编译的单个文件列表。

默认包含当前目录和子目录下所有 TypeScript 文件。

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.  // ...  
    3.   
  
  
  
  3.   "files": [  
    4.   
  
  
  
  4.     // 指定编译文件是src目录下的leo.ts文件  
    5.   
  
  
  
  5.     "scr/leo.ts"  
    6.   
  
  
  
  6.   ]  
    7.   
  
  
  
  7. } 
    8.

6. include

include 属性作用是指定编译需要编译的文件或目录。

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.  // ...  
    3.   
  
  
  
  3.   "include": [  
    4.   
  
  
  
  4.     // "scr" // 会编译src目录下的所有文件，包括子目录  
    5.   
  
  
  
  5.     // "scr/*" // 只会编译scr一级目录下的文件  
    6.   
  
  
  
  6.     "scr/*/*" // 只会编译scr二级目录下的文件  
    7.   
  
  
  
  7.   ]  
    8.   
  
  
  
  8. } 
    9.

7. references

references 属性作用是指定工程引用依赖。

在项目开发中，有时候我们为了方便将前端项目和后端node项目放在同一个目录下开发，两个项目依赖同一个配置文件和通用文件，但我们希望前后端项目进行灵活的分别打包，那么我们可以进行如下配置：

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.  // ...  
    3.   
  
  
  
  3.   "references": [ // 指定依赖的工程  
    4.   
  
  
  
  4.      {"path": "./common"}  
    5.   
  
  
  
  5.   ]  
    6.   
  
  
  
  6. } 
    7.

8. typeAcquisition

typeAcquisition 属性作用是设置自动引入库类型定义文件(.d.ts)相关。

包含 3 个子属性：

  •  enable  : 布尔类型，是否开启自动引入库类型定义文件(.d.ts)，默认为 false；
  •  include  : 数组类型，允许自动引入的库名，如：["jquery", "lodash"]；
  •  exculde  : 数组类型，排除的库名。 
 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.  // ...  
    3.   
  
  
  
  3.   "typeAcquisition": {  
    4.   
  
  
  
  4.     "enable": false,  
    5.   
  
  
  
  5.     "exclude": ["jquery"],
    6.   
  
  
  
  6.      "include": ["jest"]  
    7.   
  
  
  
  7.   }  
    8.   
  
  
  
  8. } 
    9.

六、常见配置示例

本部分内容中，我们找了几个实际开发中比较常见的配置，当然，还有很多配置需要自己摸索哟~~

1. 移除代码中注释

tsconfig.json：

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.   "compilerOptions": {  
    3.   
  
  
  
  3.     "removeComments": true,  
    4.   
  
  
  
  4.   }  
    5.   
  
  
  
  5. } 
    6.

编译前：

 
 
 
 
      
  
  
  
  1. // 返回当前版本号  
    2.   
  
  
  
  2. function getVersion(version:string = "1.0.0"): string{  
    3.   
  
  
  
  3.     return version;  
    4.   
  
  
  
  4. }  
    5.   
  
  
  
  5. console.log(getVersion("1.0.1")) 
    6.

编译结果：

 
 
 
 
      
  
  
  
  1. function getVersion(version) {  
    2.   
  
  
  
  2.     if (version === void 0) { version = "1.0.0"; }  
    3.   
  
  
  
  3.     return version;  
    4.   
  
  
  
  4. }  
    5.   
  
  
  
  5. console.log(getVersion("1.0.1")); 
    6.

2. 开启null、undefined检测

tsconfig.json：

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.     "compilerOptions": {  
    3.   
  
  
  
  3.         "strictNullChecks": true  
    4.   
  
  
  
  4.     },  
    5.   
  
  
  
  5. } 
    6.

修改 index.ts 文件内容：

 
 
 
 
      
  
  
  
  1. const leo;  
    2.   
  
  
  
  2. leo = new Pingan('leo','hello'); 
    3.

这时候编辑器也会提示错误信息，执行 tsc 后，控制台报错：

 
 
 
 
      
  
  
  
  1. src/index.ts:9:11 - error TS2304: Cannot find name 'Pingan'.  
    2.   
  
  
  
  2. 9 leo = new Pingan('leo','hello');  
    3.   
  
  
  
  3. Found 1 error. 
    4.

3. 配置复用

通过 extends 属性实现配置复用，即一个配置文件可以继承另一个文件的配置属性。

比如，建立一个基础的配置文件 configs/base.json ：

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.   "compilerOptions": {  
    3.   
  
  
  
  3.     "noImplicitAny": true,  
    4.   
  
  
  
  4.     "strictNullChecks": true  
    5.   
  
  
  
  5.   }  
    6.   
  
  
  
  6. } 
    7.

在tsconfig.json 就可以引用这个文件的配置了：

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.   "extends": "./configs/base",  
    3.   
  
  
  
  3.   "files": [  
    4.   
  
  
  
  4.     "main.ts",  
    5.   
  
  
  
  5.     "supplemental.ts"  
    6.   
  
  
  
  6.   ]  
    7.   
  
  
  
  7. } 
    8.

4. 生成枚举的映射代码

在默认情况下，使用 const 修饰符后，枚举不会生成映射代码。

如下，我们可以看出：使用 const 修饰符后，编译器不会生成任何 RequestMethod 枚举的任何映射代码，在其他地方使用时，内联每个成员的值，节省很大开销。

 
 
 
 
      
  
  
  
  1. const enum RequestMethod {  
    2.   
  
  
  
  2.   Get,  
    3.   
  
  
  
  3.   Post,  
    4.   
  
  
  
  4.   Put,  
    5.   
  
  
  
  5.   Delete  
    6.   
  
  
  
  6. }  
    7.   
  
  
  
  7. let methods = [  
    8.   
  
  
  
  8.   RequestMethod.Get,  
    9.   
  
  
  
  9.   RequestMethod.Post  
    10.   
  
  
  
  10. ] 
    11.

编译结果：

 
 
 
 
      
  
  
  
  1. "use strict";  
    2.   
  
  
  
  2. let methods = [  
    3.   
  
  
  
  3.     0 /* Get */,  
    4.   
  
  
  
  4.     1 /* Post */  
    5.   
  
  
  
  5. ]; 
    6.

当然，我们希望生成映射代码时，也可以设置 tsconfig.json 中的配置，设置 preserveConstEnums 编译器选项为 true ：

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.   "compilerOptions": {  
    3.   
  
  
  
  3.     "target": "es5",  
    4.   
  
  
  
  4.     "preserveConstEnums": true  
    5.   
  
  
  
  5.   }  
    6.   
  
  
  
  6. } 
    7.

最后编译结果变成：

 
 
 
 
      
  
  
  
  1. "use strict";  
    2.   
  
  
  
  2. var RequestMethod;  
    3.   
  
  
  
  3. (function (RequestMethod) {  
    4.   
  
  
  
  4.     RequestMethod[RequestMethod["Get"] = 0] = "Get";  
    5.   
  
  
  
  5.     RequestMethod[RequestMethod["Post"] = 1] = "Post";  
    6.   
  
  
  
  6.     RequestMethod[RequestMethod["Put"] = 2] = "Put";  
    7.   
  
  
  
  7.     RequestMethod[RequestMethod["Delete"] = 3] = "Delete";  
    8.   
  
  
  
  8. })(RequestMethod || (RequestMethod = {}));  
    9.   
  
  
  
  9. let methods = [  
    10.   
  
  
  
  10.     0 /* Get */,  
    11.   
  
  
  
  11.     1 /* Post */  
    12.   
  
  
  
  12. ]; 
    13.

5. 关闭 this 类型注解提示

通过下面代码编译后会报错：

 
 
 
 
      
  
  
  
  1. const button = document.querySelector("button");  
    2.   
  
  
  
  2. button?.addEventListener("click", handleClick);  
    3.   
  
  
  
  3. function handleClick(this) {  
    4.   
  
  
  
  4.  console.log("Clicked!");  
    5.   
  
  
  
  5.  this.removeEventListener("click", handleClick);  
    6.   
  
  
  
  6. } 
    7.

报错内容：

 
 
 
 
      
  
  
  
  1. src/index.ts:10:22 - error TS7006: Parameter 'this' implicitly has an 'any' type.  
    2.   
  
  
  
  2. 10 function handleClick(this) {  
    3.   
  
  
  
  3. Found 1 error. 
    4.

这是因为 this 隐式具有 any 类型，如果没有指定类型注解，编译器会提示“"this" 隐式具有类型 "any"，因为它没有类型注释。”。

解决方法有2种：

  1.  指定 this 类型，如本代码中为 HTMLElement 类型：

HTMLElement 接口表示所有的 HTML 元素。一些HTML元素直接实现了 HTMLElement 接口，其它的间接实现HTMLElement接口。

关于 HTMLElement 可查看详细。

      2.  使用 --noImplicitThis 配置项：

在 TS2.0 还增加一个新的编译选项： --noImplicitThis，表示当 this 表达式值为 any 类型时生成一个错误信息。我们设置为 true 后就能正常编译。

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.   "compilerOptions": {  
    3.   
  
  
  
  3.     "noImplicitThis": true  
    4.   
  
  
  
  4.   }  
    5.   
  
  
  
  5. } 
    6.

七、Webpack/React 中使用示例

1. 配置编译 ES6 代码，JSX 文件

创建测试项目 webpack-demo，结构如下：

 
 
 
 
      
  
  
  
  1. webpack-demo/  
    2.   
  
  
  
  2.   |- package.json  
    3.   
  
  
  
  3.   |- tsconfig.json  
    4.   
  
  
  
  4.   |- webpack.config.js  
    5.   
  
  
  
  5.   |- /dist  
    6.   
  
  
  
  6.     |- bundle.js  
    7.   
  
  
  
  7.     |- index.html  
    8.   
  
  
  
  8.   |- /src  
    9.   
  
  
  
  9.     |- index.js  
    10.   
  
  
  
  10.     |- index.ts  
    11.   
  
  
  
  11.   |- /node_modules 
    12.

安装 TypeScript 和 ts-loader：

 
 
 
 
      
  
  
  
  1. $ npm install --save-dev typescript ts-loader 
    2.

配置 tsconfig.json，支持 JSX，并将 TypeScript 编译为 ES5：

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.   "compilerOptions": {  
    3.   
  
  
  
  3.     "outDir": "./dist/",  
    4.   
  
  
  
  4.     "noImplicitAny": true,  
    5.   
  
  
  
  5. +   "module": "es6",  
    6.   
  
  
  
  6. +   "target": "es5",  
    7.   
  
  
  
  7. +   "jsx": "react",  
    8.   
  
  
  
  8.     "allowJs": true 
    9.   
  
  
  
  9.    }  
    10.   
  
  
  
  10. } 
    11.

还需要配置 webpack.config.js，使其能够处理 TypeScript 代码，这里主要在 rules 中添加 ts-loader ：

 
 
 
 
      
  
  
  
  1. const path = require('path');  
    2.   
  
  
  
  2. module.exports = {  
    3.   
  
  
  
  3.   entry: './src/index.ts',  
    4.   
  
  
  
  4.   module: {  
    5.   
  
  
  
  5.     rules: [  
    6.   
  
  
  
  6.       {  
    7.   
  
  
  
  7.         test: /\.tsx?$/,  
    8.   
  
  
  
  8.         use: 'ts-loader',  
    9.   
  
  
  
  9.         exclude: /node_modules/  
    10.   
  
  
  
  10.       }  
    11.   
  
  
  
  11.     ]  
    12.   
  
  
  
  12.   },  
    13.   
  
  
  
  13.   resolve: {  
    14.   
  
  
  
  14.     extensions: [ '.tsx', '.ts', '.js' ]  
    15.   
  
  
  
  15.   },  
    16.   
  
  
  
  16.   output: {  
    17.   
  
  
  
  17.     filename: 'bundle.js',  
    18.   
  
  
  
  18.     path: path.resolve(__dirname, 'dist')  
    19.   
  
  
  
  19.   }  
    20.   
  
  
  
  20. }; 
    21.

2. 配置 source map

想要启用 source map，我们必须配置 TypeScript，以将内联的 source map 输出到编译后的 JavaScript 文件中。

只需要在 tsconfig.json 中配置 sourceMap 属性：

 
 
 
 
      
  
  
  
  1. {  
    2.   
  
  
  
  2.    "compilerOptions": {  
    3.   
  
  
  
  3.      "outDir": "./dist/",  
    4.   
  
  
  
  4.      "sourceMap": true,  
    5.   
  
  
  
  5.      "noImplicitAny": true,  
    6.   
  
  
  
  6.      "module": "commonjs",  
    7.   
  
  
  
  7.      "target": "es5",  
    8.   
  
  
  
  8.      "jsx": "react",  
    9.   
  
  
  
  9.      "allowJs": true  
    10.   
  
  
  
  10.    }  
    11.   
  
  
  
  11.  } 
    12.

然后配置 webpack.config.js 文件，让 webpack 提取 source map，并内联到最终的 bundle 中：

 
 
 
 
      
  
  
  
  1. const path = require('path');  
    2.   
  
  
  
  2.  module.exports = {  
    3.   
  
  
  
  3.    entry: './src/index.ts',  
    4.   
  
  
  
  4.    devtool: 'inline-source-map',  
    5.   
  
  
  
  5.    module: {  
    6.   
  
  
  
  6.      rules: [  
    7.   
  
  
  
  7.        {  
    8.   
  
  
  
  8.          test: /\.tsx?$/,  
    9.   
  
  
  
  9.          use: 'ts-loader',  
    10.   
  
  
  
  10.          exclude: /node_modules/  
    11.   
  
  
  
  11.        }  
    12.   
  
  
  
  12.      ]  
    13.   
  
  
  
  13.    },  
    14.   
  
  
  
  14.    resolve: {  
    15.   
  
  
  
  15.      extensions: [ '.tsx', '.ts', '.js' ]  
    16.   
  
  
  
  16.    },  
    17.   
  
  
  
  17.    output: {  
    18.   
  
  
  
  18.      filename: 'bundle.js',  
    19.   
  
  
  
  19.      path: path.resolve(__dirname, 'dist')  
    20.   
  
  
  
  20.    }  
    21.   
  
  
  
  21.  }; 
    22.

八、总结

本文较全面介绍了 tsconfig.json 文件的知识，从“什么是 tsconfig.js 文件”开始，一步步带领大家全面认识 tsconfig.json 文件。

文中通过一个简单 learnTsconfig 项目，让大家知道项目中如何使用 tsconfig.json 文件。在后续文章中，我们将这么多的配置项进行分类学习。最后通过几个常见配置示例，解决我们开发中遇到的几个常见问题。

当然，本文篇幅有限，无法针对每个属性进行深入介绍，这就需要大家在实际开发中，多去尝试和使用啦~

文章名称：了不起的tsconfig.json指南
转载源于：http://www.shufengxianlan.com/qtweb/news7/473157.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

品牌网站建设知识

分类信息网站

长城雪茄　　 　东电技服　　 　服务器托管　　 　鳄鱼养殖　　 　品牌网站建设　　 　成都网络推广公司　　 　温江做网站公司　　 　成都艺考培训　　 　网络营销推广　　 　网络营销推广　　 　成都添翼二手车　　 　香港云主机　　 　边坡防护网　　 　瑞杰企业管理　　 　成都网站设计　　 　400电话申请　　 　兴久牧业　　 　盐亭网站设计　　 　成都微信小程序开发　　 　成都企业网站设计