@canonical/pragma-cli 0.31.0 → 0.32.0

package/src/domains/setup/helpers/completionScripts.test.ts

@@ -1,58 +0,0 @@
-import { describe, expect, it } from "vitest";
-import {
-  completionScriptContent,
-  completionScriptPath,
-  postInstallHint,
-} from "./completionScripts.js";
-
-describe("completionScriptContent", () => {
-  it("produces zsh completion with compdef", () => {
-    const script = completionScriptContent("zsh");
-    expect(script).toContain("#compdef pragma");
-    expect(script).toContain("pragma --completions");
-  });
-
-  it("produces bash completion with complete -F", () => {
-    const script = completionScriptContent("bash");
-    expect(script).toContain("complete -F _pragma pragma");
-    expect(script).toContain("pragma --completions");
-  });
-
-  it("produces fish completion with complete -c", () => {
-    const script = completionScriptContent("fish");
-    expect(script).toContain("complete -c pragma");
-    expect(script).toContain("pragma --completions");
-  });
-});
-
-describe("completionScriptPath", () => {
-  it("returns zsh path under ~/.zfunc", () => {
-    expect(completionScriptPath("zsh")).toContain(".zfunc/_pragma");
-  });
-
-  it("returns bash path under ~/.local/share/bash-completion", () => {
-    expect(completionScriptPath("bash")).toContain(
-      "bash-completion/completions/pragma",
-    );
-  });
-
-  it("returns fish path under ~/.config/fish/completions", () => {
-    expect(completionScriptPath("fish")).toContain(
-      "fish/completions/pragma.fish",
-    );
-  });
-});
-
-describe("postInstallHint", () => {
-  it("hints source for zsh", () => {
-    expect(postInstallHint("zsh")).toContain("source ~/.zshrc");
-  });
-
-  it("hints source for bash", () => {
-    expect(postInstallHint("bash")).toContain("source ~/.bashrc");
-  });
-
-  it("hints new shell for fish", () => {
-    expect(postInstallHint("fish")).toContain("new shell");
-  });
-});

package/src/domains/setup/helpers/completionScripts.ts

@@ -1,92 +0,0 @@
-import type { ShellId } from "./detectShell.js";
-
-const HOME = process.env.HOME ?? "";
-
-/**
- * Generate the shell-specific completion script content.
- *
- * Each script delegates to `pragma --completions` at runtime
- * so the completion logic stays in the CLI, not in the shell script.
- *
- * @param shell - Target shell identifier.
- * @returns The completion script content as a string.
- */
-export function completionScriptContent(shell: ShellId): string {
-  switch (shell) {
-    case "zsh":
-      return [
-        "#compdef pragma",
-        "# Generated by `pragma setup completions`",
-        "",
-        "_pragma() {",
-        "  local -a completions",
-        // biome-ignore lint/suspicious/noTemplateCurlyInString: shell syntax, not JS template
-        '  completions=("${(@f)$(pragma --completions "${words[@]}" 2>/dev/null)}")',
-        "  compadd -- $completions",
-        "}",
-        "",
-        "compdef _pragma pragma",
-        "",
-      ].join("\n");
-
-    case "bash":
-      return [
-        "# Generated by `pragma setup completions`",
-        "",
-        "_pragma() {",
-        // biome-ignore lint/suspicious/noTemplateCurlyInString: shell syntax, not JS template
-        '  local cur="${COMP_WORDS[COMP_CWORD]}"',
-        "  local completions",
-        // biome-ignore lint/suspicious/noTemplateCurlyInString: shell syntax, not JS template
-        '  completions=$(pragma --completions "${COMP_WORDS[@]}" 2>/dev/null)',
-        "  # shellcheck disable=SC2207",
-        '  COMPREPLY=($(compgen -W "$completions" -- "$cur"))',
-        "}",
-        "",
-        "complete -F _pragma pragma",
-        "",
-      ].join("\n");
-
-    case "fish":
-      return [
-        "# Generated by `pragma setup completions`",
-        "",
-        "complete -c pragma -f -a '(pragma --completions (commandline -cop) 2>/dev/null)'",
-        "",
-      ].join("\n");
-  }
-}
-
-/**
- * Return the standard filesystem path where the completion script should be installed.
- *
- * @param shell - Target shell identifier.
- * @returns Absolute path to the completion script location.
- */
-export function completionScriptPath(shell: ShellId): string {
-  switch (shell) {
-    case "zsh":
-      return `${HOME}/.zfunc/_pragma`;
-    case "bash":
-      return `${HOME}/.local/share/bash-completion/completions/pragma`;
-    case "fish":
-      return `${HOME}/.config/fish/completions/pragma.fish`;
-  }
-}
-
-/**
- * Return a post-install hint instructing the user how to activate completions.
- *
- * @param shell - Target shell identifier.
- * @returns A human-readable activation hint.
- */
-export function postInstallHint(shell: ShellId): string {
-  switch (shell) {
-    case "zsh":
-      return "Run `source ~/.zshrc` or start a new shell to activate.";
-    case "bash":
-      return "Run `source ~/.bashrc` or start a new shell to activate.";
-    case "fish":
-      return "Start a new shell to activate.";
-  }
-}

