@herb-tools/linter 0.8.6 → 0.8.8

package/README.md

@@ -192,6 +192,54 @@ npx @herb-tools/linter template.html.erb --format=simple --github
 npx @herb-tools/linter template.html.erb --no-github
 ```
 
+**Exit Behavior:** <Badge type="info" text="v0.8.7+" />
+```bash
+# Exit with error code when warnings or higher are present
+npx @herb-tools/linter template.html.erb --fail-level warning
+
+# Exit with error code when info diagnostics or higher are present
+npx @herb-tools/linter template.html.erb --fail-level info
+
+# Exit with error code when any diagnostic (including hints) is present
+npx @herb-tools/linter template.html.erb --fail-level hint
+```
+
+By default, the linter exits with code `1` only when errors are present. The `--fail-level` option allows you to control this behavior for CI/CD pipelines where you want stricter enforcement. Valid values are: `error` (default), `warning`, `info`, `hint`.
+
+This can also be configured in `.herb.yml`:
+```yaml [.herb.yml]
+linter:
+  failLevel: warning
+```
+
+The CLI flag takes precedence over the configuration file.
+
+**Autofix:**
+
+Automatically fix auto-correctable offenses:
+```bash
+npx @herb-tools/linter --fix
+```
+
+Also apply unsafe auto-fixes (implies `--fix`):
+```bash
+npx @herb-tools/linter --fix-unsafely
+```
+
+The `--fix` flag automatically corrects offenses that have safe, deterministic fixes (like formatting issues). The `--fix-unsafely` flag additionally applies fixes that may change code behavior or require manual review after application.
+
+**Safe fixes** (`--fix`):
+- Formatting corrections (whitespace, quotes, trailing newlines)
+- Syntax normalization (tag casing, attribute formatting)
+
+**Unsafe fixes** (`--fix-unsafely`):
+- Changes that may alter runtime behavior
+- Insertions that require manual completion (e.g., adding empty strict locals declarations)
+
+::: warning
+Always review changes made by `--fix-unsafely` before committing. These fixes are intentionally separated because they may require additional manual adjustments.
+:::
+
 **Help and Version:**
 ```bash
 # Show help
@@ -219,7 +267,7 @@ npx @herb-tools/linter --format=simple --github
 
 **Example: `--github` (GitHub annotations + detailed format)**
 ```
-::error file=template.html.erb,line=3,col=3,title=html-img-require-alt • @herb-tools/linter@0.8.6::Missing required `alt` attribute on `<img>` tag [html-img-require-alt]%0A%0A%0Atemplate.html.erb:3:3%0A%0A      1 │ <div>%0A      2 │   <span>Test content</span>%0A  →   3 │   <img src="test.jpg">%0A        │    ~~~%0A      4 │ </div>%0A
+::error file=template.html.erb,line=3,col=3,title=html-img-require-alt • @herb-tools/linter@0.8.8::Missing required `alt` attribute on `<img>` tag [html-img-require-alt]%0A%0A%0Atemplate.html.erb:3:3%0A%0A      1 │ <div>%0A      2 │   <span>Test content</span>%0A  →   3 │   <img src="test.jpg">%0A        │    ~~~%0A      4 │ </div>%0A
 
 [error] Missing required `alt` attribute on `<img>` tag [html-img-require-alt]
 
@@ -234,7 +282,7 @@ template.html.erb:3:3
 
 **Example: `--format=simple --github` (GitHub annotations + simple format)**
 ```
-::error file=template.html.erb,line=3,col=3,title=html-img-require-alt • @herb-tools/linter@0.8.6::Missing required `alt` attribute on `<img>` tag [html-img-require-alt]%0A%0A%0Atemplate.html.erb:3:3%0A%0A      1 │ <div>%0A      2 │   <span>Test content</span>%0A  →   3 │   <img src="test.jpg">%0A        │    ~~~%0A      4 │ </div>%0A
+::error file=template.html.erb,line=3,col=3,title=html-img-require-alt • @herb-tools/linter@0.8.8::Missing required `alt` attribute on `<img>` tag [html-img-require-alt]%0A%0A%0Atemplate.html.erb:3:3%0A%0A      1 │ <div>%0A      2 │   <span>Test content</span>%0A  →   3 │   <img src="test.jpg">%0A        │    ~~~%0A      4 │ </div>%0A
 
 template.html.erb:
   3:3 ✗ Missing required `alt` attribute on `<img>` tag [html-img-require-alt]
@@ -393,6 +441,10 @@ npx @herb-tools/linter --init
 linter:
   enabled: true
 
+  # # Exit with error code when diagnostics of this severity or higher are present
+  # # Valid values: error (default), warning, info, hint
+  # failLevel: warning
+
   # Additional glob patterns to include (additive to defaults)
   include:
     - '**/*.xml.erb'