svg-eslint-parser 0.1.0 → 0.3.0

package/README.md

@@ -87,9 +87,9 @@ import {
 const { ast } = parseForESLint(svgSource)
 const document = ast.document
 
-// Find all tag nodes
-const tags = findNodeByType(document, NodeTypes.Element)
-console.log(`Found ${tags.length} tags`)
+// Find all element nodes
+const elements = findNodeByType(document, NodeTypes.Element)
+console.log(`Found ${elements.length} elements`)
 
 // Traverse with visitor pattern
 traverseAST(document, {
@@ -110,7 +110,7 @@ traverseAST(document, {
 
 #### `parseForESLint(code: string, options?: ParserOptions)`
 
-Returns an ESLint-compatible result with AST, visitor keys, and services.
+Returns an ESLint-compatible result with AST, visitor keys, and services. Recoverable parser diagnostics are available on `services.errors` and `services.warnings`.
 
 #### `parse(code: string, options?: ParserOptions)`
 
@@ -155,8 +155,6 @@ The parser currently exposes 16 AST node types:
 
 **Error Handling**: `Error`
 
-`NodeTypes.Tag` is still available as a deprecated alias of `NodeTypes.Element` for backward compatibility.
-
 ## Documentation
 
 Full documentation is available at [svg-eslint-parser.ntnyq.com](https://svg-eslint-parser.ntnyq.com):
@@ -188,9 +186,9 @@ const svgCode = `
 const { ast } = parseForESLint(svgCode)
 const document = ast.document
 
-// Find all tags and filter for circles
-const allTags = findNodeByType(document, NodeTypes.Element)
-const circles = allTags.filter(tag => tag.name === 'circle')
+// Find all elements and filter for circles
+const allElements = findNodeByType(document, NodeTypes.Element)
+const circles = allElements.filter(element => element.name === 'circle')
 
 console.log(`Found ${circles.length} circles`)
 

package/dist/index.d.ts

@@ -1,13 +1,32 @@
-import * as _$eslint from "eslint";
 import { SourceCode } from "eslint";
 
 //#region src/meta.d.ts
+/**
+ * Package metadata exposed to parser consumers.
+ */
 declare const meta: {
   name: string;
   version: string;
 };
 //#endregion
 //#region src/parser/error.d.ts
+/**
+ * parse error options
+ */
+interface ParseErrorOptions extends ErrorOptions {
+  /**
+   * The index of the error in the source code
+   */
+  column: number;
+  /**
+   * The line number of the error in the source code
+   */
+  line: number;
+  /**
+   * The offset of the error in the source code
+   */
+  offset: number;
+}
 /**
  * parse error
  */
@@ -15,6 +34,7 @@ declare class ParseError extends SyntaxError {
   index: number;
   lineNumber: number;
   column: number;
+  constructor(message: string, options: ParseErrorOptions);
   constructor(message: string, offset: number, line: number, column: number);
 }
 //#endregion
@@ -37,26 +57,29 @@ declare const XML_DECLARATION_START = "<?xml";
 declare const XML_DECLARATION_END = "?>";
 /**
  * regexp for open tag start
- * @regex101 https://regex101.com/?regex=%5E%3C%5Cw&flavor=javascript
+ * @regex101 https://regex101.com/?regex=%5E%3C%5Cw&flags=u&flavor=javascript
  */
 declare const RE_OPEN_TAG_START: RegExp;
 /**
  * regexp for open tag name
- * @regex101 https://regex101.com/?regex=%5E%3C%28%5CS%2B%29&flavor=javascript
+ * @regex101 https://regex101.com/?regex=%5E%3C%28%3F%3CtagName%3E%5CS%2B%29&flags=u&flavor=javascript
  */
 declare const RE_OPEN_TAG_NAME: RegExp;
 /**
  * regexp for close tag name
- * @regex101 https://regex101.com/?regex=%5E%3C%5C%2F%28%28%3F%3A.%7C%5Cr%3F%5Cn%29*%29%3E%24&flavor=javascript
+ * @regex101 https://regex101.com/?regex=%5E%3C%5C%2F%28%3F%3CtagName%3E%28%3F%3A.%7C%5Cr%3F%5Cn%29*%29%3E%24&flags=u&flavor=javascript
  */
 declare const RE_CLOSE_TAG_NAME: RegExp;
 /**
  * regexp for incomplete closing tag
- * @regex101 https://regex101.com/?regex=%3C%5C%2F%5B%5E%3E%5D%2B%24&flavor=javascript
+ * @regex101 https://regex101.com/?regex=%3C%5C%2F%5B%5E%3E%5D%2B%24&flags=u&flavor=javascript
  */
 declare const RE_INCOMPLETE_CLOSING_TAG: RegExp;
 //#endregion
 //#region src/constants/nodeTypes.d.ts
+/**
+ * AST node type names emitted by the parser.
+ */
 declare enum NodeTypes {
   Attribute = "Attribute",
   AttributeKey = "AttributeKey",
@@ -69,8 +92,6 @@ declare enum NodeTypes {
   Element = "Element",
   Error = "Error",
   Program = "Program",
-  /** @deprecated Use Element instead. */
-  Tag = "Element",
   Text = "Text",
   XMLDeclaration = "XMLDeclaration",
   XMLDeclarationAttribute = "XMLDeclarationAttribute",
@@ -79,6 +100,9 @@ declare enum NodeTypes {
 }
 //#endregion
 //#region src/constants/tokenTypes.d.ts
+/**
+ * Token type names emitted by tokenizer contexts.
+ */
 declare enum TokenTypes {
   /**
    * @pg Content tokens
@@ -125,6 +149,9 @@ declare enum TokenTypes {
 }
 //#endregion
 //#region src/constants/specialChar.d.ts
+/**
+ * Character constants used by tokenizer handlers.
+ */
 declare const SPECIAL_CHAR: {
   closingCorner: string;
   colon: string;
@@ -161,6 +188,9 @@ declare const DEPRECATED_SVG_ELEMENTS: Set<string>;
 declare const SELF_CLOSING_ELEMENTS: Set<string>;
 //#endregion
 //#region src/constants/tokenizerContextTypes.d.ts
+/**
+ * Tokenizer state machine contexts.
+ */
 declare enum TokenizerContextTypes {
   AttributeKey = "AttributeKey",
   Attributes = "Attributes",
@@ -188,6 +218,9 @@ declare enum TokenizerContextTypes {
 }
 //#endregion
 //#region src/constants/constructTreeContextTypes.d.ts
+/**
+ * AST construction state machine contexts.
+ */
 declare enum ConstructTreeContextTypes {
   Attribute = "Attribute",
   Attributes = "Attributes",
@@ -206,10 +239,16 @@ declare enum ConstructTreeContextTypes {
 }
 //#endregion
 //#region src/types/ast/common.d.ts
+/**
+ * AST node source range and location metadata.
+ */
 interface Locations {
   loc: SourceLocation;
   range: Range;
 }
+/**
+ * One-based line and zero-based column position.
+ */
 interface Position {
   /**
    * 0 based index (>= 0)
@@ -220,7 +259,13 @@ interface Position {
    */
   line: number;
 }
+/**
+ * Character offset range in `[start, end]` form.
+ */
 type Range = [number, number];
+/**
+ * Start and end positions for a node or token.
+ */
 interface SourceLocation {
   /**
    * end position of source
@@ -234,11 +279,11 @@ interface SourceLocation {
 //#endregion
 //#region src/types/ast/token.d.ts
 /**
- * any token
+ * Union of all tokenizer output token shapes.
  */
 type AnyToken = Token<TokenTypes.AttributeAssignment> | Token<TokenTypes.AttributeKey> | Token<TokenTypes.AttributeValue> | Token<TokenTypes.AttributeValueWrapperEnd> | Token<TokenTypes.AttributeValueWrapperStart> | Token<TokenTypes.CloseTag> | Token<TokenTypes.CommentClose> | Token<TokenTypes.CommentContent> | Token<TokenTypes.CommentOpen> | Token<TokenTypes.DoctypeAttributeValue> | Token<TokenTypes.DoctypeAttributeWrapperEnd> | Token<TokenTypes.DoctypeAttributeWrapperStart> | Token<TokenTypes.DoctypeClose> | Token<TokenTypes.DoctypeOpen> | Token<TokenTypes.OpenTagEnd> | Token<TokenTypes.OpenTagStart> | Token<TokenTypes.Text> | Token<TokenTypes.XMLDeclarationAttributeAssignment> | Token<TokenTypes.XMLDeclarationAttributeKey> | Token<TokenTypes.XMLDeclarationAttributeValue> | Token<TokenTypes.XMLDeclarationAttributeValueWrapperEnd> | Token<TokenTypes.XMLDeclarationAttributeValueWrapperStart> | Token<TokenTypes.XMLDeclarationClose> | Token<TokenTypes.XMLDeclarationOpen>;
 /**
- * token
+ * Source token emitted by the tokenizer.
  */
 interface Token<T extends TokenTypes> extends Locations {
   /**
@@ -252,55 +297,76 @@ interface Token<T extends TokenTypes> extends Locations {
 }
 //#endregion
 //#region src/types/ast/node.d.ts
+/**
+ * Base shape shared by all AST nodes.
+ */
 interface BaseNode extends Locations {
   type: NodeTypes;
 }
+/**
+ * Leaf AST node that stores a string value.
+ */
 interface SimpleNode<T extends NodeTypes> extends BaseNode {
   type: T;
   value: string;
 }
+/**
+ * Text content between SVG/XML nodes.
+ */
 type TextNode = SimpleNode<NodeTypes.Text>;
+/**
+ * ESLint-compatible comment object.
+ */
 interface ESLintComment extends Locations {
   type: 'Block' | 'Line';
   value: string;
 }
 /**
- * attribute nodes
- * @pg
+ * Attribute key node.
  */
 type AttributeKeyNode = SimpleNode<NodeTypes.AttributeKey>;
+/**
+ * Attribute value node.
+ */
 type AttributeValueNode = SimpleNode<NodeTypes.AttributeValue>;
+/**
+ * Element attribute node.
+ */
 interface AttributeNode extends BaseNode {
   key: AttributeKeyNode;
   type: NodeTypes.Attribute;
-  value?: AttributeValueNode;
   quoteChar?: '"' | "'" | undefined;
+  value?: AttributeValueNode;
 }
 /**
- * comment nodes
- * @pg
+ * SVG/XML comment node.
  */
 interface CommentNode extends BaseNode {
   content: string;
   type: NodeTypes.Comment;
+  value: string;
 }
 /**
- * doctype nodes
- * @pg
+ * Doctype attribute value node.
  */
 type DoctypeAttributeValueNode = SimpleNode<NodeTypes.DoctypeAttributeValue>;
+/**
+ * Doctype attribute node.
+ */
 interface DoctypeAttributeNode extends BaseNode {
   type: NodeTypes.DoctypeAttribute;
   quoteChar?: '"' | "'" | undefined;
   value?: DoctypeAttributeValueNode;
 }
+/**
+ * Doctype declaration node.
+ */
 interface DoctypeNode extends BaseNode {
   attributes: DoctypeAttributeNode[];
   type: NodeTypes.Doctype;
 }
 /**
- * element nodes
- * @pg
+ * SVG/XML element node.
  */
 interface ElementNode extends BaseNode {
   attributes: AttributeNode[];
@@ -309,26 +375,32 @@ interface ElementNode extends BaseNode {
   selfClosing: boolean;
   type: NodeTypes.Element;
 }
-/** @deprecated Use ElementNode instead. */
-type TagNode = ElementNode;
 /**
- * XML declaration nodes
+ * XML declaration attribute key node.
  */
 type XMLDeclarationAttributeKeyNode = SimpleNode<NodeTypes.XMLDeclarationAttributeKey>;
+/**
+ * XML declaration attribute value node.
+ */
 type XMLDeclarationAttributeValueNode = SimpleNode<NodeTypes.XMLDeclarationAttributeValue>;
+/**
+ * XML declaration attribute node.
+ */
 interface XMLDeclarationAttributeNode extends BaseNode {
   key: XMLDeclarationAttributeKeyNode;
   type: NodeTypes.XMLDeclarationAttribute;
-  value?: XMLDeclarationAttributeValueNode;
   quoteChar?: '"' | "'" | undefined;
+  value?: XMLDeclarationAttributeValueNode;
 }
+/**
+ * XML declaration node.
+ */
 interface XMLDeclarationNode extends BaseNode {
   attributes: XMLDeclarationAttributeNode[];
   type: NodeTypes.XMLDeclaration;
 }
 /**
- * error nodes
- * @pg
+ * Parser recovery error node.
  */
 interface ErrorNode extends BaseNode {
   code: string;
@@ -337,14 +409,15 @@ interface ErrorNode extends BaseNode {
   recoveredNode?: AnyNode;
 }
 /**
- * child node
- * @pg
+ * Node types allowed as direct document children.
  */
-type DocumentChildNode = XMLDeclarationNode | DoctypeNode | ElementNode | CommentNode | TextNode;
-type ElementChildNode = ElementNode | CommentNode | TextNode;
+type DocumentChildNode = CommentNode | DoctypeNode | ElementNode | TextNode | XMLDeclarationNode;
 /**
- * program
- * @pg
+ * Node types allowed as element children.
+ */
+type ElementChildNode = CommentNode | ElementNode | TextNode;
+/**
+ * ESLint program wrapper around the SVG document.
  */
 interface Program extends BaseNode {
   body: [];
@@ -353,17 +426,66 @@ interface Program extends BaseNode {
   tokens: AnyToken[];
   type: NodeTypes.Program;
 }
+/**
+ * Root SVG document node.
+ */
 interface DocumentNode extends BaseNode {
   children: DocumentChildNode[];
   type: NodeTypes.Document;
 }
 /**
- * any node
- * @pg
+ * Union of every parser AST node.
  */
 type AnyNode = AttributeKeyNode | AttributeNode | AttributeValueNode | CommentNode | DoctypeAttributeNode | DoctypeAttributeValueNode | DoctypeNode | DocumentNode | ElementNode | ErrorNode | Program | TextNode | XMLDeclarationAttributeKeyNode | XMLDeclarationAttributeNode | XMLDeclarationAttributeValueNode | XMLDeclarationNode;
 //#endregion
+//#region src/types/errors.d.ts
+/**
+ * Categories of recoverable parse diagnostics.
+ */
+declare enum ParseErrorType {
+  InvalidAttribute = "InvalidAttribute",
+  InvalidCharacter = "InvalidCharacter",
+  InvalidDoctypeAttribute = "InvalidDoctypeAttribute",
+  InvalidXMLDeclaration = "InvalidXMLDeclaration",
+  MalformedComment = "MalformedComment",
+  MismatchedTag = "MismatchedTag",
+  UnclosedTag = "UnclosedTag",
+  UnexpectedToken = "UnexpectedToken",
+  UnmatchedQuote = "UnmatchedQuote"
+}
+/**
+ * Recoverable parser diagnostic with source location information.
+ */
+interface ParseError$1 {
+  loc: SourceLocation;
+  message: string;
+  range: Range;
+  type: ParseErrorType;
+  recovery?: string;
+}
+/**
+ * Collector interface used while building parser diagnostics.
+ */
+interface ErrorContext {
+  errors: ParseError$1[];
+  warnings: ParseError$1[];
+  addError(error: Omit<ParseError$1, 'type'> & {
+    type: ParseErrorType;
+  }): void;
+  addWarning(warning: Omit<ParseError$1, 'type'> & {
+    type: ParseErrorType;
+  }): void;
+  clear(): void;
+  getErrors(): ParseError$1[];
+  getWarnings(): ParseError$1[];
+  hasErrors(): boolean;
+  hasWarnings(): boolean;
+}
+//#endregion
 //#region src/types/parse.d.ts
+/**
+ * Parser options accepted by direct and ESLint parse entry points.
+ */
 interface Options {
   comment?: boolean;
   /**
@@ -385,83 +507,190 @@ interface Options {
 interface ParseForESLintResult {
   ast: Program;
   scopeManager: any;
+  visitorKeys: SourceCode.VisitorKeys;
   services: {
+    errors: ParseError$1[];
     isSVG: boolean;
+    warnings: ParseError$1[];
   };
-  visitorKeys: SourceCode.VisitorKeys;
 }
+/**
+ * Result returned by the direct parser entry point.
+ */
 interface ParseResult {
   ast: DocumentNode;
+  errors: ParseError$1[];
   tokens: AnyToken[];
+  warnings: ParseError$1[];
 }
 //#endregion
 //#region src/types/contextualNode.d.ts
+/**
+ * Union of AST nodes while they are still being constructed.
+ */
 type AnyContextualNode = ContextualAttributeNode | ContextualCommentNode | ContextualDoctypeAttributeNode | ContextualDoctypeNode | ContextualDocumentNode | ContextualElementNode | ContextualXMLDeclarationAttributeNode | ContextualXMLDeclarationNode;
+/**
+ * Attribute node with key/value filled as tokens are consumed.
+ */
 type ContextualAttributeNode = ContextualNode<AttributeNode, 'key' | 'value'>;
-type ContextualCommentNode = ContextualNode<CommentNode, 'content'>;
+/**
+ * Comment node before comment content has been finalized.
+ */
+type ContextualCommentNode = ContextualNode<CommentNode, 'content' | 'value'>;
+/**
+ * Doctype attribute node before value has been finalized.
+ */
 type ContextualDoctypeAttributeNode = ContextualNode<DoctypeAttributeNode, 'type' | 'value'>;
+/**
+ * Doctype node while its attributes are being collected.
+ */
 type ContextualDoctypeNode = ContextualNode<DoctypeNode, 'attributes'> & {
   attributes: ContextualDoctypeAttributeNode[];
 };
+/**
+ * Document root while child nodes are being attached.
+ */
 type ContextualDocumentNode = Omit<ContextualNode<DocumentNode, never>, 'children'> & {
-  children: Array<DocumentNode['children'][number] | ContextualCommentNode | ContextualDoctypeNode | ContextualElementNode | ContextualXMLDeclarationNode>;
+  children: Array<ContextualCommentNode | ContextualDoctypeNode | ContextualElementNode | ContextualXMLDeclarationNode | DocumentNode['children'][number]>;
 };
+/**
+ * Construction-time node with selected fields allowed to be incomplete.
+ */
 type ContextualNode<T extends AnyNode, K extends keyof T> = PartialBy<T, K> & {
   parentRef?: any;
 };
+/**
+ * Element node while name, attributes, and children are being collected.
+ */
 type ContextualElementNode = ContextualNode<ElementNode, 'attributes' | 'children' | 'name' | 'selfClosing'> & {
   attributes: ContextualAttributeNode[];
   children: Array<ContextualCommentNode | ContextualElementNode | ElementNode['children'][number]>;
 };
-/** @deprecated Use ContextualElementNode instead. */
-type ContextualTagNode = ContextualElementNode;
+/**
+ * XML declaration attribute node before key/value are finalized.
+ */
 type ContextualXMLDeclarationAttributeNode = ContextualNode<XMLDeclarationAttributeNode, 'key' | 'value'>;
+/**
+ * XML declaration node while attributes are being collected.
+ */
 type ContextualXMLDeclarationNode = ContextualNode<XMLDeclarationNode, 'attributes'> & {
   attributes: ContextualXMLDeclarationAttributeNode[];
 };
+/**
+ * Make selected keys optional while leaving the rest of a type intact.
+ */
 type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 //#endregion
 //#region src/tokenizer/chars.d.ts
+/**
+ * Buffered source characters with their source range.
+ */
 declare class Chars {
   value: string;
   range: Range;
   constructor(value: string, range: Range);
-  concat(chars: Chars): void;
+  /**
+   * Append adjacent characters into this range.
+   */
+  append(chars: Chars): void;
+  /**
+   * Compare the buffered value with raw text.
+   */
   equals(chars: string): boolean;
+  /**
+   * Get the buffered string length.
+   */
   length(): number;
 }
 //#endregion
 //#region src/tokenizer/charsBuffer.d.ts
+/**
+ * Mutable buffer used by tokenizer handlers while deciding token boundaries.
+ */
 declare class CharsBuffer {
   charsBuffer: Chars[];
+  /**
+   * Append a character wrapper to the buffer.
+   */
   concat(chars: Chars): void;
+  /**
+   * Append another buffer without merging its entries.
+   */
   concatBuffer(buffer: CharsBuffer): void;
+  /**
+   * Get the total buffered character length.
+   */
   length(): number;
+  /**
+   * Clear all buffered characters.
+   */
   clear(): void;
+  /**
+   * Get the concatenated buffered string.
+   */
   value(): string;
+  /**
+   * Get the last buffered character wrapper.
+   */
   last(): Chars;
+  /**
+   * Get the first buffered character wrapper.
+   */
   first(): Chars;
+  /**
+   * Remove the last buffered entry.
+   */
   removeLast(): void;
+  /**
+   * Remove the first buffered entry.
+   */
   removeFirst(): void;
+  /**
+   * Replace this buffer with a copy of another buffer.
+   */
   replace(other: CharsBuffer): void;
 }
 //#endregion
 //#region src/tokenizer/sourceCode.d.ts
+/**
+ * Cursor-based view over source text for tokenizer handlers.
+ */
 declare class SourceCode$1 {
   readonly source: string;
   private charsList;
   private charsIndex;
   constructor(source: string);
+  /**
+   * Convert a character range to source locations.
+   */
   getLocationOf(range: Range): SourceLocation;
+  /**
+   * Get the current character wrapper.
+   */
   current(): Chars;
+  /**
+   * Advance to the next character.
+   */
   next(): void;
+  /**
+   * Move back to the previous character.
+   */
   prev(): void;
+  /**
+   * Check whether the cursor has reached the end of source.
+   */
   isEof(): boolean;
+  /**
+   * Get the current zero-based character index.
+   */
   index(): number;
   private createCharsList;
 }
 //#endregion
 //#region src/types/tokenizerState.d.ts
+/**
+ * Mutable state shared by tokenizer handlers.
+ */
 type TokenizerState = {
   accumulatedContent: CharsBuffer;
   contextParams: ContextParams;
@@ -491,9 +720,13 @@ type ContextParams = {
 };
 //#endregion
 //#region src/types/constructTreeState.d.ts
+/**
+ * Mutable state shared by AST construction handlers.
+ */
 type ConstructTreeState<Node extends AnyContextualNode> = {
   caretPosition: number;
   currentNode: Node;
+  errorHandler: ErrorContext;
   rootNode: DocumentNode;
   currentContext: {
     type: ConstructTreeContextTypes;
@@ -503,20 +736,32 @@ type ConstructTreeState<Node extends AnyContextualNode> = {
 };
 //#endregion
 //#region src/types/constructTreeHandler.d.ts
+/**
+ * Constructor handler for a single AST construction context.
+ */
 interface ConstructTreeHandler {
   construct: (token: AnyToken, state: ConstructTreeState<any>) => ConstructTreeState<any>;
 }
 //#endregion
 //#region src/types/tokenizerContextHandler.d.ts
+/**
+ * Tokenizer handler for a single tokenizer context.
+ */
 interface TokenizeHandler {
   parse: (chars: CharsBuffer, state: TokenizerState) => void;
   handleContentEnd?: (state: TokenizerState) => void;
 }
 declare namespace index_d_exports {
-  export { AnyContextualNode, AnyNode, AnyToken, AttributeKeyNode, AttributeNode, AttributeValueNode, BaseNode, CommentNode, ConstructTreeHandler, ConstructTreeState, ContextualAttributeNode, ContextualCommentNode, ContextualDoctypeAttributeNode, ContextualDoctypeNode, ContextualDocumentNode, ContextualElementNode, ContextualNode, ContextualTagNode, ContextualXMLDeclarationAttributeNode, ContextualXMLDeclarationNode, DoctypeAttributeNode, DoctypeAttributeValueNode, DoctypeNode, DocumentChildNode, DocumentNode, ESLintComment, ElementChildNode, ElementNode, ErrorNode, Locations, Options, ParseForESLintResult, ParseResult, PartialBy, Position, Program, Range, SimpleNode, SourceLocation, TagNode, TextNode, Token, TokenizeHandler, TokenizerState, XMLDeclarationAttributeKeyNode, XMLDeclarationAttributeNode, XMLDeclarationAttributeValueNode, XMLDeclarationNode };
+  export { AnyContextualNode, AnyNode, AnyToken, AttributeKeyNode, AttributeNode, AttributeValueNode, BaseNode, CommentNode, ConstructTreeHandler, ConstructTreeState, ContextualAttributeNode, ContextualCommentNode, ContextualDoctypeAttributeNode, ContextualDoctypeNode, ContextualDocumentNode, ContextualElementNode, ContextualNode, ContextualXMLDeclarationAttributeNode, ContextualXMLDeclarationNode, DoctypeAttributeNode, DoctypeAttributeValueNode, DoctypeNode, DocumentChildNode, DocumentNode, ESLintComment, ElementChildNode, ElementNode, ErrorContext, ErrorNode, Locations, Options, ParseError$1 as ParseError, ParseErrorType, ParseForESLintResult, ParseResult, PartialBy, Position, Program, Range, SimpleNode, SourceLocation, TextNode, Token, TokenizeHandler, TokenizerState, XMLDeclarationAttributeKeyNode, XMLDeclarationAttributeNode, XMLDeclarationAttributeValueNode, XMLDeclarationNode };
 }
 //#endregion
 //#region src/parser/parseForESLint.d.ts
+/**
+ * Parse SVG source into an ESLint-compatible parser result.
+ * @param source - SVG source code
+ * @param options - Parser options forwarded to the base parser
+ * @returns ESLint parser result with visitor keys, services, tokens, and comments
+ */
 declare function parseForESLint(source: string, options?: Options): ParseForESLintResult;
 //#endregion
 //#region src/utils/cloneNode.d.ts
@@ -629,8 +874,20 @@ declare function findNodeByType<T extends NodeTypes>(node: AnyNode, type: T): An
 declare function findFirstNodeByType<T extends NodeTypes>(node: AnyNode, type: T): AnyNode | undefined;
 //#endregion
 //#region src/index.d.ts
+/**
+ * Parser package name.
+ */
 declare const name: string;
-declare const VisitorKeys: _$eslint.SourceCode.VisitorKeys;
+/**
+ * ESLint visitor keys for parser-specific nodes.
+ */
+declare const VisitorKeys: import("eslint").SourceCode.VisitorKeys;
+/**
+ * Parse SVG source and return the document node directly.
+ * @param code - SVG source code
+ * @param options - Parser options
+ * @returns Parsed SVG document node
+ */
 declare function parse(code: string, options?: Options): DocumentNode;
 //#endregion
-export { type index_d_exports as AST, type ASTVisitor, AnyContextualNode, AnyNode, AnyToken, AttributeKeyNode, AttributeNode, AttributeValueNode, BaseNode, COMMENT_END, COMMENT_START, CommentNode, ConstructTreeContextTypes, ConstructTreeHandler, ConstructTreeState, ContextualAttributeNode, ContextualCommentNode, ContextualDoctypeAttributeNode, ContextualDoctypeNode, ContextualDocumentNode, ContextualElementNode, ContextualNode, ContextualTagNode, ContextualXMLDeclarationAttributeNode, ContextualXMLDeclarationNode, DEPRECATED_SVG_ELEMENTS, DoctypeAttributeNode, DoctypeAttributeValueNode, DoctypeNode, DocumentChildNode, DocumentNode, ESLintComment, ElementChildNode, ElementNode, ErrorNode, Locations, NodeTypes, Options, ParseError, ParseForESLintResult, ParseResult, PartialBy, Position, Program, RE_CLOSE_TAG_NAME, RE_INCOMPLETE_CLOSING_TAG, RE_OPEN_TAG_NAME, RE_OPEN_TAG_START, Range, SELF_CLOSING_ELEMENTS, SPECIAL_CHAR, SVG_ELEMENTS, SimpleNode, SourceLocation, TagNode, TextNode, Token, TokenTypes, TokenizeHandler, TokenizerContextTypes, TokenizerState, VisitorKeys, XMLDeclarationAttributeKeyNode, XMLDeclarationAttributeNode, XMLDeclarationAttributeValueNode, XMLDeclarationNode, XML_DECLARATION_END, XML_DECLARATION_START, cloneNode, cloneNodeWithParent, countNodes, filterNodes, findFirstNodeByType, findNodeByType, getNodeDepth, getParentChain, isNodeType, mapNodes, meta, name, parse, parseForESLint, traverseAST, validateNode, walkAST };
+export { type index_d_exports as AST, type ASTVisitor, AnyContextualNode, AnyNode, AnyToken, AttributeKeyNode, AttributeNode, AttributeValueNode, BaseNode, COMMENT_END, COMMENT_START, CommentNode, ConstructTreeContextTypes, ConstructTreeHandler, ConstructTreeState, ContextualAttributeNode, ContextualCommentNode, ContextualDoctypeAttributeNode, ContextualDoctypeNode, ContextualDocumentNode, ContextualElementNode, ContextualNode, ContextualXMLDeclarationAttributeNode, ContextualXMLDeclarationNode, DEPRECATED_SVG_ELEMENTS, DoctypeAttributeNode, DoctypeAttributeValueNode, DoctypeNode, DocumentChildNode, DocumentNode, ESLintComment, ElementChildNode, ElementNode, ErrorContext, ErrorNode, Locations, NodeTypes, Options, ParseError, ParseErrorType, ParseForESLintResult, ParseResult, PartialBy, Position, Program, RE_CLOSE_TAG_NAME, RE_INCOMPLETE_CLOSING_TAG, RE_OPEN_TAG_NAME, RE_OPEN_TAG_START, Range, SELF_CLOSING_ELEMENTS, SPECIAL_CHAR, SVG_ELEMENTS, SimpleNode, SourceLocation, TextNode, Token, TokenTypes, TokenizeHandler, TokenizerContextTypes, TokenizerState, VisitorKeys, XMLDeclarationAttributeKeyNode, XMLDeclarationAttributeNode, XMLDeclarationAttributeValueNode, XMLDeclarationNode, XML_DECLARATION_END, XML_DECLARATION_START, cloneNode, cloneNodeWithParent, countNodes, filterNodes, findFirstNodeByType, findNodeByType, getNodeDepth, getParentChain, isNodeType, mapNodes, meta, name, parse, parseForESLint, traverseAST, validateNode, walkAST };