@herb-tools/config 0.8.10 → 0.9.0

package/dist/herb-config.esm.js

@@ -1,6 +1,6 @@
 import path, { join } from 'path';
 import { promises, existsSync, readFileSync, writeFileSync, mkdirSync } from 'fs';
-import { parseDocument, stringify, isMap, parse as parse$1 } from 'yaml';
+import { parse as parse$1, parseDocument, stringify, isMap } from 'yaml';
 import picomatch from 'picomatch';
 import { glob } from 'tinyglobby';
 
@@ -4798,9 +4798,18 @@ const FormatterConfigSchema = object({
     maxLineLength: number().int().positive().optional().describe("Maximum line length before wrapping"),
     rewriter: RewriterConfigSchema.describe("Rewriter configuration for pre and post-format transformations"),
 }).strict().optional();
+const ValidatorsConfigSchema = object({
+    security: boolean().optional().describe("Enable or disable the security validator (default: true)"),
+    nesting: boolean().optional().describe("Enable or disable the nesting validator (default: true)"),
+    accessibility: boolean().optional().describe("Enable or disable the accessibility validator (default: true)"),
+}).strict().optional();
+const EngineConfigSchema = object({
+    validators: ValidatorsConfigSchema.describe("Per-validator enable/disable configuration"),
+}).strict().optional();
 const HerbConfigSchema = object({
     version: string().describe("Configuration file version"),
     files: FilesConfigSchema.describe("Top-level file configuration"),
+    engine: EngineConfigSchema.describe("Engine configuration"),
     linter: LinterConfigSchema,
     formatter: FormatterConfigSchema,
 }).strict();
