@truenine/eslint9-config 1.0.14 → 1.0.17

package/README.md

@@ -1,144 +1,241 @@
-# @truenine/eslint9-config
+# ESLint 9 配置包
 
-ESLint 9 configuration package for Compose Client projects with TypeScript, Vue, and modern JavaScript support.
+这是一个针对 Compose Client 项目优化的 ESLint 9 配置包，提供了缓存优化、性能调优和规则优化功能。
 
-## Features
+## 功能特性
 
-- 🚀 **ESLint 9** - Latest ESLint version with flat config
-- 🎯 **TypeScript** - Full TypeScript support with strict rules
-- 🖖 **Vue 3** - Vue.js 3 specific linting rules
-- 🎨 **Stylistic** - Code formatting and style consistency
-- 🧪 **Testing** - Vitest and testing library support
-- 🎭 **UnoCSS** - Atomic CSS framework integration
-- ⚡ **Performance** - Optimized for fast linting
+### 🚀 性能优化
+- **智能缓存**: 支持 metadata 和 content 两种缓存策略
+- **并行处理**: 自动利用多核 CPU 进行并行检查
+- **规则优化**: 可选择跳过性能影响大的规则
+- **渐进式检查**: 优先检查关键文件
 
-## Installation
+### 📋 预设配置
+- **performance**: 性能优先，适用于大型项目或 CI 环境
+- **quality**: 质量优先，适用于小型项目或开发环境
+- **balanced**: 平衡配置，默认推荐
+- **ci**: CI 环境专用配置
+- **dev**: 开发环境友好配置
+- **library**: 库项目严格配置
 
-```bash
-# Using pnpm (recommended)
-pnpm add -D @truenine/eslint9-config
-
-# Using npm
-npm install --save-dev @truenine/eslint9-config
-
-# Using yarn
-yarn add -D @truenine/eslint9-config
-```
+### 🎯 智能忽略
+- 自动忽略构建产物、缓存目录、压缩文件等
+- 可配置的关键文件优先检查
+- 支持自定义忽略模式
 
-## Usage
+## 使用方法
 
-Create an `eslint.config.mjs` file in your project root:
+### 基础用法
 
 ```javascript
+// eslint.config.mjs
 import eslint9 from '@truenine/eslint9-config'
 
 export default eslint9({
-  // Configuration options
-  // type: 'lib' for libraries, 'app' for applications
   type: 'lib',
-  vue: true,
-  typescript: true,
-  test: true,
-  unocss: false,
-  stylistic: true,
-  formatters: false
+  typescript: {
+    strictTypescriptEslint: true,
+    tsconfigPath: './tsconfig.json',
+  },
 })
 ```
 
-### Configuration Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `type` | `'app' \| 'lib'` | `'lib'` | Project type |
-| `vue` | `boolean \| VueConfig` | `false` | Enable Vue.js support |
-| `typescript` | `boolean \| TsConfig` | `true` | Enable TypeScript support |
-| `test` | `boolean \| TestConfig` | `true` | Enable testing support |
-| `unocss` | `boolean \| UnocssConfig` | `false` | Enable UnoCSS support |
-| `stylistic` | `boolean \| StylisticConfig` | `true` | Enable stylistic rules |
-| `formatters` | `boolean \| FormatterConfig` | `false` | Enable formatters |
-| `jsx` | `boolean` | `false` | Enable JSX support |
-| `pnpm` | `boolean` | `false` | Enable pnpm-specific rules |
-| `ignores` | `string[]` | `[]` | Additional ignore patterns |
-
-### Examples
-
-#### Basic Library Configuration
+### 使用预设配置
 
 ```javascript
-import eslint9 from '@truenine/eslint9-config'
+// eslint.config.mjs
+import eslint9, { applyPreset } from '@truenine/eslint9-config'
 
 export default eslint9({
   type: 'lib',
-  typescript: true,
-  test: true
+  typescript: {
+    strictTypescriptEslint: true,
+    tsconfigPath: './tsconfig.json',
+  },
+  // 使用平衡预设
+  ...applyPreset('balanced'),
 })
 ```
 
-#### Vue Application Configuration
+### 自定义配置
 
 ```javascript
-import eslint9 from '@truenine/eslint9-config'
+// eslint.config.mjs
+import eslint9, { applyPreset } from '@truenine/eslint9-config'
 
 export default eslint9({
-  type: 'app',
+  type: 'lib',
   vue: true,
-  typescript: true,
-  unocss: true,
-  formatters: true
+  typescript: {
+    strictTypescriptEslint: true,
+    tsconfigPath: './tsconfig.json',
+  },
+  // 自定义缓存配置
+  cache: {
+    location: '.eslintcache',
+    strategy: 'metadata',
+  },
+  // 性能优化配置
+  performance: {
+    parallel: true,
+    skipExpensiveRules: false,
+  },
+  // 规则优化配置
+  ruleOptimization: {
+    progressive: true,
+    criticalFirst: true,
+    customOverrides: {
+      'ts/no-explicit-any': 'warn',
+      'complexity': ['warn', { max: 15 }],
+    },
+  },
 })
 ```
 
