@herb-tools/core 0.8.10 → 0.9.1

package/dist/types/parse-result.d.ts

@@ -2,15 +2,18 @@ import { Result } from "./result.js";
 import { DocumentNode } from "./nodes.js";
 import { HerbError } from "./errors.js";
 import { HerbWarning } from "./warning.js";
+import { ParserOptions } from "./parser-options.js";
 import type { SerializedHerbError } from "./errors.js";
 import type { SerializedHerbWarning } from "./warning.js";
 import type { SerializedDocumentNode } from "./nodes.js";
+import type { SerializedParserOptions } from "./parser-options.js";
 import type { Visitor } from "./visitor.js";
 export type SerializedParseResult = {
     value: SerializedDocumentNode;
     source: string;
     warnings: SerializedHerbWarning[];
     errors: SerializedHerbError[];
+    options: SerializedParserOptions;
 };
 /**
  * Represents the result of a parsing operation, extending the base `Result` class.
@@ -19,6 +22,8 @@ export type SerializedParseResult = {
 export declare class ParseResult extends Result {
     /** The document node generated from the source code. */
     readonly value: DocumentNode;
+    /** The parser options used during parsing. */
+    readonly options: ParserOptions;
     /**
      * Creates a `ParseResult` instance from a serialized result.
      * @param result - The serialized parse result containing the value and source.
@@ -31,8 +36,9 @@ export declare class ParseResult extends Result {
      * @param source - The source code that was parsed.
      * @param warnings - An array of warnings encountered during parsing.
      * @param errors - An array of errors encountered during parsing.
+     * @param options - The parser options used during parsing.
      */
-    constructor(value: DocumentNode, source: string, warnings?: HerbWarning[], errors?: HerbError[]);
+    constructor(value: DocumentNode, source: string, warnings?: HerbWarning[], errors?: HerbError[], options?: ParserOptions);
     /**
      * Determines if the parsing failed.
      * @returns `true` if there are errors, otherwise `false`.

package/dist/types/parser-options.d.ts

@@ -1,4 +1,35 @@
-export interface ParserOptions {
+export interface ParseOptions {
     track_whitespace?: boolean;
+    analyze?: boolean;
+    strict?: boolean;
+    action_view_helpers?: boolean;
+    render_nodes?: boolean;
+    prism_nodes?: boolean;
+    prism_nodes_deep?: boolean;
+    prism_program?: boolean;
+}
+export type SerializedParserOptions = Required<ParseOptions>;
+export declare const DEFAULT_PARSER_OPTIONS: SerializedParserOptions;
+/**
+ * Represents the parser options used during parsing.
+ */
+export declare class ParserOptions {
+    /** Whether strict mode was enabled during parsing. */
+    readonly strict: boolean;
+    /** Whether whitespace tracking was enabled during parsing. */
+    readonly track_whitespace: boolean;
+    /** Whether analysis was performed during parsing. */
+    readonly analyze: boolean;
+    /** Whether ActionView tag helper transformation was enabled during parsing. */
+    readonly action_view_helpers: boolean;
+    /** Whether ActionView render call detection was enabled during parsing. */
+    readonly render_nodes: boolean;
+    /** Whether Prism node serialization was enabled during parsing. */
+    readonly prism_nodes: boolean;
+    /** Whether deep Prism node serialization was enabled during parsing. */
+    readonly prism_nodes_deep: boolean;
+    /** Whether the full Prism ProgramNode was serialized on the DocumentNode. */
+    readonly prism_program: boolean;
+    static from(options: SerializedParserOptions): ParserOptions;
+    constructor(options?: ParseOptions);
 }
-export declare const DEFAULT_PARSER_OPTIONS: ParserOptions;

package/dist/types/prism/index.d.ts

