@herb-tools/linter 0.4.2 → 0.5.0

package/README.md

@@ -6,27 +6,238 @@
 
 The Herb Linter provides comprehensive HTML+ERB validation with a set of configurable rules to enforce best practices and catch common errors.
 
+## Installation
+
+### Global Installation
+
+:::code-group
+
+```shell [npm]
+npm install -g @herb-tools/linter
+```
+
+```shell [pnpm]
+pnpm add -g @herb-tools/linter
+```
+
+```shell [yarn]
+yarn global add @herb-tools/linter
+```
+
+```shell [bun]
+bun add -g @herb-tools/linter
+```
+
+:::
+
+Then run directly:
+```bash
+herb-lint template.html.erb
+```
+
+### One-time Usage
+For occasional use without installing:
+```bash
+npx @herb-tools/linter template.html.erb
+```
+
+### Project Installation
+
+:::code-group
+
+```shell [npm]
+npm add -D @herb-tools/linter
+```
+
+```shell [pnpm]
+pnpm add -D @herb-tools/linter
+```
+
+```shell [yarn]
+yarn add -D @herb-tools/linter
+```
+
+```shell [bun]
+bun add -D @herb-tools/linter
+```
+
+:::
+
+After installing as a dev dependency, add a lint NPM script to your `package.json`:
+```json
+{
+  "scripts": {
+    "herb:lint": "herb-lint '**/*.html.erb'"
+  }
+}
+```
+
+Then run the scripts:
+
+:::code-group
+
+```shell [npm]
+npm run herb:lint
+```
+
+```shell [pnpm]
+pnpm herb:lint
+```
+
+```shell [yarn]
+yarn herb:lint
+```
+
+```shell [bun]
+bun run herb:lint
+```
+
+:::
+
 ## Usage
 
 ### Command Line
+
+Basic usage:
 ```bash
 npx @herb-tools/linter template.html.erb
+npx @herb-tools/linter "**/*.html.erb"
+npx @herb-tools/linter app/
 ```
 
-### Language Server Integration
+#### Options
 
-The linter is automatically integrated into the [Herb Language Server](https://herb-tools.dev/projects/language-server), providing real-time validation in supported editors like VS Code, Zed, and Neovim.
+**Output Format:**
+```bash
+# Use detailed output (default)
+npx @herb-tools/linter template.html.erb --format detailed
 
-## Configuration
+# Use simple output format
+npx @herb-tools/linter template.html.erb --simple
+# or
+npx @herb-tools/linter template.html.erb --format simple
+
+# Use JSON output format
+npx @herb-tools/linter template.html.erb --json
+# or
+npx @herb-tools/linter template.html.erb --format json
+
+# Use GitHub Actions output format
+npx @herb-tools/linter template.html.erb --github
+# or
+npx @herb-tools/linter template.html.erb --format github
+```
+
+**Display Options:**
+```bash
+# Disable colored output
+npx @herb-tools/linter template.html.erb --no-color
 
-By default, all rules are enabled. You can customize the rules by passing a custom set to the Linter constructor:
+# Set syntax highlighting theme
+npx @herb-tools/linter template.html.erb --theme github-dark
 
-```typescript
-import { Linter, HTMLTagNameLowercaseRule } from "@herb-tools/linter"
+# Disable timing information
+npx @herb-tools/linter template.html.erb --no-timing
 
-// Only run specific rules
-const linter = new Linter([HTMLTagNameLowercaseRule])
+# Disable line wrapping
+npx @herb-tools/linter template.html.erb --no-wrap-lines
 
-// Run with no rules (disabled)
-const linter = new Linter([])
+# Enable line truncation (mutually exclusive with line wrapping)
+npx @herb-tools/linter template.html.erb --truncate-lines --no-wrap-lines
 ```
+
+**Help and Version:**
+```bash
+# Show help
+npx @herb-tools/linter --help
+
+# Show version information
+npx @herb-tools/linter --version
+```
+
+#### GitHub Actions Output Format
+
+The linter supports GitHub Actions annotation format with the `--github` flag, which outputs errors and warnings in a format that GitHub Actions can parse to create inline annotations in pull requests:
+
+```bash
+npx @herb-tools/linter "**/*.html.erb" --github
+```
+
+Example output:
+```
+::error file=template.html.erb,line=5,col=5::File must end with trailing newline [erb-requires-trailing-newline]
+::warning file=template.html.erb,line=3,col=10::Consider using semantic HTML tags [html-semantic-tags]
+```
+
+This format is ideal for CI/CD workflows in GitHub Actions:
+
+```yaml [.github/workflows/herb-lint.yml]
+name: Herb Lint
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - run: npx @herb-tools/linter "**/*.html.erb" --github
+```
+
+#### JSON Output Format
+
+The linter supports structured JSON output with the `--json` flag, useful for programmatic consumption:
+
+```bash
+npx @herb-tools/linter template.html.erb --json
+```
+
+<details>
+<summary>Example output:</summary>
+
+```json
+{
+  "offenses": [
+    {
+      "filename": "template.html.erb",
+      "message": "File must end with trailing newline",
+      "location": {
+        "start": { "line": 1, "column": 21 },
+        "end": { "line": 1, "column": 22 }
+      },
+      "severity": "error",
+      "code": "erb-requires-trailing-newline",
+      "source": "Herb Linter"
+    }
+  ],
+  "summary": {
+    "filesChecked": 1,
+    "filesWithOffenses": 1,
+    "totalErrors": 1,
+    "totalWarnings": 0,
+    "totalOffenses": 1,
+    "ruleCount": 21
+  },
+  "timing": {
+    "startTime": "2025-08-14T16:00:48.845Z",
+    "duration": 27
+  },
+  "completed": true,
+  "clean": false,
+  "message": null
+}
+```
+
+</details>
+
+JSON output fields:
+- `offenses`: Array of linting offenses with location and severity
+- `summary`: Statistics about the linting run (null on errors)
+- `timing`: Timing information with ISO timestamp (null with `--no-timing`)
+- `completed`: Whether the linter ran successfully on files
+- `clean`: Whether there were no offenses (null when `completed=false`)
+- `message`: Error or informational message (null on success)
+
+### Language Server Integration
+
+The linter is automatically integrated into the [Herb Language Server](https://herb-tools.dev/projects/language-server), providing real-time validation in supported editors like VS Code, Zed, and Neovim.