-#### Strict TypeScript Configuration
+## 配置选项
 
-```javascript
-import eslint9 from '@truenine/eslint9-config'
+### 缓存配置 (cache)
 
-export default eslint9({
-  typescript: {
-    strictTypescriptEslint: true,
-    tsconfigPath: './tsconfig.json'
-  }
-})
+```typescript
+cache?: boolean | {
+  /** 缓存位置，默认为 .eslintcache */
+  location?: string
+  /** 缓存策略，默认为 metadata */
+  strategy?: 'metadata' | 'content'
+}
 ```
 
-## Package Scripts
+### 性能配置 (performance)
 
-Add these scripts to your `package.json`:
+```typescript
+performance?: {
+  /** 启用并行处理，默认为 true */
+  parallel?: boolean
+  /** 最大并行数，默认为 CPU 核心数 */
+  maxParallel?: number
+  /** 忽略性能影响大的规则 */
+  skipExpensiveRules?: boolean
+}
+```
 
-```json
+### 规则优化配置 (ruleOptimization)
+
+```typescript
+ruleOptimization?: {
+  /** 是否启用渐进式检查 */
+  progressive?: boolean
+  /** 关键文件优先检查 */
+  criticalFirst?: boolean
+  /** 跳过性能影响大的规则 */
+  skipExpensive?: boolean
+  /** 自定义规则覆盖 */
+  customOverrides?: Record<string, string>
+}
+```
+
+## 预设配置详情
+
+### Performance 预设
+适用于大型项目或 CI 环境，优先考虑检查速度：
+- 启用 metadata 缓存策略
+- 跳过性能影响大的规则
+- 启用渐进式检查
+
+### Quality 预设
+适用于小型项目或开发环境，优先考虑代码质量：
+- 启用 content 缓存策略
+- 保留所有质量检查规则
+- 严格的错误级别
+
+### Balanced 预设
+默认推荐配置，平衡性能和质量：
+- metadata 缓存策略
+- 适中的规则严格程度
+- 启用关键文件优先检查
+
+### CI 预设
+专为持续集成环境优化：
+- 跳过耗时规则
+- 只保留关键错误检查
+- 忽略测试文件
+
+### Dev 预设
+开发环境友好配置：
+- 更宽松的规则设置
+- 允许 console 和 debugger
+- 警告级别而非错误级别
+
+### Library 预设
+适用于开源库或组件库：
+- 最严格的规则设置
+- 要求完整的类型注解
+- 强制文档注释
+
+## 性能优化建议
+
+### 1. 启用缓存
+```bash
+# package.json
 {
   "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint": "eslint --fix --cache --cache-location .eslintcache"
   }
 }
 ```
 
-## IDE Integration
+### 2. 使用合适的预设
+- 开发环境使用 `dev` 预设
+- CI 环境使用 `ci` 预设
+- 生产库使用 `library` 预设
 
