@herb-tools/printer 0.6.0

package/README.md

@@ -0,0 +1,123 @@
+# Herb Syntax Tree Printer
+
+**Package:** [`@herb-tools/printer`](https://www.npmjs.com/package/@herb-tools/printer)
+
+---
+
+AST printer infrastructure for lossless HTML+ERB reconstruction and AST-to-source code conversion for the Herb Parser Syntax Tree.
+
+### Installation
+
+:::code-group
+```shell [npm]
+npm add @herb-tools/printer
+```
+
+```shell [pnpm]
+pnpm add @herb-tools/printer
+```
+
+```shell [yarn]
+yarn add @herb-tools/printer
+```
+
+```shell [bun]
+bun add @herb-tools/printer
+```
+:::
+
+### Usage
+
+#### IdentityPrinter (Provides lossless reconstruction of the original source)
+
+For lossless reconstruction of the original source:
+
+```javascript
+import { IdentityPrinter } from '@herb-tools/printer'
+import { Herb } from '@herb-tools/node-wasm'
+
+await Herb.load()
+
+const parseResult = Herb.parse(
+  '<div class="hello" >  Hello  </div>',
+  { track_whitespace: true }
+)
+
+const printer = new IdentityPrinter()
+const output = printer.print(parseResult.value)
+
+// output === '<div class="hello" >  Hello  </div>' (exact preservation)
+```
+
+#### Custom Printers
+
+Create custom printers by extending the base `Printer` class and override specific visitors for custom behavior:
+
+```typescript
+import { Printer } from "@herb-tools/printer"
+import { HTMLAttributeNode } from "@herb-tools/core"
+
+class CustomPrinter extends Printer {
+  protected write(content: string) {
+    super.write(content.toUpperCase())
+  }
+
+  protected visitHTMLAttributeNode(node: HTMLAttributeNode) {
+    // do nothing to strip attributes
+  }
+}
+```
+
+and then printing the result using `print`
+
+```js
+import { Herb } from "@herb-tools/node-wasm"
+
+await Herb.load()
+
+const parseResult = Herb.parse(
+  '<div class="hello">  Hello  </div>',
+  { track_whitespace: true }
+)
+
+const printer = new CustomPrinter()
+const output = printer.print(parseResult.value)
+
+// output === '<div >  HELLO  </div>'
+```
+
+#### Print Options
+
+The printer supports options to control how nodes are printed:
+
+```typescript
+import { IdentityPrinter, DEFAULT_PRINT_OPTIONS } from "@herb-tools/printer"
+import type { PrintOptions } from "@herb-tools/printer"
+
+const printer = new IdentityPrinter()
+
+// Will throw error if node has parse errors (default behavior)
+const output1 = printer.print(nodeWithErrors)
+
+// Will print the node despite parse errors
+const output2 = printer.print(nodeWithErrors, { ignoreErrors: true })
+```
+
+When `ignoreErrors` is `false` (default), the printer will throw an error if you attempt to print a node that contains parse errors. Set `ignoreErrors` to `true` to print nodes with errors, which can be useful for debugging or partial AST reconstruction.
+
+:::warning Important
+The Printer expects the source to be parsed using the `track_whitespace: true` parser option for accurate source reconstruction.
+:::
+
+#### CLI Usage
+
+```bash
+# Basic round-trip printing
+herb-print input.html.erb > output.html.erb
+
+# Verify parser accuracy
+herb-print input.html.erb --verify
+
+# Show parsing statistics
+herb-print input.html.erb --stats
+```

package/bin/herb-print

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import("../dist/herb-print.js")

package/dist/cli.js

@@ -0,0 +1,190 @@
+#!/usr/bin/env node
+import dedent from "dedent";
+import { readFileSync, writeFileSync } from "fs";
+import { resolve } from "path";
+import { glob } from "glob";
+import { Herb } from "@herb-tools/node-wasm";
+import { IdentityPrinter } from "./index.js";
+export class CLI {
+    parseArgs(args) {
+        const options = {};
+        for (let i = 2; i < args.length; i++) {
+            const arg = args[i];
+            switch (arg) {
+                case '-i':
+                case '--input':
+                    options.input = args[++i];
+                    break;
+                case '-o':
+                case '--output':
+                    options.output = args[++i];
+                    break;
+                case '--verify':
+                    options.verify = true;
+                    break;
+                case '--stats':
+                    options.stats = true;
+                    break;
+                case '--glob':
+                    options.glob = true;
+                    break;
+                case '-h':
+                case '--help':
+                    options.help = true;
+                    break;
+                default:
+                    if (!arg.startsWith('-') && !options.input) {
+                        options.input = arg;
+                    }
+            }
+        }
+        return options;
+    }
+    showHelp() {
+        console.log(dedent `
+      herb-print - Print HTML+ERB AST back to source code
+
+      This tool parses HTML+ERB templates and prints them back, preserving the original
+      formatting as closely as possible. Useful for testing parser accuracy and as a
+      baseline for other transformations.
+
+      Usage:
+        herb-print [options] <input-file-or-pattern>
+        herb-print -i <input-file> -o <output-file>
+
+      Options:
+        -i, --input <file>           Input file path
+        -o, --output <file>          Output file path (defaults to stdout)
+        --verify                     Verify that output matches input exactly
+        --stats                      Show parsing and printing statistics
+        --glob                       Treat input as glob pattern (default: **/*.html.erb)
+        -h, --help                   Show this help message
+
+      Examples:
+        # Single file
+        herb-print input.html.erb > output.html.erb
+        herb-print -i input.html.erb -o output.html.erb --verify
+        herb-print input.html.erb --stats
+
+        # Glob patterns (batch verification)
+        herb-print --glob --verify                    # All .html.erb files
+        herb-print "app/views/**/*.html.erb" --glob --verify --stats
+        herb-print "*.erb" --glob --verify
+        herb-print "/path/to/templates" --glob --verify    # Directory (auto-appends /**/*.html.erb)
+        herb-print "/path/to/templates/**/*.html.erb" --glob --verify
+
+        # The --verify flag is useful to test parser fidelity:
+        herb-print input.html.erb --verify
+        # Checks if parsing and printing results in identical content
+    `);
+    }
+    async run() {
+        const options = this.parseArgs(process.argv);
+        if (options.help || (!options.input && !options.glob)) {
+            this.showHelp();
+            process.exit(0);
+        }
+        try {
+            await Herb.load();
+            if (options.glob) {
+                const pattern = options.input || "**/*.html.erb";
+                const files = await glob(pattern);
+                if (files.length === 0) {
+                    console.error(`No files found matching pattern: ${pattern}`);
+                    process.exit(1);
+                }
+                let totalFiles = 0;
+                let failedFiles = 0;
+                let verificationFailures = 0;
+                let totalBytes = 0;
+                console.log(`Processing ${files.length} files...\n`);
+                for (const file of files) {
+                    try {
+                        const input = readFileSync(file, 'utf-8');
+                        const parseResult = Herb.parse(input, { track_whitespace: true });
+                        if (parseResult.errors.length > 0) {
+                            console.error(`\x1b[31m✗\x1b[0m \x1b[1m${file}\x1b[0m: \x1b[1m\x1b[31mFailed\x1b[0m to parse`);
+                            failedFiles++;
+                            continue;
+                        }
+                        const printer = new IdentityPrinter();
+                        const output = printer.print(parseResult.value);
+                        totalFiles++;
+                        totalBytes += input.length;
+                        if (options.verify) {
+                            if (input === output) {
+                                console.log(`\x1b[32m✓\x1b[0m \x1b[1m${file}\x1b[0m: \x1b[32mPerfect match\x1b[0m`);
+                            }
+                            else {
+                                console.error(`\x1b[31m✗\x1b[0m \x1b[1m${file}\x1b[0m: \x1b[1m\x1b[31mVerification failed\x1b[0m - differences detected`);
+                                verificationFailures++;
+                            }
+                        }
+                        else {
+                            console.log(`\x1b[32m✓\x1b[0m \x1b[1m${file}\x1b[0m: \x1b[32mProcessed\x1b[0m`);
+                        }
+                    }
+                    catch (error) {
+                        console.error(`\x1b[31m✗\x1b[0m \x1b[1m${file}\x1b[0m: \x1b[1m\x1b[31mError\x1b[0m - ${error}`);
+                        failedFiles++;
+                    }
+                }
+                console.log(`\nSummary:`);
+                console.log(`  Files processed: ${totalFiles}`);
+                console.log(`  Files failed:    ${failedFiles}`);
+                if (options.verify) {
+                    console.log(`  Verifications:    ${totalFiles - verificationFailures} passed, ${verificationFailures} failed`);
+                }
+                if (options.stats) {
+                    console.log(`  Total bytes:      ${totalBytes}`);
+                }
+                process.exit(failedFiles > 0 || verificationFailures > 0 ? 1 : 0);
+            }
+            else {
+                const inputPath = resolve(options.input);
+                const input = readFileSync(inputPath, 'utf-8');
+                const parseResult = Herb.parse(input, { track_whitespace: true });
+                if (parseResult.errors.length > 0) {
+                    console.error('Parse errors:', parseResult.errors.map(e => e.message).join(', '));
+                    process.exit(1);
+                }
+                const printer = new IdentityPrinter();
+                const output = printer.print(parseResult.value);
+                if (options.output) {
+                    const outputPath = resolve(options.output);
+                    writeFileSync(outputPath, output, 'utf-8');
+                    console.log(`Output written to: ${outputPath}`);
+                }
+                else {
+                    console.log(output);
+                }
+                if (options.verify) {
+                    if (input === output) {
+                        console.error('\x1b[32m✓ Verification passed\x1b[0m - output matches input exactly');
+                    }
+                    else {
+                        console.error('\x1b[31m✗ Verification failed\x1b[0m - output differs from input');
+                        process.exit(1);
+                    }
+                }
+                if (options.stats) {
+                    const errors = parseResult.errors?.length || 0;
+                    const warnings = parseResult.warnings?.length || 0;
+                    console.error(dedent `
+            Printing Statistics:
+              Input size:     ${input.length} bytes
+              Output size:    ${output.length} bytes
+              Parse errors:   ${errors}
+              Parse warnings: ${warnings}
+              Round-trip:     ${input === output ? 'Perfect' : 'Differences detected'}
+          `);
+                }
+            }
+        }
+        catch (error) {
+            console.error('Error:', error instanceof Error ? error.message : error);
+            process.exit(1);
+        }
+    }
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,MAAM,MAAM,QAAQ,CAAA;AAE3B,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,IAAI,CAAA;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAC9B,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAE3B,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAW5C,MAAM,OAAO,GAAG;IACN,SAAS,CAAC,IAAc;QAC9B,MAAM,OAAO,GAAe,EAAE,CAAA;QAE9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;YAEnB,QAAQ,GAAG,EAAE,CAAC;gBACZ,KAAK,IAAI,CAAC;gBACV,KAAK,SAAS;oBACZ,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;oBACzB,MAAK;gBACP,KAAK,IAAI,CAAC;gBACV,KAAK,UAAU;oBACb,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;oBAC1B,MAAK;gBACP,KAAK,UAAU;oBACb,OAAO,CAAC,MAAM,GAAG,IAAI,CAAA;oBACrB,MAAK;gBACP,KAAK,SAAS;oBACZ,OAAO,CAAC,KAAK,GAAG,IAAI,CAAA;oBACpB,MAAK;gBACP,KAAK,QAAQ;oBACX,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;oBACnB,MAAK;gBACP,KAAK,IAAI,CAAC;gBACV,KAAK,QAAQ;oBACX,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;oBACnB,MAAK;gBACP;oBACE,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;wBAC3C,OAAO,CAAC,KAAK,GAAG,GAAG,CAAA;oBACrB,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAEO,QAAQ;QACd,OAAO,CAAC,GAAG,CAAC,MAAM,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAmCjB,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,GAAG;QACP,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAE5C,IAAI,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,QAAQ,EAAE,CAAA;YACf,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;YAEjB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;gBACjB,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,eAAe,CAAA;gBAChD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAA;gBAEjC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACvB,OAAO,CAAC,KAAK,CAAC,oCAAoC,OAAO,EAAE,CAAC,CAAA;oBAC5D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACjB,CAAC;gBAED,IAAI,UAAU,GAAG,CAAC,CAAA;gBAClB,IAAI,WAAW,GAAG,CAAC,CAAA;gBACnB,IAAI,oBAAoB,GAAG,CAAC,CAAA;gBAC5B,IAAI,UAAU,GAAG,CAAC,CAAA;gBAElB,OAAO,CAAC,GAAG,CAAC,cAAc,KAAK,CAAC,MAAM,aAAa,CAAC,CAAA;gBAEpD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,IAAI,CAAC;wBACH,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;wBACzC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAA;wBAEjE,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;4BAClC,OAAO,CAAC,KAAK,CAAC,2BAA2B,IAAI,gDAAgD,CAAC,CAAA;4BAC9F,WAAW,EAAE,CAAA;4BACb,SAAQ;wBACV,CAAC;wBAED,MAAM,OAAO,GAAG,IAAI,eAAe,EAAE,CAAA;wBACrC,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;wBAE/C,UAAU,EAAE,CAAA;wBACZ,UAAU,IAAI,KAAK,CAAC,MAAM,CAAA;wBAE1B,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;4BACnB,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gCACrB,OAAO,CAAC,GAAG,CAAC,2BAA2B,IAAI,uCAAuC,CAAC,CAAA;4BACrF,CAAC;iCAAM,CAAC;gCACN,OAAO,CAAC,KAAK,CAAC,2BAA2B,IAAI,2EAA2E,CAAC,CAAA;gCACzH,oBAAoB,EAAE,CAAA;4BACxB,CAAC;wBACH,CAAC;6BAAM,CAAC;4BACN,OAAO,CAAC,GAAG,CAAC,2BAA2B,IAAI,mCAAmC,CAAC,CAAA;wBACjF,CAAC;oBAEH,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,OAAO,CAAC,KAAK,CAAC,2BAA2B,IAAI,0CAA0C,KAAK,EAAE,CAAC,CAAA;wBAC/F,WAAW,EAAE,CAAA;oBACf,CAAC;gBACH,CAAC;gBAED,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;gBACzB,OAAO,CAAC,GAAG,CAAC,sBAAsB,UAAU,EAAE,CAAC,CAAA;gBAC/C,OAAO,CAAC,GAAG,CAAC,sBAAsB,WAAW,EAAE,CAAC,CAAA;gBAEhD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;oBACnB,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,GAAG,oBAAoB,YAAY,oBAAoB,SAAS,CAAC,CAAA;gBAChH,CAAC;gBAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;oBAClB,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAA;gBAClD,CAAC;gBAED,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,IAAI,oBAAoB,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAEnE,CAAC;iBAAM,CAAC;gBACN,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,KAAM,CAAC,CAAA;gBACzC,MAAM,KAAK,GAAG,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;gBAE9C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAA;gBAEjE,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAClC,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;oBACjF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACjB,CAAC;gBAED,MAAM,OAAO,GAAG,IAAI,eAAe,EAAE,CAAA;gBACrC,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;gBAE/C,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;oBACnB,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;oBAC1C,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;oBAE1C,OAAO,CAAC,GAAG,CAAC,sBAAsB,UAAU,EAAE,CAAC,CAAA;gBACjD,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBACrB,CAAC;gBAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;oBACnB,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;wBACrB,OAAO,CAAC,KAAK,CAAC,qEAAqE,CAAC,CAAA;oBACtF,CAAC;yBAAM,CAAC;wBACN,OAAO,CAAC,KAAK,CAAC,kEAAkE,CAAC,CAAA;wBACjF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;oBACjB,CAAC;gBACH,CAAC;gBAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;oBAClB,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,CAAA;oBAC9C,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,CAAC,CAAA;oBAElD,OAAO,CAAC,KAAK,CAAC,MAAM,CAAA;;gCAEE,KAAK,CAAC,MAAM;gCACZ,MAAM,CAAC,MAAM;gCACb,MAAM;gCACN,QAAQ;gCACR,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,sBAAsB;WAC1E,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QAEH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;YACvE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC;IACH,CAAC;CACF"}