跳到主要内容

-- TS的配置

Create by fall on 06 Feb 2021 Recently revised in 12 Apr 2024

TS 配置​

初始化开发环境

tsc --init // 初始化开发环境
# tsc 是 typescript 的检查命令

ts 项目中，根目录下面的 tsconfig.json 是配置文件，如果文件是一个空的 json 文件

TypeScript 将会把此目录和子目录下的所有 .ts 文件作为编译上下文的一部分，它还会包含一部分默认的编译选项。

环境配置​

对于不同的环境，可能需要不同的 TypeScript 文件进行配置，因此可能需要多个配置文件

  • tsconfig.json：vscode、tsc 命令默认读取的配置
  • tsconfig.base.json：基础配置
  • tsconfig.node.json：node 环境配置

当然，你可以自定义其它名称的配置

可以在运行环境检查时，指定对应的配置文件

tsc -p tsconfig.build.json
# 指定 tsconfig.build.json 作为类型检查的文件

指定文件​

好的 IDE 支持对 TypeScript 的即时编译

VS Code 中，终端 -> 运行任务 -> typescript -> 监视

指定文件

{
  "files":['./some/file.ts'], // 指定需要编译的文件
  // include 和 exclude 选项用来指定需要包含的文件和排除的文件
	"include":[
    "./folder",
    "src/**/*.ts",
    "src/**/*.tsx"
  ],
  "exclude":[
    "node_modules"
  ]
}

字段配置详情​

{
  "compilerOptions": {
    /* 基本选项 */
    "target": "es5",                       // 指定 ECMAScript 目标版本: 'ES3' (default), 'ES5', 'ES6'/'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'
    "module": "commonjs",                  // 指定使用模块: 'commonjs', 'amd', 'system', 'umd' or 'es2015'
    "lib": [],                             // 指定要包含在编译中的库文件，可为 ['dom',"es6","DOM.Iterable"]
    "allowJs": true,                       // 允许编译 javascript 文件
    "checkJs": true,                       // 报告 javascript 文件中的错误
    "jsx": "preserve",                     // 指定 jsx 代码的生成: 'preserve', 'react-native', or 'react'
    "declaration": true,                   // 生成相应的 '.d.ts' 文件
    "skipLibCheck":false,                  // 跳过 node_module 中的 type 检查
    "sourceMap": true,                     // 生成相应的 '.map' 文件
    "outFile": "./",                       // 将输出文件合并为一个文件
    "outDir": "./",                        // 指定输出目录
    "rootDir": "./",                       // 用来控制输出目录结构 --outDir.
    "removeComments": true,                // 删除编译后的所有的注释
    "noEmit": true,                        // 不生成输出文件
    "importHelpers": true,                 // 从 tslib 导入辅助工具函数
    "isolatedModules": true,               // 将每个文件作为单独的模块 （与 'ts.transpileModule' 类似）如果使 用esbuild 来转译 TypeScript，应当设置为 true

    /* 严格的类型检查选项 */
    "strict": true,                        // 启用所有严格类型检查选项
    "noImplicitAny": true,                 // 在表达式和声明上有隐含的 any 类型时报错
    "strictNullChecks": true,              // 启用严格的 null 检查
    "noImplicitThis": true,                // 当 this 表达式值为 any 类型的时候，生成一个错误
    "alwaysStrict": true,                  // 以严格模式检查每个模块，并在每个文件里加入 'use strict'

    /* 额外的检查 */
    "noUnusedLocals": true,                // 有未使用的变量时，抛出错误
    "noUnusedParameters": true,            // 有未使用的参数时，抛出错误
    "noImplicitReturns": true,             // 并不是所有函数里的代码都有返回值时，抛出错误
    "noFallthroughCasesInSwitch": true,    // 报告 switch 语句的 fallthrough 错误。（即，不允许 switch 的 case 语句贯穿）

    /* 模块解析选项 */
    "moduleResolution": "node",            // 选择模块解析策略： 'node' (Node.js) or 'classic' (TypeScript pre-1.6)
    "baseUrl": "./",                       // 用于解析非相对模块名称的基目录
    "paths": {},                           // 模块名到基于 baseUrl 的路径映射的列表
    "rootDirs": [],                        // 根文件夹列表，其组合内容表示项目运行时的结构内容
    "typeRoots": [],                       // 包含类型声明的文件列表
    "types": [],                           // 需要包含的类型声明文件名列表
    "allowSyntheticDefaultImports": true,  // 允许从没有设置默认导出的模块中默认导入。

    /* Source Map Options */
    "sourceRoot": "./",                    // 指定调试器应该找到 TypeScript 文件而不是源文件的位置
    "mapRoot": "./",                       // 指定调试器应该找到映射文件而不是生成文件的位置
    "inlineSourceMap": true,               // 生成单个 soucemaps 文件，而不是将 sourcemaps 生成不同的文件
    "inlineSources": true,                 // 将代码与 sourcemaps 生成到一个文件中，要求同时设置了 --inlineSourceMap 或 --sourceMap 属性

    /* 其他选项 */
    "experimentalDecorators": true,        // 启用装饰器
    "emitDecoratorMetadata": true          // 为装饰器提供元数据的支持
  }
}

参考文章​

名称链接
深入理解TypeScripthttps://jkchao.github.io/typescript-book-chinese/