@reteps/tree-sitter-htmlmustache 0.0.18

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Peter Stenger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,105 @@
+<p align="center">
+  <img src="lsp/icon.png" alt="HTML Mustache Logo" width="128">
+</p>
+
+<h1 align="center">HTML Mustache</h1>
+
+<p align="center">
+  <strong>Full language support for HTML with Mustache/Handlebars templates</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/reteps/tree-sitter-htmlmustache/actions/workflows/lint.yml"><img src="https://img.shields.io/github/actions/workflow/status/reteps/tree-sitter-htmlmustache/lint.yml?logo=github&label=Lint" alt="Lint"></a>
+  <a href="https://github.com/reteps/tree-sitter-htmlmustache/actions/workflows/lsp.yml"><img src="https://img.shields.io/github/actions/workflow/status/reteps/tree-sitter-htmlmustache/lsp.yml?logo=github&label=LSP" alt="LSP"></a>
+  <a href="https://marketplace.visualstudio.com/items?itemName=reteps.htmlmustache-lsp"><img src="https://img.shields.io/visual-studio-marketplace/v/reteps.htmlmustache-lsp?logo=visualstudiocode&label=VS%20Code" alt="VS Code Marketplace"></a>
+</p>
+
+---
+
+## 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
+- **Document Symbols** — Outline view and breadcrumb navigation
+- **Folding** — Collapse HTML elements and Mustache sections
+- **Hover Information** — Tag and attribute documentation
+
+### Supported Mustache Syntax
+
+| Syntax                    | Description            |
+| ------------------------- | ---------------------- |
+| `{{name}}`                | Variable interpolation |
+| `{{{html}}}`              | Unescaped HTML         |
+| `{{#items}}...{{/items}}` | Sections               |
+| `{{^items}}...{{/items}}` | Inverted sections      |
+| `{{! comment }}`          | Comments               |
+| `{{> partial}}`           | Partials               |
+
+## CLI
+
+Check templates for errors before committing:
+
+```
+npx @reteps/tree-sitter-htmlmustache check '**/*.mustache' '**/*.hbs'
+```
+
+```
+file.mustache:3:3 error: Mismatched mustache section: {{/wrong}}
+  |
+1 | {{#items}}
+2 |   <li>{{name}}
+3 |   {{/wrong}}
+  |   ^^^^^^^^^^ Mismatched mustache section: {{/wrong}}
+
+1 error in 1 file (5 files checked)
+```
+
+Or install globally:
+
+```
+npm install -g @reteps/tree-sitter-htmlmustache
+htmlmustache check '**/*.mustache'
+```
+
+Detects parse errors, mismatched Mustache sections, mismatched HTML end tags, and missing tokens.
+
+## Installation
+
+### 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.
+
+Alternatively, download `htmlmustache-lsp.vsix` from the [latest release](https://github.com/reteps/tree-sitter-htmlmustache/releases) and install via:
+
+```
+code --install-extension htmlmustache-lsp.vsix
+```
+
+### WASM
+
+Download `tree-sitter-htmlmustache.wasm` from the [latest release](https://github.com/reteps/tree-sitter-htmlmustache/releases).
+
+## 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".
+
+## Acknowledgments
+
+This project is based on [tree-sitter-html](https://github.com/tree-sitter/tree-sitter-html) by Max Brunsfeld and Amaan Qureshi.
+
+## References
+
+- [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/)

package/binding.gyp

@@ -0,0 +1,30 @@
+{
+  "targets": [
+    {
+      "target_name": "tree_sitter_html_binding",
+      "dependencies": [
+        "<!(node -p \"require('node-addon-api').targets\"):node_addon_api_except",
+      ],
+      "include_dirs": [
+        "src",
+      ],
+      "sources": [
+        "bindings/node/binding.cc",
+        "src/parser.c",
+        "src/scanner.c",
+      ],
+      "conditions": [
+        ["OS!='win'", {
+          "cflags_c": [
+            "-std=c11",
+          ],
+        }, { # OS == "win"
+          "cflags_c": [
+            "/std:c11",
+            "/utf-8",
+          ],
+        }],
+      ],
+    }
+  ]
+}

package/bindings/node/binding.cc

@@ -0,0 +1,19 @@
+#include <napi.h>
+
+typedef struct TSLanguage TSLanguage;
+
+extern "C" TSLanguage *tree_sitter_htmlmustache();
+
+// "tree-sitter", "language" hashed with BLAKE2
+const napi_type_tag LANGUAGE_TYPE_TAG = {
+    0x8AF2E5212AD58ABF, 0xD5006CAD83ABBA16
+};
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+    auto language = Napi::External<TSLanguage>::New(env, tree_sitter_htmlmustache());
+    language.TypeTag(&LANGUAGE_TYPE_TAG);
+    exports["language"] = language;
+    return exports;
+}
+
+NODE_API_MODULE(tree_sitter_htmlmustache_binding, Init)

package/bindings/node/binding_test.js

@@ -0,0 +1,9 @@
+const assert = require('node:assert');
+const { test } = require('node:test');
+
+const Parser = require('tree-sitter');
+
+test('can load grammar', () => {
+  const parser = new Parser();
+  assert.doesNotThrow(() => parser.setLanguage(require('.')));
+});

package/bindings/node/index.d.ts

@@ -0,0 +1,27 @@
+type BaseNode = {
+  type: string;
+  named: boolean;
+};
+
+type ChildNode = {
+  multiple: boolean;
+  required: boolean;
+  types: BaseNode[];
+};
+
+type NodeInfo =
+  | (BaseNode & {
+      subtypes: BaseNode[];
+    })
+  | (BaseNode & {
+      fields: { [name: string]: ChildNode };
+      children: ChildNode[];
+    });
+
+type Language = {
+  language: unknown;
+  nodeTypeInfo: NodeInfo[];
+};
+
+declare const language: Language;
+export = language;

package/bindings/node/index.js

@@ -0,0 +1,13 @@
+const root = require('path').join(__dirname, '..', '..');
+
+module.exports =
+  typeof process.versions.bun === 'string'
+    ? // Support `bun build --compile` by being statically analyzable enough to find the .node file at build-time
+      require(
+        `../../prebuilds/${process.platform}-${process.arch}/tree-sitter-htmlmustache.node`,
+      )
+    : require('node-gyp-build')(root);
+
+try {
+  module.exports.nodeTypeInfo = require('../../src/node-types.json');
+} catch (_) {}

package/cli/out/check.js

@@ -0,0 +1,210 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.collectErrors = collectErrors;
+exports.formatError = formatError;
+exports.formatSummary = formatSummary;
+exports.expandGlobs = expandGlobs;
+exports.run = run;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const chalk_1 = __importDefault(require("chalk"));
+function loadParser() {
+    let Parser;
+    try {
+        Parser = require('tree-sitter');
+    }
+    catch {
+        console.error(chalk_1.default.red('Error: tree-sitter is not installed.\n') +
+            'Install it with: npm install tree-sitter');
+        process.exit(1);
+    }
+    let language;
+    try {
+        language = require(node_path_1.default.resolve(__dirname, '..', '..'));
+    }
+    catch {
+        console.error(chalk_1.default.red('Error: could not load tree-sitter-htmlmustache bindings.\n') +
+            'Run "npm install" in the tree-sitter-htmlmustache root first.');
+        process.exit(1);
+    }
+    const parser = new Parser();
+    parser.setLanguage(language);
+    return parser;
+}
+// ── Error collection ──
+function errorMessageForNode(nodeType, node) {
+    if (nodeType === 'mustache_erroneous_section_end' || nodeType === 'mustache_erroneous_inverted_section_end') {
+        const tagNameNode = node.children.find((c) => c.type === 'mustache_erroneous_tag_name');
+        return `Mismatched mustache section: {{/${tagNameNode?.text || '?'}}}`;
+    }
+    if (nodeType === 'html_erroneous_end_tag') {
+        const tagNameNode = node.children.find((c) => c.type === 'html_erroneous_end_tag_name');
+        return `Mismatched HTML end tag: </${tagNameNode?.text || '?'}>`;
+    }
+    if (nodeType === 'ERROR') {
+        return 'Syntax error';
+    }
+    // isMissing node
+    return `Missing ${nodeType}`;
+}
+const ERROR_NODE_TYPES = new Set([
+    'ERROR',
+    'mustache_erroneous_section_end',
+    'mustache_erroneous_inverted_section_end',
+    'html_erroneous_end_tag',
+]);
+function collectErrors(tree, file) {
+    const errors = [];
+    const cursor = tree.walk();
+    function visit() {
+        const node = cursor.currentNode;
+        const nodeType = cursor.nodeType;
+        if (ERROR_NODE_TYPES.has(nodeType) || cursor.nodeIsMissing) {
+            errors.push({
+                file,
+                line: node.startPosition.row + 1,
+                column: node.startPosition.column + 1,
+                endLine: node.endPosition.row + 1,
+                endColumn: node.endPosition.column + 1,
+                message: errorMessageForNode(nodeType, node),
+                nodeText: node.text,
+            });
+            // Don't recurse into ERROR nodes — the children are not meaningful
+            if (nodeType === 'ERROR')
+                return;
+        }
+        if (cursor.gotoFirstChild()) {
+            do {
+                visit();
+            } while (cursor.gotoNextSibling());
+            cursor.gotoParent();
+        }
+    }
+    visit();
+    return errors;
+}
+// ── Formatting ──
+function formatError(error, source) {
+    const lines = source.split('\n');
+    const errorLine = error.line - 1; // 0-based index
+    // Location header
+    const header = chalk_1.default.bold(`${error.file}:${error.line}:${error.column}`) +
+        ' ' + chalk_1.default.red('error') + ': ' + error.message;
+    // Context lines: up to 2 before + the error line(s)
+    const contextStart = Math.max(0, errorLine - 2);
+    const contextEnd = Math.min(lines.length - 1, error.endLine - 1);
+    const gutterWidth = String(contextEnd + 1).length;
+    const pad = (n) => String(n).padStart(gutterWidth);
+    const outputLines = [header];
+    outputLines.push(chalk_1.default.dim(' '.repeat(gutterWidth) + ' |'));
+    for (let i = contextStart; i <= contextEnd; i++) {
+        const lineNum = i + 1;
+        outputLines.push(chalk_1.default.dim(`${pad(lineNum)} |`) + ' ' + lines[i]);
+    }
+    // Underline: only on the last displayed line of the error
+    const lastErrorLineIdx = error.endLine - 1;
+    const lastLine = lines[lastErrorLineIdx] || '';
+    let underlineStart;
+    let underlineEnd;
+    if (error.line === error.endLine) {
+        // Single-line error
+        underlineStart = error.column - 1;
+        underlineEnd = error.endColumn - 1;
+    }
+    else {
+        // Multi-line: underline to end of last line
+        underlineStart = 0;
+        underlineEnd = lastLine.length;
+    }
+    const underlineLength = Math.max(1, underlineEnd - underlineStart);
+    const underline = ' '.repeat(underlineStart) + '^'.repeat(underlineLength) +
+        ' ' + error.message;
+    outputLines.push(chalk_1.default.dim(' '.repeat(gutterWidth) + ' |') + ' ' + chalk_1.default.red(underline));
+    return outputLines.join('\n');
+}
+function formatSummary(totalErrors, filesWithErrors, totalFiles) {
+    if (totalErrors === 0) {
+        return chalk_1.default.green(`No errors found (${totalFiles} ${totalFiles === 1 ? 'file' : 'files'} checked)`);
+    }
+    const errStr = totalErrors === 1 ? 'error' : 'errors';
+    const errFileStr = filesWithErrors === 1 ? 'file' : 'files';
+    const totalStr = totalFiles === 1 ? 'file' : 'files';
+    return chalk_1.default.red(`${totalErrors} ${errStr} in ${filesWithErrors} ${errFileStr}`) +
+        ` (${totalFiles} ${totalStr} checked)`;
+}
+// ── Glob expansion ──
+function expandGlobs(patterns) {
+    const files = new Set();
+    for (const pattern of patterns) {
+        for (const match of node_fs_1.default.globSync(pattern)) {
+            files.add(node_path_1.default.resolve(match));
+        }
+    }
+    return [...files].sort();
+}
+// ── Main ──
+const USAGE = `Usage: htmlmustache check <patterns...>
+
+Check HTML Mustache templates for errors.
+
+Arguments:
+  patterns  One or more glob patterns (e.g. '**/*.mustache' '**/*.hbs')
+
+Options:
+  --help    Show this help message
+
+Examples:
+  htmlmustache check '**/*.mustache'
+  htmlmustache check 'templates/**/*.hbs' 'partials/**/*.mustache'`;
+function run(args) {
+    // Strip "check" subcommand if present
+    if (args[0] === 'check') {
+        args = args.slice(1);
+    }
+    if (args.includes('--help') || args.length === 0) {
+        console.log(USAGE);
+        return args.includes('--help') ? 0 : 1;
+    }
+    const files = expandGlobs(args);
+    if (files.length === 0) {
+        console.error(chalk_1.default.yellow('No files matched the given patterns.'));
+        return 1;
+    }
+    const parser = loadParser();
+    let totalErrors = 0;
+    let filesWithErrors = 0;
+    for (const file of files) {
+        const source = node_fs_1.default.readFileSync(file, 'utf-8');
+        const tree = parser.parse(source);
+        const errors = collectErrors(tree, file);
+        if (errors.length > 0) {
+            filesWithErrors++;
+            totalErrors += errors.length;
+            for (const error of errors) {
+                console.log(formatError(error, source));
+                console.log();
+            }
+        }
+    }
+    console.log(formatSummary(totalErrors, filesWithErrors, files.length));
+    return totalErrors > 0 ? 1 : 0;
+}
+// CLI entry point
+if (require.main === module) {
+    const args = process.argv.slice(2);
+    if (args[0] !== 'check' && !args.includes('--help')) {
+        if (args.length === 0) {
+            console.log(USAGE);
+            process.exit(1);
+        }
+        console.error(chalk_1.default.red(`Unknown command: ${args[0]}`));
+        console.error('Run "htmlmustache --help" for usage.');
+        process.exit(1);
+    }
+    const code = run(args);
+    process.exit(code);
+}