@herb-tools/core 0.1.1 → 0.3.0

package/src/parse-result.ts

@@ -1,11 +1,13 @@
 import { Result } from "./result.js"
+
 import { DocumentNode } from "./nodes.js"
-import { HerbError } from "./error.js"
+import { HerbError } from "./errors.js"
 import { HerbWarning } from "./warning.js"
 
-import type { SerializedHerbError } from "./error.js"
+import type { SerializedHerbError } from "./errors.js"
 import type { SerializedHerbWarning } from "./warning.js"
 import type { SerializedDocumentNode } from "./nodes.js"
+
 import type { Visitor } from "./visitor.js"
 
 export type SerializedParseResult = {
@@ -58,7 +60,7 @@ export class ParseResult extends Result {
    * Determines if the parsing failed.
    * @returns `true` if there are errors, otherwise `false`.
    */
-  failed(): boolean {
+  get failed(): boolean {
     // TODO: this should probably be recursive as noted in the Ruby version
     return this.errors.length > 0 || this.value.errors.length > 0
   }
@@ -67,8 +69,8 @@ export class ParseResult extends Result {
    * Determines if the parsing was successful.
    * @returns `true` if there are no errors, otherwise `false`.
    */
-  success(): boolean {
-    return !this.failed()
+  get successful(): boolean {
+    return this.errors.length === 0
   }
 
   /**

package/src/result.ts

@@ -1,7 +1,7 @@
-import { HerbError } from "./error.js"
+import { HerbError } from "./errors.js"
 import { HerbWarning } from "./warning.js"
 
-export class Result {
+export abstract class Result {
   readonly source: string
   readonly warnings: HerbWarning[]
   readonly errors: HerbError[]
@@ -16,11 +16,19 @@ export class Result {
     this.errors = errors || []
   }
 
-  success(): boolean {
-    return false
+  /**
+   * Determines if the parsing was successful.
+   * @returns `true` if there are no errors, otherwise `false`.
+   */
+  get successful(): boolean {
+    return this.errors.length === 0
   }
 
-  failed(): boolean {
-    return true
+  /**
+   * Determines if the parsing failed.
+   * @returns `true` if there are errors, otherwise `false`.
+   */
+  get failed(): boolean {
+    return this.errors.length > 0
   }
 }

package/src/visitor.ts

@@ -1,14 +1,173 @@
-import { Node } from "./node.js"
+// NOTE: This file is generated by the templates/template.rb script and should not
+// be modified manually. See /Users/marcoroth/Development/herb-release/templates/javascript/packages/core/src/visitor.ts.erb
+
+import {
+  Node,
+  DocumentNode,
+  LiteralNode,
+  HTMLOpenTagNode,
+  HTMLCloseTagNode,
+  HTMLSelfCloseTagNode,
+  HTMLElementNode,
+  HTMLAttributeValueNode,
+  HTMLAttributeNameNode,
+  HTMLAttributeNode,
+  HTMLTextNode,
+  HTMLCommentNode,
+  HTMLDoctypeNode,
+  WhitespaceNode,
+  ERBContentNode,
+  ERBEndNode,
+  ERBElseNode,
+  ERBIfNode,
+  ERBBlockNode,
+  ERBWhenNode,
+  ERBCaseNode,
+  ERBCaseMatchNode,
+  ERBWhileNode,
+  ERBUntilNode,
+  ERBForNode,
+  ERBRescueNode,
+  ERBEnsureNode,
+  ERBBeginNode,
+  ERBUnlessNode,
+  ERBYieldNode,
+  ERBInNode,
+} from "./nodes.js"
 
-/**
- * Represents a visitor that can traverse nodes.
- */
 export class Visitor {
-  /**
-   * Visits a node and performs an action.
-   * @param node - The node to visit.
-   */
-  visit(node: Node) {
-    console.log("Node", node) // TODO: implement
+  visit(node: Node | null | undefined): void {
+    if (!node) return
+
+    node.accept(this)
+  }
+
+  visitAll(nodes: (Node | null | undefined)[]): void {
+    nodes.forEach(node => node?.accept(this))
+  }
+
+  visitChildNodes(node: Node): void {
+    node.compactChildNodes().forEach(node => node.accept(this))
+  }
+
+  visitDocumentNode(node: DocumentNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitLiteralNode(node: LiteralNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLOpenTagNode(node: HTMLOpenTagNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLCloseTagNode(node: HTMLCloseTagNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLSelfCloseTagNode(node: HTMLSelfCloseTagNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLElementNode(node: HTMLElementNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLAttributeValueNode(node: HTMLAttributeValueNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLAttributeNameNode(node: HTMLAttributeNameNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLAttributeNode(node: HTMLAttributeNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLTextNode(node: HTMLTextNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLCommentNode(node: HTMLCommentNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitHTMLDoctypeNode(node: HTMLDoctypeNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitWhitespaceNode(node: WhitespaceNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBContentNode(node: ERBContentNode): void {
+    this.visitChildNodes(node)
   }
+
+  visitERBEndNode(node: ERBEndNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBElseNode(node: ERBElseNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBIfNode(node: ERBIfNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBBlockNode(node: ERBBlockNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBWhenNode(node: ERBWhenNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBCaseNode(node: ERBCaseNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBCaseMatchNode(node: ERBCaseMatchNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBWhileNode(node: ERBWhileNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBUntilNode(node: ERBUntilNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBForNode(node: ERBForNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBRescueNode(node: ERBRescueNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBEnsureNode(node: ERBEnsureNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBBeginNode(node: ERBBeginNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBUnlessNode(node: ERBUnlessNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBYieldNode(node: ERBYieldNode): void {
+    this.visitChildNodes(node)
+  }
+
+  visitERBInNode(node: ERBInNode): void {
+    this.visitChildNodes(node)
+  }
+
 }

package/dist/types/ast.d.ts

@@ -1,4 +0,0 @@
-export declare class ASTNode {
-    readonly errors: any[];
-    constructor();
-}

package/dist/types/error.d.ts

@@ -1,16 +0,0 @@
-import { Location, SerializedLocation } from "./location.js";
-export interface SerializedHerbError {
-    type: string;
-    message: string;
-    location: SerializedLocation;
-}
-export declare abstract class HerbError {
-    readonly type: string;
-    readonly message: string;
-    readonly location: Location;
-    static from(error: SerializedHerbError): HerbError;
-    constructor(type: string, message: string, location: Location);
-    toJSON(): SerializedHerbError;
-    inspect(): string;
-    abstract treeInspect(indent?: number): string;
-}

package/dist/types/node.d.ts

@@ -1,27 +0,0 @@
-import { Location, SerializedLocation } from "./location.js";
-import { HerbError, SerializedHerbError } from "./error.js";
-import { NodeType, SerializedNodeType } from "./nodes.js";
-export interface SerializedNode {
-    type: SerializedNodeType;
-    location: SerializedLocation;
-    errors: SerializedHerbError[];
-}
-export interface BaseNodeProps {
-    type: NodeType;
-    location: Location;
-    errors: HerbError[];
-}
-export declare abstract class Node implements BaseNodeProps {
-    readonly type: NodeType;
-    readonly location: Location;
-    readonly errors: HerbError[];
-    static from(node: SerializedNode): Node;
-    constructor(type: NodeType, location: Location, errors: HerbError[]);
-    toJSON(): SerializedNode;
-    inspect(): string;
-    abstract treeInspect(indent?: number): string;
-    abstract recursiveErrors(): HerbError[];
-    abstract childNodes(): Node[];
-    protected inspectArray(array: (Node | HerbError)[] | null | undefined, prefix: string): string;
-    protected inspectNode(node: Node | HerbError | undefined | null, prefix: string, prefix2?: string, last?: boolean, trailingNewline?: boolean): string;
-}

package/src/ast.ts

@@ -1,7 +0,0 @@
-export class ASTNode {
-  readonly errors: any[]
-
-  constructor() {
-    this.errors = []
-  }
-}

package/src/error.ts

@@ -1,38 +0,0 @@
-import { Location, SerializedLocation } from "./location.js"
-import { fromSerializedError } from "./errors.js"
-
-export interface SerializedHerbError {
-  type: string
-  message: string
-  location: SerializedLocation
-}
-
-export abstract class HerbError {
-  readonly type: string
-  readonly message: string
-  readonly location: Location
-
-  static from(error: SerializedHerbError): HerbError {
-    return fromSerializedError(error)
-  }
-
-  constructor(type: string, message: string, location: Location) {
-    this.type = type
-    this.message = message
-    this.location = location
-  }
-
-  toJSON(): SerializedHerbError {
-    return {
-      type: this.type,
-      message: this.message,
-      location: this.location.toJSON(),
-    }
-  }
-
-  inspect(): string {
-    return this.treeInspect(0)
-  }
-
-  abstract treeInspect(indent?: number): string
-}

package/src/node.ts

@@ -1,106 +0,0 @@
-import { Location, SerializedLocation } from "./location.js"
-import { HerbError, SerializedHerbError } from "./error.js"
-import { NodeType, SerializedNodeType, fromSerializedNode } from "./nodes.js"
-
-export interface SerializedNode {
-  type: SerializedNodeType
-  location: SerializedLocation
-  errors: SerializedHerbError[]
-}
-
-export interface BaseNodeProps {
-  type: NodeType
-  location: Location
-  errors: HerbError[]
-}
-
-export abstract class Node implements BaseNodeProps {
-  readonly type: NodeType
-  readonly location: Location
-  readonly errors: HerbError[]
-
-  static from(node: SerializedNode): Node {
-    return fromSerializedNode(node)
-  }
-
-  constructor(type: NodeType, location: Location, errors: HerbError[]) {
-    this.type = type
-    this.location = location
-    this.errors = errors
-  }
-
-  toJSON(): SerializedNode {
-    return {
-      type: this.type,
-      location: this.location.toJSON(),
-      errors: this.errors,
-    }
-  }
-
-  inspect(): string {
-    return this.treeInspect(0)
-  }
-
-  abstract treeInspect(indent?: number): string
-  abstract recursiveErrors(): HerbError[]
-  abstract childNodes(): Node[]
-
-  protected inspectArray(
-    array: (Node | HerbError)[] | null | undefined,
-    prefix: string,
-  ): string {
-    if (!array) return "∅\n"
-    if (array.length === 0) return "[]\n"
-
-    let output = `(${array.length} item${array.length == 1 ? "" : "s"})\n`
-
-    array.forEach((item, index) => {
-      const isLast = index === array.length - 1
-
-      if (item instanceof Node || item instanceof HerbError) {
-        output += this.inspectNode(
-          item,
-          prefix,
-          isLast ? "    " : "│   ",
-          isLast,
-          false,
-        )
-      } else {
-        const symbol = isLast ? "└── " : "├── "
-        output += `${prefix}${symbol} ${item}\n`
-      }
-    })
-
-    output += `${prefix}\n`
-
-    return output
-  }
-
-  protected inspectNode(
-    node: Node | HerbError | undefined | null,
-    prefix: string,
-    prefix2: string = "    ",
-    last: boolean = true,
-    trailingNewline: boolean = true,
-  ): string {
-    if (!node) return "∅\n"
-
-    let output = trailingNewline ? "\n" : ""
-    output += `${prefix}`
-
-    output += last ? "└── " : "├── "
-    output += node
-      .treeInspect()
-      .trimStart()
-      .split("\n")
-      .map((line, index) =>
-        index == 0 ? line.trimStart() : `${prefix}${prefix2}${line}`,
-      )
-      .join("\n")
-      .trimStart()
-
-    output += `\n`
-
-    return output
-  }
-}