22186324748

Committed 19 Feb 2026 02:40PM UTC coverage: 71.032% (-2.3%) from 73.311%

Build # 22186324748

Build Type

push

github

Committed by

web-flow

Commit Message

Add ESLint language plugin support to eslint-plugin-jsonc (#471)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ota-meshi <16508807+ota-meshi@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Yosuke Ota <otameshiyo23@gmail.com>

Run Details

1029 of 1276 branches covered (80.64%)

Branch coverage included in aggregate %.

580 of 1177 new or added lines in 10 files covered. (49.28%)

2 existing lines in 1 file now uncovered.

7448 of 10658 relevant lines covered (69.88%)

77.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

44.7

/lib/language/jsonc-source-code.ts

/**
 * @fileoverview The JSONCSourceCode class.
 */

import { traverseNodes, VisitorKeys } from "jsonc-eslint-parser";
import type { AST } from "jsonc-eslint-parser";
import type {
  TraversalStep,
  IDirective as Directive,
} from "@eslint/plugin-kit";
import {
  TextSourceCodeBase,
  CallMethodStep,
  VisitNodeStep,
  ConfigCommentParser,
  Directive as DirectiveImpl,
} from "@eslint/plugin-kit";
import type { DirectiveType, FileProblem, RulesConfig } from "@eslint/core";
import {
  TokenStore,
  type CursorWithSkipOptionsWithoutFilter,
  type CursorWithSkipOptionsWithFilter,
  type CursorWithSkipOptionsWithComment,
  type CursorWithCountOptionsWithoutFilter,
  type CursorWithCountOptionsWithFilter,
  type CursorWithCountOptionsWithComment,
} from "@ota-meshi/ast-token-store";
import type { AST as ESLintAST } from "eslint";
import type { Scope } from "eslint";
import type { Comment } from "estree";

//-----------------------------------------------------------------------------
// Helpers
//-----------------------------------------------------------------------------

const commentParser = new ConfigCommentParser();

/**
 * Pattern to match ESLint inline configuration comments in JSONC.
 * Matches: eslint, eslint-disable, eslint-enable, eslint-disable-line, eslint-disable-next-line
 */
const INLINE_CONFIG =
  /^\s*eslint(?:-enable|-disable(?:(?:-next)?-line)?)?(?:\s|$)/u;

//-----------------------------------------------------------------------------
// Types
//-----------------------------------------------------------------------------

/**
 * A comment token with required range and loc.
 */
export type JSONCComment = Comment & {
  range: [number, number];
  loc: AST.SourceLocation;
};

/**
 * JSONC-specific syntax element type
 */
export type JSONCSyntaxElement = AST.JSONNode | ESLintAST.Token | JSONCComment;
export type JSONCToken = ESLintAST.Token | JSONCComment;

/**
 * JSONC Source Code Object
 */
export class JSONCSourceCode extends TextSourceCodeBase<{
  LangOptions: Record<never, never>;
  RootNode: AST.JSONProgram;
  SyntaxElementWithLoc: JSONCSyntaxElement;
  ConfigNode: JSONCComment;
}> {
  public readonly hasBOM: boolean;

  public readonly parserServices: { isJSON?: boolean; parseError?: unknown };

  public readonly visitorKeys: Record<string, string[]>;

  private readonly tokenStore: TokenStore<
    AST.JSONNode,
    ESLintAST.Token,
    JSONCComment
  >;

  #steps: TraversalStep[] | null = null;

  #cacheTokensAndComments: (ESLintAST.Token | JSONCComment)[] | null = null;

  #inlineConfigComments: JSONCComment[] | null = null;

  /**
   * Creates a new instance.
   */
  public constructor(config: {
    text: string;
    ast: AST.JSONProgram;
    hasBOM: boolean;
    parserServices: { isJSON: boolean; parseError?: unknown };
    visitorKeys?: Record<string, string[]> | null | undefined;
  }) {
    super({
      ast: config.ast,
      text: config.text,
    });
    this.hasBOM = Boolean(config.hasBOM);
    this.parserServices = config.parserServices;
    this.visitorKeys = config.visitorKeys || VisitorKeys;
    this.tokenStore = new TokenStore<
      AST.JSONNode,
      ESLintAST.Token,
      JSONCComment
    >({
      tokens: [
        ...(config.ast.tokens as (ESLintAST.Token | JSONCComment)[]),
        ...(config.ast.comments as JSONCComment[]),
      ],
      isComment: (token): token is JSONCComment =>
        token.type === "Block" || token.type === "Line",
    });
  }

  public traverse(): Iterable<TraversalStep> {
    if (this.#steps != null) {
      return this.#steps;
    }

    const steps: (VisitNodeStep | CallMethodStep)[] = [];
    this.#steps = steps;

    const root = this.ast;
    steps.push(
      // ESLint core rule compatibility: onCodePathStart is called with two arguments.
      new CallMethodStep({
        target: "onCodePathStart",
        args: [{}, root],
      }),
    );

    traverseNodes(root, {
      enterNode(n) {
        steps.push(
          new VisitNodeStep({
            target: n,
            phase: 1,
            args: [n],
          }),
        );
      },
      leaveNode(n) {
        steps.push(
          new VisitNodeStep({
            target: n,
            phase: 2,
            args: [n],
          }),
        );
      },
    });

    steps.push(
      // ESLint core rule compatibility: onCodePathEnd is called with two arguments.
      new CallMethodStep({
        target: "onCodePathEnd",
        args: [{}, root],
      }),
    );
    return steps;
  }

  /**
   * Gets all tokens and comments.
   */
  public get tokensAndComments(): JSONCToken[] {
    return (this.#cacheTokensAndComments ??= [
      ...this.ast.tokens,
      ...(this.ast.comments as JSONCComment[]),
    ].sort((a, b) => a.range[0] - b.range[0]));
  }

  public getLines(): string[] {
    return this.lines;
  }

  public getAllComments(): JSONCComment[] {
    return this.tokenStore.getAllComments();
  }

  /**
   * Returns an array of all inline configuration nodes found in the source code.
   * This includes eslint-disable, eslint-enable, eslint-disable-line,
   * eslint-disable-next-line, and eslint (for inline config) comments.
   */
  public getInlineConfigNodes(): JSONCComment[] {
    if (!this.#inlineConfigComments) {
      this.#inlineConfigComments = (this.ast.comments as JSONCComment[]).filter(
        (comment) => INLINE_CONFIG.test(comment.value),
      );
    }

    return this.#inlineConfigComments;
  }

  /**
   * Returns directives that enable or disable rules along with any problems
   * encountered while parsing the directives.
   */
  public getDisableDirectives(): {
    directives: Directive[];
    problems: FileProblem[];
  } {
    const problems: FileProblem[] = [];
    const directives: Directive[] = [];

    this.getInlineConfigNodes().forEach((comment) => {
      const directive = commentParser.parseDirective(comment.value);

      if (!directive) {
        return;
      }

      const { label, value, justification } = directive;

      // `eslint-disable-line` directives are not allowed to span multiple lines
      // as it would be confusing to which lines they apply
      if (
        label === "eslint-disable-line" &&
        comment.loc.start.line !== comment.loc.end.line
      ) {
        const message = `${label} comment should not span multiple lines.`;

        problems.push({
          ruleId: null,
          message,
          loc: comment.loc,
        });
        return;
      }

      switch (label) {
        case "eslint-disable":
        case "eslint-enable":
        case "eslint-disable-next-line":
        case "eslint-disable-line": {
          const directiveType = label.slice("eslint-".length);

          directives.push(
            new DirectiveImpl({
              type: directiveType as DirectiveType,
              node: comment,
              value,
              justification,
            }),
          );
          break;
        }
        // no default
      }
    });

    return { problems, directives };
  }

  /**
   * Returns inline rule configurations along with any problems
   * encountered while parsing the configurations.
   */
  public applyInlineConfig(): {
    configs: { config: { rules: RulesConfig }; loc: AST.SourceLocation }[];
    problems: FileProblem[];
  } {
    const problems: FileProblem[] = [];
    const configs: {
      config: { rules: RulesConfig };
      loc: AST.SourceLocation;
    }[] = [];

    this.getInlineConfigNodes().forEach((comment) => {
      const directive = commentParser.parseDirective(comment.value);

      if (!directive) {
        return;
      }

      const { label, value } = directive;

      if (label === "eslint") {
        const parseResult = commentParser.parseJSONLikeConfig(value);

        if (parseResult.ok) {
          configs.push({
            config: {
              rules: parseResult.config,
            },
            loc: comment.loc,
          });
        } else {
          problems.push({
            ruleId: null,
            message: parseResult.error.message,
            loc: comment.loc,
          });
        }
      }
    });

    return { configs, problems };
  }

  /**
   * Gets the source text for the given node or the entire source if no node is provided.
   */
  public getText(
    node?: JSONCSyntaxElement,
    beforeCount?: number,
    afterCount?: number,
  ): string {
    if (!node) return this.text;
    const range = (node as { range: [number, number] }).range;
    const start = range[0] - (beforeCount ?? 0);
    const end = range[1] + (afterCount ?? 0);
    return this.text.slice(Math.max(0, start), Math.min(this.text.length, end));
  }

  public getNodeByRangeIndex(index: number): AST.JSONNode | null {
    let node = find([this.ast]);
    if (!node) return null;
    while (true) {
      const child = find(this._getChildren(node));
      if (!child) return node;
      node = child;
    }

    /**
     * Finds a node that contains the given index.
     */
    function find(nodes: AST.JSONNode[]) {
      for (const node of nodes) {
        if (node.range[0] <= index && index < node.range[1]) {
          return node;
        }
      }
      return null;
    }
  }

  /**
   * Gets the first token of the given node.
   */
  public getFirstToken(node: JSONCSyntaxElement): ESLintAST.Token;

  /**
   * Gets the first token of the given node with options.
   */
  public getFirstToken(
    node: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithoutFilter,
  ): ESLintAST.Token | null;

  /**
   * Gets the first token of the given node with filter options.
   */
  public getFirstToken<R extends ESLintAST.Token>(
    node: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithFilter<ESLintAST.Token, R>,
  ): R | null;

  /**
   * Gets the first token of the given node with comment options.
   */
  public getFirstToken<R extends ESLintAST.Token | JSONCComment>(
    node: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment, R>,
  ): R | null;

  public getFirstToken(
    node: JSONCSyntaxElement,
    options?:
      | CursorWithSkipOptionsWithoutFilter
      | CursorWithSkipOptionsWithFilter<ESLintAST.Token>
      | CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): ESLintAST.Token | JSONCComment | null {
    return this.tokenStore.getFirstToken(node as never, options as never);
  }

  /**
   * Gets the first tokens of the given node.
   */
  public getFirstTokens(
    node: JSONCSyntaxElement,
    options?: CursorWithCountOptionsWithoutFilter,
  ): ESLintAST.Token[];

  /**
   * Gets the first tokens of the given node with filter options.
   */
  public getFirstTokens<R extends ESLintAST.Token>(
    node: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithFilter<ESLintAST.Token, R>,
  ): R[];

  /**
   * Gets the first tokens of the given node with comment options.
   */
  public getFirstTokens<R extends ESLintAST.Token | JSONCComment>(
    node: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithComment<
      ESLintAST.Token,
      JSONCComment,
      R
    >,
  ): R[];

  public getFirstTokens(
    node: JSONCSyntaxElement,
    options?:
      | CursorWithCountOptionsWithoutFilter
      | CursorWithCountOptionsWithFilter<ESLintAST.Token>
      | CursorWithCountOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): (ESLintAST.Token | JSONCComment)[] {
    return this.tokenStore.getFirstTokens(node as never, options as never);
  }

  /**
   * Gets the last token of the given node.
   */
  public getLastToken(node: JSONCSyntaxElement): ESLintAST.Token;

  /**
   * Gets the last token of the given node with options.
   */
  public getLastToken(
    node: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithoutFilter,
  ): ESLintAST.Token | null;

  /**
   * Gets the last token of the given node with filter options.
   */
  public getLastToken<R extends ESLintAST.Token>(
    node: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithFilter<ESLintAST.Token, R>,
  ): R | null;

  /**
   * Gets the last token of the given node with comment options.
   */
  public getLastToken<R extends ESLintAST.Token | JSONCComment>(
    node: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment, R>,
  ): R | null;

  public getLastToken(
    node: JSONCSyntaxElement,
    options?:
      | CursorWithSkipOptionsWithoutFilter
      | CursorWithSkipOptionsWithFilter<ESLintAST.Token>
      | CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): (ESLintAST.Token | JSONCComment) | null {
    return this.tokenStore.getLastToken(node as never, options as never);
  }

  /**
   * Get the last tokens of the given node.
   */
  public getLastTokens(
    node: JSONCSyntaxElement,
    options?: CursorWithCountOptionsWithoutFilter,
  ): ESLintAST.Token[];

  /**
   * Get the last tokens of the given node with filter options.
   */
  public getLastTokens<R extends ESLintAST.Token>(
    node: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithFilter<ESLintAST.Token, R>,
  ): R[];

  /**
   * Get the last tokens of the given node with comment options.
   */
  public getLastTokens<R extends ESLintAST.Token | JSONCComment>(
    node: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithComment<
      ESLintAST.Token,
      JSONCComment,
      R
    >,
  ): R[];

  public getLastTokens(
    node: JSONCSyntaxElement,
    options?:
      | CursorWithCountOptionsWithoutFilter
      | CursorWithCountOptionsWithFilter<ESLintAST.Token>
      | CursorWithCountOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): (ESLintAST.Token | JSONCComment)[] {
    return this.tokenStore.getLastTokens(node as never, options as never);
  }

  /**
   * Gets the token that precedes a given node or token.
   */
  public getTokenBefore(
    node: JSONCSyntaxElement,
    options?: CursorWithSkipOptionsWithoutFilter,
  ): ESLintAST.Token | null;

  /**
   * Gets the token that precedes a given node or token with filter options.
   */
  public getTokenBefore<R extends ESLintAST.Token>(
    node: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithFilter<ESLintAST.Token, R>,
  ): R | null;

  /**
   * Gets the token that precedes a given node or token with comment options.
   */
  public getTokenBefore<R extends ESLintAST.Token | JSONCComment>(
    node: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment, R>,
  ): R | null;

  public getTokenBefore(
    node: JSONCSyntaxElement,
    options?:
      | CursorWithSkipOptionsWithoutFilter
      | CursorWithSkipOptionsWithFilter<ESLintAST.Token>
      | CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): ESLintAST.Token | JSONCComment | null {
    return this.tokenStore.getTokenBefore(node as never, options as never);
  }

  /**
   * Gets the `count` tokens that precedes a given node or token.
   */
  public getTokensBefore(
    node: JSONCSyntaxElement,
    options?: CursorWithCountOptionsWithoutFilter,
  ): ESLintAST.Token[];

  /**
   * Gets the `count` tokens that precedes a given node or token with filter options.
   */
  public getTokensBefore<R extends ESLintAST.Token>(
    node: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithFilter<ESLintAST.Token, R>,
  ): R[];

  /**
   * Gets the `count` tokens that precedes a given node or token with comment options.
   */
  public getTokensBefore<R extends ESLintAST.Token | JSONCComment>(
    node: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithComment<
      ESLintAST.Token,
      JSONCComment,
      R
    >,
  ): R[];

  public getTokensBefore(
    node: JSONCSyntaxElement,
    options?:
      | CursorWithCountOptionsWithoutFilter
      | CursorWithCountOptionsWithFilter<ESLintAST.Token>
      | CursorWithCountOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): (ESLintAST.Token | JSONCComment)[] {
    return this.tokenStore.getTokensBefore(node as never, options as never);
  }

  /**
   * Gets the token that follows a given node or token.
   */
  public getTokenAfter(
    node: JSONCSyntaxElement,
    options?: CursorWithSkipOptionsWithoutFilter,
  ): ESLintAST.Token | null;

  /**
   * Gets the token that follows a given node or token with filter options.
   */
  public getTokenAfter<R extends ESLintAST.Token>(
    node: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithFilter<ESLintAST.Token, R>,
  ): R | null;

  /**
   * Gets the token that follows a given node or token with comment options.
   */
  public getTokenAfter<R extends ESLintAST.Token | JSONCComment>(
    node: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment, R>,
  ): R | null;

  public getTokenAfter(
    node: JSONCSyntaxElement,
    options?:
      | CursorWithSkipOptionsWithoutFilter
      | CursorWithSkipOptionsWithFilter<ESLintAST.Token>
      | CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): ESLintAST.Token | JSONCComment | null {
    return this.tokenStore.getTokenAfter(node as never, options as never);
  }

  /**
   * Gets the `count` tokens that follows a given node or token.
   */
  public getTokensAfter(
    node: JSONCSyntaxElement,
    options?: CursorWithCountOptionsWithoutFilter,
  ): ESLintAST.Token[];

  /**
   * Gets the `count` tokens that follows a given node or token with filter options.
   */
  public getTokensAfter<R extends ESLintAST.Token>(
    node: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithFilter<ESLintAST.Token, R>,
  ): R[];

  /**
   * Gets the `count` tokens that follows a given node or token with comment options.
   */
  public getTokensAfter<R extends ESLintAST.Token | JSONCComment>(
    node: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithComment<
      ESLintAST.Token,
      JSONCComment,
      R
    >,
  ): R[];

  public getTokensAfter(
    node: JSONCSyntaxElement,
    options?:
      | CursorWithCountOptionsWithoutFilter
      | CursorWithCountOptionsWithFilter<ESLintAST.Token>
      | CursorWithCountOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): (ESLintAST.Token | JSONCComment)[] {
    return this.tokenStore.getTokensAfter(node as never, options as never);
  }

  /**
   * Gets the first token between two non-overlapping nodes.
   */
  public getFirstTokenBetween(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options?: CursorWithSkipOptionsWithoutFilter,
  ): ESLintAST.Token | null;

  /**
   * Gets the first token between two non-overlapping nodes with filter options.
   */
  public getFirstTokenBetween<R extends ESLintAST.Token>(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithFilter<ESLintAST.Token, R>,
  ): R | null;

  /**
   * Gets the first token between two non-overlapping nodes with comment options.
   */
  public getFirstTokenBetween<R extends ESLintAST.Token | JSONCComment>(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment, R>,
  ): R | null;

  public getFirstTokenBetween(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options?:
      | CursorWithSkipOptionsWithoutFilter
      | CursorWithSkipOptionsWithFilter<ESLintAST.Token>
      | CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): ESLintAST.Token | JSONCComment | null {
    return this.tokenStore.getFirstTokenBetween(
      left as never,
      right as never,
      options as never,
    );
  }

  /**
   * Gets the first tokens between two non-overlapping nodes.
   */
  public getFirstTokensBetween(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options?: CursorWithCountOptionsWithoutFilter,
  ): ESLintAST.Token[];

  /**
   * Gets the first tokens between two non-overlapping nodes with filter options.
   */
  public getFirstTokensBetween<R extends ESLintAST.Token>(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithFilter<ESLintAST.Token, R>,
  ): R[];

  /**
   * Gets the first tokens between two non-overlapping nodes with comment options.
   */
  public getFirstTokensBetween<R extends ESLintAST.Token | JSONCComment>(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithComment<
      ESLintAST.Token,
      JSONCComment,
      R
    >,
  ): R[];

  public getFirstTokensBetween(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options?:
      | CursorWithCountOptionsWithoutFilter
      | CursorWithCountOptionsWithFilter<ESLintAST.Token>
      | CursorWithCountOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): (ESLintAST.Token | JSONCComment)[] {
    return this.tokenStore.getFirstTokensBetween(
      left as never,
      right as never,
      options as never,
    );
  }

  /**
   * Gets the last token between two non-overlapping nodes.
   */
  public getLastTokenBetween(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options?: CursorWithSkipOptionsWithoutFilter,
  ): ESLintAST.Token | null;

  /**
   * Gets the last token between two non-overlapping nodes with filter options.
   */
  public getLastTokenBetween<R extends ESLintAST.Token>(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithFilter<ESLintAST.Token, R>,
  ): R | null;

  /**
   * Gets the last token between two non-overlapping nodes with comment options.
   */
  public getLastTokenBetween<R extends ESLintAST.Token | JSONCComment>(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options: CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment, R>,
  ): R | null;

  public getLastTokenBetween(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options?:
      | CursorWithSkipOptionsWithoutFilter
      | CursorWithSkipOptionsWithFilter<ESLintAST.Token>
      | CursorWithSkipOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): ESLintAST.Token | JSONCComment | null {
    return this.tokenStore.getLastTokenBetween(
      left as never,
      right as never,
      options as never,
    );
  }

  /**
   * Gets the last tokens between two non-overlapping nodes.
   */
  public getLastTokensBetween(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options?: CursorWithCountOptionsWithoutFilter,
  ): ESLintAST.Token[];

  /**
   * Gets the last tokens between two non-overlapping nodes with filter options.
   */
  public getLastTokensBetween<R extends ESLintAST.Token>(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithFilter<ESLintAST.Token, R>,
  ): R[];

  /**
   * Gets the last tokens between two non-overlapping nodes with comment options.
   */
  public getLastTokensBetween<R extends ESLintAST.Token | JSONCComment>(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithComment<
      ESLintAST.Token,
      JSONCComment,
      R
    >,
  ): R[];

  public getLastTokensBetween(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options?:
      | CursorWithCountOptionsWithoutFilter
      | CursorWithCountOptionsWithFilter<ESLintAST.Token>
      | CursorWithCountOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): (ESLintAST.Token | JSONCComment)[] {
    return this.tokenStore.getLastTokensBetween(
      left as never,
      right as never,
      options as never,
    );
  }

  /**
   * Gets all tokens that are related to the given node.
   */
  public getTokens(
    node: JSONCSyntaxElement,
    options?: CursorWithCountOptionsWithoutFilter,
  ): ESLintAST.Token[];

  /**
   * Gets all tokens that are related to the given node with filter options.
   */
  public getTokens<R extends ESLintAST.Token>(
    node: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithFilter<ESLintAST.Token, R>,
  ): R[];

  /**
   * Gets all tokens that are related to the given node with comment options.
   */
  public getTokens<R extends ESLintAST.Token | JSONCComment>(
    node: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithComment<
      ESLintAST.Token,
      JSONCComment,
      R
    >,
  ): R[];

  public getTokens(
    node: JSONCSyntaxElement,
    options?:
      | CursorWithCountOptionsWithoutFilter
      | CursorWithCountOptionsWithFilter<ESLintAST.Token>
      | CursorWithCountOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): (ESLintAST.Token | JSONCComment)[] {
    return this.tokenStore.getTokens(node as never, options as never);
  }

  /**
   * Gets all of the tokens between two non-overlapping nodes.
   */
  public getTokensBetween(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options?: CursorWithCountOptionsWithoutFilter,
  ): ESLintAST.Token[];

  /**
   * Gets all of the tokens between two non-overlapping nodes with filter options.
   */
  public getTokensBetween<R extends ESLintAST.Token>(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithFilter<ESLintAST.Token, R>,
  ): R[];

  /**
   * Gets all of the tokens between two non-overlapping nodes with comment options.
   */
  public getTokensBetween<R extends ESLintAST.Token | JSONCComment>(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options: CursorWithCountOptionsWithComment<
      ESLintAST.Token,
      JSONCComment,
      R
    >,
  ): R[];

  public getTokensBetween(
    left: JSONCSyntaxElement,
    right: JSONCSyntaxElement,
    options?:
      | CursorWithCountOptionsWithoutFilter
      | CursorWithCountOptionsWithFilter<ESLintAST.Token>
      | CursorWithCountOptionsWithComment<ESLintAST.Token, JSONCComment>,
  ): (ESLintAST.Token | JSONCComment)[] {
    return this.tokenStore.getTokensBetween(
      left as never,
      right as never,
      options as never,
    );
  }

  public getCommentsInside(nodeOrToken: JSONCSyntaxElement): JSONCComment[] {
    return this.tokenStore.getCommentsInside(nodeOrToken as never);
  }

  public getCommentsBefore(nodeOrToken: JSONCSyntaxElement): JSONCComment[] {
    return this.tokenStore.getCommentsBefore(nodeOrToken as never);
  }

  public getCommentsAfter(nodeOrToken: JSONCSyntaxElement): JSONCComment[] {
    return this.tokenStore.getCommentsAfter(nodeOrToken as never);
  }

  public isSpaceBetween(
    first: ESLintAST.Token | JSONCComment,
    second: ESLintAST.Token | JSONCComment,
  ): boolean {
    // Normalize order: ensure left comes before right
    const [left, right] =
      first.range[1] <= second.range[0] ? [first, second] : [second, first];
    return this.tokenStore.isSpaceBetween(left as never, right as never);
  }

  /**
   * Compatibility for ESLint's SourceCode API
   * @deprecated JSONC does not have scopes
   */
  public getScope(node?: AST.JSONNode): Scope.Scope | null {
    if (node?.type !== "Program") {
      return null;
    }
    return createFakeGlobalScope(this.ast);
  }

  /**
   * Compatibility for ESLint's SourceCode API
   * @deprecated JSONC does not have scopes
   */
  public get scopeManager(): Scope.ScopeManager | null {
    return {
      scopes: [],
      globalScope: createFakeGlobalScope(this.ast),
      acquire: (node) => {
        if (node.type === "Program") {
          return createFakeGlobalScope(this.ast);
        }
        return null;
      },
      getDeclaredVariables: () => [],
      addGlobals: () => {
        // noop
      },
    };
  }

  /**
   * Compatibility for ESLint's SourceCode API
   * @deprecated
   */
  public isSpaceBetweenTokens(first: JSONCToken, second: JSONCToken): boolean {
    return this.isSpaceBetween(first, second);
  }

  private _getChildren(node: AST.JSONNode) {
    const keys = this.visitorKeys[node.type] || [];
    const children: AST.JSONNode[] = [];
    for (const key of keys) {
      const value = (node as unknown as Record<string, unknown>)[key];
      if (Array.isArray(value)) {
        for (const element of value) {
          if (isNode(element)) {
            children.push(element);
          }
        }
      } else if (isNode(value)) {
        children.push(value);
      }
    }
    return children;
  }
}

/**
 * Determines whether the given value is a JSONC AST node.
 */
function isNode(value: unknown): value is AST.JSONNode {
  return (
    typeof value === "object" &&
    value !== null &&
    typeof (value as Record<string, unknown>).type === "string" &&
    Array.isArray((value as Record<string, unknown>).range) &&
    Boolean((value as Record<string, unknown>).loc) &&
    typeof (value as Record<string, unknown>).loc === "object"
  );
}

/**
 * Creates a fake global scope for JSONC files.
 * @deprecated JSONC does not have scopes
 */
function createFakeGlobalScope(node: AST.JSONProgram): Scope.Scope {
  const fakeGlobalScope: Scope.Scope = {
    type: "global",
    block: node as never,
    set: new Map(),
    through: [],
    childScopes: [],
    variableScope: null as never,
    variables: [],
    references: [],
    functionExpressionScope: false,
    isStrict: false,
    upper: null,
    implicit: {
      variables: [],
      set: new Map(),
    },
  };
  fakeGlobalScope.variableScope = fakeGlobalScope;
  return fakeGlobalScope;
}

ota-meshi / eslint-plugin-jsonc / 22186324748

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous