@bwt-st/tsconfig
v0.2.1
Published
Shared TypeScript configurations for BWT-ST projects.
Downloads
243
Readme
@bwt-st/tsconfig
BWT-ST 项目的共享 TypeScript 配置预设。配置基于严格模式,使用 ESM、Bundler 模块解析和 ES2022 目标,适合现代前端工程和 Node.js 工具项目。
安装
pnpm add -D @bwt-st/tsconfig typescript配置预设
| 入口 | 适用场景 | 主要差异 |
| -------------------------- | ------------ | --------------------------------------------- |
| @bwt-st/tsconfig/base | 通用基础配置 | 严格类型检查、ESM、Bundler 解析和声明类型支持 |
| @bwt-st/tsconfig/browser | 浏览器项目 | 增加 DOM 和 DOM.Iterable 类型 |
| @bwt-st/tsconfig/node | Node.js 项目 | 增加 Node.js 类型 |
| @bwt-st/tsconfig/vue | Vue 项目 | 基于浏览器配置,jsx: preserve |
| @bwt-st/tsconfig/react | React 项目 | 基于浏览器配置,jsx: react-jsx |
使用
在项目根目录创建 tsconfig.json,根据项目类型选择一个入口:
{
"extends": "@bwt-st/tsconfig/browser",
"include": ["src", "tests"]
}Vue:
{
"extends": "@bwt-st/tsconfig/vue",
"include": ["src", "tests"]
}React:
{
"extends": "@bwt-st/tsconfig/react",
"include": ["src", "tests"]
}Node.js:
{
"extends": "@bwt-st/tsconfig/node",
"include": ["src", "tests"]
}项目覆盖
预设提供公共基线,include、exclude、路径别名、构建输出等项目设置应由业务项目在自己的 tsconfig.json 中补充或覆盖。例如,使用 TypeScript 构建工具时可以覆盖 noEmit、outDir 等选项。
执行类型检查:
pnpm exec tsc --noEmit兼容性
- Node.js
>=20.19.0 - TypeScript 5.x 及兼容的现代 TypeScript 工具链
