openidea/src/editor/lineTokens.test.ts

import { beforeEach, describe, expect, it, vi } from "vitest";
import { EditorState } from "@codemirror/state";

const disk = new Map<string, string>();
const editors = new Map<string, EditorState>();

vi.mock(import("@/platform/ipc"), async (importOriginal) => ({
  ...(await importOriginal()),
  commands: { fsReadText: (path: string) => path } as never,
  call: (async (path: string) => disk.get(path) ?? Promise.reject(new Error("missing"))) as never,
}));
vi.mock("@/editor/api", () => ({
  editorsFor: (path: string) => {
    const state = editors.get(path);
    return state ? [{ view: { state } }] : [];
  },
}));

const { clearLineTokens, lineTokens, peekLineTokens } = await import("./lineTokens");

const SOURCE = ["/**", " * A read-only virtual document (library", " */", 'const lib = "x";'].join("\n");
const classesOf = (text: string, tokens: Array<{ from: number; to: number; cls: string }>) =>
  tokens.map((t) => `${text.slice(t.from, t.to)}:${t.cls}`);

describe("lineTokens", () => {
  beforeEach(() => {
    clearLineTokens();
    disk.clear();
    editors.clear();
  });

  it("colours a line inside a block comment with the whole file as context", async () => {
    disk.set("/p/a.ts", SOURCE);
    const text = "* A read-only virtual document (library";
    const tokens = await lineTokens({ path: "/p/a.ts", line: 1, col: 1 }, text);
    expect(classesOf(text, tokens)).toEqual([`${text}:tok-comment`]);
    expect(peekLineTokens({ path: "/p/a.ts", line: 1, col: 1 }, text)).toBe(tokens);
  });

  it("keeps positions relative to the shown text", async () => {
    disk.set("/p/a.ts", SOURCE);
    const text = 'lib = "x";';
    const tokens = await lineTokens({ path: "/p/a.ts", line: 3, col: 6 }, text);
    expect(classesOf(text, tokens)).toContain('"x":tok-string');
  });

  it("parses the line on its own when the file no longer has it there", async () => {
    disk.set("/p/a.ts", SOURCE);
    const text = "* A read-only virtual document (library";
    const tokens = await lineTokens({ path: "/p/a.ts", line: 0, col: 0 }, text);
    expect(classesOf(text, tokens)).not.toContain(`${text}:tok-comment`);
  });

  it("parses again when the open editor's document changes", async () => {
    editors.set("/p/a.ts", EditorState.create({ doc: SOURCE.replace("/**", "//") }));
    const text = "* A read-only virtual document (library";
    expect(classesOf(text, await lineTokens({ path: "/p/a.ts", line: 1, col: 1 }, text))).not.toContain(
      `${text}:tok-comment`,
    );
    editors.set("/p/a.ts", EditorState.create({ doc: SOURCE }));
    expect(classesOf(text, await lineTokens({ path: "/p/a.ts", line: 1, col: 1 }, text))).toEqual([
      `${text}:tok-comment`,
    ]);
  });

  it("parses a big file in slices, letting other tasks run in between", async () => {
    const body = "const a = 1; // filler line for the parser\n".repeat(8000);
    disk.set("/p/big.ts", `${body}const lib = "x";`);
    let ticks = 0;
    const timer = setInterval(() => ticks++, 0);
    const text = 'lib = "x";';
    const tokens = await lineTokens({ path: "/p/big.ts", line: 8000, col: 6 }, text);
    clearInterval(timer);
    expect(classesOf(text, tokens)).toContain('"x":tok-string');
    expect(ticks).toBeGreaterThan(0);
  });

  it("leaves files of unknown languages plain", async () => {
    disk.set("/p/a.unknownext", SOURCE);
    expect(await lineTokens({ path: "/p/a.unknownext", line: 1, col: 1 }, "* A read-only")).toEqual([]);
  });
});