@purea/eslint-config 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2026-01-02
+
+### Added
+- Initial release of @purea/eslint-config
+- ESLint 9+ flat config format support
+- TypeScript configuration with strict type checking
+- JavaScript modern ES6+ rules
+- Stylistic code formatting rules
+- Import/Export organization rules
+- File ignore patterns
+- TypeScript compilation with tsdown
+- MIT license
+
+### Features
+- Zero-configuration setup with sensible defaults
+- Modular config exports for flexible usage
+- Factory function for easy configuration composition
+- Type-safe configuration API
+- Support for both JavaScript and TypeScript projects
+- Optimized rule sets for modern development
+
+### Configurations
+- `javascript`: Core JavaScript rules and best practices
+- `typescript`: TypeScript-specific type safety rules
+- `stylistic`: Code style and formatting rules
+- `imports`: Import/export organization and ordering
+- `ignores`: File and directory ignore patterns

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Pure Anin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,463 @@
+# @purea/eslint-config
+
+> 一款现代化的、开箱即用的 ESLint 配置库，专为 JavaScript 和 TypeScript 项目设计。
+
+A comprehensive, opinionated ESLint configuration library for modern JavaScript and TypeScript projects.
+
+## ✨ 特性 Features
+
+- 🎯 **零配置** 开箱即用，提供合理的默认设置
+- 🔧 **TypeScript 支持** 完整的 TypeScript 集成和严格规则
+- 📦 **现代化** 使用最新的 ESLint Flat Config 格式
+- 🚀 **高性能** 通过动态导入优化加载速度
+- 🎨 **一致性** 在整个项目中强制执行统一的代码风格
+- 🛠️ **可扩展** 易于自定义和扩展
+- 📝 **完善文档** 所有规则都包含中文注释
+
+## 📦 安装 Installation
+
+```bash
+npm install --save-dev @purea/eslint-config
+# or
+pnpm add -D @purea/eslint-config
+# or
+yarn add -D @purea/eslint-config
+```
+
+## 🚀 快速开始 Quick Start
+
+### 基础用法 Basic Usage
+
+在项目根目录创建 `eslint.config.js` 文件：
+
+```javascript
+import config from '@purea/eslint-config'
+
+export default config()
+```
+
+这将使用默认配置，自动启用 JavaScript、Stylistic、TypeScript、JSONC、Vue 和导入规则。
+
+This uses the default configuration with JavaScript, Stylistic, TypeScript, JSONC, Vue, and import rules enabled.
+
+### 高级用法 Advanced Usage
+
+根据项目需求自定义配置：
+
+```javascript
+import config from '@purea/eslint-config'
+
+export default config({
+  typescript: true,      // 启用 TypeScript 规则
+  imports: true,         // 启用导入规则
+  jsonc: true,           // 启用 JSONC 规则
+  vue: true,             // 启用 Vue 规则
+  ignores: ['dist', 'build'],  // 自定义忽略模式
+})
+```
+
+**注意**：`stylistic`（代码风格规则）默认启用，无法通过配置选项禁用。
+
+### 直接使用 useConfig Using useConfig Directly
+
+```javascript
+import { useConfig } from '@purea/eslint-config'
+
+export default useConfig({
+  typescript: true,
+  imports: true
+})
+```
+
+JavaScript 和 Stylistic 配置默认启用，无需额外配置。
+
+### 使用独立配置 Using Individual Configs
+
+```javascript
+import { javascript, typescript, imports, stylistic, ignores } from '@purea/eslint-config'
+
+export default [
+  ignores(['dist', 'node_modules']),
+  javascript(),
+  stylistic(),
+  typescript(),
+  imports(),
+  {
+    // 自定义规则
+    rules: {
+      'no-console': 'off'
+    }
+  }
+]
+```
+
+### 添加自定义规则 Adding Custom Rules
+
+```javascript
+import { useConfig } from '@purea/eslint-config'
+
+export default useConfig({
+  typescript: true,
+  imports: true,
+  ignores: ['dist', 'node_modules', '*.config.js']
+}, {
+  // 额外配置
+  rules: {
+    'no-console': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@stylistic/quotes': 'off'  // 覆盖默认的stylistic规则
+  }
+})
+```
+
+## ⚙️ 配置选项 Configuration Options
+
+| 选项 Option | 类型 Type | 默认值 Default | 描述 Description |
+|------------|---------|---------------|-----------------|
+| `typescript` | `boolean \| object` | `auto` | 启用 TypeScript 特定规则，自动检测 TypeScript 是否安装 |
+| `imports` | `boolean` | `true` | 启用导入组织规则 |
+| `jsonc` | `boolean` | `true` | 启用 JSON/JSONC 文件规则 |
+| `vue` | `boolean \| object` | `auto` | 启用 Vue.js 特定规则，自动检测 Vue 是否安装 |
+| `ignores` | `string[]` | `[]` | 自定义忽略模式 |
+
+## 📋 可用配置 Available Configs
+
+所有配置函数都返回 Promise，由 ESLint 自动处理：
+
+- `javascript()` - 基础 JavaScript 规则，支持现代 ES6+ 语法（350+ 规则）
+- `typescript()` - TypeScript 特定规则，包含类型检查
+- `imports()` - 导入组织和依赖管理规则
+- `stylistic()` - 代码风格规则，基于 @stylistic/eslint-plugin（100+ 规则）
+- `jsonc()` - JSON/JSONC 文件规则
+- `vue()` - Vue.js 特定规则
+- `ignores(patterns)` - 文件和目录忽略模式（同步函数）
+
+**注意**：`javascript()` 和 `stylistic()` 配置默认启用，无法通过配置选项禁用。
+
+## 📝 规则概览 Rules Overview
+
+### JavaScript 规则 JavaScript Rules
+
+JavaScript 配置包含 350+ 条规则，涵盖：
+
+**可能的错误 Possible Errors**
+- 捕获常见的编程错误
+- `no-console` (warn): 禁用 console 语句
+- `no-debugger` (error): 禁用 debugger 语句
+- `no-dupe-args` (error): 防止重复的函数参数
+
+**最佳实践 Best Practices**
+- 强制执行现代 JavaScript 最佳实践
+- `eqeqeq` (error): 要求使用 `===` 和 `!==`
+- `no-eval` (error): 禁用 `eval()` 使用
+- `prefer-const` (error): 优先对不重新赋值的变量使用 `const`
+
+**变量 Variables**
+- 正确的变量声明和使用
+- `no-unused-vars` (warn): 禁止未使用的变量
+- `no-shadow` (warn): 禁止变量遮蔽
+
+**环境支持 Environment Support**
+- Node.js 全局变量
+- ES2023 全局变量
+- 浏览器全局变量（window, document, navigator）
+
+### Stylistic 规则 Stylistic Rules
+
+Stylistic 配置基于 `@stylistic/eslint-plugin`，包含 100+ 条代码风格规则：
+
+**数组规则 Array Rules**
+- `@stylistic/array-bracket-spacing`: 强制数组括号内无空格
+- `@stylistic/array-element-newline`: 控制数组元素换行
+
+**箭头函数规则 Arrow Function Rules**
+- `@stylistic/arrow-parens`: 强制箭头函数参数使用括号
+- `@stylistic/arrow-spacing`: 强制箭头函数箭头前后空格
+
+**块规则 Block Rules**
+- `@stylistic/block-spacing`: 强制块内空格
+- `@stylistic/brace-style`: 强制大括号风格（1TBS）
+
+**逗号规则 Comma Rules**
+- `@stylistic/comma-dangle`: 强制在多行中使用尾随逗号
+- `@stylistic/comma-spacing`: 强制逗号前后空格
+
+**缩进规则 Indent Rules**
+- `@stylistic/indent`: 强制缩进为2空格
+- 支持多种代码结构的智能缩进
+
+**引号规则 Quotes Rules**
+- `@stylistic/quotes`: 强制使用单引号
+- `@stylistic/quote-props`: 强制对象属性引号
+
+**分号规则 Semi Rules**
+- `@stylistic/semi`: 强制使用分号
+- `@stylistic/semi-spacing`: 强制分号前后空格
+
+**空格规则 Space Rules**
+- `@stylistic/space-before-blocks`: 强制块前空格
+- `@stylistic/space-infix-ops`: 强制运算符周围空格
+- `@stylistic/space-before-function-paren`: 强制函数括号前空格
+
+**其他规则 Other Rules**
+- `@stylistic/max-len`: 强制最大行长度为120
+- `@stylistic/no-trailing-spaces`: 禁止行尾空格
+- `@stylistic/no-tabs`: 禁止制表符
+- `@stylistic/linebreak-style`: 强制换行符风格（Unix）
+
+### TypeScript 规则 TypeScript Rules
+
+TypeScript 配置包含：
+
+- 自动检测 `tsconfigRootDir` 的解析器配置
+- 源代码类型：ES Module
+- 类型检查规则
+- `@typescript-eslint/no-explicit-any` (warn): 对 `any` 类型使用发出警告
+
+### 导入规则 Import Rules
+
+导入配置包含全面的规则：
+
+**静态分析 Static Analysis**
+- 确保导入存在且有效
+- `import/named` (error): 确保命名导入存在
+- `import/default` (error): 确保默认导入存在
+
+**代码风格 Code Style**
+- 组织和格式化导入
+- `import/first` (error): 确保导入在文件顶部
+- `import/no-duplicates` (error): 防止重复导入
+- `import/order` (error): 强制导入顺序（内置 → 外部 → 内部）
+
+**依赖管理 Dependency Management**
+- 管理模块依赖
+- `import/no-extraneous-dependencies` (error): 防止导入额外的依赖
+- `import/no-cycle` (warn): 对循环依赖发出警告
+
+### JSONC 规则 JSONC Rules
+
+JSONC 配置包含 JSON 和 JSONC 文件的规则：
+
+- 支持 `.json`、`.jsonc`、`.json5` 文件
+- 确保有效的 JSON 语法
+- 强制一致的 JSON 格式
+
+### Vue 规则 Vue Rules
+
+Vue 配置包含 Vue.js 特定规则：
+
+- 支持 `.vue` 单文件组件
+- Vue 3 Composition API 支持
+- 与 TypeScript 集成（当启用 TypeScript 时）
+
+### 忽略模式 Ignore Patterns
+
+默认忽略模式包括：
+- `node_modules`
+- `dist`
+- 锁文件（`package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lockb`）
+
+## 💡 使用示例 Examples
+
+### TypeScript 项目
+
+```javascript
+// eslint.config.js
+import { useConfig } from '@purea/eslint-config'
+
+export default useConfig({
+  typescript: true,
+  imports: true
+})
+```
+
+### 纯 JavaScript 项目
+
+```javascript
+// eslint.config.js
+import config from '@purea/eslint-config'
+
+export default config()
+```
+
+### 自定义配置
+
+```javascript
+// eslint.config.js
+import { useConfig } from '@purea/eslint-config'
+
+export default useConfig({
+  typescript: true,
+  imports: true,
+  ignores: ['dist', 'coverage']
+}, {
+  // 覆盖特定规则
+  rules: {
+    'no-console': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@stylistic/quotes': 'off'  // 禁用特定的代码风格规则
+  }
+})
+```
+
+JavaScript 和 Stylistic 配置默认启用，但可以通过规则覆盖来自定义特定规则。
+
+### Vue 项目
+
+```javascript
+// eslint.config.js
+import { useConfig } from '@purea/eslint-config'
+
+export default useConfig({
+  typescript: true,
+  imports: true,
+  vue: true,
+  jsonc: true
+})
+```
+
+### 使用独立配置函数
+
+```javascript
+// eslint.config.js
+import { javascript, typescript, imports, stylistic, ignores, jsonc, vue } from '@purea/eslint-config'
+
+export default [
+  ignores(['dist', 'node_modules']),
+  javascript(),
+  stylistic(),
+  typescript(),
+  imports(),
+  jsonc(),
+  vue(),
+  {
+    rules: {
+      'no-console': 'off'
+    }
+  }
+]
+```
+
+## 🔧 技术细节 Technical Details
+
+### 动态导入 Dynamic Imports
+
+配置使用动态导入以获得更好的性能：
+
+```typescript
+const [globals] = await Promise.all([
+  importDefault(import('globals')),
+] as const);
+```
+
+插件仅在需要时加载，减少初始加载时间。
+
+### 异步配置支持 Async Configuration Support
+
+ESLint 支持异步配置函数。`useConfig()` 函数返回 `Promise<FlatConfigItem[]>`，ESLint 会自动处理 Promise 解析。在配置文件中无需使用 `await`。
+
+### Flat Config 格式 Flat Config Format
+
+使用 ESLint 9.x 的 Flat Config 格式，比传统的 `.eslintrc` 文件更灵活。
+
+### 可组合设计 Composable Design
+
+轻松组合多个配置：
+
+```typescript
+export default useConfig({
+  typescript: true,
+  imports: true,
+}, {
+  // 自定义配置
+  rules: {
+    'no-console': 'off',
+    '@stylistic/quotes': 'off'  // 可以覆盖默认的stylistic规则
+  }
+})
+```
+
+JavaScript 和 Stylistic 配置默认启用，TypeScript 和 Imports 配置可通过选项控制。
+
+## 📦 依赖 Dependencies
+
+### 同伴依赖 Peer Dependencies
+
+此配置需要以下同伴依赖：
+
+```json
+{
+  "eslint": "^9.39.1",
+  "typescript": ">=5.0.0"
+}
+```
+
+**注意**：TypeScript 是可选的，仅当项目中安装时才会使用。
+
+### 运行时依赖 Runtime Dependencies
+- `globals`: 提供全局变量定义
+- `eslint-plugin-import`: 导入组织规则
+- `@stylistic/eslint-plugin`: 代码风格规则
+- `@typescript-eslint/eslint-plugin`: TypeScript 规则
+- `@typescript-eslint/parser`: TypeScript 解析器
+
+### 开发依赖 Development Dependencies
+- `eslint@^9.39.1`: ESLint 核心
+- `tsdown`: 构建工具
+- `jiti`: TypeScript 运行时加载器
+- `typescript`: TypeScript 编译器
+
+## 🛠️ 开发 Development
+
+```bash
+# 安装依赖
+pnpm install
+
+# 构建项目
+pnpm run build
+
+# 检查代码
+pnpm run lint
+
+# 开发模式（监听文件变化）
+pnpm run dev
+```
+
+## 📁 项目结构 Project Structure
+
+```
+eslint-config/
+├── src/
+│   ├── index.ts           # 主入口
+│   ├── factory.ts         # 配置工厂
+│   ├── types.ts           # TypeScript 类型定义
+│   ├── utils.ts           # 工具函数
+│   └── configs/           # 配置模块
+│       ├── ignores.ts      # 忽略模式
+│       ├── imports.ts     # 导入规则
+│       ├── javascript.ts  # JavaScript 基础规则
+│       ├── stylistic.ts   # 代码风格规则
+│       └── typescript.ts  # TypeScript 规则
+├── eslint.config.ts       # 项目自身的 ESLint 配置
+├── tsdown.config.ts       # 构建配置
+├── tsconfig.json          # TypeScript 配置
+└── package.json           # 包配置
+```
+
+## 🤝 贡献 Contributing
+
+欢迎贡献！请随时提交 Pull Request。
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📄 许可证 License
+
+MIT License - 详见 [LICENSE](LICENSE) 文件。
+
+## 📝 更新日志 Changelog
+
+查看 [CHANGELOG.md](CHANGELOG.md) 了解变更列表。
+
+---
+
+Made with ❤️ by Pure Anin

