API

Parser

The main parser API is exposed through two functions:

parseForESLint()

The primary entry point for ESLint integration. Returns an object with the AST, visitor keys, and other metadata.

function parseForESLint(
  code: string,
  options?: ParserOptions,
): {
  ast: Program
  visitorKeys: VisitorKeys
  services: { isSVG: true }
  scopeManager: null
}

Example:

import { parseForESLint } from 'svg-eslint-parser'

const result = parseForESLint('<svg><circle /></svg>')
console.log(result.ast) // Program node with Document in body

parse()

Simple parsing function that returns the Document node directly (without ESLint wrapping).

function parse(code: string, options?: ParserOptions): DocumentNode

Example:

import { parse } from 'svg-eslint-parser'

const document = parse('<svg><circle /></svg>')
console.log(document.type) // 'Document'

AST

See AST Structure for detailed information about the AST node types.

Utilities

See Utilities for helper functions to work with the AST.

Types

All TypeScript types are exported from the main entry point:

import type {
  // Node types
  AnyNode,
  ProgramNode,
  DocumentNode,
  TagNode,
  AttributeNode,
  TextNode,
  CommentNode,
  // ... and more

  // Utility types
  ASTVisitor,
  SourceLocation,
  Range,
} from 'svg-eslint-parser'