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?: Options,
): {
  ast: Program
  visitorKeys: VisitorKeys
  services: {
    errors: ParseError[]
    isSVG: true
    warnings: ParseError[]
  }
  scopeManager: null
}

Parsing is strict by default. Invalid SVG throws a positioned ParseError, so ESLint reports it as a parsing error. Pass { errorRecovery: true } to receive the recovered AST and inspect services.errors instead.

Well-formedness validation covers the document root, top-level content, XML declaration and DOCTYPE placement, XML names, comments, processing instructions, and element attributes. Recovery mode preserves invalid constructs in the AST where possible and reports each issue with its source range.

Example:

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

const result = parseForESLint('<svg><circle /></svg>')
console.log(result.ast) // Program node with `document`
console.log(result.services.errors) // Recoverable parser diagnostics

Incomplete tags, comments, declarations, and quoted values are preserved when possible and reported through services.errors with source ranges.

parse()

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

function parse(code: string, options?: Options): 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,
  Program,
  DocumentNode,
  ElementNode,
  AttributeNode,
  TextNode,
  CommentNode,
  // ... and more

  // Utility types
  ASTVisitor,
  SourceLocation,
  Range,

  // ESLint rule-author types
  SVGNodeMap,
  SVGParserServices,
  SVGRuleContext,
  SVGRuleListener,
  SVGRuleModule,
  SVGRuleNodeMap,
  SVGSourceCode,
} from 'svg-eslint-parser'

Use defineSVGRule() to contextually type SVG listeners while returning an ESLint-compatible rule module:

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

export default defineSVGRule({
  create(context) {
    return {
      Element(node) {
        // ElementNode, including the ESLint-added parent link
        if (node.name === 'circle') {
          context.report({ node, message: 'Found a circle' })
        }
      },
    }
  },
})