@canonical/pragma-cli 0.30.0 → 0.32.0

package/src/domains/config/formatters/channel.ts

@@ -1,37 +0,0 @@
-import type { Formatters } from "../../shared/formatters.js";
-
-/**
- * Formatter sets for `pragma config channel` output, grouped by branch:
- *
- * - **set** formats the confirmation after setting a channel (plain/llm/json).
- * - **reset** formats the confirmation after resetting to default (plain/llm/json).
- * - **query** formats the current channel value (plain/llm/json).
- */
-const channelFormatters = {
-  set: {
-    plain: (d: { field: string; value: string; path: string }) =>
-      `Set ${d.field} to "${d.value}".\nWrote ${d.path}`,
-    llm: (d: { field: string; value: string; path: string }) =>
-      `Set ${d.field} to "${d.value}".\nWrote ${d.path}`,
-    json: (d: { field: string; value: string; path: string }) =>
-      JSON.stringify({ field: d.field, value: d.value, path: d.path }),
-  } satisfies Formatters<{ field: string; value: string; path: string }>,
-
-  reset: {
-    plain: (d: { field: string; path: string }) =>
-      `Reset channel to default.\nWrote ${d.path}`,
-    llm: (d: { field: string; path: string }) =>
-      `Reset channel to default.\nWrote ${d.path}`,
-    json: (d: { field: string; path: string }) =>
-      JSON.stringify({ field: "channel", reset: true, path: d.path }),
-  } satisfies Formatters<{ field: string; path: string }>,
-
-  query: {
-    plain: (channel: string) => `Current channel: ${channel}`,
-    llm: (channel: string) => `Current channel: ${channel}`,
-    json: (channel: string) =>
-      JSON.stringify({ field: "channel", value: channel }),
-  } satisfies Formatters<string>,
-};
-
-export default channelFormatters;

package/src/domains/config/formatters/framework.ts

@@ -1,37 +0,0 @@
-import type { Formatters } from "../../shared/formatters.js";
-
-/**
- * Formatter sets for `pragma config framework` output, grouped by branch:
- *
- * - **set** formats the confirmation after setting a framework.
- * - **reset** formats the confirmation after resetting to default.
- * - **query** formats the current framework value (or "none").
- */
-const frameworkFormatters = {
-  set: {
-    plain: (d: { field: string; value: string; path: string }) =>
-      `Set ${d.field} to "${d.value}".\nWrote ${d.path}`,
-    llm: (d: { field: string; value: string; path: string }) =>
-      `Set ${d.field} to "${d.value}".\nWrote ${d.path}`,
-    json: (d: { field: string; value: string; path: string }) =>
-      JSON.stringify({ field: d.field, value: d.value, path: d.path }),
-  } satisfies Formatters<{ field: string; value: string; path: string }>,
-
-  reset: {
-    plain: (d: { field: string; path: string }) =>
-      `Reset framework to default.\nWrote ${d.path}`,
-    llm: (d: { field: string; path: string }) =>
-      `Reset framework to default.\nWrote ${d.path}`,
-    json: (d: { field: string; path: string }) =>
-      JSON.stringify({ field: "framework", reset: true, path: d.path }),
-  } satisfies Formatters<{ field: string; path: string }>,
-
-  query: {
-    plain: (framework: string) => `Current framework: ${framework}`,
-    llm: (framework: string) => `Current framework: ${framework}`,
-    json: (framework: string) =>
-      JSON.stringify({ field: "framework", value: framework }),
-  } satisfies Formatters<string>,
-};
-
-export default frameworkFormatters;

package/src/domains/config/formatters/index.ts

@@ -1,6 +0,0 @@
-/** @module Formatter sets for config domain output. */
-export { default as channelFormatters } from "./channel.js";
-export { default as frameworkFormatters } from "./framework.js";
-export { default as showFormatters } from "./show.js";
-export { default as tierFormatters } from "./tier.js";
-export { default as traceFormatters } from "./trace.js";