package/src/domains/setup/helpers/constants.ts

@@ -1,2 +0,0 @@
-/** MCP server name written into harness config files. */
-export const MCP_SERVER_NAME = "pragma";

package/src/domains/setup/helpers/detectShell.test.ts

@@ -1,48 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import detectShell from "./detectShell.js";
-
-describe("detectShell", () => {
-  let original: string | undefined;
-
-  beforeEach(() => {
-    original = process.env.SHELL;
-  });
-
-  afterEach(() => {
-    if (original !== undefined) {
-      process.env.SHELL = original;
-    } else {
-      delete process.env.SHELL;
-    }
-  });
-
-  it("detects zsh from /bin/zsh", () => {
-    process.env.SHELL = "/bin/zsh";
-    expect(detectShell()).toBe("zsh");
-  });
-
-  it("detects zsh from /usr/bin/zsh", () => {
-    process.env.SHELL = "/usr/bin/zsh";
-    expect(detectShell()).toBe("zsh");
-  });
-
-  it("detects bash from /bin/bash", () => {
-    process.env.SHELL = "/bin/bash";
-    expect(detectShell()).toBe("bash");
-  });
-
-  it("detects fish from /usr/bin/fish", () => {
-    process.env.SHELL = "/usr/bin/fish";
-    expect(detectShell()).toBe("fish");
-  });
-
-  it("returns null for unknown shell", () => {
-    process.env.SHELL = "/bin/tcsh";
-    expect(detectShell()).toBeNull();
-  });
-
-  it("returns null when SHELL is unset", () => {
-    delete process.env.SHELL;
-    expect(detectShell()).toBeNull();
-  });
-});

package/src/domains/setup/helpers/detectShell.ts

@@ -1,20 +0,0 @@
-/** Union of supported shell identifiers. */
-export type ShellId = "zsh" | "bash" | "fish";
-
-const SHELL_MAP: Record<string, ShellId> = {
-  zsh: "zsh",
-  bash: "bash",
-  fish: "fish",
-};
-
-/**
- * Detect the user's shell from the `$SHELL` environment variable.
- *
- * @returns The detected ShellId, or null if `$SHELL` is unset or unrecognized.
- * @note Impure
- */
-export default function detectShell(): ShellId | null {
-  const shell = process.env.SHELL ?? "";
-  const basename = shell.split("/").pop() ?? "";
-  return SHELL_MAP[basename] ?? null;
-}

package/src/domains/setup/helpers/index.ts

@@ -1,12 +0,0 @@
-/** @module Shared helpers for setup commands: shell detection, completion scripts, and task execution. */
-export {
-  completionScriptContent,
-  completionScriptPath,
-  postInstallHint,
-} from "./completionScripts.js";
-export { MCP_SERVER_NAME } from "./constants.js";
-export { default as detectShell, type ShellId } from "./detectShell.js";
-export {
-  default as runSetupTask,
-  type SetupTaskOptions,
-} from "./runSetupTask.js";

package/src/domains/setup/helpers/runSetupTask.test.ts