@@ -0,0 +1,28 @@
+import type { ParseResult as PrismParseResult } from "@ruby/prism/src/deserialize.js";
+export * as PrismNodes from "@ruby/prism/src/nodes.js";
+export { Visitor as PrismVisitor, BasicVisitor as PrismBasicVisitor } from "@ruby/prism/src/visitor.js";
+export type PrismNode = any;
+export type PrismLocation = {
+    startOffset: number;
+    length: number;
+};
+export type { PrismParseResult };
+export { inspectPrismNode, inspectPrismSerialized } from "./inspect.js";
+/**
+ * Deserialize a Prism parse result from the raw bytes produced by pm_serialize().
+ *
+ * @param bytes - The serialized bytes (from prism_serialized field on ERB nodes)
+ * @param source - The original source string that was parsed
+ * @returns The deserialized Prism ParseResult containing the AST
+ */
+export declare function deserializePrismParseResult(bytes: Uint8Array, source: string): PrismParseResult;
+/**
+ * Deserialize a Prism node from the raw bytes produced by pm_serialize().
+ * pm_serialize() serializes a single node subtree, so the ParseResult's
+ * value is the Prism node directly (not wrapped in ProgramNode).
+ *
+ * @param bytes - The serialized bytes (from prism_serialized field on ERB nodes)
+ * @param source - The original source string that was parsed
+ * @returns The Prism node, or null if deserialization fails
+ */
+export declare function deserializePrismNode(bytes: Uint8Array, source: string): PrismNode | null;

package/dist/types/prism/inspect.d.ts

@@ -0,0 +1,3 @@
+import type { PrismNode } from "./index.js";
+export declare function inspectPrismNode(node: PrismNode, source: string, prefix?: string): string;
+export declare function inspectPrismSerialized(bytes: Uint8Array, source: string, prefix?: string): string;

package/dist/types/util.d.ts

@@ -1,2 +1 @@
 export declare function ensureString(object: any): string;
-export declare function convertToUTF8(string: string): string;

package/dist/types/visitor.d.ts