package/src/domains/config/formatters/show.test.ts

@@ -1,153 +0,0 @@
-import { describe, expect, it } from "vitest";
-import type { ConfigShowData } from "../operations/types.js";
-import formatters from "./show.js";
-
-const WITH_TIER: ConfigShowData = {
-  tier: "apps/lxd",
-  tierChain: ["global", "apps", "apps/lxd"],
-  channel: "experimental",
-  includedReleases: ["stable", "experimental"],
-  packageManager: "bun",
-  installSource: "bun (global)",
-  configFilePath: "/project/pragma.config.json",
-  configFileExists: true,
-  globalConfigPath: "/home/u/.config/pragma/config.json",
-  globalConfigExists: false,
-  origins: {
-    tier: "project",
-    channel: "project",
-    packages: "default",
-    trace: "default",
-    framework: "default",
-  },
-};
-
-const WITHOUT_TIER: ConfigShowData = {
-  tier: undefined,
-  tierChain: [],
-  channel: "normal",
-  includedReleases: ["stable"],
-  packageManager: "npm",
-  installSource: "bun (local)",
-  configFilePath: "/project/pragma.config.json",
-  configFileExists: false,
-  globalConfigPath: "/home/u/.config/pragma/config.json",
-  globalConfigExists: false,
-  origins: {
-    tier: "project",
-    channel: "project",
-    packages: "default",
-    trace: "default",
-    framework: "default",
-  },
-};
-
-const PRERELEASE: ConfigShowData = {
-  tier: "global",
-  tierChain: ["global"],
-  channel: "prerelease",
-  includedReleases: ["stable", "experimental", "alpha", "beta"],
-  packageManager: "pnpm",
-  installSource: "pnpm (global)",
-  configFilePath: "/project/pragma.config.json",
-  configFileExists: true,
-  globalConfigPath: "/home/u/.config/pragma/config.json",
-  globalConfigExists: false,
-  origins: {
-    tier: "project",
-    channel: "project",
-    packages: "default",
-    trace: "default",
-    framework: "default",
-  },
-};
-
-describe("formatters.plain", () => {
-  it("renders full config with tier", () => {
-    const output = formatters.plain(WITH_TIER);
-    expect(output).toContain("tier: apps/lxd (global → apps → apps/lxd)");
-    expect(output).toContain("channel: experimental (stable + experimental)");
-    expect(output).toContain("installed via: bun (global)");
-    expect(output).toContain("config file: /project/pragma.config.json");
-  });
-
-  it("renders config without tier", () => {
-    const output = formatters.plain(WITHOUT_TIER);
-    expect(output).toContain("tier: (none — all tiers visible)");
-    expect(output).toContain("channel: normal (stable)");
-    expect(output).toContain("installed via: bun (local)");
-    expect(output).toContain("config file: (not found)");
-  });
-
-  it("renders prerelease channel with all release levels", () => {
-    const output = formatters.plain(PRERELEASE);
-    expect(output).toContain(
-      "channel: prerelease (stable + experimental + alpha + beta)",
-    );
-  });
-});
-
-describe("formatters.llm", () => {
-  it("renders markdown heading", () => {
-    const output = formatters.llm(WITH_TIER);
-    expect(output).toContain("## Configuration");
-  });
-
-  it("renders tier info as markdown", () => {
-    const output = formatters.llm(WITH_TIER);
-    expect(output).toContain("**Tier:** apps/lxd (global > apps > apps/lxd)");
-  });
-
-  it("renders channel info as markdown", () => {
-    const output = formatters.llm(WITH_TIER);
-    expect(output).toContain(
-      "**Channel:** experimental (stable, experimental)",
-    );
-  });
-
-  it("renders config file path in backticks", () => {
-    const output = formatters.llm(WITH_TIER);
-    expect(output).toContain("`/project/pragma.config.json`");
-  });
-
-  it("renders no tier message", () => {
-    const output = formatters.llm(WITHOUT_TIER);
-    expect(output).toContain("**Tier:** none (all tiers visible)");
-  });
-
-  it("renders missing config file", () => {
-    const output = formatters.llm(WITHOUT_TIER);
-    expect(output).toContain("**Config file:** not found");
-  });
-});
-
-describe("formatters.json", () => {
-  it("returns valid JSON", () => {
-    const text = formatters.json(WITH_TIER);
-    const parsed = JSON.parse(text);
-    expect(parsed.tier).toBe("apps/lxd");
-    expect(parsed.channel).toBe("experimental");
-    expect(parsed.tierChain).toEqual(["global", "apps", "apps/lxd"]);
-    expect(parsed.includedReleases).toEqual(["stable", "experimental"]);
-    expect(parsed.packageManager).toBe("bun");
-    expect(parsed.configFileExists).toBe(true);
-  });
-
-  it("returns JSON without tier when undefined", () => {
-    const text = formatters.json(WITHOUT_TIER);
-    const parsed = JSON.parse(text);
-    expect(parsed.tier).toBeUndefined();
-    expect(parsed.tierChain).toEqual([]);
-  });
-
-  it("preserves all fields", () => {
-    const text = formatters.json(PRERELEASE);
-    const parsed = JSON.parse(text);
-    expect(parsed.includedReleases).toEqual([
-      "stable",
-      "experimental",
-      "alpha",
-      "beta",
-    ]);
-  });
-});

