tsconfig 之 compilerOptions 详解

tsconfig.json 文件指定编译项目所需的根文件和编译器选项,本文只将compilerOptions配置选项进行中文化解析,完整内容请参考官方文档 https://www.typescriptlang.org/tsconfig

{
/* 基本选项 */
"target": "es5",                       // 指定 ECMAScript 目标版本: es3、es5、es6/es2015、es2016、es2017、es2018、es2019、es2020、es2021、es2022、esnext
"module": "commonjs",                  // 指定使用模块: none、commonjs、amd、umd、system、es6/es2015、es2020、es2022、esnext、node16、nodenext
"lib": [],                             // 指定要包含在编译中的库文件
"allowJs": true,                       // 允许编译 javascript 文件
"checkJs": true,                       // 报告 javascript 文件中的错误
"jsx": "preserve",                     // 指定 jsx 代码的生成: 'preserve', 'react-native', or 'react'
"declaration": true,                   // 生成相应的 '.d.ts' 文件
"sourceMap": true,                     // 生成相应的 '.map' 文件
"outFile": "./",                       // 将输出文件合并为一个文件
"outDir": "./",                        // 指定输出目录
"rootDir": "./",                       // 用来控制输出目录结构 --outDir.
"removeComments": true,                // 删除编译后的所有的注释
"noEmit": true,                        // 不生成输出文件
"importHelpers": true,                 // 从 tslib 导入辅助工具函数
"isolatedModules": true,               // 将每个文件做为单独的模块 (与 'ts.transpileModule' 类似).

/* 严格的类型检查选项 */
"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          // 为装饰器提供元数据的支持
}
文章作者: 若海; 原文链接: https://www.rehiy.com/post/432/; 转载需声明来自技术写真 - 若海

添加新评论