@@ -1,4 +1,4 @@
-import { Node, ERBNode, DocumentNode, LiteralNode, HTMLOpenTagNode, HTMLCloseTagNode, HTMLElementNode, HTMLAttributeValueNode, HTMLAttributeNameNode, HTMLAttributeNode, HTMLTextNode, HTMLCommentNode, HTMLDoctypeNode, XMLDeclarationNode, CDATANode, WhitespaceNode, ERBContentNode, ERBEndNode, ERBElseNode, ERBIfNode, ERBBlockNode, ERBWhenNode, ERBCaseNode, ERBCaseMatchNode, ERBWhileNode, ERBUntilNode, ERBForNode, ERBRescueNode, ERBEnsureNode, ERBBeginNode, ERBUnlessNode, ERBYieldNode, ERBInNode } from "./nodes.js";
+import { Node, ERBNode, DocumentNode, LiteralNode, HTMLOpenTagNode, HTMLConditionalOpenTagNode, HTMLCloseTagNode, HTMLOmittedCloseTagNode, HTMLVirtualCloseTagNode, HTMLElementNode, HTMLConditionalElementNode, HTMLAttributeValueNode, HTMLAttributeNameNode, HTMLAttributeNode, RubyLiteralNode, RubyHTMLAttributesSplatNode, ERBOpenTagNode, HTMLTextNode, HTMLCommentNode, HTMLDoctypeNode, XMLDeclarationNode, CDATANode, WhitespaceNode, ERBContentNode, ERBEndNode, ERBElseNode, ERBIfNode, ERBBlockNode, ERBWhenNode, ERBCaseNode, ERBCaseMatchNode, ERBWhileNode, ERBUntilNode, ERBForNode, ERBRescueNode, ERBEnsureNode, ERBBeginNode, ERBUnlessNode, RubyRenderLocalNode, ERBRenderNode, ERBYieldNode, ERBInNode } from "./nodes.js";
 /**
  * Interface that enforces all node visit methods are implemented
  * This ensures that any class implementing IVisitor must have a visit method for every node type
@@ -10,11 +10,18 @@ export interface IVisitor {
     visitDocumentNode(node: DocumentNode): void;
     visitLiteralNode(node: LiteralNode): void;
     visitHTMLOpenTagNode(node: HTMLOpenTagNode): void;
+    visitHTMLConditionalOpenTagNode(node: HTMLConditionalOpenTagNode): void;
     visitHTMLCloseTagNode(node: HTMLCloseTagNode): void;
+    visitHTMLOmittedCloseTagNode(node: HTMLOmittedCloseTagNode): void;
+    visitHTMLVirtualCloseTagNode(node: HTMLVirtualCloseTagNode): void;
     visitHTMLElementNode(node: HTMLElementNode): void;
+    visitHTMLConditionalElementNode(node: HTMLConditionalElementNode): void;
     visitHTMLAttributeValueNode(node: HTMLAttributeValueNode): void;
     visitHTMLAttributeNameNode(node: HTMLAttributeNameNode): void;
     visitHTMLAttributeNode(node: HTMLAttributeNode): void;
+    visitRubyLiteralNode(node: RubyLiteralNode): void;
+    visitRubyHTMLAttributesSplatNode(node: RubyHTMLAttributesSplatNode): void;
+    visitERBOpenTagNode(node: ERBOpenTagNode): void;
     visitHTMLTextNode(node: HTMLTextNode): void;
     visitHTMLCommentNode(node: HTMLCommentNode): void;
     visitHTMLDoctypeNode(node: HTMLDoctypeNode): void;
@@ -36,6 +43,8 @@ export interface IVisitor {
     visitERBEnsureNode(node: ERBEnsureNode): void;
     visitERBBeginNode(node: ERBBeginNode): void;
     visitERBUnlessNode(node: ERBUnlessNode): void;
+    visitRubyRenderLocalNode(node: RubyRenderLocalNode): void;
+    visitERBRenderNode(node: ERBRenderNode): void;
     visitERBYieldNode(node: ERBYieldNode): void;
     visitERBInNode(node: ERBInNode): void;
     visitNode(node: Node): void;
@@ -50,11 +59,18 @@ export declare class Visitor implements IVisitor {
     visitDocumentNode(node: DocumentNode): void;
     visitLiteralNode(node: LiteralNode): void;
     visitHTMLOpenTagNode(node: HTMLOpenTagNode): void;
+    visitHTMLConditionalOpenTagNode(node: HTMLConditionalOpenTagNode): void;
     visitHTMLCloseTagNode(node: HTMLCloseTagNode): void;
+    visitHTMLOmittedCloseTagNode(node: HTMLOmittedCloseTagNode): void;
+    visitHTMLVirtualCloseTagNode(node: HTMLVirtualCloseTagNode): void;
     visitHTMLElementNode(node: HTMLElementNode): void;
+    visitHTMLConditionalElementNode(node: HTMLConditionalElementNode): void;
     visitHTMLAttributeValueNode(node: HTMLAttributeValueNode): void;
     visitHTMLAttributeNameNode(node: HTMLAttributeNameNode): void;
     visitHTMLAttributeNode(node: HTMLAttributeNode): void;
+    visitRubyLiteralNode(node: RubyLiteralNode): void;
+    visitRubyHTMLAttributesSplatNode(node: RubyHTMLAttributesSplatNode): void;
+    visitERBOpenTagNode(node: ERBOpenTagNode): void;
     visitHTMLTextNode(node: HTMLTextNode): void;
     visitHTMLCommentNode(node: HTMLCommentNode): void;
     visitHTMLDoctypeNode(node: HTMLDoctypeNode): void;
@@ -76,6 +92,8 @@ export declare class Visitor implements IVisitor {
     visitERBEnsureNode(node: ERBEnsureNode): void;
     visitERBBeginNode(node: ERBBeginNode): void;
     visitERBUnlessNode(node: ERBUnlessNode): void;
+    visitRubyRenderLocalNode(node: RubyRenderLocalNode): void;
+    visitERBRenderNode(node: ERBRenderNode): void;
     visitERBYieldNode(node: ERBYieldNode): void;
     visitERBInNode(node: ERBInNode): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@herb-tools/core",
-  "version": "0.8.10",
+  "version": "0.9.1",
   "description": "Core module exporting shared interfaces, AST node definitions, and common utilities for Herb",
   "license": "MIT",
   "homepage": "https://herb-tools.dev",
@@ -30,6 +30,9 @@
     }
   },
   "dependencies": {},
+  "devDependencies": {
+    "@ruby/prism": "^1.9.0"
+  },
   "files": [
     "package.json",
     "README.md",