@huaiyou/config-ts

@huaiyou/config-ts

共享的 TypeScript 配置预设，适用于 monorepo 中的所有项目。

📦 安装

pnpm add -D @huaiyou/config-ts typescript

🚀 使用方法

Base 配置（通用）

适用于所有 TypeScript 项目的基础配置。

{
  "extends": "@huaiyou/config-ts/base.json",
  "compilerOptions": {
    "outDir": "./dist",
    "rootDir": "./src"
  },
  "include": ["src"]
}

React 配置

针对 React 项目优化的配置，包含 JSX 支持和 DOM 类型。

{
  "extends": "@huaiyou/config-ts/react.json",
  "compilerOptions": {
    "outDir": "./dist",
    "rootDir": "./src"
  },
  "include": ["src"]
}

Node 配置

针对 Node.js 项目的配置，使用 CommonJS 模块系统。

{
  "extends": "@huaiyou/config-ts/node.json",
  "compilerOptions": {
    "outDir": "./dist",
    "rootDir": "./src"
  },
  "include": ["src"]
}

📋 配置说明

Base 配置特性

• 目标: ES2020
• 模块系统: ESNext with bundler resolution
• 严格模式: 完全启用
• 源码映射: 支持
• 声明文件: 自动生成

React 配置特性

继承 Base 配置，额外包含：

• JSX: React 17+ 的自动运行时
• DOM 类型: 浏览器环境类型支持
• Vite 类型: 内置 Vite 客户端类型

Node 配置特性

继承 Base 配置，调整为：

• 模块系统: CommonJS
• Node 类型: 内置 Node.js 类型支持

🔧 高级用法

自定义路径别名

{
  "extends": "@huaiyou/config-ts/react.json",
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["src/*"],
      "@components/*": ["src/components/*"]
    }
  }
}

启用实验性功能

{
  "extends": "@huaiyou/config-ts/base.json",
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

📝 最佳实践

• 始终使用严格模式: 所有配置默认启用严格类型检查
• 路径映射: 使用路径别名提高代码可读性
• 增量编译: 大型项目建议启用 incremental: true
• 项目引用: Monorepo 中使用 references 优化构建性能

🤝 贡献

如需添加新的配置预设或修改现有配置，请提交 Pull Request。

📄 License

MIT