@reteps/tree-sitter-htmlmustache 0.0.31 → 0.0.35

package/README.md

@@ -18,9 +18,9 @@
 
 ## Features
 
-- **CLI Linter** — Check templates for errors from the command line
-- **Syntax Highlighting** — Full semantic highlighting for HTML and Mustache syntax
-- **Document Formatting** — Auto-format with EditorConfig support
+- **Syntax Highlighting** — Full semantic highlighting for HTML and Mustache, plus embedded JS/TS in `<script>` and CSS in `<style>`
+- **Document Formatting** — Auto-format with EditorConfig and config file support
+- **CLI Linter & Formatter** — Check and format templates from the command line
 - **Document Symbols** — Outline view and breadcrumb navigation
 - **Folding** — Collapse HTML elements and Mustache sections
 - **Hover Information** — Tag and attribute documentation
@@ -36,12 +36,53 @@
 | `{{! comment }}`          | Comments               |
 | `{{> partial}}`           | Partials               |
 
+## VS Code Extension
+
+Install from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=reteps.htmlmustache-lsp) or search for "HTML Mustache" in the Extensions view.
+
+What you get out of the box:
+
+- Syntax highlighting (including embedded JS/TS and CSS)
+- Document formatting (format on save, format selection)
+- Error diagnostics (parse errors, mismatched tags)
+- Document outline and breadcrumbs
+- Hover information for HTML tags and attributes
+- Code folding for HTML elements and Mustache sections
+
+### Using with `.html` Files
+
+By default, the extension activates for `.mustache`, `.hbs`, and `.handlebars` files. To use it with `.html` files, add this to your VS Code settings:
+
+```json
+{
+  "files.associations": {
+    "*.html": "htmlmustache"
+  }
+}
+```
+
+You can also change the language mode for a single file by clicking the language indicator in the status bar and selecting "HTML Mustache".
+
 ## CLI
 
-Check templates for errors before committing:
+Install globally or run via `npx`:
+
+```
+npm install -g @reteps/tree-sitter-htmlmustache
+```
+
+### `htmlmustache check`
+
+Check templates for parse errors:
+
+```
+htmlmustache check '**/*.mustache' '**/*.hbs'
+```
+
+If `include` is configured in `.htmlmustache.jsonc`, patterns are optional:
 
 ```
-npx @reteps/tree-sitter-htmlmustache check '**/*.mustache' '**/*.hbs'
+htmlmustache check
 ```
 
 ```
@@ -55,51 +96,84 @@ file.mustache:3:3 error: Mismatched mustache section: {{/wrong}}
 1 error in 1 file (5 files checked)
 ```
 
-Or install globally:
+Detects parse errors, mismatched Mustache sections, mismatched HTML end tags, and missing tokens.
+
+### `htmlmustache format`
+
+Format templates:
 
 ```
-npm install -g @reteps/tree-sitter-htmlmustache
-htmlmustache check '**/*.mustache'
+htmlmustache format --write '**/*.mustache'
 ```
 
-Detects parse errors, mismatched Mustache sections, mismatched HTML end tags, and missing tokens.
+If `include` is configured in `.htmlmustache.jsonc`, patterns are optional:
 
-## Installation
+```
+htmlmustache format --write
+```
 
-### VS Code Extension
+Check formatting in CI (exits 1 if any files would change):
 
-Install from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=reteps.htmlmustache-lsp) or search for "HTML Mustache" in the Extensions view.
+```
+htmlmustache format --check 'templates/**/*.hbs'
+```
 
-Alternatively, download `htmlmustache-lsp.vsix` from the [latest release](https://github.com/reteps/tree-sitter-htmlmustache/releases) and install via:
+Read from stdin:
 
 ```
-code --install-extension htmlmustache-lsp.vsix
+echo '<div><p>hi</p></div>' | htmlmustache format --stdin
 ```
 
-### WASM
+**Options:**
 
-Download `tree-sitter-htmlmustache.wasm` from the [latest release](https://github.com/reteps/tree-sitter-htmlmustache/releases).
+| Flag                | Description                                      |
+| ------------------- | ------------------------------------------------ |
+| `--write`           | Modify files in-place (default: print to stdout) |
+| `--check`           | Exit 1 if any files would change (for CI)        |
+| `--stdin`           | Read from stdin, write to stdout                 |
+| `--indent-size N`   | Spaces per indent level (default: 2)             |
+| `--print-width N`   | Max line width (default: 80)                     |
+| `--mustache-spaces` | Add spaces inside mustache delimiters            |
 
-## Using with `.html` Files
+## Configuration
 
-By default, the extension activates for `.mustache`, `.hbs`, and `.handlebars` files. To use it with `.html` files, add this to your VS Code settings:
+### `.htmlmustache.jsonc`
 
-```json
+Create a `.htmlmustache.jsonc` file in your project root to configure formatting options. Both the VS Code extension and CLI will pick it up automatically (the file is found by walking up from the formatted file).
+
+```jsonc
 {
-  "files.associations": {
-    "*.html": "htmlmustache"
-  }
+  // File patterns for CLI commands (used when no patterns are passed as arguments)
+  "include": ["**/*.mustache", "**/*.hbs"],
+
+  // Patterns to always exclude (node_modules and .git are excluded by default)
+  "exclude": ["**/vendor/**"],
+
+  // Max line width before wrapping (default: 80)
+  "printWidth": 100,
+
+  // Spaces per indent level (default: 2)
+  "indentSize": 4,
+
+  // Add spaces inside mustache delimiters: {{ foo }} vs {{foo}} (default: false)
+  "mustacheSpaces": true,
+
+  // Treat custom tags as raw code blocks (like <script>/<style>)
+  "customCodeTags": [
+    {
+      "name": "x-code",
+      "languageDefault": "javascript",
+    },
+  ],
 }
 ```
 
-You can also change the language mode for a single file by clicking the language indicator in the status bar and selecting "HTML Mustache".
+### EditorConfig
 
-## Acknowledgments
+Both the CLI and VS Code extension respect your `.editorconfig` file for indentation settings (`indent_style`, `indent_size`). EditorConfig values override `.htmlmustache.jsonc` for indentation, and CLI flags override everything.
 
-This project is based on [tree-sitter-html](https://github.com/tree-sitter/tree-sitter-html) by Max Brunsfeld and Amaan Qureshi.
+**Priority order:** defaults < `.htmlmustache.jsonc` < `.editorconfig` (indent only) < CLI flags
 
-## References
+## Acknowledgments
 
-- [The HTML5 Spec](https://www.w3.org/TR/html5/syntax.html)
-- [Mustache Manual](https://mustache.github.io/mustache.5.html)
-- [Handlebars Language Guide](https://handlebarsjs.com/guide/)
+This project is based on [tree-sitter-html](https://github.com/tree-sitter/tree-sitter-html) by Max Brunsfeld and Amaan Qureshi.