-### VS Code
-
-Install the [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and add to your `.vscode/settings.json`:
+### 3. 配置忽略模式
+确保 `.eslintignore` 或配置中包含不需要检查的文件：
+```
+dist/
+build/
+coverage/
+.turbo/
+node_modules/
+*.min.js
+```
 
-```json
-{
-  "eslint.experimental.useFlatConfig": true,
-  "eslint.validate": [
-    "javascript",
-    "javascriptreact",
-    "typescript",
-    "typescriptreact",
-    "vue"
-  ]
+### 4. 渐进式检查
+对于大型项目，启用渐进式检查：
+```javascript
+ruleOptimization: {
+  progressive: true,
+  criticalFirst: true,
 }
 ```
 
-## Contributing
+## 故障排除
+
+### 缓存问题
+如果遇到缓存相关问题，可以清理缓存：
+```bash
+rm -rf .eslintcache
+```
+
+### 性能问题
+如果检查速度过慢，可以：
+1. 启用 `skipExpensiveRules` 选项
+2. 使用 `performance` 预设
+3. 增加忽略模式
 
-Contributions are welcome! Please read our [contributing guidelines](../../README.md) for details.
+### 规则冲突
+如果遇到规则冲突，可以通过 `customOverrides` 覆盖：
+```javascript
+ruleOptimization: {
+  customOverrides: {
+    'conflicting-rule': 'off',
+  },
+}
+```
 
-## Support
+## 更新日志
 
-- 🐛 [Report Issues](https://github.com/TrueNine/compose-client/issues)
-- 💬 [Discussions](https://github.com/TrueNine/compose-client/discussions)
-- 📖 [Documentation](https://github.com/TrueNine/compose-client#readme)
+### v1.0.0
+- 初始版本
+- 支持缓存优化
+- 提供预设配置
+- 集成规则优化器

package/dist/defaults/index.d.ts

@@ -1,35 +1,40 @@
-import { AntFuFormatterConfig, AntFuJsConfig, AntFuStylisticConfig, AntFuTestConfig, AntFuTsConfig, AntFuUnocssConfig, AntFuVueConfig } from '../types';
-export declare const defaultUnocssConfig: AntFuUnocssConfig;
-export declare const defaultVueConfig: AntFuVueConfig;
-export declare const defaultJsConfig: AntFuJsConfig;
-export declare const defaultTsConfig: AntFuTsConfig;
-export declare const defaultFormatterConfig: AntFuFormatterConfig;
+import { AntFuFormatterConfig, AntFuJsConfig, AntFuStylisticConfig, AntFuTestConfig, AntFuTsConfig, AntFuUnocssConfig, AntFuVueConfig } from "../types/index.js";
+
+//#region src/defaults/index.d.ts
+declare const defaultUnocssConfig: AntFuUnocssConfig;
+declare const defaultVueConfig: AntFuVueConfig;
+declare const defaultJsConfig: AntFuJsConfig;
+declare const defaultTsConfig: AntFuTsConfig;
+declare const defaultFormatterConfig: AntFuFormatterConfig;
 /**
- * 严格 ts 模式 的默认配置
- *
- * 这些配置需要 配置 parserOptions 和 tsconfigPath 等
- * @see https://typescript-eslint.io/getting-started/typed-linting
- */
-export declare const defaultStrictTsConfig: AntFuTsConfig;
-export declare const defaultStylisticConfig: AntFuStylisticConfig;
-export declare const defaultTestConfig: AntFuTestConfig;
+* 严格 ts 模式 的默认配置
+*
+* 这些配置需要 配置 parserOptions 和 tsconfigPath 等
+* @see https://typescript-eslint.io/getting-started/typed-linting
+*/
+declare const defaultStrictTsConfig: AntFuTsConfig;
+declare const defaultStylisticConfig: AntFuStylisticConfig;
+declare const defaultTestConfig: AntFuTestConfig;
 /**
- * 合并配置项，支持以下场景：
- * 1. 布尔值与对象配置的混合
- * 2. 使用 vite 的 mergeConfig 进行对象合并
- * 3. 处理 undefined 和 null 的默认值
- *
- * @example
- * ```ts
- * // 场景1: 布尔值转换为默认对象
- * mergeWithDefaults(true, { foo: 'bar' }) // => { foo: 'bar' }
- *
- * // 场景2: vite配置合并
- * mergeWithDefaults({ plugins: [vue()] }, { plugins: [unocss()] })
- *
- * // 场景3: undefined/null/false 处理
- * mergeWithDefaults(false, true) // => false
- * ```
- */
-export declare function mergeWithDefaults<T extends object>(value?: boolean | T | null, defaults?: T): T;
-export declare function mergeWithDefaults<T extends object>(value?: boolean | T | null, defaults?: boolean): boolean | T;
+* 合并配置项，支持以下场景：
+* 1. 布尔值与对象配置的混合
+* 2. 使用 vite 的 mergeConfig 进行对象合并
+* 3. 处理 undefined 和 null 的默认值
+*
+* @example
+* ```ts
+* // 场景1: 布尔值转换为默认对象
+* mergeWithDefaults(true, { foo: 'bar' }) // => { foo: 'bar' }
+*
+* // 场景2: vite配置合并
+* mergeWithDefaults({ plugins: [vue()] }, { plugins: [unocss()] })
+*
+* // 场景3: undefined/null/false 处理
+* mergeWithDefaults(false, true) // => false
+* ```
+*/
+declare function mergeWithDefaults<T extends object>(value?: boolean | T | null, defaults?: T): T;
+declare function mergeWithDefaults<T extends object>(value?: boolean | T | null, defaults?: boolean): boolean | T;
+//#endregion
+export { defaultFormatterConfig, defaultJsConfig, defaultStrictTsConfig, defaultStylisticConfig, defaultTestConfig, defaultTsConfig, defaultUnocssConfig, defaultVueConfig, mergeWithDefaults };
+//# sourceMappingURL=index.d.ts.map

package/dist/defaults/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":["defaultUnocssConfig: AntFuUnocssConfig","defaultVueConfig: AntFuVueConfig","defaultJsConfig: AntFuJsConfig","defaultTsConfig: AntFuTsConfig","defaultFormatterConfig: AntFuFormatterConfig","defaultStrictTsConfig: AntFuTsConfig","defaultStylisticConfig: AntFuStylisticConfig","defaultTestConfig: AntFuTestConfig"],"sources":["../../src/defaults/index.ts"],"sourcesContent":[],"mappings":";;;cAEaA,qBAAqB;cAKrBC,kBAAkB;AALlBD,cAyEAE,eAzEqB,EAyEJ,aAzEI;AAKrBD,cA2FAE,eA3FkB,EA2FD,aA3FC;AAoElBD,cAgDAE,sBAhDiB,EAgDO,oBAhDP;AAuB9B;AAyBA;AAsBA;AAUA;AAYA;AA8BA;AAAgB,cApDHC,qBAoDG,EApDoB,aAoDpB;AACI,cA3CPC,sBA2CO,EA3CiB,oBA2CjB;AACP,cAhCAC,iBAgCA,EAhCmB,eAgCnB;;;AAEb;;;;;;;;;;;;;;;;iBAJgB,sDACI,qBACP,IACV;iBACa,sDACI,yCAEP"}