rhine-lint 1.4.1 → 1.4.3

package/README.md

@@ -151,8 +151,9 @@ CLI 参数优先级高于配置文件：
 - `--level <level>`: 强制指定项目类型（`js`, `ts`, `frontend`, `nextjs`）。
 - `--no-project-type-check`: 禁用基于项目的类型检查 (可加快单文件处理速度)。
 - `--tsconfig <path>`: 指定 tsconfig 文件路径 (用于类型检查和 import 解析)。
+- `--ignore-file <path>`: 指定类似 `.gitignore` 的忽略文件 (支持多次使用, e.g. `--ignore-file .gitignore --ignore-file .eslintignore`)。
 - `--ignore <pattern>`: 添加忽略模式 (支持多次使用, e.g. `--ignore dist --ignore coverage`)。
-- `--no-ignore`: 强制禁用所有忽略规则 (包括 .gitignore)。
+- `--no-ignore`: 强制禁用所有忽略规则 (包括 ignoreFiles 和 ignores)。
 - `--debug`: 打印调试信息（包括生成的配置、忽略列表等）。
 - `--cache-dir <dir>`: 指定缓存目录（默认使用 `node_modules/.cache/rhine-lint`）。
 
@@ -202,37 +203,66 @@ Rhine Lint 提供了灵活的文件忽略机制，支持多种配置方式。
 以下目录始终被忽略（无需配置）：
 - `node_modules`, `dist`, `.next`, `.git`, `.output`, `.nuxt`, `coverage`, `.cache`
 
-#### 自动读取 .gitignore
+以下文件默认被忽略（可通过配置覆盖）：
+- `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lock`
 
-Rhine Lint 会自动解析项目根目录的 `.gitignore` 文件，将其中的模式转换为 ESLint 忽略规则。
+#### 忽略文件 ignoreFiles
 
-#### CLI 忽略选项
+Rhine Lint 会自动解析 `.gitignore` 风格的文件，将其中的模式转换为 ESLint 忽略规则。
+
+**默认值**: `['./.gitignore']`
 
 ```bash
-# 添加额外的忽略模式 (支持多次使用)
-rl --ignore temp --ignore generated --ignore "*.test.ts"
+# CLI: 指定忽略文件 (覆盖默认值，支持多次使用)
+rl --ignore-file .gitignore --ignore-file .eslintignore
+```
 
-# 禁用所有忽略规则 (包括 .gitignore 和默认忽略)
-rl --no-ignore
+```typescript
+// rhine-lint.config.ts
+export default {
+  // 指定要读取的忽略文件列表
+  ignoreFiles: ['./.gitignore', './.eslintignore']
+}
 ```
 
-#### 配置文件忽略
+#### 忽略模式 ignores
+
+直接指定要忽略的文件或目录模式。
+
+**默认值**: `['package-lock.json', 'yarn.lock', 'pnpm-lock.yaml', 'bun.lock']`
+
+```bash
+# CLI: 添加忽略模式 (与配置文件合并，支持多次使用)
+rl --ignore temp --ignore generated --ignore "*.test.ts"
+```
 
 ```typescript
 // rhine-lint.config.ts
 export default {
-  ignore: ['temp', 'generated', '*.test.ts']
+  // 指定要忽略的文件/目录模式
+  ignores: ['temp', 'generated', '*.test.ts']
 }
 ```
 
+#### 禁用忽略 --no-ignore
+
+```bash
+# 禁用所有忽略规则 (包括 ignoreFiles 和 ignores)
+rl --no-ignore
+```
+
 #### 忽略模式优先级
 
 1. `--no-ignore` 会禁用所有忽略处理
-2. 否则，按以下顺序合并（后面的追加到前面）：
-   - 默认忽略目录
-   - `.gitignore` 解析结果
-   - 配置文件 `ignore` 数组
-   - CLI `--ignore` 参数
+2. 否则，按以下顺序合并：
+   - 默认忽略目录（始终生效）
+   - `ignoreFiles` 中各文件的解析结果
+   - `ignores` 模式列表
+
+**优先级规则**：
+- `--ignore-file`: CLI 指定时覆盖配置文件中的 `ignoreFiles`
+- `--ignore`: CLI 指定时覆盖配置文件中的 `ignores`
+- 最终 `ignoreFiles` 和 `ignores` 的结果都会生效（合并）
 
 ### 缓存目录 Cache Directory
 
