前言
在前端项目开发过程中，配置 TypeScript 的 tsconfig.json 文件是必不可少的一步。然而，每次从头开始编写 tsconfig.json 文件都是一件比较繁琐的事情。为了解决这个问题，可以使用 @1stg/tsconfig 这个 npm 包来快速生成 tsconfig.json 文件，本篇文章就是为大家详细介绍如何使用 @1stg/tsconfig。
安装
首先，需要在项目中安装 @1stg/tsconfig，可以使用以下命令进行安装：
npm install -D @1stg/tsconfig
或者使用 yarn：
yarn add -D @1stg/tsconfig
如何使用
安装完成后，在项目根目录下使用以下命令：
npx 1stg-tsconfig create
或者将其添加到 package.json 的 scripts 中使用：
{
"scripts": {
"tsconfig": "1stg-tsconfig create"
}
}使用 npm run tsconfig 即可执行命令。
运行后，会在根目录下生成一个默认的 tsconfig.json 文件，其格式如下：
-- -------------------- ---- -------
-
---------- ---------------------------------
------------------ -
--------- ---------
------------------ -----
--------------- -----
------ ------- -------
--------- ---------
------------------- -------
--------- --------
--
---------- -
----------
--
---------- -
---------------
------
--
------------- --
-配置项解释
extends
该字段用于继承其他配置文件。@tsconfig/node14 是一个默认配置文件，可以根据自己的项目需求进行自定义。
"extends": "@tsconfig/node14/tsconfig.json"
compilerOptions
该字段用于配置编译器选项，具体可用的选项如下：
outDir
输出目录，默认为项目根目录下的 dist 文件夹。
"outDir": "./dist"
esModuleInterop
该选项配置是否允许导入 es 模块时使用命名空间。
"esModuleInterop": true
skipLibCheck
该选项配置是否跳过 JavaScript 库文件的类型检查。
"skipLibCheck": true
lib
该选项配置 TypeScript 编译器所使用的库文件，默认为 es6 和 dom。
"lib": ["es6", "dom"]
module
该选项配置出口模块的类型，默认为 CommonJS，可以配置为 ESNext、AMD、System 等。
"module": "esnext"
moduleResolution
该选项配置模块解析策略，默认为 Node.js 的解析策略。
"moduleResolution": "node"
target
该选项设置 TypeScript 编译器所生成代码的目标环境。可以设置为 ES3、ES5、ES6、ES7、ES2015、ES2016、ES2017、ES2018、ES2019、ES2020、ES2021 或 ESNext。
"target": "esnext"
include 和 exclude
include 表示要包含哪些文件进行编译，exclude 表示要排除哪些文件。
"include": ["src/**/*"], "exclude": ["node_modules", "dist"]
references
该项用于指定项目依赖的 TypeScript 项目。
"references": []
总结
通过 @1stg/tsconfig，我们可以快速创建一个标准的 tsconfig.json 文件，省去每次手动编写该文件的烦恼。同时，深入了解如何配置 tsconfig.json 还是很有必要的，在项目开发中能够更好的运用 TypeScript。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/stg-tsconfig