sailfork / t3code-github / packages/ shared/ src/ gitPatchPath.test.ts

import { describe, expect, it } from "vite-plus/test";

import { quoteGitPatchPath, unquoteGitPatchPath } from "./gitPatchPath.ts";

const BELL = "\u0007";
const UNIT_SEPARATOR = "\u001f";
const DELETE = "\u007f";

describe("quoteGitPatchPath", () => {
  it("leaves a name a header can carry as itself", () => {
    expect(quoteGitPatchPath("src/app.ts")).toBe("src/app.ts");
    expect(quoteGitPatchPath("with space.txt")).toBe("with space.txt");
    expect(quoteGitPatchPath("café/résumé.ts")).toBe("café/résumé.ts");
    expect(quoteGitPatchPath("🚀.ts")).toBe("🚀.ts");
  });

  it("writes git's escape for a character the header would read as its own", () => {
    expect(quoteGitPatchPath("tab\tfile.txt")).toBe('"tab\\tfile.txt"');
    expect(quoteGitPatchPath("line\nfile.txt")).toBe('"line\\nfile.txt"');
    expect(quoteGitPatchPath('quo"te.txt')).toBe('"quo\\"te.txt"');
    expect(quoteGitPatchPath("back\\slash.txt")).toBe('"back\\\\slash.txt"');
    expect(quoteGitPatchPath(`ring${BELL}.txt`)).toBe('"ring\\a.txt"');
  });

  it("writes the octal of a control character git has no name for", () => {
    expect(quoteGitPatchPath(`unit${UNIT_SEPARATOR}.txt`)).toBe('"unit\\037.txt"');
    expect(quoteGitPatchPath(`del${DELETE}.txt`)).toBe('"del\\177.txt"');
  });
});

describe("a name written into a header and read back out", () => {
  const names = [
    "src/app.ts",
    "with space.txt",
    "café/résumé.ts",
    "🚀.ts",
    "\uFEFFtab\tfile.txt",
    "tab\tfile.txt",
    "line\nfile.txt",
    "carriage\rfile.txt",
    'quo"te.txt',
    "back\\slash.txt",
    `ring${BELL}.txt`,
    `unit${UNIT_SEPARATOR}.txt`,
    `del${DELETE}.txt`,
    `every\t\n\r"\\${BELL}.txt`,
  ];

  it.each(names)("is the name that went in: %j", (name) => {
    const written = quoteGitPatchPath(name);
    expect(unquoteGitPatchPath(written)).toBe(name);
    const unwrapped = written.startsWith('"') ? written.slice(1, -1) : written;
    expect(unquoteGitPatchPath(unwrapped)).toBe(name);
  });
});

describe("unquoteGitPatchPath", () => {
  it.each(['"\\357\\273\\277note.txt"', "\\357\\273\\277note.txt"])(
    "preserves an escaped U+FEFF at the start of a filename: %j",
    (token) => {
      expect(unquoteGitPatchPath(token)).toBe("\uFEFFnote.txt");
    },
  );

  it("reads the octal escapes a host with core.quotePath on writes", () => {
    expect(unquoteGitPatchPath('"caf\\303\\251/r\\303\\251sum\\303\\251.ts"')).toBe(
      "café/résumé.ts",
    );
    expect(unquoteGitPatchPath('"\\360\\237\\232\\200.ts"')).toBe("🚀.ts");
  });
});

describe("a name a parser handed back with its quotes already off", () => {
  it("is read for the escapes it still carries", () => {
    expect(unquoteGitPatchPath("tab\\tfile.txt")).toBe("tab\tfile.txt");
    expect(unquoteGitPatchPath("caf\\303\\251.ts")).toBe("café.ts");
  });

  it("reads an escape git would never write the way C reads it", () => {
    expect(unquoteGitPatchPath("odd\\zname.txt")).toBe("oddzname.txt");
    expect(unquoteGitPatchPath("trailing\\")).toBe("trailing\\");
    expect(unquoteGitPatchPath("short\\12.txt")).toBe("short12.txt");
  });
});