开源项目 tsconfig/bases 使用教程

开源项目 tsconfig/bases 使用教程

basesHosts TSConfigs to extend in a TypeScript app, tuned to a particular runtime environment项目地址:https://gitcode.com/gh_mirrors/ba/bases

1. 项目的目录结构及介绍

tsconfig/bases/
├── bases/
│   ├── browser.json
│   ├── node12.json
│   ├── node14.json
│   ├── node16.json
│   ├── node18.json
│   ├── react-library.json
│   └── recommended.json
├── LICENSE
├── README.md
└── package.json

• bases/: 该目录包含了多个预设的 tsconfig.json 文件，每个文件针对不同的运行环境（如浏览器、不同版本的Node.js、React库等）提供了相应的TypeScript配置。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• package.json: 项目的npm配置文件，包含了项目依赖、脚本等信息。

2. 项目的启动文件介绍

该项目没有传统意义上的“启动文件”，因为它主要提供了一系列预设的 tsconfig.json 文件，供用户在自己的项目中引用。用户可以通过在项目根目录下创建一个 tsconfig.json 文件，并使用 extends 属性来继承这些预设配置。

例如：

{
  "extends": "tsconfig/bases/node14.json",
  "compilerOptions": {
    "outDir": "./dist"
  },
  "include": ["src"]
}

3. 项目的配置文件介绍

项目的主要配置文件是 bases/ 目录下的各个 tsconfig.json 文件。以下是一些关键配置文件的介绍：

• browser.json: 适用于浏览器环境的TypeScript配置。
• node12.json: 适用于Node.js 12版本的TypeScript配置。
• node14.json: 适用于Node.js 14版本的TypeScript配置。
• node16.json: 适用于Node.js 16版本的TypeScript配置。
• node18.json: 适用于Node.js 18版本的TypeScript配置。
• react-library.json: 适用于React库的TypeScript配置。
• recommended.json: 推荐的通用TypeScript配置。

每个配置文件都包含了针对特定环境的TypeScript编译选项，用户可以根据自己的项目需求选择合适的配置文件进行继承。

例如，node14.json 文件的内容可能如下：

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  }
}

通过继承这些预设配置，用户可以快速搭建适合自己项目环境的TypeScript编译配置。

basesHosts TSConfigs to extend in a TypeScript app, tuned to a particular runtime environment项目地址:https://gitcode.com/gh_mirrors/ba/bases