@@ -303,6 +333,7 @@ cli
   .option("--level <level>", "Project level (js, ts, frontend, nextjs)")
   .option("--no-project-type-check", "Disable project-based type checking")
   .option("--tsconfig <path>", "Path to tsconfig file")
+  .option("--ignore-file [path]", "Add gitignore-style file (can be used multiple times)")
   .option("--ignore [pattern]", "Add ignore pattern (can be used multiple times)")
   .option("--no-ignore", "Disable all ignore rules")
   .option("--cache-dir <dir>", "Custom cache directory")
@@ -322,6 +353,13 @@ if (!noIgnore && options.ignore && options.ignore !== true) {
     ? options.ignore.filter((p: unknown) => typeof p === 'string')
     : [options.ignore];
 }
+// --ignore-file 参数处理
+let ignoreFiles: string[] = [];
+if (!noIgnore && options.ignoreFile && options.ignoreFile !== true) {
+  ignoreFiles = Array.isArray(options.ignoreFile)
+    ? options.ignoreFile.filter((p: unknown) => typeof p === 'string')
+    : [options.ignoreFile];
+}
 ```
 
 - **逻辑**: 
@@ -345,7 +383,8 @@ export async function generateTempConfig(
     cliProjectTypeCheck?: boolean,            // --no-project-type-check
     cliTsconfig?: string,                     // --tsconfig 参数
     cliIgnorePatterns: string[] = [],         // --ignore 参数 (数组)
-    noIgnore: boolean = false                 // --no-ignore 参数
+    noIgnore: boolean = false,                // --no-ignore 参数
+    cliIgnoreFiles: string[] = []             // --ignore-file 参数 (数组)
 ): Promise<{ eslintPath: string; prettierPath: string; cachePath: string }>
 ```
 
