wordpress做下载型网站,网络服务平台建设概况,asp.net窗体网站,应届生去外包公司前言 ❝ Nealyang/blog0 使用 ts 已多年#xff0c;但是貌似对于 tsconfig 总是记忆不清#xff0c;每次都是 cv 历史项目#xff0c;所以写了这篇备忘录#xff0c;希望能帮助到大家。 本文总结整理自 Matt Pocock 的一篇文章3#xff0c;加以个人理解#xff0c;并做了… 前言 ❝ Nealyang/blog0 使用 ts 已多年但是貌似对于 tsconfig 总是记忆不清每次都是 cv 历史项目所以写了这篇备忘录希望能帮助到大家。 本文总结整理自 Matt Pocock 的一篇文章3加以个人理解并做了一些修改。 配置清单 {compilerOptions: {/* 基础选项: */esModuleInterop: true,skipLibCheck: true,target: es2022,allowJs: true,resolveJsonModule: true,moduleResolution: node,isolatedModules: true,noUnusedLocals: true,/* 严格模式 */strict: true,noUncheckedIndexedAccess: true,noImplicitOverride: true,/* 使用 tsc 编译: */module: NodeNext,outDir: dist,sourceMap: true,/* 需要构建成库: */declaration: true,/* 需要在 monorepo 中构建成库: */composite: true,declarationMap: true,/* 如果不适用 tsc 编译: */module: preserve,noEmit: true,/* 如果需要再浏览器中运行你的代码: */lib: [es2022, dom, dom.iterable],/* 如果你不需要再浏览器中运行你的代码比如 node: */lib: [es2022]}
} 完整的配置说明 基础配置 {compilerOptions: {esModuleInterop: true,skipLibCheck: true,target: es2022,allowJs: true,resolveJsonModule: true,moduleResolution: node,isolatedModules: true,noUnusedLocals: true}
} esModuleInterop 解决 ES Module 和 CommonJS 之间的兼容性问题 比如我们在 ts 中引入 import React from react,我们会看到如下报错 alt text 核心是因为 esm 有 default 这个概念而 cjs 没有。任何导出的变量在 cjs 看来都是 module.exports 这个对象上的属性esm 的 default 导出也只是 cjs 上的 module.exports.default 属性而已而且目前已有的大量的第三方库大多都是用 UMD / cjs 写的或者说使用的是他们编译之后的产物而编译之后的产物一般都为 cjs 但现在前端代码基本上都是用 esm 来写所以 esm 与 cjs 需要一套规则来兼容。 ❝ 详细解释可参见esModuleInterop 到底做了什么1 skipLibCheck默认情况下TypeScript 会对加载的类型声明文件进行检查包括内置的lib.d.ts和各种type/*可以使用 skipLibCheck 跳过对这些类型声明文件的检查这也能进一步加快编译速度。target指定 ECMAScript 目标版本可选值es3、es5、es2015、es2016、es2017、es2018、es2019、es2020、es2021、esnext。如果没有特殊需要推荐将 target 设置为 es2018一个对常用语法支持较为全面的版本。需要注意的是更改 target 配置也会同时影响你的 lib 配置默认值allowJs 和 resolveJsonModule允许导入 js 和 jsonmoduleResolution :指定模块的解析规则其实就是 node 如何去查找模块的规则可选值node、classic、none。详细解释_moduleResolution 总结_2isolatedModules确保每一个文件都被视为独立模块可被独立编译noUnusedLocals当设置为 true编译器会报告文件中未使用的局部变量 严格模式 {compilerOptions: {strict: true,noUncheckedIndexedAccess: true,noImplicitOverride: true}
} strict : 开启严格模式具体来说启动了以下选项 noImplicitAny: 不允许隐式的 any 类型noImplicitThis: 不允许对 this 表达式的隐式 any 类型。alwaysStrict: 以严格模式strict mode解析并为每个源文件生成 use strict。strictBindCallApply: 更严格地检查 bind、call 和 apply 的参数是否与原函数匹配。strictNullChecks: 在严格空检查模式下工作null 和 undefined 值不包含在任何类型中只允许对他们执行任何操作。strictFunctionTypes: 禁止函数参数双向协变检查strictPropertyInitialization: 确保类的每个实例属性都被明确赋值。noUncheckedIndexedAccess 启用后可对索引签名进行更加严格的检查使得访问如对象或数组等带索引签名类型的元素时返回的类型会自动包含 undefined。这让开发人员更像在严格 null 检查的环境中工作时一样意识到可能未定义的值。 const array: number[] [];
const value: number | undefined array[0]; // noUncheckedIndexedAccess - value有类型number | undefined noImplicitOverride :当一个子类的方法重写了基类的方法时需要用 override 关键字显式地标记这个行为。这确保了当基类的方法被重命名或移除的时候派生类也相应地更新防止意外的覆盖或者运行时错误。 class Base {greet() {}
}class Derived extends Base {greet() {} // Error! 方法应该有override关键字来标记重写override greet() {} // Correct
} 使用 tsc 编译 {compilerOptions: {module: NodeNext,outDir: dist}
} module指定生成哪种模块系统代码可选值None、CommonJS、AMD、System、UMD、ES6、ES2015、ESNext。outDir指定输出目录 为库构建 {compilerOptions: {declaration: true}
} declaration生成相应的 .d.ts 文件对于 JavaScript 库来说非常有用你懂的 对于构建 monorepo 的类库 (大型复杂项目同样适用) {compilerOptions: {declaration: true,composite: true,sourceMap: true,declarationMap: true}
} composite 在 Project References 的被引用子项目 tsconfig.json 中必须为启用状态它通过一系列额外的配置项确保你的子项目能被 Project References 引用而在子项目中必须启用 declaration 必须通过 files 或 includes 声明子项目内需要包含的文件等。 这是 TypeScript3.0 新增的配置核心是提供的Project Reference能力当然这个不仅仅适用于构建 monorepo 的类库对于构建单个项目的类库也同样适用。 sourceMap 启用这个选项后编译过程会生成 .js.map 文件这些文件是原始源文件.ts和生成的 JavaScript 文件.js之间的映射信息。有了 source map你可以在调试时看到原始的 TypeScript 源码而不是编译后的 JavaScript 代码这极大地简化了调试过程declarationMap :当这个选项和 declaration 一起启用时编译器不仅会为 .ts 文件生成 .d.ts 声明文件还会创建 .d.ts.map 文件。这些 map 文件包含了.ts 源文件和.d.ts 声明文件之间的映射信息允许在使用类型定义文件时进行源码映射。这使得在使用 IDE 或调试器时开发者可以直接从使用库的代码跳转到相应的类型定义中即便这些定义来自第三方库。 不适用 tsc 编译 {compilerOptions: {module: preserve,noEmit: true}
} module: 指定生成哪种模块系统代码,设置为 preserve这告诉 TypeScript 编译器在处理模块语法时不要转换 ES6 模块语句如 import 和 exportnoEmit: 不生成输出,只用 ts 来做类型检查这也是现在的很多 CI 环境中常用的方式。实际的 js 代码由 Babel 去编译生成 在 DOM 中运行 {compilerOptions: {lib: [es2022, dom, dom.iterable]}
} lib 选项通常用于模拟特定的运行环境告诉 TypeScript 编译器那些 api 是内置的可以直接使用的 es2022这个库包含了 ECMAScript 2022或者说是 ES12标准规定的所有特性的类型声明dom:这个库提供了所有与 Web 浏览器的文档对象模型DOM相关的类型声明dom.iterable这个库提供了关于 DOM 中可迭代对象如 NodeList 或 HTMLCollection的类型声明 如果不是在 DOM 中运行那么可以将 lib 选项改为 [es2022]即可 常用配置 其他常用配置这里就不说了包括 include、exclude、files、baseUrl、rootDir等 关于上述基本配置可以从 tsconfig.guide4 中 copy 出来 参考文章 Nealyang/PersonalBlog https://github.com/Nealyang/PersonalBlog/issues/136esModuleInterop 到底做了什么 https://zhuanlan.zhihu.com/p/148081795moduleResolution 总结 https://zhuanlan.zhihu.com/p/621795173tsconfig-cheat-sheet https://www.totaltypescript.com/tsconfig-cheat-sheettsconfig.guide https://tsconfig.guide/