svg-eslint-parser 0.0.6 → 0.1.0

package/README.md

@@ -85,10 +85,10 @@ import {
 } from 'svg-eslint-parser'
 
 const { ast } = parseForESLint(svgSource)
-const document = ast.body[0]
+const document = ast.document
 
 // Find all tag nodes
-const tags = findNodeByType(document, NodeTypes.Tag)
+const tags = findNodeByType(document, NodeTypes.Element)
 console.log(`Found ${tags.length} tags`)
 
 // Traverse with visitor pattern
@@ -145,22 +145,18 @@ Returns a Document node directly.
 
 ### Node Types
 
-The parser defines 34 node types:
+The parser currently exposes 16 AST node types:
 
-**Document Structure**: `Program`, `Document`
+**Program & Document**: `Program`, `Document`
 
-**Elements**: `Tag`, `OpenTagStart`, `OpenTagEnd`, `CloseTag`
+**Element Tree**: `Element`, `Attribute`, `AttributeKey`, `AttributeValue`, `Text`, `Comment`
 
-**Attributes**: `Attribute`, `AttributeKey`, `AttributeValue`, `AttributeValueWrapperStart`, `AttributeValueWrapperEnd`
-
-**Text & Comments**: `Text`, `Comment`, `CommentOpen`, `CommentContent`, `CommentClose`
-
-**XML Declaration**: `XMLDeclaration`, `XMLDeclarationOpen`, `XMLDeclarationClose`, `XMLDeclarationAttribute`, `XMLDeclarationAttributeKey`, `XMLDeclarationAttributeValue`, `XMLDeclarationAttributeValueWrapperStart`, `XMLDeclarationAttributeValueWrapperEnd`
-
-**DOCTYPE**: `Doctype`, `DoctypeOpen`, `DoctypeClose`, `DoctypeAttribute`, `DoctypeAttributeValue`, `DoctypeAttributeWrapperStart`, `DoctypeAttributeWrapperEnd`
+**Declarations**: `Doctype`, `DoctypeAttribute`, `DoctypeAttributeValue`, `XMLDeclaration`, `XMLDeclarationAttribute`, `XMLDeclarationAttributeKey`, `XMLDeclarationAttributeValue`
 
 **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):
@@ -190,10 +186,10 @@ const svgCode = `
 `
 
 const { ast } = parseForESLint(svgCode)
-const document = ast.body[0]
+const document = ast.document
 
 // Find all tags and filter for circles
-const allTags = findNodeByType(document, NodeTypes.Tag)
+const allTags = findNodeByType(document, NodeTypes.Element)
 const circles = allTags.filter(tag => tag.name === 'circle')
 
 console.log(`Found ${circles.length} circles`)

package/dist/chunk-pbuEa-1d.js

@@ -0,0 +1,13 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+export { __exportAll as t };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import * as eslint0 from "eslint";
+import * as _$eslint from "eslint";
 import { SourceCode } from "eslint";
 
 //#region src/meta.d.ts