package/src/domains/config/formatters/show.ts

@@ -1,89 +0,0 @@
-import type { Formatters } from "../../shared/formatters.js";
-import type { ConfigShowData } from "../operations/types.js";
-
-/**
- * Formatters for `pragma config show` output.
- *
- * - **plain** renders tier chain, channel, package manager, and config path.
- * - **llm** renders a markdown section with bullet points.
- * - **json** serializes the raw ConfigShowData.
- */
-/** Render a `[layer]` marker for values a config file supplied. */
-function originMarker(origin: "default" | "global" | "project"): string {
-  return origin === "default" ? "" : ` [${origin}]`;
-}
-
-const formatters: Formatters<ConfigShowData> = {
-  plain(data) {
-    const lines: string[] = [];
-
-    if (data.tier !== undefined) {
-      const chain = data.tierChain.join(" → ");
-      lines.push(
-        `tier: ${data.tier} (${chain})${originMarker(data.origins.tier)}`,
-      );
-    } else {
-      lines.push("tier: (none — all tiers visible)");
-    }
-
-    const releases = data.includedReleases.join(" + ");
-    lines.push(
-      `channel: ${data.channel} (${releases})${originMarker(data.origins.channel)}`,
-    );
-    lines.push(`installed via: ${data.installSource}`);
-
-    if (data.configFileExists) {
-      lines.push(`config file: ${data.configFilePath}`);
-    } else {
-      lines.push("config file: (not found)");
-    }
-    if (data.globalConfigExists) {
-      lines.push(`global config: ${data.globalConfigPath}`);
-    } else {
-      lines.push("global config: (not found)");
-    }
-
-    return lines.join("\n");
-  },
-
-  llm(data) {
-    const lines: string[] = [];
-
-    lines.push("## Configuration");
-    lines.push("");
-
-    if (data.tier !== undefined) {
-      const chain = data.tierChain.join(" > ");
-      lines.push(
-        `- **Tier:** ${data.tier} (${chain})${originMarker(data.origins.tier)}`,
-      );
-    } else {
-      lines.push("- **Tier:** none (all tiers visible)");
-    }
-
-    const releases = data.includedReleases.join(", ");
-    lines.push(
-      `- **Channel:** ${data.channel} (${releases})${originMarker(data.origins.channel)}`,
-    );
-    lines.push(`- **Installed via:** ${data.installSource}`);
-
-    if (data.configFileExists) {
-      lines.push(`- **Config file:** \`${data.configFilePath}\``);
-    } else {
-      lines.push("- **Config file:** not found");
-    }
-    if (data.globalConfigExists) {
-      lines.push(`- **Global config:** \`${data.globalConfigPath}\``);
-    } else {
-      lines.push("- **Global config:** not found");
-    }
-
-    return lines.join("\n");
-  },
-
-  json(data) {
-    return JSON.stringify(data, null, 2);
-  },
-};
-
-export default formatters;

package/src/domains/config/formatters/tier.test.ts

@@ -1,86 +0,0 @@
-import { describe, expect, it } from "vitest";
-import formatters from "./tier.js";
-
-describe("tierFormatters.set", () => {
-  const data = {
-    field: "tier",
-    value: "apps/lxd",
-    path: "/repo/pragma.config.json",
-  };
-
-  it("plain renders set message with the written path", () => {
-    expect(formatters.set.plain(data)).toBe(
-      'Set tier to "apps/lxd".\nWrote /repo/pragma.config.json',
-    );
-  });
-
-  it("llm renders set message with the written path", () => {
-    expect(formatters.set.llm(data)).toBe(
-      'Set tier to "apps/lxd".\nWrote /repo/pragma.config.json',
-    );
-  });
-
-  it("json returns valid JSON", () => {
-    const parsed = JSON.parse(formatters.set.json(data));
-    expect(parsed.field).toBe("tier");
-    expect(parsed.value).toBe("apps/lxd");
-    expect(parsed.path).toBe("/repo/pragma.config.json");
-  });
-});
-
-describe("tierFormatters.reset", () => {
-  const data = { field: "tier", path: "/repo/pragma.config.json" };
-
-  it("plain renders reset message with the written path", () => {
-    expect(formatters.reset.plain(data)).toBe(
-      "Reset tier to default.\nWrote /repo/pragma.config.json",
-    );
-  });
-
-  it("llm renders reset message with the written path", () => {
-    expect(formatters.reset.llm(data)).toBe(
-      "Reset tier to default.\nWrote /repo/pragma.config.json",
-    );
-  });
-
-  it("json returns valid JSON", () => {
-    const parsed = JSON.parse(formatters.reset.json(data));
-    expect(parsed.field).toBe("tier");
-    expect(parsed.reset).toBe(true);
-    expect(parsed.path).toBe("/repo/pragma.config.json");
-  });
-});
-
-describe("tierFormatters.query", () => {
-  it("plain shows current tier when set", () => {
-    expect(formatters.query.plain("apps")).toBe("Current tier: apps");
-  });
-
-  it("plain shows no tier message when undefined", () => {
-    expect(formatters.query.plain(undefined)).toBe(
-      "No tier set (all tiers visible).",
-    );
-  });
-
-  it("llm shows current tier when set", () => {
-    expect(formatters.query.llm("apps")).toBe("Current tier: apps");
-  });
-
-  it("llm shows no tier message when undefined", () => {
-    expect(formatters.query.llm(undefined)).toBe(
-      "No tier set (all tiers visible).",
-    );
-  });
-
-  it("json returns value when set", () => {
-    const parsed = JSON.parse(formatters.query.json("apps"));
-    expect(parsed.field).toBe("tier");
-    expect(parsed.value).toBe("apps");
-  });
-
-  it("json returns null value when undefined", () => {
-    const parsed = JSON.parse(formatters.query.json(undefined));
-    expect(parsed.field).toBe("tier");
-    expect(parsed.value).toBeNull();
-  });
-});

package/src/domains/config/formatters/tier.ts

@@ -1,48 +0,0 @@
-import type { Formatters } from "../../shared/formatters.js";
-
-/** Payload for a persisted config write, including the file written. */
-interface TierWrite {
-  readonly field: string;
-  readonly value: string;
-  readonly path: string;
-}
-
-/**
- * Formatter sets for `pragma config tier` output, grouped by branch:
- *
- * - **set** formats the confirmation after setting a tier (plain/llm/json).
- * - **reset** formats the confirmation after resetting to default (plain/llm/json).
- * - **query** formats the current tier value (plain/llm/json).
- */
-const tierFormatters = {
-  set: {
-    plain: (d: TierWrite) => `Set ${d.field} to "${d.value}".\nWrote ${d.path}`,
-    llm: (d: TierWrite) => `Set ${d.field} to "${d.value}".\nWrote ${d.path}`,
-    json: (d: TierWrite) =>
-      JSON.stringify({ field: d.field, value: d.value, path: d.path }),
-  } satisfies Formatters<TierWrite>,
-
-  reset: {
-    plain: (d: { field: string; path: string }) =>
-      `Reset tier to default.\nWrote ${d.path}`,
-    llm: (d: { field: string; path: string }) =>
-      `Reset tier to default.\nWrote ${d.path}`,
-    json: (d: { field: string; path: string }) =>
-      JSON.stringify({ field: "tier", reset: true, path: d.path }),
-  } satisfies Formatters<{ field: string; path: string }>,
-
-  query: {
-    plain: (tier: string | undefined) =>
-      tier !== undefined
-        ? `Current tier: ${tier}`
-        : "No tier set (all tiers visible).",
-    llm: (tier: string | undefined) =>
-      tier !== undefined
-        ? `Current tier: ${tier}`
-        : "No tier set (all tiers visible).",
-    json: (tier: string | undefined) =>
-      JSON.stringify({ field: "tier", value: tier ?? null }),
-  } satisfies Formatters<string | undefined>,
-};
-
-export default tierFormatters;

package/src/domains/config/formatters/trace.ts

@@ -1,28 +0,0 @@
-import type { Formatters } from "../../shared/formatters.js";
-
-/**
- * Formatter sets for `pragma config trace` output, grouped by branch:
- *
- * - **set** formats the confirmation after enabling/disabling.
- * - **query** formats the current trace status.
- */
-const traceFormatters = {
-  set: {
-    plain: (d: { field: string; value: boolean; path: string }) =>
-      `${d.value ? "Tracing enabled." : "Tracing disabled."}\nWrote ${d.path}`,
-    llm: (d: { field: string; value: boolean; path: string }) =>
-      `${d.value ? "Tracing enabled." : "Tracing disabled."}\nWrote ${d.path}`,
-    json: (d: { field: string; value: boolean; path: string }) =>
-      JSON.stringify({ field: d.field, value: d.value, path: d.path }),
-  } satisfies Formatters<{ field: string; value: boolean; path: string }>,
-
-  query: {
-    plain: (status: string) => status,
-    llm: (status: string) => status,
-    // Emit the human-readable status under `status`, not `value`, so the JSON
-    // shape stays consistent with `set` (where `value` is the boolean state).
-    json: (status: string) => JSON.stringify({ field: "trace", status }),
-  } satisfies Formatters<string>,
-};
-
-export default traceFormatters;

package/src/domains/config/index.ts

@@ -1,36 +0,0 @@
-/** @module Config domain -- tier, channel, and show commands for `pragma config`. */
-
-import type { CommandDefinition } from "@canonical/cli-core";
-import type { PragmaContext } from "../shared/context.js";
-import {
-  channelCommand,
-  frameworkCommand,
-  showCommand,
-  tierCommand,
-  traceCommand,
-} from "./commands/index.js";
-
-/**
- * Return all config command definitions.
- *
- * @param ctx - Pragma context providing cwd, store, and formatter selection.
- * @returns An array of CommandDefinitions for the config subcommands.
- */
-export function commands(ctx: PragmaContext): CommandDefinition[] {
-  return [
-    tierCommand(ctx),
-    channelCommand(ctx),
-    traceCommand(ctx),
-    frameworkCommand(ctx),
-    showCommand(ctx),
-  ];
-}
-
-export { specs as mcpSpecs } from "./mcp/index.js";
-export type { ConfigShowData } from "./operations/index.js";
-export {
-  resolveConfigShow,
-  validateChannel,
-  validateFramework,
-  validateTier,
-} from "./operations/index.js";

package/src/domains/config/mcp/index.ts

@@ -1,2 +0,0 @@
-/** @module Config domain MCP barrel — config_show, config_tier, config_channel. */
-export { default as specs } from "./specs.js";

package/src/domains/config/mcp/specs.ts

@@ -1,100 +0,0 @@
-/**
- * MCP tool specs for the config domain — config_show, config_tier,
- * config_channel.
- *
- * config_show is compiled from the config read story in `../stories.ts`
- * so both surfaces share resolution and formatters; the mutating tier and
- * channel tools are spec'd by hand.
- */
-
-import { readConfig, writeConfig } from "#config";
-import { compileReadTool } from "../../shared/stories/index.js";
-import type { ToolSpec } from "../../shared/ToolSpec.js";
-import { validateChannel, validateTier } from "../operations/index.js";
-import { configShowStory } from "../stories.js";
-
-const specs: readonly ToolSpec[] = [
-  compileReadTool(configShowStory),
-  {
-    name: "config_tier",
-    description:
-      "Set or reset the active tier. Pass a tier path to set, or reset=true to clear.",
-    params: {
-      path: {
-        type: "string",
-        description: "Tier path (e.g. 'global', 'apps/lxd')",
-        optional: true,
-      },
-      reset: {
-        type: "boolean",
-        description: "Reset tier to default",
-        optional: true,
-      },
-      global: {
-        type: "boolean",
-        description: "Write to the global config instead of the project file",
-        optional: true,
-      },
-    },
-    readOnly: false,
-    async execute(rt, { path, reset, global: globalScope }) {
-      const scope = globalScope === true ? "global" : undefined;
-
-      if (reset) {
-        const written = writeConfig(rt.cwd, { tier: undefined }, scope);
-        return { data: { tier: null, action: "reset", path: written } };
-      }
-
-      if (path) {
-        await validateTier(rt.store, path as string);
-        const written = writeConfig(rt.cwd, { tier: path as string }, scope);
-        return { data: { tier: path, action: "set", path: written } };
-      }
-
-      const config = readConfig(rt.cwd);
-      return { data: { tier: config.tier ?? null, action: "query" } };
-    },
-  },
-  {
-    name: "config_channel",
-    description:
-      "Set or reset the release channel. Pass a value to set, or reset=true to clear.",
-    params: {
-      value: {
-        type: "string",
-        description: "Channel (normal, experimental, prerelease)",
-        optional: true,
-      },
-      reset: {
-        type: "boolean",
-        description: "Reset channel to normal",
-        optional: true,
-      },
-      global: {
-        type: "boolean",
-        description: "Write to the global config instead of the project file",
-        optional: true,
-      },
-    },
-    readOnly: false,
-    async execute(rt, { value, reset, global: globalScope }) {
-      const scope = globalScope === true ? "global" : undefined;
-
-      if (reset) {
-        const written = writeConfig(rt.cwd, { channel: undefined }, scope);
-        return { data: { channel: "normal", action: "reset", path: written } };
-      }
-
-      if (value) {
-        const channel = validateChannel(value as string);
-        const written = writeConfig(rt.cwd, { channel }, scope);
-        return { data: { channel, action: "set", path: written } };
-      }
-
-      const config = readConfig(rt.cwd);
-      return { data: { channel: config.channel, action: "query" } };
-    },
-  },
-];
-
-export default specs;

package/src/domains/config/operations/index.ts

@@ -1,6 +0,0 @@
-/** @module Config operations: show, validate tier, validate channel. */
-export { default as resolveConfigShow } from "./show.js";
-export type { ConfigShowData } from "./types.js";
-export { default as validateChannel } from "./validateChannel.js";
-export { default as validateFramework } from "./validateFramework.js";
-export { default as validateTier } from "./validateTier.js";