@@ -1,277 +0,0 @@
-import { answerPromptWithDefaults } from "@canonical/cli-core";
-import { pure, type Task, writeFile } from "@canonical/task";
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import runSetupTask from "./runSetupTask.js";
-
-const {
-  runGeneratorTaskMock,
-  runUndoMock,
-  sessionAnswerMock,
-  sessionDisposeMock,
-} = vi.hoisted(() => ({
-  runGeneratorTaskMock: vi.fn(),
-  runUndoMock: vi.fn(),
-  sessionAnswerMock: vi.fn(),
-  sessionDisposeMock: vi.fn(),
-}));
-
-// runSetupTask orchestrates: dry-run/undo use real formatting and runUndo,
-// while production runs through the shared execution core. Mock the core,
-// runUndo, and the interactive prompt session, so the wiring and lifecycle
-// stay under test with real effect formatting.
-vi.mock("@canonical/cli-core", async (importOriginal) => ({
-  ...(await importOriginal<typeof import("@canonical/cli-core")>()),
-  runGeneratorTask: runGeneratorTaskMock,
-}));
-
-vi.mock("@canonical/task/node", async (importOriginal) => ({
-  ...(await importOriginal<typeof import("@canonical/task/node")>()),
-  runUndo: runUndoMock,
-}));
-
-vi.mock("../../shared/createInteractivePromptSession.js", () => ({
-  default: () => ({
-    answerPrompt: sessionAnswerMock,
-    wasInterrupted: () => false,
-    dispose: sessionDisposeMock,
-  }),
-}));
-
-const succeed = async (): Promise<undefined> => undefined;
-
-describe("runSetupTask", () => {
-  let stderrSpy: ReturnType<typeof vi.spyOn>;
-
-  beforeEach(() => {
-    vi.clearAllMocks();
-    stderrSpy = vi
-      .spyOn(process.stderr, "write")
-      .mockImplementation(() => true);
-  });
-
-  afterEach(() => {
-    stderrSpy.mockRestore();
-  });
-
-  // ===========================================================================
-  // Dry-run mode
-  // ===========================================================================
-
-  it("returns output result in dry-run mode", async () => {
-    const result = await runSetupTask(writeFile("/tmp/test.txt", "hello"), {
-      dryRun: true,
-    });
-
-    expect(result.tag).toBe("output");
-    if (result.tag === "output") {
-      const text = result.render.plain(result.value);
-      expect(text).toContain("Dry run");
-      expect(text).toContain("/tmp/test.txt");
-    }
-    expect(runGeneratorTaskMock).not.toHaveBeenCalled();
-  });
-
-  it("returns json output in dry-run + json mode", async () => {
-    const result = await runSetupTask(writeFile("/tmp/test.txt", "hello"), {
-      dryRun: true,
-      format: "json",
-    });
-
-    expect(result.tag).toBe("output");
-    if (result.tag === "output") {
-      const parsed = JSON.parse(result.render.plain(result.value));
-      expect(Array.isArray(parsed)).toBe(true);
-      expect(parsed[0].action).toBe("WriteFile");
-    }
-  });
-
-  it("returns llm markdown in dry-run + llm mode", async () => {
-    const result = await runSetupTask(writeFile("/tmp/test.txt", "hello"), {
-      dryRun: true,
-      llm: true,
-    });
-
-    expect(result.tag).toBe("output");
-    if (result.tag === "output") {
-      expect(result.render.plain(result.value)).toContain("Dry Run");
-    }
-  });
-
-  it("shows the no-visible-effects message when a dry-run collects none", async () => {
-    const result = await runSetupTask(pure(undefined) as Task<void>, {
-      dryRun: true,
-      verbose: false,
-    });
-
-    expect(result.tag).toBe("output");
-    if (result.tag === "output") {
-      expect(result.render.plain(result.value)).toContain("no visible effects");
-    }
-  });
-
-  // ===========================================================================
-  // Production execution — through the shared execution core
-  // ===========================================================================
-
-  it("runs production through the shared execution core and returns exit 0", async () => {
-    runGeneratorTaskMock.mockImplementation(succeed);
-
-    const result = await runSetupTask(writeFile("/tmp/x", "y"), { yes: true });
-
-    expect(runGeneratorTaskMock).toHaveBeenCalledTimes(1);
-    expect(result.tag).toBe("exit");
-    if (result.tag === "exit") expect(result.code).toBe(0);
-  });
-
-  it("wires the auto-confirm handler in yes mode", async () => {
-    runGeneratorTaskMock.mockImplementation(async (_task, options) => {
-      expect(options.promptHandler).toBe(answerPromptWithDefaults);
-      return succeed();
-    });
-
-    await runSetupTask(writeFile("/tmp/x", "y"), { yes: true });
-    expect(runGeneratorTaskMock).toHaveBeenCalledTimes(1);
-  });
-
-  it("wires an interactive prompt session when not in yes mode and disposes it", async () => {
-    runGeneratorTaskMock.mockImplementation(async (_task, options) => {
-      expect(options.promptHandler).toBe(sessionAnswerMock);
-      expect(sessionDisposeMock).not.toHaveBeenCalled();
-      return succeed();
-    });
-
-    await runSetupTask(writeFile("/tmp/x", "y"), {});
-    expect(runGeneratorTaskMock).toHaveBeenCalledTimes(1);
-    expect(sessionDisposeMock).toHaveBeenCalledTimes(1);
-  });
-
-  it("disposes the prompt session even when production execution fails", async () => {
-    runGeneratorTaskMock.mockRejectedValue(new Error("boom"));
-
-    const result = await runSetupTask(writeFile("/tmp/x", "y"), {});
-
-    expect(result.tag).toBe("exit");
-    expect(sessionDisposeMock).toHaveBeenCalledTimes(1);
-  });
-
-  it("suppresses debug logs unless verbose during production", async () => {
-    runGeneratorTaskMock.mockImplementation(async (_task, options) => {
-      options.onLog("debug", "hidden");
-      options.onLog("info", "shown");
-      return succeed();
-    });
-
-    await runSetupTask(writeFile("/tmp/x", "y"), { yes: true });
-
-    expect(stderrSpy).toHaveBeenCalledWith("shown\n");
-    expect(stderrSpy).not.toHaveBeenCalledWith("hidden\n");
-  });
-
-  it("emits debug logs when verbose during production", async () => {
-    runGeneratorTaskMock.mockImplementation(async (_task, options) => {
-      options.onLog("debug", "shown-debug");
-      return succeed();
-    });
-
-    await runSetupTask(writeFile("/tmp/x", "y"), { yes: true, verbose: true });
-    expect(stderrSpy).toHaveBeenCalledWith("shown-debug\n");
-  });
-
-  it("returns exit 1 when production execution fails", async () => {
-    runGeneratorTaskMock.mockRejectedValue(new Error("permission denied"));
-
-    const result = await runSetupTask(writeFile("/tmp/x", "y"), { yes: true });
-
-    expect(result.tag).toBe("exit");
-    if (result.tag === "exit") expect(result.code).toBe(1);
-    expect(stderrSpy).toHaveBeenCalledWith("Setup failed: permission denied\n");
-  });
-
-  it("stringifies a non-Error production rejection", async () => {
-    runGeneratorTaskMock.mockRejectedValue("raw failure");
-
-    const result = await runSetupTask(writeFile("/tmp/x", "y"), { yes: true });
-
-    expect(result.tag).toBe("exit");
-    if (result.tag === "exit") expect(result.code).toBe(1);
-    expect(stderrSpy).toHaveBeenCalledWith("Setup failed: raw failure\n");
-  });
-
-  // ===========================================================================
-  // Undo mode
-  // ===========================================================================
-
-  it("reports nothing to undo when no undos are collected", async () => {
-    runUndoMock.mockResolvedValue({ undoCount: 0 });
-
-    const result = await runSetupTask(writeFile("/tmp/x", "y"), {
-      undo: true,
-      yes: true,
-    });
-
-    expect(result.tag).toBe("exit");
-    if (result.tag === "exit") expect(result.code).toBe(0);
-    expect(stderrSpy).toHaveBeenCalledWith("Nothing to undo.\n");
-  });
-
-  it("writes verbose undo logs and the singular completion message", async () => {
-    runUndoMock.mockImplementation(async (_task, options) => {
-      options.onLog("debug", "debug line");
-      options.onLog("info", "undoing");
-      return { undoCount: 1 };
-    });
-
-    const result = await runSetupTask(writeFile("/tmp/x", "y"), {
-      undo: true,
-      yes: true,
-      verbose: true,
-    });
-
-    expect(result.tag).toBe("exit");
-    expect(stderrSpy).toHaveBeenCalledWith("debug line\n");
-    expect(stderrSpy).toHaveBeenCalledWith("undoing\n");
-    expect(stderrSpy).toHaveBeenCalledWith(
-      "Undo complete (1 step reversed).\n",
-    );
-  });
-
-  it("writes the plural undo completion message", async () => {
-    runUndoMock.mockResolvedValue({ undoCount: 2 });
-
-    const result = await runSetupTask(writeFile("/tmp/x", "y"), {
-      undo: true,
-      yes: true,
-    });
-
-    expect(result.tag).toBe("exit");
-    expect(stderrSpy).toHaveBeenCalledWith(
-      "Undo complete (2 steps reversed).\n",
-    );
-  });
-
-  it("returns exit 1 when undo fails", async () => {
-    runUndoMock.mockRejectedValue(new Error("cannot undo"));
-
-    const result = await runSetupTask(writeFile("/tmp/x", "y"), {
-      undo: true,
-      yes: true,
-    });
-
-    expect(result.tag).toBe("exit");
-    if (result.tag === "exit") expect(result.code).toBe(1);
-    expect(stderrSpy).toHaveBeenCalledWith("Undo failed: cannot undo\n");
-  });
-
-  it("stringifies a non-Error undo rejection", async () => {
-    runUndoMock.mockRejectedValue("raw undo failure");
-
-    const result = await runSetupTask(writeFile("/tmp/x", "y"), {
-      undo: true,
-      yes: true,
-    });
-
-    expect(result.tag).toBe("exit");
-    if (result.tag === "exit") expect(result.code).toBe(1);
-    expect(stderrSpy).toHaveBeenCalledWith("Undo failed: raw undo failure\n");
-  });
-});