Skip to content

The IDE you know, rebuilt in Rust. IntelliJ IDEA–style keymap, tool windows and search-everywhere in a fast native app: editor, code insight, debugger, Git, terminal, database and HTTP clients for 60+ languages.

4.4 KB
Raw Blame
// @vitest-environment jsdom
import { afterEach, beforeEach, describe, expect, it } from "vitest";
import { EditorSelection, EditorState } from "@codemirror/state";
import {
  MAX_CLIPBOARD_ENTRIES,
  clearClipboardHistory,
  clipLabel,
  clipboardHistory,
  copiedText,
  installClipboardTracking,
  isLinewiseClipboardText,
  recordClipboard,
  removeClipboardEntries,
} from "./clipboardHistory";

beforeEach(() => clearClipboardHistory());

describe("clipboard history (Paste from History)", () => {
  it("keeps entries newest first, without duplicates, capped", () => {
    recordClipboard("a");
    recordClipboard("b");
    recordClipboard("a");
    recordClipboard("");
    expect(clipboardHistory()).toEqual([
      { text: "a", linewise: false },
      { text: "b", linewise: false },
    ]);
    for (let i = 0; i < MAX_CLIPBOARD_ENTRIES + 5; i++) recordClipboard(`x${i}`);
    expect(clipboardHistory()).toHaveLength(MAX_CLIPBOARD_ENTRIES);
    expect(clipboardHistory()[0]?.text).toBe(`x${MAX_CLIPBOARD_ENTRIES + 4}`);
  });

  it("copies the selections, or whole caret lines without a selection", () => {
    const doc = "one\ntwo\nthree";
    const ext = EditorState.allowMultipleSelections.of(true);
    const sel = EditorState.create({
      doc,
      extensions: ext,
      selection: EditorSelection.create([EditorSelection.range(0, 3), EditorSelection.range(8, 13)]),
    });
    expect(copiedText(sel)).toBe("one\nthree");
    const carets = EditorState.create({
      doc,
      extensions: ext,
      selection: EditorSelection.create([
        EditorSelection.cursor(1),
        EditorSelection.cursor(2),
        EditorSelection.cursor(5),
      ]),
    });
    expect(copiedText(carets)).toBe("one\ntwo");
  });

  it("keeps a line-wise flag with older history entries and restores it when promoted", () => {
    recordClipboard("one", true);
    recordClipboard("two");
    expect(clipboardHistory()).toEqual([
      { text: "two", linewise: false },
      { text: "one", linewise: true },
    ]);
    expect(isLinewiseClipboardText("two")).toBe(false);
    expect(isLinewiseClipboardText("one")).toBe(false);
    const entry = clipboardHistory()[1]!;
    recordClipboard(entry.text, entry.linewise);
    expect(isLinewiseClipboardText("one")).toBe(true);
    expect(isLinewiseClipboardText("one\n")).toBe(false);
    expect(isLinewiseClipboardText("other app")).toBe(false);
  });

  it("replaces the flag when the same text is copied as a selection", () => {
    recordClipboard("one", true);
    recordClipboard("one");
    expect(clipboardHistory()).toEqual([{ text: "one", linewise: false }]);
    expect(isLinewiseClipboardText("one")).toBe(false);
  });

  it("clears remembered line-wise text with the history", () => {
    recordClipboard("one", true);
    clearClipboardHistory();
    expect(isLinewiseClipboardText("one")).toBe(false);
  });

  it("removes entries by content without disturbing the remaining history", () => {
    recordClipboard("oldest");
    recordClipboard("middle");
    recordClipboard("newest");
    removeClipboardEntries(["oldest", "newest", "missing", "newest"]);
    expect(clipboardHistory().map((e) => e.text)).toEqual(["middle"]);
    removeClipboardEntries([]);
    expect(clipboardHistory().map((e) => e.text)).toEqual(["middle"]);
    recordClipboard("newest");
    expect(clipboardHistory().map((e) => e.text)).toEqual(["newest", "middle"]);
    removeClipboardEntries(clipboardHistory().map((e) => e.text));
    expect(clipboardHistory().map((e) => e.text)).toEqual([]);
  });

  it("labels rows by their first non-blank line and line count", () => {
    expect(clipLabel("\n  foo()\nbar\n")).toEqual({ label: "foo()", detail: "3 lines" });
    expect(clipLabel("x".repeat(100), 10).label).toBe(`${"x".repeat(9)}…`);
    expect(clipLabel("   ").label).toBe("(whitespace)");
    expect(clipLabel("first\rsecond\r").detail).toBe("2 lines");
  });

  describe("outside editors", () => {
    let dispose: () => void;
    afterEach(() => dispose());
    it("records the selected text of inputs", () => {
      dispose = installClipboardTracking();
      const input = document.createElement("input");
      input.value = "hello world";
      document.body.appendChild(input);
      input.setSelectionRange(6, 11);
      input.dispatchEvent(new Event("copy", { bubbles: true }));
      expect(clipboardHistory()[0]).toEqual({ text: "world", linewise: false });
      input.remove();
    });
  });
});