基础

在项目的根目录下创建一个空tsconfig.json文件。通过这种方式，TypeScript 将会把此目录和子目录下的所有 .ts 文件作为编译上下文的一部分，它还会包含一部分默认的编译选项。

  1. {}

compilerOptions

  1. {
  2.   "compilerOptions": {
  4.     /* 基本选项 */
  5.     "target": "es5",                       // 指定 ECMAScript 目标版本: 'ES3' (default), 'ES5', 'ES6'/'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'
  6.     "module": "commonjs",                  // 指定使用模块: 'commonjs', 'amd', 'system', 'umd' or 'es2015'
  7.     "lib": [],                             // 指定要包含在编译中的库文件
  8.     "allowJs": true,                       // 允许编译 javascript 文件
  9.     "checkJs": true,                       // 报告 javascript 文件中的错误
  10.     "jsx": "preserve",                     // 指定 jsx 代码的生成: 'preserve', 'react-native', or 'react'
  11.     "declaration": true,                   // 生成相应的 '.d.ts' 文件
  12.     "sourceMap": true,                     // 生成相应的 '.map' 文件
  13.     "outFile": "./",                       // 将输出文件合并为一个文件
  14.     "outDir": "./",                        // 指定输出目录
  15.     "rootDir": "./",                       // 用来控制输出目录结构 --outDir.
  16.     "removeComments": true,                // 删除编译后的所有的注释
  17.     "noEmit": true,                        // 不生成输出文件
  18.     "importHelpers": true,                 // 从 tslib 导入辅助工具函数
  19.     "isolatedModules": true,               // 将每个文件作为单独的模块 （与 'ts.transpileModule' 类似）.
  21.     /* 严格的类型检查选项 */
  22.     "strict": true,                        // 启用所有严格类型检查选项
  23.     "noImplicitAny": true,                 // 在表达式和声明上有隐含的 any类型时报错
  24.     "strictNullChecks": true,              // 启用严格的 null 检查
  25.     "noImplicitThis": true,                // 当 this 表达式值为 any 类型的时候，生成一个错误
  26.     "alwaysStrict": true,                  // 以严格模式检查每个模块，并在每个文件里加入 'use strict'
  28.     /* 额外的检查 */
  29.     "noUnusedLocals": true,                // 有未使用的变量时，抛出错误
  30.     "noUnusedParameters": true,            // 有未使用的参数时，抛出错误
  31.     "noImplicitReturns": true,             // 并不是所有函数里的代码都有返回值时，抛出错误
  32.     "noFallthroughCasesInSwitch": true,    // 报告 switch 语句的 fallthrough 错误。（即，不允许 switch 的 case 语句贯穿）
  34.     /* 模块解析选项 */
  35.     "moduleResolution": "node",            // 选择模块解析策略： 'node' (Node.js) or 'classic' (TypeScript pre-1.6)
  36.     "baseUrl": "./",                       // 用于解析非相对模块名称的基目录
  37.     "paths": {},                           // 模块名到基于 baseUrl 的路径映射的列表
  38.     "rootDirs": [],                        // 根文件夹列表，其组合内容表示项目运行时的结构内容
  39.     "typeRoots": [],                       // 包含类型声明的文件列表
  40.     "types": [],                           // 需要包含的类型声明文件名列表
  41.     "allowSyntheticDefaultImports": true,  // 允许从没有设置默认导出的模块中默认导入。
  43.     /* Source Map Options */
  44.     "sourceRoot": "./",                    // 指定调试器应该找到 TypeScript 文件而不是源文件的位置
  45.     "mapRoot": "./",                       // 指定调试器应该找到映射文件而不是生成文件的位置
  46.     "inlineSourceMap": true,               // 生成单个 soucemaps 文件，而不是将 sourcemaps 生成不同的文件
  47.     "inlineSources": true,                 // 将代码与 sourcemaps 生成到一个文件中，要求同时设置了 --inlineSourceMap 或 --sourceMap 属性
  49.     /* 其他选项 */
  50.     "experimentalDecorators": true,        // 启用装饰器
  51.     "emitDecoratorMetadata": true          // 为装饰器提供元数据的支持
  52.   }
  53. }

TypeScript 编译

好的 IDE 支持对 TypeScript 的即时编译。但是，如果想在使用 tsconfig.json 时从命令行手动运行 TypeScript 编译器，可以通过以下方式：

  • 运行 tsc，它会在当前目录或者是父级目录寻找tsconfig.json文件。
  • 运行 tsc -p ./path-to-project-directory 。当然，这个路径可以是绝对路径，也可以是相对路径。

甚至可以使用 tsc -w 来启用 TypeScript 编译器的观测模式，在检测到文件改动之后，它将重新编译。

指定文件

可以显式指定需要编译的文件：

  1. {
  2.   "files": [
  3.     "./some/file.ts"
  4.   ]
  5. }

还可以使用 include 和 exclude 选项来指定需要包含的文件和排除的文件：

  1. {
  2.   "include": [
  3.     "./folder"
  4.   ],
  5.   "exclude": [
  6.     "./folder/**/*.spec.ts",
  7.     "./folder/someSubFolder"
  8.   ]
  9. }

注意 使用 globs：/* （一个示例用法：some/folder//*）意味着匹配所有的文件夹和所有文件（扩展名为 .ts/.tsx，当开启了 allowJs: true 选项时，扩展名可以是 .js/.jsx）。