⬅️ Back to Table of Contents

📄 Parser.ts

📊 Analysis Summary

Metric	Count
📦 Imports	4
📐 Interfaces	3
📑 Type Aliases	2

📚 Table of Contents

• Imports
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/utils/src/ts-eslint/Parser.ts

📦 Imports

Name	Source
ParserServices	../ts-estree
TSESTree	../ts-estree
ParserOptions	./ParserOptions
Scope	./Scope

---

Interfaces

ParserMeta

Interface Code

export interface ParserMeta {
    /**
     * The unique name of the parser.
     */
    name: string;
    /**
     * The a string identifying the version of the parser.
     */
    version?: string;
  }

Properties

Name	Type	Optional	Description
name	string	✗
version	string	✓

ParseResult

Interface Code

export interface ParseResult {
    /**
     * The ESTree AST
     */
    ast: TSESTree.Program;
    /**
     * A `ScopeManager` object.
     * Custom parsers can use customized scope analysis for experimental/enhancement syntaxes.
     * The default is the `ScopeManager` object which is created by `eslint-scope`.
     */
    scopeManager?: Scope.ScopeManager;
    /**
     * Any parser-dependent services (such as type checkers for nodes).
     * The value of the services property is available to rules as `context.sourceCode.parserServices`.
     * The default is an empty object.
     */
    services?: ParserServices;
    /**
     * An object to customize AST traversal.
     * The keys of the object are the type of AST nodes.
     * Each value is an array of the property names which should be traversed.
     * The default is `KEYS` of `eslint-visitor-keys`.
     */
    visitorKeys?: VisitorKeys;
  }

Properties

Name	Type	Optional	Description
ast	TSESTree.Program	✗
scopeManager	Scope.ScopeManager	✓
services	ParserServices	✓
visitorKeys	VisitorKeys	✓

VisitorKeys

Interface Code

export interface VisitorKeys {
    [nodeType: string]: readonly string[];
  }

---

Type Aliases

LooseParserModule

/* * A loose definition of the ParserModule type for use with configs * This type intended to relax validation of configs so that parsers that have * different AST types or scope managers can still be passed to configs * * @see {@link LooseRuleDefinition}, {@link LooseProcessorModule} /

type LooseParserModule = | {
        /**
         * Information about the parser to uniquely identify it when serializing.
         */
        meta?: { [K in keyof ParserMeta]?: ParserMeta[K] | undefined };
        /**
         * Parses the given text into an AST
         */
        parseForESLint(
          text: string,
          options?: unknown,
        ): {
          // intentionally not using a Record to preserve optionals
          [k in keyof ParseResult]: unknown;
        };
      }
    | {
        /**
         * Information about the parser to uniquely identify it when serializing.
         */
        meta?: { [K in keyof ParserMeta]?: ParserMeta[K] | undefined };
        /**
         * Parses the given text into an ESTree AST
         */
        parse(text: string, options?: unknown): unknown;
      };

ParserModule

type ParserModule = | {
        /**
         * Information about the parser to uniquely identify it when serializing.
         */
        meta?: ParserMeta;
        /**
         * Parses the given text into an AST
         */
        parseForESLint(text: string, options?: ParserOptions): ParseResult;
      }
    | {
        /**
         * Information about the parser to uniquely identify it when serializing.
         */
        meta?: ParserMeta;
        /**
         * Parses the given text into an ESTree AST
         */
        parse(text: string, options?: ParserOptions): TSESTree.Program;
      };

---