@@ -66,9 +66,11 @@ declare enum NodeTypes {
   DoctypeAttribute = "DoctypeAttribute",
   DoctypeAttributeValue = "DoctypeAttributeValue",
   Document = "Document",
+  Element = "Element",
   Error = "Error",
   Program = "Program",
-  Tag = "Tag",
+  /** @deprecated Use Element instead. */
+  Tag = "Element",
   Text = "Text",
   XMLDeclaration = "XMLDeclaration",
   XMLDeclarationAttribute = "XMLDeclarationAttribute",
@@ -258,6 +260,10 @@ interface SimpleNode<T extends NodeTypes> extends BaseNode {
   value: string;
 }
 type TextNode = SimpleNode<NodeTypes.Text>;
+interface ESLintComment extends Locations {
+  type: 'Block' | 'Line';
+  value: string;
+}
 /**
  * attribute nodes
  * @pg
@@ -267,7 +273,7 @@ type AttributeValueNode = SimpleNode<NodeTypes.AttributeValue>;
 interface AttributeNode extends BaseNode {
   key: AttributeKeyNode;
   type: NodeTypes.Attribute;
-  value: AttributeValueNode;
+  value?: AttributeValueNode;
   quoteChar?: '"' | "'" | undefined;
 }
 /**
@@ -293,16 +299,18 @@ interface DoctypeNode extends BaseNode {
   type: NodeTypes.Doctype;
 }
 /**
- * tag nodes
+ * element nodes
  * @pg
  */
-interface TagNode extends BaseNode {
+interface ElementNode extends BaseNode {
   attributes: AttributeNode[];
-  children: NestableNode[];
+  children: ElementChildNode[];
   name: string;
   selfClosing: boolean;
-  type: NodeTypes.Tag;
+  type: NodeTypes.Element;
 }
+/** @deprecated Use ElementNode instead. */
+type TagNode = ElementNode;
 /**
  * XML declaration nodes
  */
@@ -311,7 +319,7 @@ type XMLDeclarationAttributeValueNode = SimpleNode<NodeTypes.XMLDeclarationAttri
 interface XMLDeclarationAttributeNode extends BaseNode {
   key: XMLDeclarationAttributeKeyNode;
   type: NodeTypes.XMLDeclarationAttribute;
-  value: XMLDeclarationAttributeValueNode;
+  value?: XMLDeclarationAttributeValueNode;
   quoteChar?: '"' | "'" | undefined;
 }
 interface XMLDeclarationNode extends BaseNode {
@@ -329,29 +337,31 @@ interface ErrorNode extends BaseNode {
   recoveredNode?: AnyNode;
 }
 /**
- * nestable node
+ * child node
  * @pg
  */
-type NestableNode = CommentNode | DoctypeNode | TagNode | TextNode | XMLDeclarationNode;
+type DocumentChildNode = XMLDeclarationNode | DoctypeNode | ElementNode | CommentNode | TextNode;
+type ElementChildNode = ElementNode | CommentNode | TextNode;
 /**
  * program
  * @pg
  */
 interface Program extends BaseNode {
-  body: DocumentNode[];
-  comments: string[];
+  body: [];
+  comments: ESLintComment[];
+  document: DocumentNode;
   tokens: AnyToken[];
   type: NodeTypes.Program;
 }
 interface DocumentNode extends BaseNode {
-  children: NestableNode[];
+  children: DocumentChildNode[];
   type: NodeTypes.Document;
 }
 /**
  * any node
  * @pg
  */
-type AnyNode = AttributeKeyNode | AttributeNode | AttributeValueNode | CommentNode | DoctypeAttributeNode | DoctypeAttributeValueNode | DoctypeNode | DocumentNode | ErrorNode | Program | TagNode | TextNode | XMLDeclarationAttributeKeyNode | XMLDeclarationAttributeNode | XMLDeclarationAttributeValueNode | XMLDeclarationNode;
+type AnyNode = AttributeKeyNode | AttributeNode | AttributeValueNode | CommentNode | DoctypeAttributeNode | DoctypeAttributeValueNode | DoctypeNode | DocumentNode | ElementNode | ErrorNode | Program | TextNode | XMLDeclarationAttributeKeyNode | XMLDeclarationAttributeNode | XMLDeclarationAttributeValueNode | XMLDeclarationNode;
 //#endregion
 //#region src/types/parse.d.ts
 interface Options {
@@ -386,7 +396,7 @@ interface ParseResult {
 }
 //#endregion
 //#region src/types/contextualNode.d.ts
-type AnyContextualNode = ContextualAttributeNode | ContextualCommentNode | ContextualDoctypeAttributeNode | ContextualDoctypeNode | ContextualDocumentNode | ContextualTagNode | ContextualXMLDeclarationAttributeNode | ContextualXMLDeclarationNode;
+type AnyContextualNode = ContextualAttributeNode | ContextualCommentNode | ContextualDoctypeAttributeNode | ContextualDoctypeNode | ContextualDocumentNode | ContextualElementNode | ContextualXMLDeclarationAttributeNode | ContextualXMLDeclarationNode;
 type ContextualAttributeNode = ContextualNode<AttributeNode, 'key' | 'value'>;
 type ContextualCommentNode = ContextualNode<CommentNode, 'content'>;
 type ContextualDoctypeAttributeNode = ContextualNode<DoctypeAttributeNode, 'type' | 'value'>;
@@ -394,15 +404,17 @@ type ContextualDoctypeNode = ContextualNode<DoctypeNode, 'attributes'> & {
   attributes: ContextualDoctypeAttributeNode[];
 };
 type ContextualDocumentNode = Omit<ContextualNode<DocumentNode, never>, 'children'> & {
-  children: Array<DocumentNode['children'][number] | Exclude<AnyContextualNode, ContextualDoctypeNode>>;
+  children: Array<DocumentNode['children'][number] | ContextualCommentNode | ContextualDoctypeNode | ContextualElementNode | ContextualXMLDeclarationNode>;
 };
 type ContextualNode<T extends AnyNode, K extends keyof T> = PartialBy<T, K> & {
   parentRef?: any;
 };
-type ContextualTagNode = ContextualNode<TagNode, 'attributes' | 'children' | 'name' | 'selfClosing'> & {
+type ContextualElementNode = ContextualNode<ElementNode, 'attributes' | 'children' | 'name' | 'selfClosing'> & {
   attributes: ContextualAttributeNode[];
-  children: Array<ContextualCommentNode | ContextualDoctypeNode | ContextualTagNode | TagNode['children'][number]>;
+  children: Array<ContextualCommentNode | ContextualElementNode | ElementNode['children'][number]>;
 };
+/** @deprecated Use ContextualElementNode instead. */
+type ContextualTagNode = ContextualElementNode;
 type ContextualXMLDeclarationAttributeNode = ContextualNode<XMLDeclarationAttributeNode, 'key' | 'value'>;
 type ContextualXMLDeclarationNode = ContextualNode<XMLDeclarationNode, 'attributes'> & {
   attributes: ContextualXMLDeclarationAttributeNode[];
@@ -479,9 +491,9 @@ type ContextParams = {
 };
 //#endregion
 //#region src/types/constructTreeState.d.ts
-type ConstructTreeState<N extends AnyContextualNode> = {
+type ConstructTreeState<Node extends AnyContextualNode> = {
   caretPosition: number;
-  currentNode: N;
+  currentNode: Node;
   rootNode: DocumentNode;
   currentContext: {
     type: ConstructTreeContextTypes;
@@ -501,7 +513,7 @@ interface TokenizeHandler {
   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, ContextualNode, ContextualTagNode, ContextualXMLDeclarationAttributeNode, ContextualXMLDeclarationNode, DoctypeAttributeNode, DoctypeAttributeValueNode, DoctypeNode, DocumentNode, ErrorNode, Locations, NestableNode, 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, 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 };
 }
 //#endregion
 //#region src/parser/parseForESLint.d.ts
@@ -618,7 +630,7 @@ declare function findFirstNodeByType<T extends NodeTypes>(node: AnyNode, type: T
 //#endregion
 //#region src/index.d.ts
 declare const name: string;
-declare const VisitorKeys: eslint0.SourceCode.VisitorKeys;
-declare function parse(code: string, options?: Options): Program;
+declare const VisitorKeys: _$eslint.SourceCode.VisitorKeys;
+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, ContextualNode, ContextualTagNode, ContextualXMLDeclarationAttributeNode, ContextualXMLDeclarationNode, DEPRECATED_SVG_ELEMENTS, DoctypeAttributeNode, DoctypeAttributeValueNode, DoctypeNode, DocumentNode, ErrorNode, Locations, NestableNode, 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, 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 };