@@ -355,6 +394,15 @@ export async function generateTempConfig(
    ```typescript
    const projectTypeCheck = cliProjectTypeCheck ?? userConfigResult.config.projectTypeCheck ?? true;
    const tsconfigPath = cliTsconfig ?? userConfigResult.config.tsconfig;
+   // ignoreFiles: CLI 覆盖 config 覆盖默认值
+   const resolvedIgnoreFiles = cliIgnoreFiles.length > 0
+       ? cliIgnoreFiles
+       : (userConfigResult.config.ignoreFiles ?? DEFAULT_IGNORE_FILES);
+   // ignores: CLI 覆盖 config 覆盖默认值
+   const resolvedIgnores = cliIgnorePatterns.length > 0
+       ? cliIgnorePatterns
+       : (configIgnores.length > 0 ? configIgnores : DEFAULT_IGNORES);
+   // 最终 ignoreFiles 和 ignores 都会生效
    ```
 
 2. **智能缓存 (SHA-256 指纹)**:
@@ -364,14 +412,18 @@ export async function generateTempConfig(
    hash.update(cliLevel || "default");
    hash.update(projectTypeCheck ? "ptc-on" : "ptc-off");
    hash.update(tsconfigPath || "default-tsconfig");
-   hash.update(cliIgnorePatterns.join(",") || "no-cli-ignore");
+   hash.update(resolvedIgnoreFiles.join(",") || "no-ignore-files");
+   hash.update(resolvedIgnores.join(",") || "no-ignores");
    hash.update(noIgnore ? "no-ignore" : "with-ignore");
-   // + 用户配置文件内容 + .gitignore 内容
+   // + 用户配置文件内容 + 各忽略文件内容
    ```
 
 3. **忽略模式处理**:
    - 若 `--no-ignore`，跳过所有忽略处理
-   - 否则：解析 `.gitignore` → 合并默认忽略 → 合并 CLI/Config 忽略
+   - 否则：
+     1. 添加默认始终忽略的目录
+     2. 解析所有 `ignoreFiles` 中的文件
+     3. 添加 `ignores` 模式列表
    - 模式规范化：自动添加 `**/` 前缀和 `/**` 后缀
 
 4. **生成虚拟配置**: 动态生成 `eslint.config.mjs` 内容，包含：

package/dist/assets/eslint.config.js

@@ -6,14 +6,6 @@ import reactPlugin from 'eslint-plugin-react';
 import reactHooksPlugin from 'eslint-plugin-react-hooks';
 
 import css from '@eslint/css'
-
-// ... skipped standard imports ...
-
-// Removed Patch Mock - No longer needed as we don't use eslint-config-next
-
-// ...
-
-
 import js from '@eslint/js'
 import json from '@eslint/json'
 import markdown from '@eslint/markdown'

package/dist/cli.js

@@ -17,6 +17,7 @@ cli
     .option("--level <level>", "Project level (js, ts, frontend, nextjs)")
     .option("--no-project-type-check", "Disable project-based type checking (faster for single files)")
     .option("--tsconfig <path>", "Path to tsconfig file for type checking and import resolution")
+    .option("--ignore-file [path]", "Add gitignore-style file for ignore patterns (can be used multiple times)")
     .option("--ignore [pattern]", "Add ignore pattern (can be used multiple times)")
     .option("--no-ignore", "Disable all ignore rules (including .gitignore)")
     .option("--cache-dir <dir>", "Custom temporary cache directory")
@@ -59,7 +60,14 @@ cli
                 ? options.ignore.filter((p) => typeof p === 'string')
                 : [options.ignore];
         }
-        const temps = await generateTempConfig(cwd, userConfigResult, options.level, options.cacheDir, options.debug, options.projectTypeCheck, options.tsconfig, ignorePatterns, noIgnore);
+        // Normalize ignore-file option to array
+        let ignoreFiles = [];
+        if (!noIgnore && options.ignoreFile && options.ignoreFile !== true) {
+            ignoreFiles = Array.isArray(options.ignoreFile)
+                ? options.ignoreFile.filter((p) => typeof p === 'string')
+                : [options.ignoreFile];
+        }
+        const temps = await generateTempConfig(cwd, userConfigResult, options.level, options.cacheDir, options.debug, options.projectTypeCheck, options.tsconfig, ignorePatterns, noIgnore, ignoreFiles);
         usedCachePath = temps.cachePath; // Save for cleanup
         // 计时：第一阶段（准备阶段）
         if (showTime) {

package/dist/config.d.ts

@@ -23,6 +23,21 @@ export type Config = {
      */
     tsconfig?: string;
     /**
+     * List of gitignore-style files to read ignore patterns from.
+     * Each file should follow .gitignore syntax.
+     * @default ['./.gitignore']
+     * @example ['./.gitignore', './.eslintignore']
+     */
+    ignoreFiles?: string[];
+    /**
+     * List of specific files or patterns to ignore.
+     * Patterns follow glob syntax.
+     * @default ['package-lock.json', 'yarn.lock', 'pnpm-lock.yaml', 'bun.lock']
+     * @example ['temp', 'generated', '*.test.ts']
+     */
+    ignores?: string[];
+    /**
+     * @deprecated Use `ignores` instead. This field will be removed in a future version.
      * Additional ignore patterns to exclude files from linting.
      * Patterns follow glob syntax.
      * @example ['temp', 'generated', '*.test.ts']

package/dist/core/config.d.ts

@@ -6,7 +6,7 @@ export declare function loadUserConfig(cwd: string): Promise<{
 export declare function generateTempConfig(cwd: string, userConfigResult: {
     config: Config;
     path?: string;
-}, cliLevel?: string, cliCacheDir?: string, debug?: boolean, cliProjectTypeCheck?: boolean, cliTsconfig?: string, cliIgnorePatterns?: string[], noIgnore?: boolean): Promise<{
+}, cliLevel?: string, cliCacheDir?: string, debug?: boolean, cliProjectTypeCheck?: boolean, cliTsconfig?: string, cliIgnorePatterns?: string[], noIgnore?: boolean, cliIgnoreFiles?: string[]): Promise<{
     eslintPath: string;
     prettierPath: string;
     cachePath: string;

package/dist/core/config.js

@@ -50,18 +50,40 @@ export async function loadUserConfig(cwd) {
     }
     return { config: {} };
 }
-export async function generateTempConfig(cwd, userConfigResult, cliLevel, cliCacheDir, debug, cliProjectTypeCheck, cliTsconfig, cliIgnorePatterns = [], noIgnore = false) {
+// 默认的忽略文件列表
+const DEFAULT_IGNORE_FILES = ['./.gitignore'];
+// 默认的忽略模式列表
+const DEFAULT_IGNORES = ['package-lock.json', 'yarn.lock', 'pnpm-lock.yaml', 'bun.lock'];
+// 默认始终忽略的目录
+const DEFAULT_IGNORE_DIRS = [
+    'node_modules', 'dist', '.next', '.git', '.output', '.nuxt', 'coverage', '.cache'
+];
+export async function generateTempConfig(cwd, userConfigResult, cliLevel, cliCacheDir, debug, cliProjectTypeCheck, cliTsconfig, cliIgnorePatterns = [], noIgnore = false, cliIgnoreFiles = []) {
     const cachePath = getCacheDir(cwd, userConfigResult.config, cliCacheDir);
     await fs.ensureDir(cachePath);
     const eslintTempPath = path.join(cachePath, "eslint.config.mjs");
     const prettierTempPath = path.join(cachePath, "prettier.config.mjs");
     const metaPath = path.join(cachePath, "metadata.json");
-    const gitignorePath = path.join(cwd, ".gitignore");
     // Determine projectTypeCheck: CLI flag takes precedence over config file, default is true
     // When --no-project-type-check is used, options.projectTypeCheck will be false
     const projectTypeCheck = cliProjectTypeCheck ?? userConfigResult.config.projectTypeCheck ?? true;
     // Determine tsconfig path: CLI flag takes precedence over config file
     const tsconfigPath = cliTsconfig ?? userConfigResult.config.tsconfig;
+    // 解析忽略文件列表：CLI 覆盖 config，否则使用 config 或默认值
+    // CLI 优先级最高，如果 CLI 有值则完全使用 CLI 的值
+    const resolvedIgnoreFiles = cliIgnoreFiles.length > 0
+        ? cliIgnoreFiles
+        : (userConfigResult.config.ignoreFiles !== undefined
+            ? userConfigResult.config.ignoreFiles
+            : DEFAULT_IGNORE_FILES);
+    // 解析忽略模式列表：CLI 覆盖 config，否则使用 config 或默认值
+    // 同时兼容旧的 ignore 字段
+    const configIgnores = userConfigResult.config.ignores ?? userConfigResult.config.ignore ?? [];
+    const resolvedIgnores = cliIgnorePatterns.length > 0
+        ? cliIgnorePatterns
+        : (configIgnores.length > 0
+            ? configIgnores
+            : DEFAULT_IGNORES);
     let calculatedHash = "";
     try {
         const hash = createHash("sha256");
@@ -69,18 +91,23 @@ export async function generateTempConfig(cwd, userConfigResult, cliLevel, cliCac
         hash.update(cliLevel || "default");
         hash.update(projectTypeCheck ? "ptc-on" : "ptc-off");
         hash.update(tsconfigPath || "default-tsconfig");
-        hash.update(cliIgnorePatterns.join(",") || "no-cli-ignore");
+        hash.update(resolvedIgnoreFiles.join(",") || "no-ignore-files");
+        hash.update(resolvedIgnores.join(",") || "no-ignores");
         hash.update(noIgnore ? "no-ignore" : "with-ignore");
         if (userConfigResult.path && await fs.pathExists(userConfigResult.path)) {
             const content = await fs.readFile(userConfigResult.path);
             hash.update(content);
         }
-        if (await fs.pathExists(gitignorePath)) {
-            const content = await fs.readFile(gitignorePath);
-            hash.update(content);
-        }
-        else {
-            hash.update("no-gitignore");
+        // 为每个忽略文件计算 hash
+        for (const ignoreFile of resolvedIgnoreFiles) {
+            const ignoreFilePath = path.resolve(cwd, ignoreFile);
+            if (await fs.pathExists(ignoreFilePath)) {
+                const content = await fs.readFile(ignoreFilePath);
+                hash.update(content);
+            }
+            else {
+                hash.update(`no-file:${ignoreFile}`);
+            }
         }
         calculatedHash = hash.digest("hex");
         if (await fs.pathExists(metaPath)) {
@@ -97,7 +124,7 @@ export async function generateTempConfig(cwd, userConfigResult, cliLevel, cliCac
     let ignoredPatterns = [];
     // If --no-ignore is set, skip all ignore processing
     if (!noIgnore) {
-        // Parse .gitignore file and convert to ESLint ignore patterns
+        // Parse gitignore-style file and convert to ESLint ignore patterns
         // ESLint ignores are relative to the cwd where ESLint runs (which is the project root)
         // NOT relative to the config file location
         const parseGitignore = (content) => {
@@ -159,62 +186,65 @@ export async function generateTempConfig(cwd, userConfigResult, cliLevel, cliCac
             }
             return patterns;
         };
-        // Default directories to always ignore (relative to project root)
-        const defaultIgnores = [
-            'node_modules', 'dist', '.next', '.git', '.output', '.nuxt', 'coverage', '.cache'
-        ].map(dir => `**/${dir}/**`);
-        if (await fs.pathExists(gitignorePath)) {
-            try {
-                const gitignoreContent = await fs.readFile(gitignorePath, 'utf-8');
-                if (debug) {
-                    console.log("-----------------------------------------");
-                    console.log("DEBUG: .gitignore content preview:");
-                    console.log(gitignoreContent.substring(0, 500));
-                    console.log("-----------------------------------------");
+        // 规范化忽略模式（添加 **/ 前缀和 /** 后缀）
+        const normalizePattern = (pattern) => {
+            // If pattern doesn't start with ** or !, add **/ prefix
+            if (!pattern.startsWith('**') && !pattern.startsWith('!')) {
+                pattern = `**/${pattern}`;
+            }
+            // If pattern doesn't end with /** and doesn't contain *, add /** suffix
+            if (!pattern.endsWith('/**') && !pattern.includes('*')) {
+                pattern = `${pattern}/**`;
+            }
+            return pattern;
+        };
+        // 1. 添加默认始终忽略的目录
+        const defaultDirPatterns = DEFAULT_IGNORE_DIRS.map(dir => `**/${dir}/**`);
+        ignoredPatterns.push(...defaultDirPatterns);
+        // 2. 解析所有忽略文件
+        for (const ignoreFile of resolvedIgnoreFiles) {
+            const ignoreFilePath = path.resolve(cwd, ignoreFile);
+            if (await fs.pathExists(ignoreFilePath)) {
+                try {
+                    const content = await fs.readFile(ignoreFilePath, 'utf-8');
+                    if (debug) {
+                        console.log("-----------------------------------------");
+                        console.log(`DEBUG: ${ignoreFile} content preview:`);
+                        console.log(content.substring(0, 500));
+                        console.log("-----------------------------------------");
+                    }
+                    const parsedPatterns = parseGitignore(content);
+                    if (debug) {
+                        console.log("-----------------------------------------");
+                        console.log(`DEBUG: Parsed patterns from ${ignoreFile}:`);
+                        parsedPatterns.forEach((p, i) => console.log(`  [${i}] "${p}"`));
+                        console.log("-----------------------------------------");
+                    }
+                    ignoredPatterns.push(...parsedPatterns);
                 }
-                const parsedPatterns = parseGitignore(gitignoreContent);
-                if (debug) {
-                    console.log("-----------------------------------------");
-                    console.log("DEBUG: Parsed gitignore patterns:");
-                    parsedPatterns.forEach((p, i) => console.log(`  [${i}] "${p}"`));
-                    console.log("-----------------------------------------");
+                catch (e) {
+                    logger.debug(`Failed to parse ignore file: ${ignoreFile}`, e);
                 }
-                // Merge defaults with parsed patterns, removing duplicates
-                const allPatterns = [...defaultIgnores, ...parsedPatterns];
-                ignoredPatterns = [...new Set(allPatterns)];
             }
-            catch (e) {
-                logger.debug("Failed to parse .gitignore", e);
-                ignoredPatterns = defaultIgnores;
+            else if (debug) {
+                console.log(`DEBUG: Ignore file not found: ${ignoreFile}`);
             }
         }
-        else {
-            ignoredPatterns = defaultIgnores;
-        }
-        // Add CLI and config file ignore patterns
-        const configIgnorePatterns = (userConfigResult.config.ignore || []).filter((p) => typeof p === 'string');
-        const allCliPatterns = [...cliIgnorePatterns, ...configIgnorePatterns];
-        if (allCliPatterns.length > 0) {
-            // Normalize CLI patterns (add **/ prefix and /** suffix if needed)
-            const normalizedCliPatterns = allCliPatterns.map(pattern => {
-                // If pattern doesn't start with ** or !, add **/ prefix
-                if (!pattern.startsWith('**') && !pattern.startsWith('!')) {
-                    pattern = `**/${pattern}`;
-                }
-                // If pattern doesn't end with /** and doesn't contain *, add /** suffix
-                if (!pattern.endsWith('/**') && !pattern.includes('*')) {
-                    pattern = `${pattern}/**`;
-                }
-                return pattern;
-            });
-            ignoredPatterns = [...new Set([...ignoredPatterns, ...normalizedCliPatterns])];
+        // 3. 添加解析后的忽略模式
+        if (resolvedIgnores.length > 0) {
+            const normalizedPatterns = resolvedIgnores
+                .filter((p) => typeof p === 'string')
+                .map(normalizePattern);
+            ignoredPatterns.push(...normalizedPatterns);
             if (debug) {
                 console.log("-----------------------------------------");
-                console.log("DEBUG: CLI/Config ignore patterns added:");
-                normalizedCliPatterns.forEach((p, i) => console.log(`  [${i}] "${p}"`));
+                console.log("DEBUG: Resolved ignore patterns:");
+                normalizedPatterns.forEach((p, i) => console.log(`  [${i}] "${p}"`));
                 console.log("-----------------------------------------");
             }
         }
+        // 去重
+        ignoredPatterns = [...new Set(ignoredPatterns)];
     }
     else if (debug) {
         console.log("-----------------------------------------");
@@ -295,13 +325,15 @@ prefixConfig.push({ ignores: ${JSON.stringify(ignoredPatterns)} });
 ` : ''}
 
 if (${isEslintOverlay} || userEslint.overlay) {
-    if (Array.isArray(userEslint.config)) {
-        finalConfig = [...prefixConfig, ...defaultEslint, ...userEslint.config];
+    // overlay=true: 用户配置完全覆盖内置配置
+    const userConf = userEslint.config || [];
+    if (Array.isArray(userConf)) {
+        finalConfig = [...prefixConfig, ...userConf];
     } else {
-        finalConfig = defu(userEslint, defaultEslint); 
-        if (!Array.isArray(finalConfig)) finalConfig = [...prefixConfig, finalConfig];
+        finalConfig = [...prefixConfig, userConf];
     }
 } else {
+    // overlay=false: 内置配置 + 用户配置追加
     const userConf = userEslint.config || [];
     const defaultConf = Array.isArray(defaultEslint) ? defaultEslint : [defaultEslint];
     finalConfig = [...prefixConfig, ...defaultConf, ...userConf];
@@ -326,8 +358,10 @@ const defaultPrettier = defaultOne;
 
 let finalConfig;
 if (${isPrettierOverlay} || userPrettier.overlay) {
-    finalConfig = defu(userPrettier.config || {}, defaultPrettier);
+    // overlay=true: 用户配置完全覆盖内置配置
+    finalConfig = userPrettier.config || {};
 } else {
+    // overlay=false: 内置配置为基础，用户配置补充
     finalConfig = defu(userPrettier.config || {}, defaultPrettier);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rhine-lint",
-  "version": "1.4.1",
+  "version": "1.4.3",
   "module": "./dist/index.js",
   "type": "module",
   "main": "./dist/index.js",