@@ -4824,7 +4833,7 @@ function deepMerge(target, source) {
                 continue;
             }
             if (Array.isArray(sourceValue)) {
-                if (key === 'include' && Array.isArray(targetValue)) {
+                if ((key === 'include' || key === 'exclude') && Array.isArray(targetValue)) {
                     output[key] = [...targetValue, ...sourceValue];
                 }
                 else {
@@ -4842,13 +4851,16 @@ function deepMerge(target, source) {
     return output;
 }
 
-var version = "0.8.10";
+var version = "0.9.0";
 var packageJson = {
 	version: version};
 
-var configTemplate = "# This file configures Herb for your project and team.\n# Settings here take precedence over individual editor preferences.\n#\n# Herb is a suite of tools for HTML+ERB templates including:\n# - Linter: Validates templates and enforces best practices\n# - Formatter: Auto-formats templates with intelligent indentation\n# - Language Server: Provides IDE support (VS Code, Zed, Neovim, etc.)\n#\n# Website: https://herb-tools.dev\n# Configuration: https://herb-tools.dev/configuration\n# GitHub Repo: https://github.com/marcoroth/herb\n#\n\nversion: 0.8.10\n\n# files:\n#   # Additional patterns beyond the defaults (**.html, **.rhtml, **.html.erb, etc.)\n#   include:\n#     - '**/*.xml.erb'\n#     - 'custom/**/*.html'\n#\n#   # Patterns to exclude (can exclude defaults too)\n#   exclude:\n#     - 'public/**/*'\n#     - 'tmp/**/*'\n\nlinter:\n  enabled: true\n\n  # # Exit with error code when diagnostics of this severity or higher are present\n  # # Valid values: error (default), warning, info, hint\n  # failLevel: warning\n\n  # # Additional patterns beyond the defaults for linting\n  # include:\n  #   - '**/*.xml.erb'\n  #\n  # # Patterns to exclude from linting\n  # exclude:\n  #   - 'app/views/admin/**/*'\n\n  # rules:\n  #   erb-no-extra-newline:\n  #     enabled: false\n  #\n  #   # Rules can have 'include', 'only', and 'exclude' patterns\n  #   some-rule:\n  #     # Additional patterns to check (additive, ignored when 'only' is present)\n  #     include:\n  #       - 'app/components/**/*'\n  #     # Don't apply this rule to files matching these patterns\n  #     exclude:\n  #       - 'app/views/admin/**/*'\n  #\n  #   another-rule:\n  #     # Only apply this rule to files matching these patterns (overrides all 'include')\n  #     only:\n  #       - 'app/views/**/*'\n  #     # Exclude still applies even with 'only'\n  #     exclude:\n  #       - 'app/views/admin/**/*'\n\nformatter:\n  enabled: false\n  indentWidth: 2\n  maxLineLength: 80\n\n  # # Additional patterns beyond the defaults for formatting\n  # include:\n  #   - '**/*.xml.erb'\n  #\n  # # Patterns to exclude from formatting\n  # exclude:\n  #   - 'app/views/admin/**/*'\n\n  # # Rewriters modify templates during formatting\n  # rewriter:\n  #   # Pre-format rewriters (modify AST before formatting)\n  #   pre:\n  #     - tailwind-class-sorter\n  #   # Post-format rewriters (modify formatted output string)\n  #   post: []\n";
+var configTemplate = "# This file configures Herb for your project and team.\n# Settings here take precedence over individual editor preferences.\n#\n# Herb is a suite of tools for HTML+ERB templates including:\n# - Linter: Validates templates and enforces best practices\n# - Formatter: Auto-formats templates with intelligent indentation\n# - Language Server: Provides IDE support (VS Code, Zed, Neovim, etc.)\n#\n# Website: https://herb-tools.dev\n# Configuration: https://herb-tools.dev/configuration\n# GitHub Repo: https://github.com/marcoroth/herb\n#\n\nversion: 0.9.0\n\n# files:\n#   # Additional patterns beyond the defaults (**.html, **.rhtml, **.html.erb, etc.)\n#   include:\n#     - '**/*.xml.erb'\n#     - 'custom/**/*.html'\n#\n#   # Patterns to exclude (can exclude defaults too)\n#   exclude:\n#     - 'public/**/*'\n#     - 'tmp/**/*'\n\n# engine:\n#   validators:\n#     security: true       # default: true\n#     nesting: true        # default: true\n#     accessibility: true  # default: true\n\nlinter:\n  enabled: true\n\n  # # Exit with error code when diagnostics of this severity or higher are present\n  # # Valid values: error (default), warning, info, hint\n  # failLevel: warning\n\n  # # Additional patterns beyond the defaults for linting\n  # include:\n  #   - '**/*.xml.erb'\n  #\n  # # Patterns to exclude from linting\n  # exclude:\n  #   - 'app/views/admin/**/*'\n\n  # rules:\n  #   erb-no-extra-newline:\n  #     enabled: false\n  #\n  #   # Rules can have 'include', 'only', and 'exclude' patterns\n  #   some-rule:\n  #     # Additional patterns to check (additive, ignored when 'only' is present)\n  #     include:\n  #       - 'app/components/**/*'\n  #     # Don't apply this rule to files matching these patterns\n  #     exclude:\n  #       - 'app/views/admin/**/*'\n  #\n  #   another-rule:\n  #     # Only apply this rule to files matching these patterns (overrides all 'include')\n  #     only:\n  #       - 'app/views/**/*'\n  #     # Exclude still applies even with 'only'\n  #     exclude:\n  #       - 'app/views/admin/**/*'\n\nformatter:\n  enabled: false\n  indentWidth: 2\n  maxLineLength: 80\n\n  # # Additional patterns beyond the defaults for formatting\n  # include:\n  #   - '**/*.xml.erb'\n  #\n  # # Patterns to exclude from formatting\n  # exclude:\n  #   - 'app/views/admin/**/*'\n\n  # # Rewriters modify templates during formatting\n  # rewriter:\n  #   # Pre-format rewriters (modify AST before formatting)\n  #   pre:\n  #     - tailwind-class-sorter\n  #   # Post-format rewriters (modify formatted output string)\n  #   post: []\n";
+
+var defaultsYaml = "files:\n  include:\n    - \"**/*.herb\"\n    - \"**/*.html.erb\"\n    - \"**/*.html.herb\"\n    - \"**/*.html\"\n    - \"**/*.html+*.erb\"\n    - \"**/*.rhtml\"\n    - \"**/*.turbo_stream.erb\"\n\n  exclude:\n    - \"coverage/**/*\"\n    - \"log/**/*\"\n    - \"node_modules/**/*\"\n    - \"storage/**/*\"\n    - \"tmp/**/*\"\n    - \"vendor/**/*\"\n\nengine:\n  validators:\n    security: true\n    nesting: true\n    accessibility: true\n\nlinter:\n  enabled: true\n  rules: {}\n\nformatter:\n  enabled: false\n  indentWidth: 2\n  maxLineLength: 80\n";
 
 const DEFAULT_VERSION = packageJson.version;
+const PARSED_DEFAULTS = parse$1(defaultsYaml);
 class Config {
     static configPath = ".herb.yml";
     static PROJECT_INDICATORS = [
@@ -4922,8 +4934,9 @@ class Config {
     }
     /**
      * Get the files configuration for a specific tool.
-     * Tool-specific file config takes precedence over top-level config.
-     * Include patterns are additive (defaults are already merged in this.config).
+     * Both include and exclude patterns are additive:
+     * - Include: defaults + files.include + tool.include
+     * - Exclude: defaults + files.exclude + tool.exclude
      * @param tool - The tool to get files config for ('linter' or 'formatter')
      * @returns The merged files configuration
      */
@@ -4933,7 +4946,9 @@ class Config {
         const topLevelInclude = topLevelFiles.include || [];
         const toolInclude = toolConfig?.include || [];
         const include = [...topLevelInclude, ...toolInclude];
-        const exclude = toolConfig?.exclude || topLevelFiles.exclude || [];
+        const topLevelExclude = topLevelFiles.exclude || [];
+        const toolExclude = toolConfig?.exclude || [];
+        const exclude = [...topLevelExclude, ...toolExclude];
         return {
             include,
             exclude
@@ -5017,7 +5032,7 @@ class Config {
     }
     /**
      * Check if a tool (linter or formatter) is enabled for a specific file path.
-     * Respects both the tool's enabled state and its exclude patterns.
+     * Respects the tool's enabled state and all exclude patterns (defaults + files.exclude + tool.exclude).
      * @param filePath - The file path to check
      * @param tool - The tool to check ('linter' or 'formatter')
      * @returns true if the tool is enabled for this path
@@ -5027,8 +5042,8 @@ class Config {
         if (!isEnabled) {
             return false;
         }
-        const toolConfig = tool === 'linter' ? this.config.linter : this.config.formatter;
-        const excludePatterns = toolConfig?.exclude || [];
+        const filesConfig = this.getFilesConfigForTool(tool);
+        const excludePatterns = filesConfig.exclude || [];
         return !this.isPathExcluded(filePath, excludePatterns);
     }
     /**
@@ -5051,11 +5066,11 @@ class Config {
     }
     /**
      * Check if a specific rule is enabled for a specific file path.
-     * Respects linter.enabled, linter.exclude, rule.enabled, rule.include, rule.only, and rule.exclude patterns.
+     * Respects rule.enabled, rule.include, rule.only, and rule.exclude patterns.
      *
      * Pattern precedence:
-     * - If rule.only is specified: Only files matching 'only' patterns (ignores all 'include' patterns)
-     * - If rule.only is NOT specified: Files matching 'include' patterns (if specified, additive)
+     * - If rule.only or rule.include matches the path: bypasses parent excludes (linter.exclude, files.exclude, defaults)
+     * - If no rule.only/include patterns or path doesn't match: respects all parent excludes
      * - rule.exclude is always applied regardless of 'only' or 'include'
      *
      * @param ruleName - The name of the rule to check
@@ -5063,7 +5078,7 @@ class Config {
      * @returns true if the rule is enabled for this path
      */
     isRuleEnabledForPath(ruleName, filePath) {
-        if (!this.isLinterEnabledForPath(filePath)) {
+        if (!this.isLinterEnabled) {
             return false;
         }
         if (this.isRuleDisabled(ruleName)) {
@@ -5073,13 +5088,25 @@ class Config {
         const ruleOnlyPatterns = ruleConfig?.only || [];
         const ruleIncludePatterns = ruleConfig?.include || [];
         const ruleExcludePatterns = ruleConfig?.exclude || [];
+        let bypassParentExcludes = false;
         if (ruleOnlyPatterns.length > 0) {
-            if (!this.isPathIncluded(filePath, ruleOnlyPatterns)) {
+            if (this.isPathIncluded(filePath, ruleOnlyPatterns)) {
+                bypassParentExcludes = true;
+            }
+            else {
                 return false;
             }
         }
         else if (ruleIncludePatterns.length > 0) {
-            if (!this.isPathIncluded(filePath, ruleIncludePatterns)) {
+            if (this.isPathIncluded(filePath, ruleIncludePatterns)) {
+                bypassParentExcludes = true;
+            }
+            else {
+                return false;
+            }
+        }
+        if (!bypassParentExcludes) {
+            if (!this.isLinterEnabledForPath(filePath)) {
                 return false;
             }
         }
@@ -5416,7 +5443,7 @@ class Config {
                     result.push('');
                 }
             }
-            if (/^    [a-z][\w-]*:/.test(line) && prevLine && /^      /.test(prevLine)) {
+            if (/^    [a-z][\w-]*:/.test(line) && prevLine && prevLine.startsWith('      ')) {
                 result.push('');
             }
             result.push(line);
@@ -5570,7 +5597,7 @@ class Config {
                 console.error(`✓ Created default configuration at ${configPath}`);
             }
         }
-        catch (error) {
+        catch (_error) {
             if (!silent) {
                 console.error(`⚠ Could not create config file at ${configPath}, using defaults in-memory`);
             }
@@ -5659,62 +5686,57 @@ class Config {
      * Read, parse, and validate config file
      */
     static async readAndValidateConfig(configPath, projectRoot, version, exitOnError = false) {
+        const content = await promises.readFile(configPath, "utf8");
+        let parsed;
         try {
-            const content = await promises.readFile(configPath, "utf8");
-            let parsed;
-            try {
-                parsed = parse$1(content);
+            parsed = parse$1(content);
+        }
+        catch (error) {
+            if (exitOnError) {
+                console.error(`\n✗ Invalid YAML syntax in ${configPath}`);
+                if (error instanceof Error) {
+                    console.error(`  ${error.message}\n`);
+                }
+                process.exit(1);
             }
-            catch (error) {
+            else {
+                throw new Error(`Invalid YAML syntax in ${configPath}: ${error instanceof Error ? error.message : String(error)}`);
+            }
+        }
+        if (parsed === null || parsed === undefined) {
+            parsed = {};
+        }
+        if (!parsed.version) {
+            parsed.version = version;
+        }
+        try {
+            HerbConfigSchema.parse(parsed);
+        }
+        catch (error) {
+            if (error instanceof ZodError) {
+                const validationError = fromZodError(error, {
+                    prefix: `Configuration errors in ${configPath}`,
+                });
                 if (exitOnError) {
-                    console.error(`\n✗ Invalid YAML syntax in ${configPath}`);
-                    if (error instanceof Error) {
-                        console.error(`  ${error.message}\n`);
-                    }
+                    console.error(`\n✗ ${validationError.toString()}\n`);
                     process.exit(1);
                 }
                 else {
-                    throw new Error(`Invalid YAML syntax in ${configPath}: ${error instanceof Error ? error.message : String(error)}`);
-                }
-            }
-            if (parsed === null || parsed === undefined) {
-                parsed = {};
-            }
-            if (!parsed.version) {
-                parsed.version = version;
-            }
-            try {
-                HerbConfigSchema.parse(parsed);
-            }
-            catch (error) {
-                if (error instanceof ZodError) {
-                    const validationError = fromZodError(error, {
-                        prefix: `Configuration errors in ${configPath}`,
-                    });
-                    if (exitOnError) {
-                        console.error(`\n✗ ${validationError.toString()}\n`);
-                        process.exit(1);
-                    }
-                    else {
-                        throw new Error(validationError.toString());
-                    }
+                    throw new Error(validationError.toString());
                 }
-                throw error;
-            }
-            if (parsed.version && parsed.version !== version) {
-                console.error(`\n⚠️ Configuration version mismatch in ${configPath}`);
-                console.error(`   Config version: ${parsed.version}`);
-                console.error(`   Current version: ${version}`);
-                console.error(`   Consider updating your .herb.yml file.\n`);
             }
-            const defaults = this.getDefaultConfig(version);
-            const resolved = deepMerge(defaults, parsed);
-            resolved.version = version;
-            return new Config(projectRoot, resolved);
-        }
-        catch (error) {
             throw error;
         }
+        if (parsed.version && parsed.version !== version) {
+            console.error(`\n⚠️ Configuration version mismatch in ${configPath}`);
+            console.error(`   Config version: ${parsed.version}`);
+            console.error(`   Current version: ${version}`);
+            console.error(`   Consider updating your .herb.yml file.\n`);
+        }
+        const defaults = this.getDefaultConfig(version);
+        const resolved = deepMerge(defaults, parsed);
+        resolved.version = version;
+        return new Config(projectRoot, resolved);
     }
     /**
      * Get default configuration object
@@ -5722,29 +5744,7 @@ class Config {
     static getDefaultConfig(version = DEFAULT_VERSION) {
         return {
             version,
-            files: {
-                include: [
-                    '**/*.html',
-                    '**/*.rhtml',
-                    '**/*.html.erb',
-                    '**/*.html+*.erb',
-                    '**/*.turbo_stream.erb'
-                ],
-                exclude: [
-                    'node_modules/**/*',
-                    'vendor/bundle/**/*',
-                    'coverage/**/*',
-                ]
-            },
-            linter: {
-                enabled: true,
-                rules: {}
-            },
-            formatter: {
-                enabled: false,
-                indentWidth: 2,
-                maxLineLength: 80
-            }
+            ...PARSED_DEFAULTS
         };
     }
 }
@@ -5784,7 +5784,7 @@ function readExtensionsJson(filePath) {
         }
         return parsed;
     }
-    catch (error) {
+    catch (_error) {
         console.warn(`Warning: Could not parse ${filePath}, creating new file`);
         return { recommendations: [] };
     }