vendor eslint tests

Author: lilnasy

apps/oxlint/test/tokens.test.ts

@@ -0,0 +1,115 @@
+import assert from 'node:assert';
+import { describe, it, vi } from 'vitest';
+import { getTokens, type Token } from '../src-js/plugins/tokens.js';
+import type { Node } from '../src-js/plugins/types.js';
+
+let sourceText = 'null;';
+
+vi.mock('../src-js/plugins/source_code.ts', () => {
+  return {
+    get sourceText() {
+      return sourceText;
+    },
+  };
+});
+
+/**
+ * `TokenStore` is abstraction within ESLint.
+ * We create an object named `store` to use ESLint tests verbatim.
+ */
+const store = {
+  getTokens,
+};
+
+describe('when calling getTokens', () => {
+  sourceText = '/*A*/var answer/*B*/=/*C*/a/*D*/* b/*E*///F\n    call();\n/*Z*/';
+
+  // Parsing source text to AST is done on the rust side.
+  // To test tokens, we only need the range.
+  // TODO: a JS API for parsing source text to AST (and buffer) for testing.
+  const Program = { range: [5, 73] } as Node;
+  const BinaryExpression = { range: [26, 35] } as Node;
+
+  // https://github.com/eslint/eslint/blob/v9.39.1/tests/lib/languages/js/source-code/token-store.js#L63
+  it('should retrieve all tokens for root node', () => {
+    check(store.getTokens(Program), ['var', 'answer', '=', 'a', '*', 'b', 'call', '(', ')', ';']);
+  });
+
+  it('should retrieve all tokens for binary expression', () => {
+    check(store.getTokens(BinaryExpression), ['a', '*', 'b']);
+  });
+
+  it('should retrieve all tokens plus one before for binary expression', () => {
+    check(store.getTokens(BinaryExpression, 1), ['=', 'a', '*', 'b']);
+  });
+
+  it('should retrieve all tokens plus one after for binary expression', () => {
+    check(store.getTokens(BinaryExpression, 0, 1), ['a', '*', 'b', 'call']);
+  });
+
+  it('should retrieve all tokens plus two before and one after for binary expression', () => {
+    check(store.getTokens(BinaryExpression, 2, 1), ['answer', '=', 'a', '*', 'b', 'call']);
+  });
+
+  it('should retrieve all matched tokens for root node with filter', () => {
+    check(
+      store.getTokens(Program, (t) => t.type === 'Identifier'),
+      ['answer', 'a', 'b', 'call'],
+    );
+    check(
+      store.getTokens(Program, {
+        filter: (t) => t.type === 'Identifier',
+      }),
+      ['answer', 'a', 'b', 'call'],
+    );
+  });
+
+  it('should retrieve all tokens and comments in the node for root node with includeComments option', () => {
+    check(store.getTokens(Program, { includeComments: true }), [
+      'var',
+      'answer',
+      'B',
+      '=',
+      'C',
+      'a',
+      'D',
+      '*',
+      'b',
+      'E',
+      'F',
+      'call',
+      '(',
+      ')',
+      ';',
+    ]);
+  });
+
+  it('should retrieve matched tokens and comments in the node for root node with includeComments and filter options', () => {
+    check(
+      store.getTokens(Program, {
+        includeComments: true,
+        filter: (t) => t.type.startsWith('Block'),
+      }),
+      ['B', 'C', 'D', 'E'],
+    );
+  });
+
+  it('should retrieve all tokens and comments in the node for binary expression with includeComments option', () => {
+    check(store.getTokens(BinaryExpression, { includeComments: true }), ['a', 'D', '*', 'b']);
+  });
+});
+
+/**
+ * Checks the values of tokens against an array of expected values.
+ */
+function check(
+  /** Tokens returned from the API. */
+  tokens: Token[],
+  /** Expected token values */
+  expected: string[],
+) {
+  assert.deepStrictEqual(
+    tokens.map((token) => token.value),
+    expected,
+  );
+}