@infra-x/create-eslint-config 0.1.4 → 0.2.1

package/dist/template/src/index.ts

@@ -1,7 +1,7 @@
 /**
  * @workspace/eslint-config
  *
- * 统一 ESLint 配置工具
+ * Composable ESLint configuration factory
  *
  * @example
  * ```typescript
@@ -12,27 +12,23 @@
  *   react: true,
  *   tailwind: true,
  *   imports: { typescript: true },
- *   prettier: true,
  * })
  * ```
  */
 
-import { defineConfig } from 'eslint/config'
-import { configs as tsConfigs, parser as tsParser } from 'typescript-eslint'
-
 import { a11y } from './configs/a11y'
 import { tailwind } from './configs/better-tailwindcss'
 import { boundaries } from './configs/boundaries'
 import { depend } from './configs/depend'
-import { ignores } from './configs/ignores'
+import { ignores } from './configs/global-ignores'
 import { imports } from './configs/imports'
 import { javascript } from './configs/javascript'
 import { jsdoc } from './configs/jsdoc'
 import { nextjs } from './configs/nextjs'
 import { packageJson } from './configs/package-json'
-import { prettier } from './configs/prettier'
 import { react } from './configs/react'
 import { storybook } from './configs/storybook'
+import { oxlintConfig } from './configs/oxlint'
 import { stylistic } from './configs/stylistic'
 import { typescript } from './configs/typescript'
 import { unicorn } from './configs/unicorn'
@@ -47,8 +43,8 @@ import type {
   JavaScriptOptions,
   JsdocOptions,
   NextjsOptions,
+  OxlintOptions,
   PackageJsonOptions,
-  PrettierOptions,
   ReactOptions,
   StorybookOptions,
   StylisticOptions,
@@ -60,68 +56,72 @@ import type {
 import type { Linter } from 'eslint'
 
 // ============================================================================
-// 类型定义
+// Type definitions
 // ============================================================================
 
 /**
- * composeConfig 配置选项
+ * Options for composeConfig
  *
- * 每个配置项支持：
- * - `true` - 使用默认选项
- * - `对象` - 传入自定义选项
- * - `false` - 关闭（默认开启的配置需要显式关闭）
- * - 不写 - 不启用（非默认开启的配置）
+ * Each config entry accepts:
+ * - `true` - enable with default options
+ * - `object` - enable with custom options
+ * - `false` - explicitly disable (required for configs that are on by default)
+ * - omitted - leave disabled (for configs that are off by default)
  */
 export interface ComposeConfigOptions {
-  // 基础配置（默认开启）
-  /** 忽略文件配置 @default true */
-  ignores?: boolean | IgnoresOptions
-  /** JavaScript 基础配置 @default true */
+  // Base configuration (enabled by default)
+  /** Ignore patterns configuration @default true */
+  globalIgnores?: boolean | IgnoresOptions
+  /** JavaScript base configuration @default true */
   javascript?: boolean | JavaScriptOptions
-  /** TypeScript 配置 @default true */
+  /** TypeScript configuration @default true */
   typescript?: boolean | TypeScriptOptions
-  /** 代码风格规则 @default true */
+  /** Code style rules @default true */
   stylistic?: boolean | StylisticOptions
-  /** Unicorn 最佳实践 @default true */
+  /** Unicorn best practices @default true */
   unicorn?: boolean | UnicornOptions
-  /** 依赖优化建议 @default true */
+  /** Dependency optimization suggestions @default true */
   depend?: boolean | DependOptions
-  /** config 文件（*.config.ts）专属规则（不启用类型检查）@default true */
-  configFiles?: boolean
-
-  // 框架配置
-  /** React 配置 */
+  // Framework configuration
+  /** React configuration */
   react?: boolean | ReactOptions
-  /** Next.js 配置 */
+  /** Next.js configuration */
   nextjs?: boolean | NextjsOptions
-  /** Tailwind CSS 配置 */
+  /** Tailwind CSS configuration */
   tailwind?: boolean | TailwindOptions
 
-  // 工具配置
-  /** Import 排序和规则 */
+  // Tooling configuration
+  /** Import ordering and rules */
   imports?: boolean | ImportsOptions
-  /** Prettier 格式化 */
-  prettier?: boolean | PrettierOptions
 
-  // 质量配置
-  /** 无障碍访问规则 */
+  // Quality configuration
+  /** Accessibility rules */
   a11y?: boolean | A11yOptions
-  /** JSDoc 文档规则 */
+  /** JSDoc documentation rules */
   jsdoc?: boolean | JsdocOptions
-  /** 模块边界规则 */
+  /** Module boundary rules */
   boundaries?: boolean | BoundariesOptions
-  /** package.json 规则 */
+  /** package.json rules */
   packageJson?: boolean | PackageJsonOptions
 
-  // 测试配置
-  /** Vitest 测试规则 */
+  // Testing configuration
+  /** Vitest testing rules */
   vitest?: boolean | VitestOptions
-  /** Storybook 规则 */
+  /** Storybook rules */
   storybook?: boolean | StorybookOptions
+
+  // Linter integration
+  /**
+   * Disable ESLint rules already covered by oxlint.
+   * Requires oxlint to be run separately.
+   * - `true` uses the `flat/recommended` preset
+   * - `{ configFile }` generates disabled rules from your oxlint config file
+   */
+  oxlint?: boolean | OxlintOptions
 }
 
 // ============================================================================
-// 主函数
+// Core function
 // ============================================================================
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -131,13 +131,13 @@ type ConfigEntry = {
   key: keyof ComposeConfigOptions
   fn: ConfigFn
   defaultOn?: boolean
-  /** 根据全局 options 派生注入值，优先级低于用户配置 */
+  /** Values derived from global options to inject; overridden by explicit user config */
   inject?: (options: ComposeConfigOptions) => Record<string, unknown>
 }
 
 const CONFIG_REGISTRY: ConfigEntry[] = [
-  // 默认开启
-  { key: 'ignores', fn: ignores, defaultOn: true },
+  // Enabled by default
+  { key: 'globalIgnores', fn: ignores, defaultOn: true },
   { key: 'javascript', fn: javascript, defaultOn: true },
   {
     key: 'typescript',
@@ -147,11 +147,16 @@ const CONFIG_REGISTRY: ConfigEntry[] = [
   { key: 'stylistic', fn: stylistic, defaultOn: true },
   { key: 'unicorn', fn: unicorn, defaultOn: true },
   { key: 'depend', fn: depend, defaultOn: true },
-  // 按需开启（顺序固定，prettier 最后）
+  // Opt-in (order is fixed; prettier must come last)
   {
     key: 'imports',
     fn: imports,
-    inject: (options) => ({ typescript: options.typescript !== false }),
+    inject: (options) => ({
+      typescript: options.typescript !== false,
+      tsconfigRootDir: typeof options.typescript === 'object'
+        ? options.typescript.tsconfigRootDir
+        : undefined,
+    }),
   },
   { key: 'react', fn: react },
   { key: 'nextjs', fn: nextjs },
@@ -162,10 +167,10 @@ const CONFIG_REGISTRY: ConfigEntry[] = [
   { key: 'packageJson', fn: packageJson },
   { key: 'vitest', fn: vitest },
   { key: 'storybook', fn: storybook },
-  { key: 'prettier', fn: prettier },
+  { key: 'oxlint', fn: oxlintConfig },
 ]
 
-/** 组合 ESLint 配置，内部按正确顺序组合 */
+/** Composes ESLint configs in the correct internal order */
 export function composeConfig(options: ComposeConfigOptions = {}): Linter.Config[] {
   const configs: Linter.Config[] = []
 
@@ -179,30 +184,11 @@ export function composeConfig(options: ComposeConfigOptions = {}): Linter.Config
     configs.push(...fn({ ...injected, ...base }))
   }
 
-  return options.configFiles === false
-    ? configs
-    : defineConfig([
-        {
-          ignores: ['*.config.ts', '*.config.mts'],
-          extends: [configs],
-        },
-        {
-          name: 'typescript/config-files',
-          files: ['*.config.ts', '*.config.mts'],
-          extends: [tsConfigs.recommended],
-          languageOptions: {
-            parser: tsParser,
-            parserOptions: {
-              project: false,
-              tsconfigRootDir: (typeof options.typescript === 'object' ? options.typescript.tsconfigRootDir : undefined) ?? process.cwd(),
-            },
-          },
-        },
-      ])
+  return configs
 }
 
 // ============================================================================
-// 类型导出
+// Type exports
 // ============================================================================
 
 export type {
@@ -214,8 +200,8 @@ export type {
   JavaScriptOptions,
   JsdocOptions,
   NextjsOptions,
+  OxlintOptions,
   PackageJsonOptions,
-  PrettierOptions,
   ReactOptions,
   StorybookOptions,
   StylisticOptions,
@@ -226,7 +212,7 @@ export type {
 } from './types'
 
 // ============================================================================
-// 常量导出
+// Constant exports
 // ============================================================================
 
 export { GLOB_SRC, GLOB_JS, GLOB_TS, GLOB_JSX, GLOB_TESTS, GLOB_JSON, GLOB_MARKDOWN } from './utils'

package/dist/template/src/types.ts

@@ -1,38 +1,27 @@
 import type { RulesConfig } from '@eslint/core'
 
 /**
- * 规则覆盖选项
+ * Rule override options
  */
 export interface OptionsOverrides {
   /**
-   * 自定义规则覆盖
+   * Custom rule overrides
    */
   overrides?: Partial<RulesConfig>
 }
 
 /**
- * 风格化选项
- */
-export interface OptionsStylistic {
-  /**
-   * 是否启用风格化规则
-   * @default true
-   */
-  stylistic?: boolean
-}
-
-/**
- * 文件匹配选项
+ * File matching options
  */
 export interface OptionsFiles {
   /**
-   * 自定义文件匹配模式
+   * Custom file glob patterns
    */
   files?: string[]
 }
 
 /**
- * TypeScript 配置选项
+ * TypeScript configuration options
  */
 export interface OptionsTypeScript {
   tsconfigRootDir?: string
@@ -41,18 +30,18 @@ export interface OptionsTypeScript {
 }
 
 /**
- * Tailwind CSS 配置选项
+ * Tailwind CSS configuration options
  */
 export interface OptionsTailwind {
   /**
-   * Tailwind CSS 入口文件路径
+   * Path to the Tailwind CSS entry file
    * @default 'src/global.css'
    */
   entryPoint?: string
 }
 
 // ============================================================================
-// Config Options 类型
+// Config option types
 // ============================================================================
 
 export type A11yOptions = OptionsFiles & OptionsOverrides
@@ -74,48 +63,53 @@ export interface BoundariesOptions extends OptionsFiles, OptionsOverrides {
 
 export interface DependOptions extends OptionsOverrides {
   /**
-   * 预设列表
+   * Preset list
    *
-   * - `native`: 检测可用原生 JavaScript API 替代的包(如 `is-nan` → `Number.isNaN()`)
-   * - `microutilities`: 检测微型工具库(一行代码可实现的包)
-   * - `preferred`: 推荐更轻量、维护更好的替代方案
+   * - `native`: Flags packages replaceable with native JavaScript APIs (e.g. `is-nan` → `Number.isNaN()`)
+   * - `microutilities`: Flags micro-utility packages implementable in a single line
+   * - `preferred`: Recommends lighter-weight, better-maintained alternatives
    *
    * @default ['native', 'microutilities', 'preferred']
    */
   presets?: ('native' | 'microutilities' | 'preferred')[]
 
   /**
-   * 自定义禁用的模块列表
+   * Additional modules to ban
    * @default []
    */
   modules?: string[]
 
   /**
-   * 允许使用的模块列表(即使在 presets 中)
+   * Modules to allow even if matched by a preset
    * @default []
    */
   allowed?: string[]
 }
 
 export interface IgnoresOptions {
-  /** 用户自定义忽略规则，传入 false 禁用默认规则 */
-  ignores?: string[] | false
-  /** gitignore 文件路径或启用标志 */
-  gitignore?: string | boolean
+  /** Additional ignore patterns to merge with DEFAULT_IGNORES; pass false to disable all global ignores */
+  ignores?: string | string[] | false
+  /** Whether to parse .gitignore and merge into global ignores @default true */
+  gitignore?: boolean
 }
 
-export interface ImportsOptions extends OptionsOverrides, OptionsStylistic {
+export interface ImportsOptions extends OptionsOverrides {
   /**
-   * 是否启用 TypeScript 支持
-   * 当全局 typescript 开启时，由 composeConfig 自动注入为 true
-   * @default false（独立调用时）/ 跟随全局 typescript 选项（通过 composeConfig）
+   * Whether to enable TypeScript support
+   * Automatically injected as true by composeConfig when the global typescript option is enabled
+   * @default false (standalone) / follows global typescript option (via composeConfig)
    */
   typescript?: boolean
   /**
-   * 禁止使用 ../ 父级相对导入
+   * Disallow parent-relative imports (paths starting with ../)
    * @default false
    */
   noRelativeParentImports?: boolean
+  /**
+   * Root directory for tsconfig.json lookup; restricts resolver scope in monorepo to avoid cross-app漫游
+   * Automatically injected by composeConfig from the global typescript.tsconfigRootDir option
+   */
+  tsconfigRootDir?: string
 }
 
 export type JavaScriptOptions = OptionsFiles & OptionsOverrides
@@ -135,9 +129,13 @@ export interface PackageJsonOptions extends OptionsOverrides {
   enforceForPrivate?: boolean
 }
 
-export type PrettierOptions = OptionsOverrides
-
-export type ReactOptions = OptionsFiles & OptionsOverrides
+export interface ReactOptions extends OptionsFiles, OptionsOverrides {
+  /**
+   * Whether to enable react-refresh plugin (for Vite projects).
+   * @default false
+   */
+  vite?: boolean
+}
 
 export type StorybookOptions = OptionsOverrides
 
@@ -152,3 +150,12 @@ export type UnicornOptions = OptionsFiles & OptionsOverrides
 export type VitestOptions = OptionsFiles & OptionsOverrides & {
   isInEditor?: boolean
 }
+
+export interface OxlintOptions {
+  /**
+   * Path to oxlint config file for dynamic rule generation.
+   * When provided, uses `buildFromOxlintConfigFile()` instead of the `flat/recommended` preset.
+   * @example './.oxlintrc.json'
+   */
+  configFile?: string
+}

package/dist/template/src/utils.ts

@@ -1,13 +1,13 @@
 /**
- * 工具函数和常量
+ * Utility functions and constants
  */
 
 // ============================================================================
-// 环境检测
+// Environment detection
 // ============================================================================
 
 /**
- * 检测是否在 Git Hooks 或 lint-staged 中运行
+ * Detects whether running inside Git Hooks or lint-staged
  */
 function isInGitHooksOrLintStaged(): boolean {
   const envVars = [
@@ -18,14 +18,14 @@ function isInGitHooksOrLintStaged(): boolean {
 }
 
 /**
- * 检测是否在编辑器环境中运行
+ * Detects whether running in an editor environment
  *
- * 在以下情况返回 false：
- * - CI 环境
+ * Returns false when:
+ * - CI environment
  * - Git Hooks
  * - lint-staged
  *
- * 在以下情况返回 true：
+ * Returns true when:
  * - VSCode
  * - JetBrains IDE
  * - Vim / Neovim
@@ -46,35 +46,35 @@ export function isInEditorEnv(): boolean {
 }
 
 // ============================================================================
-// 文件匹配模式 (Globs)
+// File matching patterns (Globs)
 // ============================================================================
 
 /**
- * ESLint 文件匹配模式常量
+ * ESLint file glob pattern constants
  *
- * 统一的 glob 模式，确保所有配置使用一致的文件匹配规则
+ * Unified glob patterns to ensure consistent file matching across all configurations
  */
 
-/** 所有 JS/TS 源文件（完整覆盖 ESM/CJS） */
+/** All JS/TS source files (full ESM/CJS coverage) */
 export const GLOB_SRC = '**/*.{js,mjs,cjs,jsx,ts,mts,cts,tsx}'
 
-/** 仅 JavaScript 文件 */
+/** JavaScript files only */
 export const GLOB_JS = '**/*.{js,mjs,cjs,jsx}'
 
-/** 仅 TypeScript 文件 */
+/** TypeScript files only */
 export const GLOB_TS = '**/*.{ts,mts,cts,tsx}'
 
-/** JSX/TSX 文件（React 相关） */
+/** JSX/TSX files (React-related) */
 export const GLOB_JSX = '**/*.{jsx,tsx}'
 
-/** 测试文件 */
+/** Test files */
 export const GLOB_TESTS: string[] = [
   '**/*.{test,spec}.{js,mjs,cjs,jsx,ts,mts,cts,tsx}',
   '**/__tests__/**/*.{js,mjs,cjs,jsx,ts,mts,cts,tsx}',
 ]
 
-/** JSON 文件 */
+/** JSON files */
 export const GLOB_JSON = '**/*.json'
 
-/** Markdown 文件 */
+/** Markdown files */
 export const GLOB_MARKDOWN = '**/*.md'

package/dist/template/tsconfig.json

@@ -3,6 +3,6 @@
   "include": ["src", "*.config.ts", "*.config.mts"],
   "compilerOptions": {
     "types": ["node"],
-    "isolatedDeclarations": false // 减少维护，在那时关闭吧，不然 config 需要繁琐的配置
+    "isolatedDeclarations": false // Disabled to reduce maintenance overhead; enabling it would require verbose type annotations across configs
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@infra-x/create-eslint-config",
   "type": "module",
-  "version": "0.1.4",
+  "version": "0.2.1",
   "description": "CLI to copy ESLint config source into a monorepo.",
   "author": "infra-x",
   "license": "MIT",
@@ -20,27 +20,26 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown --watch",
-    "typecheck": "tsc --noEmit",
-    "prepublishOnly": "pnpm run build"
-  },
   "dependencies": {
-    "@clack/prompts": "^0.11.0"
+    "@clack/prompts": "^1.0.1"
   },
   "devDependencies": {
-    "@infra-x/eslint-config": "workspace:*",
-    "@infra-x/typescript-config": "workspace:*",
-    "@types/node": "^25.3.1",
-    "eslint": "^9.39.3",
-    "tsdown": "^0.18.4",
-    "typescript": "^5.9.3"
+    "@types/node": "^25.3.3",
+    "bumpp": "^10.4.1",
+    "eslint": "^10.0.2",
+    "tsdown": "^0.21.0",
+    "typescript": "^5.9.3",
+    "@infra-x/typescript-config": "0.1.6",
+    "@infra-x/eslint-config": "0.1.6"
   },
-  "main": "./dist/index.mjs",
-  "module": "./dist/index.mjs",
   "exports": {
     ".": "./dist/index.mjs",
     "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "typecheck": "tsc --noEmit",
+    "release": "bumpp"
   }
-}
+}

package/README.md

@@ -1,14 +0,0 @@
-# @infra-x/create-eslint-config
-
-CLI 工具，将完整的 ESLint 配置模板复制到 monorepo 的 `eslint-config/` 目录。
-
-## 使用
-
-```bash
-pnpm dlx @infra-x/create-eslint-config
-```
-
-在 monorepo 根目录执行，会将 `eslint-config/` 目录（含规则定义和 `composeConfig` 工厂函数）
-复制到当前工作目录。如果目标路径存在冲突文件，会提示确认是否覆盖。
-
-完整集成说明见[根目录 README](../../README.md)。

package/dist/template/src/configs/ignores.ts

@@ -1,78 +0,0 @@
-/**
- * ESLint 忽略文件配置,支持默认忽略规则和 .gitignore 导入
- */
-import { existsSync } from 'node:fs'
-import path from 'node:path'
-
-import { includeIgnoreFile } from '@eslint/compat'
-
-import type { IgnoresOptions } from '../types'
-import type { Linter } from 'eslint'
-
-/**
- * 默认忽略的文件和目录
- */
-export const DEFAULT_IGNORES: string[] = [
-  // 依赖目录
-  '**/node_modules/**',
-  '**/.pnp.*',
-
-  // 构建产物
-  '**/dist/**',
-  '**/build/**',
-  '**/out/**',
-  '**/.next/**',
-
-  // 缓存目录
-  '**/.cache/**',
-  '**/.turbo/**',
-  '**/.eslintcache',
-
-  // 版本控制
-  '**/.git/**',
-  '**/.svn/**',
-  '**/.hg/**',
-  '**/public/**',
-
-  // 类型文件
-  '**/*.d.ts',
-]
-
-export function ignores(options: IgnoresOptions = {}): Linter.Config[] {
-  const { ignores: userIgnores, gitignore: gitignorePath } = options
-  const configs: Linter.Config[] = []
-
-  if (gitignorePath !== false) {
-    try {
-      const gitignoreFile
-        = typeof gitignorePath === 'string'
-          ? path.resolve(gitignorePath)
-          : path.resolve(process.cwd(), '.gitignore')
-
-      if (existsSync(gitignoreFile)) {
-        configs.push(includeIgnoreFile(gitignoreFile))
-      }
-    } catch {
-      //
-    }
-  }
-
-  const finalIgnores
-    = userIgnores === false
-      ? []
-      : (userIgnores
-          ? [...DEFAULT_IGNORES, ...userIgnores]
-          : DEFAULT_IGNORES)
-
-  if (finalIgnores.length > 0) {
-    configs.push({
-      name: 'defaults',
-      ignores: finalIgnores,
-    })
-  }
-
-  return configs.map((config) => ({
-    ...config,
-    name: `ignores/globals/${config.name}`,
-  }))
-}

package/dist/template/src/configs/prettier.ts

@@ -1,25 +0,0 @@
-/**
- * Prettier 代码格式化配置,使用官方推荐规则集
- */
-import { defineConfig } from 'eslint/config'
-import prettierConfig from 'eslint-plugin-prettier/recommended'
-
-import { GLOB_SRC } from '../utils'
-
-import type { PrettierOptions } from '../types'
-import type { Linter } from 'eslint'
-
-export function prettier(options: PrettierOptions = {}): Linter.Config[] {
-  const { overrides = {} } = options
-
-  const files = [GLOB_SRC]
-
-  return defineConfig([
-    {
-      name: 'prettier/rules',
-      files,
-      extends: [prettierConfig],
-      rules: overrides,
-    },
-  ])
-}