rhine-lint 1.4.3 → 1.5.2

package/README.md

@@ -111,6 +111,10 @@ export default {
 
   // ESLint 专项配置
   eslint: {
+    // 是否启用 ESLint (默认为 true)
+    // 设为 false 可禁用 ESLint 检查
+    enable: true,
+
     // 启用/禁用特定范围的规则
     scope: {
       frontend: true,      // 开启前端规则 (React 等)
@@ -133,6 +137,10 @@ export default {
 
   // Prettier 专项配置
   prettier: {
+    // 是否启用 Prettier (默认为 true)
+    // 设为 false 可禁用 Prettier 格式检查
+    enable: true,
+
     config: {
       printWidth: 100,
       semi: true,
@@ -154,6 +162,9 @@ CLI 参数优先级高于配置文件：
 - `--ignore-file <path>`: 指定类似 `.gitignore` 的忽略文件 (支持多次使用, e.g. `--ignore-file .gitignore --ignore-file .eslintignore`)。
 - `--ignore <pattern>`: 添加忽略模式 (支持多次使用, e.g. `--ignore dist --ignore coverage`)。
 - `--no-ignore`: 强制禁用所有忽略规则 (包括 ignoreFiles 和 ignores)。
+- `--disable-eslint`: 禁用 ESLint 检查 (覆盖配置文件中的 `eslint.enable`)。
+- `--disable-prettier`: 禁用 Prettier 格式检查 (覆盖配置文件中的 `prettier.enable`)。
+- `--no-time`: 禁用各阶段耗时信息显示（默认启用）。
 - `--debug`: 打印调试信息（包括生成的配置、忽略列表等）。
 - `--cache-dir <dir>`: 指定缓存目录（默认使用 `node_modules/.cache/rhine-lint`）。
 
@@ -337,6 +348,9 @@ cli
   .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")
+  .option("--no-time", "Disable elapsed time display")
+  .option("--disable-eslint", "Disable ESLint linting")
+  .option("--disable-prettier", "Disable Prettier formatting check")
   .option("--debug", "Enable debug mode")
 ```
 
@@ -534,16 +548,21 @@ export type Config = {
   type?: 'js' | 'ts' | 'frontend' | 'react' | 'nextjs',
   cacheDir?: string,
   fix?: boolean,
-  projectTypeCheck?: boolean,  // 启用项目级类型检查 (default: true)
-  tsconfig?: string,           // tsconfig 文件路径 (default: './tsconfig.json')
-  ignore?: string[],           // 额外的忽略模式
+  time?: boolean,                // 显示各阶段耗时 (default: true)
+  projectTypeCheck?: boolean,    // 启用项目级类型检查 (default: true)
+  tsconfig?: string,             // tsconfig 文件路径 (default: './tsconfig.json')
+  ignoreFiles?: string[],        // gitignore 风格的忽略文件列表 (default: ['./.gitignore'])
+  ignores?: string[],            // 忽略模式列表 (default: ['package-lock.json', ...])
+  ignore?: string[],             // [deprecated] 使用 ignores 代替
   eslint?: {
-    config?: [...],            // ESLint Flat Config 数组
-    overlay?: boolean,         // 覆盖模式
+    enable?: boolean,            // 是否启用 ESLint (default: true)
+    config?: [...],              // ESLint Flat Config 数组
+    overlay?: boolean,           // 覆盖模式 (true: 完全覆盖内置配置)
   },
   prettier?: {
-    config?: {...},            // Prettier 配置对象
-    overlay?: boolean,
+    enable?: boolean,            // 是否启用 Prettier (default: true)
+    config?: {...},              // Prettier 配置对象
+    overlay?: boolean,           // 覆盖模式 (true: 完全覆盖内置配置)
   }
 }
 ```

package/dist/cli.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 import { createRequire } from 'module';
-// import cac from "cac";
 import path from "node:path";
 import { loadUserConfig, generateTempConfig, cleanup } from "./core/config.js";
 import { runEslint, runPrettier } from "./core/runner.js";
@@ -21,15 +20,17 @@ cli
     .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")
-    .option("--time", "Show elapsed time for each phase")
+    .option("--no-time", "Disable elapsed time display for each phase")
+    .option("--disable-eslint", "Disable ESLint linting")
+    .option("--disable-prettier", "Disable Prettier formatting check")
     .option("--debug", "Enable debug mode")
     .action(async (files, options) => {
     const cwd = process.cwd();
     // If files is empty, default to "."
     const targetFiles = files.length > 0 ? files : ["."];
     let usedCachePath;
-    // 计时功能：从 CLI 选项或配置文件获取
-    let showTime = options.time ?? false;
+    // 计时功能：默认启用，可通过 --no-time 或配置文件禁用
+    let showTime = options.time !== false;
     const startTotal = Date.now();
     let startPhase = startTotal;
     try {
@@ -75,34 +76,55 @@ cli
             startPhase = Date.now();
         }
         console.log();
+        // 确定是否启用 ESLint 和 Prettier（CLI 选项优先于配置文件）
+        const enableEslint = options.disableEslint ? false : (userConfigResult.config.eslint?.enable ?? true);
+        const enablePrettier = options.disablePrettier ? false : (userConfigResult.config.prettier?.enable ?? true);
+        let eslintResult = null;
+        let prettierResult = null;
         // 3. Run ESLint
-        const eslintResult = await runEslint(cwd, temps.eslintPath, options.fix, targetFiles);
-        // 计时：第二阶段（ESLint）
-        if (showTime) {
-            logTime("ESLint", Date.now() - startPhase);
-            startPhase = Date.now();
+        if (enableEslint) {
+            eslintResult = await runEslint(cwd, temps.eslintPath, options.fix ?? false, targetFiles);
+            // 计时：第二阶段（ESLint）
+            if (showTime) {
+                logTime("ESLint", Date.now() - startPhase);
+                startPhase = Date.now();
+            }
+            console.log();
+        }
+        else {
+            logInfo("ESLint: Disabled");
+            console.log();
         }
-        console.log();
         // 4. Run Prettier
-        const prettierResult = await runPrettier(cwd, temps.prettierPath, options.fix, targetFiles);
-        // 计时：第三阶段（Prettier）
-        if (showTime) {
-            logTime("Prettier", Date.now() - startPhase);
+        if (enablePrettier) {
+            prettierResult = await runPrettier(cwd, temps.prettierPath, options.fix ?? false, targetFiles);
+            // 计时：第三阶段（Prettier）
+            if (showTime) {
+                logTime("Prettier", Date.now() - startPhase);
+            }
+            console.log();
+        }
+        else {
+            logInfo("Prettier: Disabled");
+            console.log();
         }
-        console.log();
         if (eslintResult || prettierResult) {
             logError("Linting completed with issues:");
-            if (eslintResult) {
-                logError(`ESLint: ${eslintResult}`);
-            }
-            else {
-                logSuccess(`ESLint: No issues found`);
-            }
-            if (prettierResult) {
-                logError(`Prettier: ${prettierResult}`);
+            if (enableEslint) {
+                if (eslintResult) {
+                    logError(`ESLint: ${eslintResult}`);
+                }
+                else {
+                    logSuccess(`ESLint: No issues found`);
+                }
             }
-            else {
-                logSuccess(`Prettier: No issues found`);
+            if (enablePrettier) {
+                if (prettierResult) {
+                    logError(`Prettier: ${prettierResult}`);
+                }
+                else {
+                    logSuccess(`Prettier: No issues found`);
+                }
             }
             process.exit(1);
         }

package/dist/config.d.ts

@@ -1,11 +1,35 @@
+/**
+ * Rhine Lint configuration options.
+ * All options are optional with sensible defaults.
+ * Priority: CLI arguments > Config file > Default values
+ */
 export type Config = {
+    /**
+     * Project type level that determines which linting rules to enable.
+     * Each level includes all rules from previous levels:
+     * - `'js'`: JavaScript only (no type checking)
+     * - `'ts'`: TypeScript with type-aware rules
+     * - `'frontend'` / `'react'`: TypeScript + React/JSX/Hooks rules
+     * - `'nextjs'`: TypeScript + React + Next.js specific rules
+     * @default 'frontend'
+     */
     type?: 'js' | 'ts' | 'frontend' | 'react' | 'nextjs';
+    /**
+     * Directory for storing generated virtual config files and cache metadata.
+     * Can be absolute or relative to the project root.
+     * @default 'node_modules/.cache/rhine-lint' (if node_modules exists) or '.cache/rhine-lint'
+     */
     cacheDir?: string;
+    /**
+     * Automatically fix linting errors and formatting issues.
+     * When enabled, ESLint will apply auto-fixes and Prettier will rewrite files.
+     * @default false
+     */
     fix?: boolean;
     /**
      * Enable timing output for each phase.
      * Shows elapsed time for: preparation, ESLint, and Prettier phases.
-     * @default false
+     * @default true
      */
     time?: boolean;
     /**
@@ -43,13 +67,71 @@ export type Config = {
      * @example ['temp', 'generated', '*.test.ts']
      */
     ignore?: string[];
+    /**
+     * ESLint configuration options.
+     */
     eslint?: {
+        /**
+         * Enable ESLint linting.
+         * Set to `false` to skip ESLint entirely (only run Prettier).
+         * @default true
+         */
+        enable?: boolean;
+        /**
+         * ESLint Flat Config array to extend or override default rules.
+         * These configurations are merged with Rhine Lint's built-in rules.
+         * @see https://eslint.org/docs/latest/use/configure/configuration-files
+         * @example
+         * ```ts
+         * config: [
+         *   {
+         *     rules: {
+         *       'no-console': 'warn',
+         *       '@typescript-eslint/no-unused-vars': 'off'
+         *     }
+         *   }
+         * ]
+         * ```
+         */
         config?: [
         ];
+        /**
+         * Overlay mode for ESLint configuration.
+         * - `true`: User config completely replaces Rhine Lint's default rules
+         * - `false`: User config is merged with Rhine Lint's default rules
+         * @default false
+         */
         overlay?: boolean;
     };
+    /**
+     * Prettier configuration options.
+     */
     prettier?: {
+        /**
+         * Enable Prettier formatting check.
+         * Set to `false` to skip Prettier entirely (only run ESLint).
+         * @default true
+         */
+        enable?: boolean;
+        /**
+         * Prettier options to extend or override default formatting rules.
+         * @see https://prettier.io/docs/en/options.html
+         * @example
+         * ```ts
+         * config: {
+         *   semi: true,
+         *   singleQuote: false,
+         *   printWidth: 80
+         * }
+         * ```
+         */
         config?: {};
+        /**
+         * Overlay mode for Prettier configuration.
+         * - `true`: User config completely replaces Rhine Lint's default options
+         * - `false`: User config is merged with Rhine Lint's default options
+         * @default false
+         */
         overlay?: boolean;
     };
 };

package/dist/core/config.js

@@ -263,7 +263,8 @@ export async function generateTempConfig(cwd, userConfigResult, cliLevel, cliCac
     const defuUrl = pathToFileURL(require.resolve("defu")).href;
     const jitiUrl = pathToFileURL(require.resolve("jiti")).href;
     let finalUserConfigUrl = userConfigUrl;
-    if (userConfigResult.path && (userConfigResult.path.endsWith('.ts') || userConfigResult.path.endsWith('.mts') || userConfigResult.path.endsWith('.cts'))) {
+    const tsExtensions = ['.ts', '.mts', '.cts'];
+    if (userConfigResult.path && tsExtensions.some(ext => userConfigResult.path.endsWith(ext))) {
         try {
             const ts = await import('typescript');
             const fileContent = await fs.readFile(userConfigResult.path, 'utf-8');

package/dist/core/runner.js

@@ -16,7 +16,7 @@ function resolveBin(pkgName, binPathRelative) {
         return require.resolve(`${pkgName}/${binPathRelative}`);
     }
     catch (e) {
-        if (e.code !== 'ERR_PACKAGE_PATH_NOT_EXPORTED' && e.code !== 'MODULE_NOT_FOUND') {
+        if (e instanceof Error && e.code !== 'ERR_PACKAGE_PATH_NOT_EXPORTED' && e.code !== 'MODULE_NOT_FOUND') {
             logger.debug(`Resolve error for ${pkgName}/${binPathRelative}:`, e);
         }
     }
@@ -114,7 +114,7 @@ export async function runEslint(cwd, configPath, fix, files = ["."]) {
     }
     catch (e) {
         logError("Failed to run ESLint", e);
-        return e.message || "Unknown error";
+        return e instanceof Error ? e.message : "Unknown error";
     }
 }
 export async function runPrettier(cwd, configPath, fix, files = ["."]) {
@@ -153,6 +153,6 @@ export async function runPrettier(cwd, configPath, fix, files = ["."]) {
     }
     catch (e) {
         logError("Failed to run Prettier", e);
-        return e.message || "Unknown error";
+        return e instanceof Error ? e.message : "Unknown error";
     }
 }

package/dist/utils/logger.js

@@ -1,10 +1,6 @@
 import { createConsola } from "consola";
 import { colors } from "consola/utils";
 const { cyan, red, green, yellow, gray } = colors;
-// Custom logger to satisfy "RL" prefix requirement
-const rLine = (colorFn, type, msg) => {
-    console.log(`${colorFn("RL")} ${msg}`);
-};
 export const logger = createConsola({
     level: 3,
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rhine-lint",
-  "version": "1.4.3",
+  "version": "1.5.2",
   "module": "./dist/index.js",
   "type": "module",
   "main": "./dist/index.js",
@@ -18,7 +18,7 @@
     "react",
     "opinionated"
   ],
-  "author": "RhineAI <hran@rhine.ai>",
+  "author": "RhineAI <rhineai@163.com>",
   "license": "MIT",
   "repository": {
     "type": "git",