refactor(linter/plugins): move token-related SourceCode methods into separate file

Author: overlookmotel

apps/oxlint/src-js/index.ts

@@ -15,7 +15,8 @@ export type {
   ScopeType,
   Variable,
 } from './plugins/scope.ts';
-export type { CountOptions, FilterFn, RangeOptions, SkipOptions, SourceCode } from './plugins/source_code.ts';
+export type { SourceCode } from './plugins/source_code.ts';
+export type { CountOptions, FilterFn, RangeOptions, SkipOptions } from './plugins/tokens.ts';
 export type {
   AfterHook,
   BeforeHook,

apps/oxlint/src-js/plugins/source_code.ts

@@ -21,10 +21,11 @@ import {
   lines,
   resetLines,
 } from './location.js';
+import * as tokenMethods from './tokens.js';
 
 import type { Program } from '../generated/types.d.ts';
 import type { Scope, ScopeManager, Variable } from './scope.ts';
-import type { BufferWithArrays, Comment, Node, NodeOrToken, Ranged, Token } from './types.ts';
+import type { BufferWithArrays, Node, NodeOrToken, Ranged } from './types.ts';
 
 const { max } = Math;
 
@@ -191,237 +192,22 @@ export const SOURCE_CODE = Object.freeze({
     throw new Error('`sourceCode.isGlobalReference` not implemented yet'); // TODO
   },
 
-  /**
-   * Get all tokens that are related to the given node.
-   * @param node - The AST node.
-   * @param countOptions? - Options object. If this is a function then it's `options.filter`.
-   * @returns Array of `Token`s.
-   */
-  /**
-   * Get all tokens that are related to the given node.
-   * @param node - The AST node.
-   * @param beforeCount? - The number of tokens before the node to retrieve.
-   * @param afterCount? - The number of tokens after the node to retrieve.
-   * @returns Array of `Token`s.
-   */
-  /* oxlint-disable no-unused-vars */
-  getTokens(
-    node: Node,
-    countOptions?: CountOptions | number | FilterFn | null | undefined,
-    afterCount?: number | null | undefined,
-  ): Token[] {
-    throw new Error('`sourceCode.getTokens` not implemented yet'); // TODO
-  },
-  /* oxlint-enable no-unused-vars */
-
-  /**
-   * Get the first token of the given node.
-   * @param node - The AST node.
-   * @param skipOptions? - Options object. If this is a number then it's `options.skip`.
-   *   If this is a function then it's `options.filter`.
-   * @returns `Token`, or `null` if all were skipped.
-   */
-  // oxlint-disable-next-line no-unused-vars
-  getFirstToken(node: Node, skipOptions?: SkipOptions | number | FilterFn | null | undefined): Token | null {
-    throw new Error('`sourceCode.getFirstToken` not implemented yet'); // TODO
-  },
-
-  /**
-   * Get the first tokens of the given node.
-   * @param node - The AST node.
-   * @param countOptions? - Options object. If this is a number then it's `options.count`.
-   *   If this is a function then it's `options.filter`.
-   * @returns Array of `Token`s.
-   */
-  // oxlint-disable-next-line no-unused-vars
-  getFirstTokens(node: Node, countOptions?: CountOptions | number | FilterFn | null | undefined): Token[] {
-    throw new Error('`sourceCode.getFirstTokens` not implemented yet'); // TODO
-  },
-
-  /**
-   * Get the last token of the given node.
-   * @param node - The AST node.
-   * @param skipOptions? - Options object. Same options as `getFirstToken()`.
-   * @returns `Token`, or `null` if all were skipped.
-   */
-  // oxlint-disable-next-line no-unused-vars
-  getLastToken(node: Node, skipOptions?: SkipOptions | number | FilterFn | null | undefined): Token | null {
-    throw new Error('`sourceCode.getLastToken` not implemented yet'); // TODO
-  },
-
-  /**
-   * Get the last tokens of the given node.
-   * @param node - The AST node.
-   * @param countOptions? - Options object. Same options as `getFirstTokens()`.
-   * @returns Array of `Token`s.
-   */
-  // oxlint-disable-next-line no-unused-vars
-  getLastTokens(node: Node, countOptions?: CountOptions | number | FilterFn | null | undefined): Token[] {
-    throw new Error('`sourceCode.getLastTokens` not implemented yet'); // TODO
-  },
-
-  /**
-   * Get the token that precedes a given node or token.
-   * @param nodeOrToken - The AST node or token.
-   * @param skipOptions? - Options object. Same options as `getFirstToken()`.
-   * @returns `Token`, or `null` if all were skipped.
-   */
-  /* oxlint-disable no-unused-vars */
-  getTokenBefore(
-    nodeOrToken: NodeOrToken | Comment,
-    skipOptions?: SkipOptions | number | FilterFn | null | undefined,
-  ): Token | null {
-    throw new Error('`sourceCode.getTokenBefore` not implemented yet'); // TODO
-  },
-  /* oxlint-enable no-unused-vars */
-
-  /**
-   * Get the tokens that precedes a given node or token.
-   * @param nodeOrToken - The AST node or token.
-   * @param countOptions? - Options object. Same options as `getFirstTokens()`.
-   * @returns Array of `Token`s.
-   */
-  /* oxlint-disable no-unused-vars */
-  getTokensBefore(
-    nodeOrToken: NodeOrToken | Comment,
-    countOptions?: CountOptions | number | FilterFn | null | undefined,
-  ): Token[] {
-    throw new Error('`sourceCode.getTokensBefore` not implemented yet'); // TODO
-  },
-  /* oxlint-enable no-unused-vars */
-
-  /**
-   * Get the token that follows a given node or token.
-   * @param nodeOrToken - The AST node or token.
-   * @param skipOptions? - Options object. Same options as `getFirstToken()`.
-   * @returns `Token`, or `null` if all were skipped.
-   */
-  /* oxlint-disable no-unused-vars */
-  getTokenAfter(
-    nodeOrToken: NodeOrToken | Comment,
-    skipOptions?: SkipOptions | number | FilterFn | null | undefined,
-  ): Token | null {
-    throw new Error('`sourceCode.getTokenAfter` not implemented yet'); // TODO
-  },
-  /* oxlint-enable no-unused-vars */
-
-  /**
-   * Get the tokens that follow a given node or token.
-   * @param nodeOrToken - The AST node or token.
-   * @param countOptions? - Options object. Same options as `getFirstTokens()`.
-   * @returns Array of `Token`s.
-   */
-  /* oxlint-disable no-unused-vars */
-  getTokensAfter(
-    nodeOrToken: NodeOrToken | Comment,
-    countOptions?: CountOptions | number | FilterFn | null | undefined,
-  ): Token[] {
-    throw new Error('`sourceCode.getTokensAfter` not implemented yet'); // TODO
-  },
-  /* oxlint-enable no-unused-vars */
-
-  /**
-   * Get all of the tokens between two non-overlapping nodes.
-   * @param nodeOrToken1 - Node before the desired token range.
-   * @param nodeOrToken2 - Node after the desired token range.
-   * @param countOptions? - Options object. If this is a function then it's `options.filter`.
-   * @returns Array of `Token`s between `nodeOrToken1` and `nodeOrToken2`.
-   */
-  /**
-   * Get all of the tokens between two non-overlapping nodes.
-   * @param nodeOrToken1 - Node before the desired token range.
-   * @param nodeOrToken2 - Node after the desired token range.
-   * @param padding - Number of extra tokens on either side of center.
-   * @returns Array of `Token`s between `nodeOrToken1` and `nodeOrToken2`.
-   */
-  /* oxlint-disable no-unused-vars */
-  getTokensBetween(
-    nodeOrToken1: NodeOrToken | Comment,
-    nodeOrToken2: NodeOrToken | Comment,
-    countOptions?: CountOptions | number | FilterFn | null | undefined,
-  ): Token[] {
-    throw new Error('`sourceCode.getTokensBetween` not implemented yet'); // TODO
-  },
-  /* oxlint-enable no-unused-vars */
-
-  /**
-   * Get the first token between two non-overlapping nodes.
-   * @param nodeOrToken1 - Node before the desired token range.
-   * @param nodeOrToken2 - Node after the desired token range.
-   * @param countOptions? - Options object. Same options as `getFirstToken()`.
-   * @returns `Token`, or `null` if all were skipped.
-   */
-  /* oxlint-disable no-unused-vars */
-  getFirstTokenBetween(
-    nodeOrToken1: NodeOrToken | Comment,
-    nodeOrToken2: NodeOrToken | Comment,
-    skipOptions?: SkipOptions | null | undefined,
-  ): Token | null {
-    throw new Error('`sourceCode.getFirstTokenBetween` not implemented yet'); // TODO
-  },
-  /* oxlint-enable no-unused-vars */
-
-  /**
-   * Get the first tokens between two non-overlapping nodes.
-   * @param nodeOrToken1 - Node before the desired token range.
-   * @param nodeOrToken2 - Node after the desired token range.
-   * @param countOptions? - Options object. Same options as `getFirstTokens()`.
-   * @returns Array of `Token`s between `nodeOrToken1` and `nodeOrToken2`.
-   */
-  /* oxlint-disable no-unused-vars */
-  getFirstTokensBetween(
-    nodeOrToken1: NodeOrToken | Comment,
-    nodeOrToken2: NodeOrToken | Comment,
-    countOptions?: CountOptions | number | FilterFn | null | undefined,
-  ): Token[] {
-    throw new Error('`sourceCode.getFirstTokensBetween` not implemented yet'); // TODO
-  },
-  /* oxlint-enable no-unused-vars */
-
-  /**
-   * Get the last token between two non-overlapping nodes.
-   * @param nodeOrToken1 - Node before the desired token range.
-   * @param nodeOrToken2 - Node after the desired token range.
-   * @param skipOptions? - Options object. Same options as `getFirstToken()`.
-   * @returns `Token`, or `null` if all were skipped.
-   */
-  /* oxlint-disable no-unused-vars */
-  getLastTokenBetween(
-    nodeOrToken1: NodeOrToken | Comment,
-    nodeOrToken2: NodeOrToken | Comment,
-    skipOptions?: SkipOptions | null | undefined,
-  ): Token | null {
-    throw new Error('`sourceCode.getLastTokenBetween` not implemented yet'); // TODO
-  },
-  /* oxlint-enable no-unused-vars */
-
-  /**
-   * Get the last tokens between two non-overlapping nodes.
-   * @param nodeOrToken1 - Node before the desired token range.
-   * @param nodeOrToken2 - Node after the desired token range.
-   * @param countOptions? - Options object. Same options as `getFirstTokens()`.
-   * @returns Array of `Token`s between `nodeOrToken1` and `nodeOrToken2`.
-   */
-  /* oxlint-disable no-unused-vars */
-  getLastTokensBetween(
-    nodeOrToken1: NodeOrToken | Comment,
-    nodeOrToken2: NodeOrToken | Comment,
-    countOptions?: CountOptions | number | FilterFn | null | undefined,
-  ): Token[] {
-    throw new Error('`sourceCode.getLastTokensBetween` not implemented yet'); // TODO
-  },
-  /* oxlint-enable no-unused-vars */
-
-  /**
-   * Get the token starting at the specified index.
-   * @param index - Index of the start of the token's range.
-   * @param options - Options object.
-   * @returns The token starting at index, or `null` if no such token.
-   */
-  // oxlint-disable-next-line no-unused-vars
-  getTokenByRangeStart(index: number, rangeOptions?: RangeOptions | null | undefined): Token | null {
-    throw new Error('`sourceCode.getTokenByRangeStart` not implemented yet'); // TODO
-  },
+  // Token methods
+  getTokens: tokenMethods.getTokens,
+  getFirstToken: tokenMethods.getFirstToken,
+  getFirstTokens: tokenMethods.getFirstTokens,
+  getLastToken: tokenMethods.getLastToken,
+  getLastTokens: tokenMethods.getLastTokens,
+  getTokenBefore: tokenMethods.getTokenBefore,
+  getTokensBefore: tokenMethods.getTokensBefore,
+  getTokenAfter: tokenMethods.getTokenAfter,
+  getTokensAfter: tokenMethods.getTokensAfter,
+  getTokensBetween: tokenMethods.getTokensBetween,
+  getFirstTokenBetween: tokenMethods.getFirstTokenBetween,
+  getFirstTokensBetween: tokenMethods.getFirstTokensBetween,
+  getLastTokenBetween: tokenMethods.getLastTokenBetween,
+  getLastTokensBetween: tokenMethods.getLastTokensBetween,
+  getTokenByRangeStart: tokenMethods.getTokenByRangeStart,
 
   /**
    * Get the deepest node containing a range index.
@@ -491,32 +277,3 @@ function getAncestors(node: Node): Node[] {
 
   return ancestors.reverse();
 }
-
-// Options for various `SourceCode` methods e.g. `getFirstToken`.
-export interface SkipOptions {
-  // Number of skipping tokens
-  skip?: number;
-  // `true` to include comment tokens in the result
-  includeComments?: boolean;
-  // Function to filter tokens
-  filter?: FilterFn | null;
-}
-
-// Options for various `SourceCode` methods e.g. `getFirstTokens`.
-export interface CountOptions {
-  // Maximum number of tokens to return
-  count?: number;
-  // `true` to include comment tokens in the result
-  includeComments?: boolean;
-  // Function to filter tokens
-  filter?: FilterFn | null;
-}
-
-// Options for various `SourceCode` methods e.g. `getTokenByRangeStart`.
-export interface RangeOptions {
-  // `true` to include comment tokens in the result
-  includeComments?: boolean;
-}
-
-// Filter function, passed as `filter` property of `SkipOptions` and `CountOptions`.
-export type FilterFn = (token: Token) => boolean;