@herb-tools/printer 0.8.10 → 0.9.1

package/dist/types/indent-printer.d.ts

@@ -0,0 +1,41 @@
+import { IdentityPrinter } from "./identity-printer.js";
+import type * as Nodes from "@herb-tools/core";
+/**
+ * IndentPrinter - Re-indentation printer that preserves content but adjusts indentation
+ *
+ * Extends IdentityPrinter to preserve all content as-is while replacing
+ * leading whitespace on each line with the correct indentation based on
+ * the AST nesting depth.
+ */
+export declare class IndentPrinter extends IdentityPrinter {
+    protected indentLevel: number;
+    protected indentWidth: number;
+    private pendingIndent;
+    constructor(indentWidth?: number);
+    protected get indent(): string;
+    protected write(content: string): void;
+    visitLiteralNode(node: Nodes.LiteralNode): void;
+    visitHTMLTextNode(node: Nodes.HTMLTextNode): void;
+    visitHTMLElementNode(node: Nodes.HTMLElementNode): void;
+    visitERBIfNode(node: Nodes.ERBIfNode): void;
+    visitERBElseNode(node: Nodes.ERBElseNode): void;
+    visitERBBlockNode(node: Nodes.ERBBlockNode): void;
+    visitERBCaseNode(node: Nodes.ERBCaseNode): void;
+    visitERBWhenNode(node: Nodes.ERBWhenNode): void;
+    visitERBWhileNode(node: Nodes.ERBWhileNode): void;
+    visitERBUntilNode(node: Nodes.ERBUntilNode): void;
+    visitERBForNode(node: Nodes.ERBForNode): void;
+    visitERBBeginNode(node: Nodes.ERBBeginNode): void;
+    visitERBRescueNode(node: Nodes.ERBRescueNode): void;
+    visitERBEnsureNode(node: Nodes.ERBEnsureNode): void;
+    visitERBUnlessNode(node: Nodes.ERBUnlessNode): void;
+    /**
+     * Write content, replacing leading whitespace on each line with the current indent.
+     *
+     * Uses a pendingIndent mechanism: when content ends with a newline followed by
+     * whitespace-only, sets pendingIndent=true instead of writing the indent immediately.
+     * The indent is then applied at the correct level when the next node writes content
+     * (via the overridden write() method).
+     */
+    protected writeWithIndent(content: string): void;
+}

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export { IdentityPrinter } from "./identity-printer.js";
+export { IndentPrinter } from "./indent-printer.js";
 export { ERBToRubyStringPrinter } from "./erb-to-ruby-string-printer.js";
 export { PrintContext } from "./print-context.js";
 export { Printer, DEFAULT_PRINT_OPTIONS } from "./printer.js";

package/dist/types/printer.d.ts

@@ -35,5 +35,5 @@ export declare abstract class Printer extends Visitor {
      * @throws {Error} When node has parse errors and ignoreErrors is false
      */
     print(input: Token | Node | ParseResult | Node[] | undefined | null, options?: PrintOptions): string;
-    protected write(content: string): void;
+    protected write(content: string | null | undefined): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@herb-tools/printer",
-  "version": "0.8.10",
+  "version": "0.9.1",
   "description": "AST printer infrastructure and lossless reconstruction tool for HTML+ERB templates",
   "license": "MIT",
   "homepage": "https://herb-tools.dev",
@@ -37,7 +37,7 @@
     "prepublishOnly": "yarn clean && yarn build && yarn test"
   },
   "dependencies": {
-    "@herb-tools/core": "0.8.10",
+    "@herb-tools/core": "0.9.1",
     "tinyglobby": "^0.2.15"
   },
   "files": [

package/src/erb-to-ruby-string-printer.ts

@@ -1,8 +1,8 @@
 import { IdentityPrinter } from "./identity-printer.js"
 import { PrintOptions, DEFAULT_PRINT_OPTIONS } from "./printer.js"
-import { isERBOutputNode, filterNodes, ERBContentNode, } from "@herb-tools/core"
+import { isERBOutputNode, filterNodes, ERBContentNode, isERBIfNode, isERBUnlessNode, isERBElseNode, isHTMLTextNode } from "@herb-tools/core"
 
-import { HTMLTextNode, ERBIfNode, ERBElseNode, ERBUnlessNode, Node, HTMLAttributeValueNode } from "@herb-tools/core"
+import { HTMLTextNode, ERBIfNode, ERBUnlessNode, Node, HTMLAttributeValueNode } from "@herb-tools/core"
 
 export interface ERBToRubyStringOptions extends PrintOptions {
   /**
@@ -34,8 +34,6 @@ export const DEFAULT_ERB_TO_RUBY_STRING_OPTIONS: ERBToRubyStringOptions = {
  * - `<% if logged_in? %>Welcome<% else %>Login<% end %>!` => `"#{logged_in? ? "Welcome" : "Login"}!"`
  */
 export class ERBToRubyStringPrinter extends IdentityPrinter {
-
-  // TODO: cleanup `.type === "AST_*" checks`
   static print(node: Node, options: Partial<ERBToRubyStringOptions> = DEFAULT_ERB_TO_RUBY_STRING_OPTIONS): string {
     const erbNodes = filterNodes([node], ERBContentNode)
 
@@ -51,22 +49,22 @@ export class ERBToRubyStringPrinter extends IdentityPrinter {
         return (childErbNodes[0].content?.value || "").trim()
       }
 
-      if (node.children.length === 1 && node.children[0].type === "AST_ERB_IF_NODE" && !options.forceQuotes) {
-        const ifNode = node.children[0] as ERBIfNode
+      const firstChild = node.children[0]
+
+      if (node.children.length === 1 && isERBIfNode(firstChild) && !options.forceQuotes) {
         const printer = new ERBToRubyStringPrinter()
 
-        if (printer.canConvertToTernary(ifNode)) {
-          printer.convertToTernaryWithoutWrapper(ifNode)
+        if (printer.canConvertToTernary(firstChild)) {
+          printer.convertToTernaryWithoutWrapper(firstChild)
           return printer.context.getOutput()
         }
       }
 
-      if (node.children.length === 1 && node.children[0].type === "AST_ERB_UNLESS_NODE" && !options.forceQuotes) {
-        const unlessNode = node.children[0] as ERBUnlessNode
+      if (node.children.length === 1 && isERBUnlessNode(firstChild) && !options.forceQuotes) {
         const printer = new ERBToRubyStringPrinter()
 
-        if (printer.canConvertUnlessToTernary(unlessNode)) {
-          printer.convertUnlessToTernaryWithoutWrapper(unlessNode)
+        if (printer.canConvertUnlessToTernary(firstChild)) {
+          printer.convertUnlessToTernaryWithoutWrapper(firstChild)
           return printer.context.getOutput()
         }
       }
@@ -119,16 +117,16 @@ export class ERBToRubyStringPrinter extends IdentityPrinter {
   }
 
   private canConvertToTernary(node: ERBIfNode): boolean {
-    if (node.subsequent && node.subsequent.type !== "AST_ERB_ELSE_NODE") {
+    if (node.subsequent && !isERBElseNode(node.subsequent)) {
       return false
     }
 
-    const ifOnlyText = node.statements ? node.statements.every(statement => statement.type === "AST_HTML_TEXT_NODE") : true
+    const ifOnlyText = node.statements ? node.statements.every(isHTMLTextNode) : true
     if (!ifOnlyText) return false
 
-    if (node.subsequent && node.subsequent.type === "AST_ERB_ELSE_NODE") {
-      return (node.subsequent as ERBElseNode).statements
-        ? (node.subsequent as ERBElseNode).statements.every(statement => statement.type === "AST_HTML_TEXT_NODE")
+    if (isERBElseNode(node.subsequent)) {
+      return node.subsequent.statements
+        ? node.subsequent.statements.every(isHTMLTextNode)
         : true
     }
 
@@ -165,8 +163,8 @@ export class ERBToRubyStringPrinter extends IdentityPrinter {
     this.context.write(" : ")
     this.context.write('"')
 
-    if (node.subsequent && node.subsequent.type === "AST_ERB_ELSE_NODE" && (node.subsequent as ERBElseNode).statements) {
-      (node.subsequent as ERBElseNode).statements.forEach(statement => this.visit(statement))
+    if (isERBElseNode(node.subsequent) && node.subsequent.statements) {
+      node.subsequent.statements.forEach(statement => this.visit(statement))
     }
 
     this.context.write('"')
@@ -174,7 +172,7 @@ export class ERBToRubyStringPrinter extends IdentityPrinter {
   }
 
   private convertToTernaryWithoutWrapper(node: ERBIfNode) {
-    if (node.subsequent && node.subsequent.type !== "AST_ERB_ELSE_NODE") {
+    if (node.subsequent && !isERBElseNode(node.subsequent)) {
       return false
     }
 
@@ -205,21 +203,21 @@ export class ERBToRubyStringPrinter extends IdentityPrinter {
     this.context.write(" : ")
     this.context.write('"')
 
-    if (node.subsequent && node.subsequent.type === "AST_ERB_ELSE_NODE" && (node.subsequent as ERBElseNode).statements) {
-      (node.subsequent as ERBElseNode).statements.forEach(statement => this.visit(statement))
+    if (isERBElseNode(node.subsequent) && node.subsequent.statements) {
+      node.subsequent.statements.forEach(statement => this.visit(statement))
     }
 
     this.context.write('"')
   }
 
   private canConvertUnlessToTernary(node: ERBUnlessNode): boolean {
-    const unlessOnlyText = node.statements ? node.statements.every(statement => statement.type === "AST_HTML_TEXT_NODE") : true
+    const unlessOnlyText = node.statements ? node.statements.every(isHTMLTextNode) : true
 
     if (!unlessOnlyText) return false
 
-    if (node.else_clause && node.else_clause.type === "AST_ERB_ELSE_NODE") {
+    if (isERBElseNode(node.else_clause)) {
       return node.else_clause.statements
-        ? node.else_clause.statements.every(statement => statement.type === "AST_HTML_TEXT_NODE")
+        ? node.else_clause.statements.every(isHTMLTextNode)
         : true
     }
 
@@ -260,7 +258,7 @@ export class ERBToRubyStringPrinter extends IdentityPrinter {
     this.context.write(" : ")
     this.context.write('"')
 
-    if (node.else_clause && node.else_clause.type === "AST_ERB_ELSE_NODE") {
+    if (isERBElseNode(node.else_clause)) {
       node.else_clause.statements.forEach(statement => this.visit(statement))
     }
 
@@ -300,7 +298,7 @@ export class ERBToRubyStringPrinter extends IdentityPrinter {
     this.context.write(" : ")
     this.context.write('"')
 
-    if (node.else_clause && node.else_clause.type === "AST_ERB_ELSE_NODE") {
+    if (isERBElseNode(node.else_clause)) {
       node.else_clause.statements.forEach(statement => this.visit(statement))
     }
 

package/src/identity-printer.ts

@@ -72,6 +72,14 @@ export class IdentityPrinter extends Printer {
     }
   }
 
+  visitHTMLVirtualCloseTagNode(_node: Nodes.HTMLVirtualCloseTagNode): void {
+    // Virtual closing tags don't print anything (they are synthetic)
+  }
+
+  visitHTMLOmittedCloseTagNode(_node: Nodes.HTMLOmittedCloseTagNode): void {
+    // Omitted closing tags don't print anything
+  }
+
   visitHTMLElementNode(node: Nodes.HTMLElementNode): void {
     const tagName = node.tag_name?.value
 
@@ -96,6 +104,30 @@ export class IdentityPrinter extends Printer {
     }
   }
 
+  visitHTMLConditionalElementNode(node: Nodes.HTMLConditionalElementNode): void {
+    const tagName = node.tag_name?.value
+
+    if (tagName) {
+      this.context.enterTag(tagName)
+    }
+
+    if (node.open_conditional) {
+      this.visit(node.open_conditional)
+    }
+
+    if (node.body) {
+      node.body.forEach(child => this.visit(child))
+    }
+
+    if (node.close_conditional) {
+      this.visit(node.close_conditional)
+    }
+
+    if (tagName) {
+      this.context.exitTag()
+    }
+  }
+
   visitHTMLAttributeNode(node: Nodes.HTMLAttributeNode): void {
     if (node.name) {
       this.visit(node.name)
@@ -126,6 +158,14 @@ export class IdentityPrinter extends Printer {
     }
   }
 
+  visitRubyLiteralNode(node: Nodes.RubyLiteralNode): void {
+    this.write(node.content)
+  }
+
+  visitRubyHTMLAttributesSplatNode(node: Nodes.RubyHTMLAttributesSplatNode): void {
+    this.write(node.content)
+  }
+
   visitHTMLCommentNode(node: Nodes.HTMLCommentNode): void {
     if (node.comment_start) {
       this.write(node.comment_start.value)
@@ -174,6 +214,10 @@ export class IdentityPrinter extends Printer {
     }
   }
 
+  visitERBOpenTagNode(node: Nodes.ERBOpenTagNode): void {
+    this.printERBNode(node)
+  }
+
   visitERBContentNode(node: Nodes.ERBContentNode): void {
     this.printERBNode(node)
   }
@@ -342,6 +386,14 @@ export class IdentityPrinter extends Printer {
     }
   }
 
+  visitERBRenderNode(node: Nodes.ERBRenderNode): void {
+    this.printERBNode(node)
+  }
+
+  visitRubyRenderLocalNode(_node: Nodes.RubyRenderLocalNode): void {
+    // extracted metadata, nothing to print
+  }
+
   visitERBYieldNode(node: Nodes.ERBYieldNode): void {
     this.printERBNode(node)
   }

package/src/indent-printer.ts

@@ -0,0 +1,313 @@
+import { IdentityPrinter } from "./identity-printer.js"
+
+import type * as Nodes from "@herb-tools/core"
+
+/**
+ * IndentPrinter - Re-indentation printer that preserves content but adjusts indentation
+ *
+ * Extends IdentityPrinter to preserve all content as-is while replacing
+ * leading whitespace on each line with the correct indentation based on
+ * the AST nesting depth.
+ */
+export class IndentPrinter extends IdentityPrinter {
+  protected indentLevel: number = 0
+  protected indentWidth: number
+  private pendingIndent: boolean = false
+
+  constructor(indentWidth: number = 2) {
+    super()
+
+    this.indentWidth = indentWidth
+  }
+
+  protected get indent(): string {
+    return " ".repeat(this.indentLevel * this.indentWidth)
+  }
+
+  protected write(content: string): void {
+    if (this.pendingIndent && content.length > 0) {
+      this.pendingIndent = false
+      this.context.write(this.indent + content)
+    } else {
+      this.context.write(content)
+    }
+  }
+
+  visitLiteralNode(node: Nodes.LiteralNode): void {
+    this.writeWithIndent(node.content)
+  }
+
+  visitHTMLTextNode(node: Nodes.HTMLTextNode): void {
+    this.writeWithIndent(node.content)
+  }
+
+  visitHTMLElementNode(node: Nodes.HTMLElementNode): void {
+    const tagName = node.tag_name?.value
+
+    if (tagName) {
+      this.context.enterTag(tagName)
+    }
+
+    if (node.open_tag) {
+      this.visit(node.open_tag)
+    }
+
+    if (node.body) {
+      this.indentLevel++
+      node.body.forEach(child => this.visit(child))
+      this.indentLevel--
+    }
+
+    if (node.close_tag) {
+      this.visit(node.close_tag)
+    }
+
+    if (tagName) {
+      this.context.exitTag()
+    }
+  }
+
+  visitERBIfNode(node: Nodes.ERBIfNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      this.indentLevel++
+      node.statements.forEach(statement => this.visit(statement))
+      this.indentLevel--
+    }
+
+    if (node.subsequent) {
+      this.visit(node.subsequent)
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBElseNode(node: Nodes.ERBElseNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      this.indentLevel++
+      node.statements.forEach(statement => this.visit(statement))
+      this.indentLevel--
+    }
+  }
+
+  visitERBBlockNode(node: Nodes.ERBBlockNode): void {
+    this.printERBNode(node)
+
+    if (node.body) {
+      this.indentLevel++
+      node.body.forEach(child => this.visit(child))
+      this.indentLevel--
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBCaseNode(node: Nodes.ERBCaseNode): void {
+    this.printERBNode(node)
+
+    if (node.children) {
+      this.indentLevel++
+      node.children.forEach(child => this.visit(child))
+      this.indentLevel--
+    }
+
+    if (node.conditions) {
+      this.indentLevel++
+      node.conditions.forEach(condition => this.visit(condition))
+      this.indentLevel--
+    }
+
+    if (node.else_clause) {
+      this.indentLevel++
+      this.visit(node.else_clause)
+      this.indentLevel--
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBWhenNode(node: Nodes.ERBWhenNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      this.indentLevel++
+      node.statements.forEach(statement => this.visit(statement))
+      this.indentLevel--
+    }
+  }
+
+  visitERBWhileNode(node: Nodes.ERBWhileNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      this.indentLevel++
+      node.statements.forEach(statement => this.visit(statement))
+      this.indentLevel--
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBUntilNode(node: Nodes.ERBUntilNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      this.indentLevel++
+      node.statements.forEach(statement => this.visit(statement))
+      this.indentLevel--
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBForNode(node: Nodes.ERBForNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      this.indentLevel++
+      node.statements.forEach(statement => this.visit(statement))
+      this.indentLevel--
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBBeginNode(node: Nodes.ERBBeginNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      this.indentLevel++
+      node.statements.forEach(statement => this.visit(statement))
+      this.indentLevel--
+    }
+
+    if (node.rescue_clause) {
+      this.visit(node.rescue_clause)
+    }
+
+    if (node.else_clause) {
+      this.visit(node.else_clause)
+    }
+
+    if (node.ensure_clause) {
+      this.visit(node.ensure_clause)
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  visitERBRescueNode(node: Nodes.ERBRescueNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      this.indentLevel++
+      node.statements.forEach(statement => this.visit(statement))
+      this.indentLevel--
+    }
+
+    if (node.subsequent) {
+      this.visit(node.subsequent)
+    }
+  }
+
+  visitERBEnsureNode(node: Nodes.ERBEnsureNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      this.indentLevel++
+      node.statements.forEach(statement => this.visit(statement))
+      this.indentLevel--
+    }
+  }
+
+  visitERBUnlessNode(node: Nodes.ERBUnlessNode): void {
+    this.printERBNode(node)
+
+    if (node.statements) {
+      this.indentLevel++
+      node.statements.forEach(statement => this.visit(statement))
+      this.indentLevel--
+    }
+
+    if (node.else_clause) {
+      this.visit(node.else_clause)
+    }
+
+    if (node.end_node) {
+      this.visit(node.end_node)
+    }
+  }
+
+  /**
+   * Write content, replacing leading whitespace on each line with the current indent.
+   *
+   * Uses a pendingIndent mechanism: when content ends with a newline followed by
+   * whitespace-only, sets pendingIndent=true instead of writing the indent immediately.
+   * The indent is then applied at the correct level when the next node writes content
+   * (via the overridden write() method).
+   */
+  protected writeWithIndent(content: string): void {
+    if (!content.includes("\n")) {
+      if (this.pendingIndent) {
+        this.pendingIndent = false
+
+        const trimmed = content.replace(/^[ \t]+/, "")
+
+        if (trimmed.length > 0) {
+          this.context.write(this.indent + trimmed)
+        }
+      } else {
+        this.context.write(content)
+      }
+
+      return
+    }
+
+    const lines = content.split("\n")
+    const lastIndex = lines.length - 1
+
+    for (let i = 0; i < lines.length; i++) {
+      if (i > 0) {
+        this.context.write("\n")
+      }
+
+      const line = lines[i]
+      const trimmed = line.replace(/^[ \t]+/, "")
+
+      if (i === 0) {
+        if (this.pendingIndent) {
+          this.pendingIndent = false
+
+          if (trimmed.length > 0) {
+            this.context.write(this.indent + trimmed)
+          }
+        } else {
+          this.context.write(line)
+        }
+      } else if (i === lastIndex && trimmed.length === 0) {
+        this.pendingIndent = true
+      } else if (trimmed.length === 0) {
+        // Middle whitespace-only line: write nothing (newline already written above)
+      } else {
+        this.context.write(this.indent + trimmed)
+      }
+    }
+  }
+}

package/src/index.ts

@@ -1,4 +1,5 @@
 export { IdentityPrinter } from "./identity-printer.js"
+export { IndentPrinter } from "./indent-printer.js"
 export { ERBToRubyStringPrinter } from "./erb-to-ruby-string-printer.js"
 export { PrintContext } from "./print-context.js"
 export { Printer, DEFAULT_PRINT_OPTIONS } from "./printer.js"

package/src/printer.ts

@@ -1,8 +1,6 @@
 import { Node, Visitor, Token, ParseResult, isToken, isParseResult } from "@herb-tools/core"
 import { PrintContext } from "./print-context.js"
 
-import type { ERBNode } from "@herb-tools/core"
-
 /**
  * Options for controlling the printing behavior
  */
@@ -33,7 +31,7 @@ export abstract class Printer extends Visitor {
    * @returns The printed string representation of the input
    * @throws {Error} When node has parse errors and ignoreErrors is false
    */
-  static print(input: Token | Node | ParseResult | Node[] | undefined | null, options: PrintOptions = DEFAULT_PRINT_OPTIONS): string {
+  static print(input: Token | Node | ParseResult | Node[] | undefined | null, options: PrintOptions = DEFAULT_PRINT_OPTIONS): string {
     const printer = new (this as any)()
 
     return printer.print(input, options)
@@ -47,7 +45,7 @@ export abstract class Printer extends Visitor {
    * @returns The printed string representation of the input
    * @throws {Error} When node has parse errors and ignoreErrors is false
    */
-  print(input: Token | Node | ParseResult | Node[] | undefined | null, options: PrintOptions = DEFAULT_PRINT_OPTIONS): string {
+  print(input: Token | Node | ParseResult | Node[] | undefined | null, options: PrintOptions = DEFAULT_PRINT_OPTIONS): string {
     if (!input) return ""
 
     if (isToken(input)) {
@@ -73,7 +71,9 @@ export abstract class Printer extends Visitor {
     return this.context.getOutput()
   }
 
-  protected write(content: string): void {
-    this.context.write(content)
+  protected write(content: string | null | undefined): void {
+    if (content !== null && content !== undefined) {
+      this.context.write(content)
+    }
   }
 }