roboomp
a9075ae509
Passed the cmd.exe /s /c command line through Bun verbatim so configured editors and temporary paths retain their quotes. Added command-line regression coverage and documented the fix. Fixes #8544
100 lines
3.0 KiB
TypeScript
100 lines
3.0 KiB
TypeScript
import { afterEach, describe, expect, it } from "bun:test";
|
|
import * as fs from "node:fs";
|
|
import * as path from "node:path";
|
|
import { TempDir } from "@oh-my-pi/pi-utils";
|
|
import { getEditorCommand, openInEditor, resolveEditorSpawnCommand } from "../src/utils/external-editor";
|
|
|
|
interface MutableProcess {
|
|
platform: NodeJS.Platform;
|
|
}
|
|
|
|
function setPlatform(value: NodeJS.Platform): void {
|
|
(process as unknown as MutableProcess).platform = value;
|
|
}
|
|
|
|
describe("getEditorCommand", () => {
|
|
const originalPlatform = process.platform;
|
|
const originalVisual = Bun.env.VISUAL;
|
|
const originalEditor = Bun.env.EDITOR;
|
|
|
|
afterEach(() => {
|
|
setPlatform(originalPlatform);
|
|
if (originalVisual === undefined) delete Bun.env.VISUAL;
|
|
else Bun.env.VISUAL = originalVisual;
|
|
if (originalEditor === undefined) delete Bun.env.EDITOR;
|
|
else Bun.env.EDITOR = originalEditor;
|
|
});
|
|
|
|
it("prefers $VISUAL over $EDITOR and the platform default", () => {
|
|
Bun.env.VISUAL = "nvim";
|
|
Bun.env.EDITOR = "nano";
|
|
setPlatform("win32");
|
|
expect(getEditorCommand()).toBe("nvim");
|
|
});
|
|
|
|
it("falls back to $EDITOR when $VISUAL is unset", () => {
|
|
delete Bun.env.VISUAL;
|
|
Bun.env.EDITOR = "nano";
|
|
expect(getEditorCommand()).toBe("nano");
|
|
});
|
|
|
|
it("trims whitespace so an accidentally padded value still works", () => {
|
|
Bun.env.VISUAL = " code --wait ";
|
|
delete Bun.env.EDITOR;
|
|
expect(getEditorCommand()).toBe("code --wait");
|
|
});
|
|
|
|
it("treats a whitespace-only $VISUAL as unset and consults $EDITOR", () => {
|
|
Bun.env.VISUAL = " ";
|
|
Bun.env.EDITOR = "vim";
|
|
expect(getEditorCommand()).toBe("vim");
|
|
});
|
|
|
|
it("defaults to notepad on Windows when neither variable is set", () => {
|
|
delete Bun.env.VISUAL;
|
|
delete Bun.env.EDITOR;
|
|
setPlatform("win32");
|
|
expect(getEditorCommand()).toBe("notepad");
|
|
});
|
|
|
|
it("returns undefined on POSIX when neither variable is set", () => {
|
|
delete Bun.env.VISUAL;
|
|
delete Bun.env.EDITOR;
|
|
setPlatform("linux");
|
|
expect(getEditorCommand()).toBeUndefined();
|
|
});
|
|
});
|
|
|
|
describe("openInEditor", () => {
|
|
it("passes the cmd.exe command line verbatim on Windows", () => {
|
|
const tmpFile = String.raw`C:\Users\Example User\AppData\Local\Temp\omp-editor-123.omp.md`;
|
|
|
|
expect(resolveEditorSpawnCommand('"C:\\Program Files\\Code.exe" --wait', tmpFile, "win32")).toEqual({
|
|
cmd: [
|
|
"cmd.exe",
|
|
"/d",
|
|
"/s",
|
|
"/c",
|
|
String.raw`""C:\Program Files\Code.exe" --wait "C:\Users\Example User\AppData\Local\Temp\omp-editor-123.omp.md""`,
|
|
],
|
|
windowsVerbatimArguments: true,
|
|
});
|
|
});
|
|
|
|
it.skipIf(process.platform === "win32")("supports quoted editor paths containing spaces", async () => {
|
|
const tempDir = TempDir.createSync("@external-editor-");
|
|
try {
|
|
const editorPath = path.join(tempDir.path(), "My Editor", "edit");
|
|
fs.mkdirSync(path.dirname(editorPath), { recursive: true });
|
|
await Bun.write(editorPath, '#!/bin/sh\nprintf "edited" > "$1"\n');
|
|
fs.chmodSync(editorPath, 0o755);
|
|
|
|
const result = await openInEditor(`"${editorPath}"`, "original");
|
|
|
|
expect(result).toBe("edited");
|
|
} finally {
|
|
await tempDir.remove();
|
|
}
|
|
});
|
|
});
|