@herb-tools/core 0.3.0 → 0.4.0

package/src/nodes.ts

@@ -24,38 +24,6 @@ export interface BaseNodeProps {
   errors: HerbError[]
 }
 
-export type NodeType =
-  | "AST_DOCUMENT_NODE"
-  | "AST_LITERAL_NODE"
-  | "AST_HTML_OPEN_TAG_NODE"
-  | "AST_HTML_CLOSE_TAG_NODE"
-  | "AST_HTML_SELF_CLOSE_TAG_NODE"
-  | "AST_HTML_ELEMENT_NODE"
-  | "AST_HTML_ATTRIBUTE_VALUE_NODE"
-  | "AST_HTML_ATTRIBUTE_NAME_NODE"
-  | "AST_HTML_ATTRIBUTE_NODE"
-  | "AST_HTML_TEXT_NODE"
-  | "AST_HTML_COMMENT_NODE"
-  | "AST_HTML_DOCTYPE_NODE"
-  | "AST_WHITESPACE_NODE"
-  | "AST_ERB_CONTENT_NODE"
-  | "AST_ERB_END_NODE"
-  | "AST_ERB_ELSE_NODE"
-  | "AST_ERB_IF_NODE"
-  | "AST_ERB_BLOCK_NODE"
-  | "AST_ERB_WHEN_NODE"
-  | "AST_ERB_CASE_NODE"
-  | "AST_ERB_CASE_MATCH_NODE"
-  | "AST_ERB_WHILE_NODE"
-  | "AST_ERB_UNTIL_NODE"
-  | "AST_ERB_FOR_NODE"
-  | "AST_ERB_RESCUE_NODE"
-  | "AST_ERB_ENSURE_NODE"
-  | "AST_ERB_BEGIN_NODE"
-  | "AST_ERB_UNLESS_NODE"
-  | "AST_ERB_YIELD_NODE"
-  | "AST_ERB_IN_NODE"
-
 export abstract class Node implements BaseNodeProps {
   readonly type: NodeType
   readonly location: Location
@@ -90,7 +58,7 @@ export abstract class Node implements BaseNodeProps {
   abstract treeInspect(indent?: number): string
   abstract recursiveErrors(): HerbError[]
   abstract accept(visitor: Visitor): void
-  abstract childNodes(): (Node | null | undefined)[]
+  abstract childNodes(): (Node | null | undefined)[]
   abstract compactChildNodes(): Node[]
 
   protected inspectArray(
@@ -2910,3 +2878,81 @@ export function fromSerializedNode(node: SerializedNode): Node {
       throw new Error(`Unknown node type: ${node.type}`);
   }
 }
+
+export type NodeType =
+  | "AST_DOCUMENT_NODE"
+  | "AST_LITERAL_NODE"
+  | "AST_HTML_OPEN_TAG_NODE"
+  | "AST_HTML_CLOSE_TAG_NODE"
+  | "AST_HTML_SELF_CLOSE_TAG_NODE"
+  | "AST_HTML_ELEMENT_NODE"
+  | "AST_HTML_ATTRIBUTE_VALUE_NODE"
+  | "AST_HTML_ATTRIBUTE_NAME_NODE"
+  | "AST_HTML_ATTRIBUTE_NODE"
+  | "AST_HTML_TEXT_NODE"
+  | "AST_HTML_COMMENT_NODE"
+  | "AST_HTML_DOCTYPE_NODE"
+  | "AST_WHITESPACE_NODE"
+  | "AST_ERB_CONTENT_NODE"
+  | "AST_ERB_END_NODE"
+  | "AST_ERB_ELSE_NODE"
+  | "AST_ERB_IF_NODE"
+  | "AST_ERB_BLOCK_NODE"
+  | "AST_ERB_WHEN_NODE"
+  | "AST_ERB_CASE_NODE"
+  | "AST_ERB_CASE_MATCH_NODE"
+  | "AST_ERB_WHILE_NODE"
+  | "AST_ERB_UNTIL_NODE"
+  | "AST_ERB_FOR_NODE"
+  | "AST_ERB_RESCUE_NODE"
+  | "AST_ERB_ENSURE_NODE"
+  | "AST_ERB_BEGIN_NODE"
+  | "AST_ERB_UNLESS_NODE"
+  | "AST_ERB_YIELD_NODE"
+  | "AST_ERB_IN_NODE"
+
+export type ERBNodeType = Extract<NodeType, `AST_ERB_${string}`>;
+
+export type ERBNode =
+  | ERBContentNode
+  | ERBEndNode
+  | ERBElseNode
+  | ERBIfNode
+  | ERBBlockNode
+  | ERBWhenNode
+  | ERBCaseNode
+  | ERBCaseMatchNode
+  | ERBWhileNode
+  | ERBUntilNode
+  | ERBForNode
+  | ERBRescueNode
+  | ERBEnsureNode
+  | ERBBeginNode
+  | ERBUnlessNode
+  | ERBYieldNode
+  | ERBInNode
+
+export const ERBNodeClasses = [
+  ERBContentNode,
+  ERBEndNode,
+  ERBElseNode,
+  ERBIfNode,
+  ERBBlockNode,
+  ERBWhenNode,
+  ERBCaseNode,
+  ERBCaseMatchNode,
+  ERBWhileNode,
+  ERBUntilNode,
+  ERBForNode,
+  ERBRescueNode,
+  ERBEnsureNode,
+  ERBBeginNode,
+  ERBUnlessNode,
+  ERBYieldNode,
+  ERBInNode,
+]
+
+export function isERBNode(node: Node): node is ERBNode {
+  
+  return node.constructor.name.startsWith("ERB")
+}

package/src/parse-result.ts

@@ -61,8 +61,8 @@ export class ParseResult extends Result {
    * @returns `true` if there are errors, otherwise `false`.
    */
   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
+    // Consider errors on this result and recursively in the document tree
+    return this.recursiveErrors().length > 0
   }
 
   /**
@@ -70,7 +70,7 @@ export class ParseResult extends Result {
    * @returns `true` if there are no errors, otherwise `false`.
    */
   get successful(): boolean {
-    return this.errors.length === 0
+    return !this.failed
   }
 
   /**

package/src/token-list.ts

@@ -19,6 +19,10 @@ export class TokenList implements Iterable<Token> {
     return this.list.length
   }
 
+  get tokens(): Token[] {
+    return this.list
+  }
+
   [Symbol.iterator](): Iterator<Token> {
     return this.list[Symbol.iterator]()
   }