package/dist/index.d.ts

@@ -0,0 +1,133 @@
+import { Linter } from "eslint";
+
+//#region src/types.d.ts
+
+/**
+  * A type that represents a value that can be either a Promise of T or T itself.
+*/
+type Awaitable<T> = Promise<T> | T;
+/**  Configuration options for the ESLint config */
+interface ConfigOptions {
+  /**
+  * User ignores patterns
+  * @default []
+  */
+  ignores?: string[];
+  /**
+   * Enable imports rules
+   * @default true
+   */
+  imports?: boolean;
+  /**
+   * Enable TypeScript rules
+   * @default true (if TypeScript is detected in the project)
+   */
+  typescript?: boolean | OptionsTypeScriptWithTypes;
+  /**
+   * Enable JSONC rules
+   * @default true
+   */
+  jsonc?: boolean;
+  /**
+   * Enable Vue rules
+   * @default true (if Vue is detected in the project)
+   */
+  vue?: boolean | VueOptions;
+}
+type FlatConfigItem = Omit<Linter.Config, 'plugins'> & {
+  /**
+   * An object containing a name-value mapping of plugin names to plugin objects.
+   * When `files` is specified, these plugins are only available to the matching files.
+   *
+   * @see [Using plugins in your configuration](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-plugins-in-your-configuration)
+   */
+  plugins?: Record<string, unknown>;
+};
+/** TypeScript options. */
+type TypeScriptOptions = OptionsTypeScriptWithTypes;
+/** Options for TypeScript with types. */
+interface OptionsTypeScriptWithTypes {
+  /**
+   * When this options is provided, type aware rules will be enabled.
+   * @see https://typescript-eslint.io/linting/typed-linting/
+   */
+  tsconfigPath?: string;
+  /**
+   * Override type aware rules.
+   */
+  overridesTypeAwareRules?: FlatConfigItem['rules'];
+}
+/** Vue options. */
+interface VueOptions {
+  /**
+   * Vue version
+   * @default 3
+   */
+  vueVersion?: 2 | 3;
+  /**
+   * Override Vue-specific rules.
+   */
+  overridesRules?: FlatConfigItem['rules'];
+  /**
+   * Enable TypeScript rules for Vue SFC
+   * @default false
+   */
+  typescript?: boolean;
+}
+//#endregion
+//#region src/factory.d.ts
+/**
+ * Create ESLint configuration based on provided options
+ *
+ * @param options - Configuration options
+ * @returns Array of ESLint configurations
+ *
+ * @example
+ * ```typescript
+ * import { useConfig } from '@purea/eslint-config'
+ *
+ * export default useConfig({
+ *   typescript: true,
+ * })
+ * ```
+ */
+declare function useConfig(options?: ConfigOptions, ...extraConfigs: Awaitable<FlatConfigItem | FlatConfigItem[] | Linter.Config[]>[]): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/ignores.d.ts
+declare function ignores(userIgnores?: string[]): FlatConfigItem;
+//#endregion
+//#region src/configs/imports.d.ts
+declare function imports(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/javascript.d.ts
+declare function javascript(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/typescript.d.ts
+declare function typescript(options?: TypeScriptOptions): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/stylistic.d.ts
+declare function stylistic(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/jsonc.d.ts
+declare function jsonc(): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/configs/vue.d.ts
+declare function vue(options?: VueOptions): Promise<FlatConfigItem[]>;
+//#endregion
+//#region src/utils.d.ts
+/**
+ * 检查值是否为非空对象
+ * @param value - 要检查的值
+ * @returns 如果值是非空对象则返回 true，否则返回 false
+ */
+declare const isObject: (value: unknown) => value is Record<string, unknown>;
+/**
+ * 导入默认导出
+ * @param importable - 动态导入的 Promise
+ * @returns 返回模块的默认导出或整个模块对象
+ */
+declare function importDefault<T>(importable: Awaitable<T>): Promise<T extends {
+  default: infer U;
+} ? U : T>;
+//#endregion
+export { Awaitable, ConfigOptions, FlatConfigItem, TypeScriptOptions, VueOptions, useConfig as default, useConfig, ignores, importDefault, imports, isObject, javascript, jsonc, stylistic, typescript, vue };