@canonical/pragma-cli 0.30.0 → 0.31.0

package/src/domains/create/commands/component.ts

@@ -1,123 +0,0 @@
-import {
-  type CommandDefinition,
-  executeGenerator,
-  type ParameterDefinition,
-  promptToParameter,
-} from "@canonical/cli-core";
-import { generators } from "@canonical/summon-component";
-import { PragmaError } from "#error";
-import { COMPONENT_GENERATORS } from "../generators.js";
-
-const FRAMEWORK_CHOICES = [
-  { label: "react", value: "react" },
-  { label: "svelte", value: "svelte" },
-  { label: "lit", value: "lit" },
-] as const;
-
-/** Reference generator used to derive shared prompt parameters. */
-const referenceGenerator = generators["component/react"];
-
-/**
- * Build the `pragma create component` command definition.
- *
- * Uses a dispatch pattern: `framework` is a required positional select
- * parameter. The execute function looks up the matching generator and
- * delegates to `executeGenerator` from cli-core.
- *
- * @returns The command definition for `pragma create component`.
- * @note Impure
- */
-export default function buildComponentCommand(): CommandDefinition {
-  const frameworkParam: ParameterDefinition = {
-    name: "framework",
-    description: "Component framework (react, svelte, lit)",
-    type: "select",
-    choices: [...FRAMEWORK_CHOICES],
-    positional: true,
-    required: true,
-  };
-
-  // Derive prompt parameters from the reference generator
-  const promptParams = referenceGenerator.prompts.map(promptToParameter);
-
-  // Execution-mode parameters (same as generatorToCommand appends)
-  const execParams: ParameterDefinition[] = [
-    {
-      name: "dryRun",
-      description: "Preview without writing files",
-      type: "boolean",
-    },
-    {
-      name: "undo",
-      description: "Reverse a previously generated component",
-      type: "boolean",
-    },
-    {
-      name: "yes",
-      description: "Skip confirmation prompts",
-      type: "boolean",
-    },
-    {
-      name: "showFiles",
-      description: "Show file contents in dry-run",
-      type: "boolean",
-    },
-    {
-      name: "preview",
-      description: "Show file preview before writing",
-      type: "boolean",
-      default: true,
-    },
-    {
-      name: "generatedStamp",
-      description: "Add generated file stamps",
-      type: "boolean",
-      default: true,
-    },
-  ];
-
-  const parameters = [frameworkParam, ...promptParams, ...execParams];
-
-  return {
-    path: ["create", "component"],
-    description:
-      "Generate a component with TypeScript, tests, stories, and styles",
-    parameters,
-    execute: async (params, ctx) => {
-      const framework = params.framework as string | undefined;
-      if (!framework) {
-        throw PragmaError.invalidInput("framework", "(missing)", {
-          validOptions: ["react", "svelte", "lit"],
-          recovery: {
-            message: "Provide a framework for component generation.",
-            cli: "pragma create component react src/components/Button",
-          },
-        });
-      }
-
-      const gen = COMPONENT_GENERATORS[framework];
-      if (!gen) {
-        throw PragmaError.invalidInput("framework", framework, {
-          validOptions: Object.keys(COMPONENT_GENERATORS),
-          recovery: {
-            message: `Valid frameworks: ${Object.keys(COMPONENT_GENERATORS).join(", ")}`,
-          },
-        });
-      }
-
-      return executeGenerator(gen, params, ctx);
-    },
-    meta: {
-      examples: [
-        "pragma create component react src/components/Button",
-        "pragma create component svelte src/lib/components/Toggle",
-        "pragma create component lit src/lib/Accordion",
-        "pragma create component react src/components/Button --dry-run",
-      ],
-    },
-    parameterGroups: {
-      Component: ["componentPath"],
-      Options: ["withStyles", "withStories", "withSsrTests"],
-    },
-  };
-}

package/src/domains/create/commands/index.ts

@@ -1,3 +0,0 @@
-/** @module Create command definitions for `pragma create`. */
-export { default as componentCommand } from "./component.js";
-export { default as packageCommand } from "./package.js";

package/src/domains/create/commands/package.test.ts

@@ -1,35 +0,0 @@
-import type { CommandContext } from "@canonical/cli-core";
-import { describe, expect, it } from "vitest";
-import buildPackageCommand from "./package.js";
-
-const ctx: CommandContext = {
-  cwd: "/tmp",
-  globalFlags: { llm: false, format: "text" as const, verbose: false },
-};
-
-describe("buildPackageCommand", () => {
-  it("has correct path", () => {
-    const cmd = buildPackageCommand();
-    expect(cmd.path).toEqual(["create", "package"]);
-  });
-
-  it("dry-run with all params returns output", async () => {
-    const cmd = buildPackageCommand();
-    const result = await cmd.execute(
-      {
-        name: "@canonical/test-pkg",
-        type: "tool-ts",
-        dryRun: true,
-        yes: true,
-      },
-      ctx,
-    );
-    expect(result.tag).toBe("output");
-  });
-
-  it("with missing required params returns batch output outside a TTY", async () => {
-    const cmd = buildPackageCommand();
-    const result = await cmd.execute({}, ctx);
-    expect(result.tag).toBe("output");
-  });
-});

package/src/domains/create/commands/package.ts

@@ -1,21 +0,0 @@
-import {
-  type CommandDefinition,
-  generatorToCommand,
-} from "@canonical/cli-core";
-import { generators as packageGenerators } from "@canonical/summon-package";
-
-/**
- * Build the `pragma create package` command definition by bridging
- * the package generator via `generatorToCommand`.
- *
- * @returns The command definition for `pragma create package`.
- * @throws Error if the package generator is not found.
- * @note Impure
- */
-export default function buildPackageCommand(): CommandDefinition {
-  const gen = packageGenerators.package;
-  if (!gen) {
-    throw new Error("Package generator not found in @canonical/summon-package");
-  }
-  return generatorToCommand(["create", "package"], gen);
-}

package/src/domains/create/generators.ts

@@ -1,8 +0,0 @@
-import { generators } from "@canonical/summon-component";
-import type { AnyGenerator } from "@canonical/summon-core";
-
-export const COMPONENT_GENERATORS: Record<string, AnyGenerator> = {
-  react: generators["component/react"],
-  svelte: generators["component/svelte"],
-  lit: generators["component/lit"],
-};

package/src/domains/standard/commands/categories.test.ts

@@ -1,70 +0,0 @@
-import type { CommandDefinition } from "@canonical/cli-core";
-import type { Store } from "@canonical/ke";
-import { afterAll, beforeAll, describe, expect, it } from "vitest";
-import { createTestStore, DS_ALL_TTL } from "#testing";
-import type { PragmaContext } from "../../shared/context.js";
-import buildCategoriesCommand from "./categories.js";
-
-let store: Store;
-let cleanup: () => void;
-
-beforeAll(async () => {
-  const result = await createTestStore({ ttl: DS_ALL_TTL });
-  store = result.store;
-  cleanup = result.cleanup;
-});
-
-afterAll(() => cleanup());
-
-function makeCtx(overrides: Partial<PragmaContext> = {}): PragmaContext {
-  return {
-    cwd: "/tmp",
-    globalFlags: { llm: false, format: "text" as const, verbose: false },
-    store,
-    config: { tier: undefined, channel: "prerelease" },
-    ...overrides,
-  };
-}
-
-async function executeOutput(
-  cmd: CommandDefinition,
-  params: Record<string, unknown>,
-  ctx: PragmaContext,
-): Promise<{ value: unknown; text: string }> {
-  const result = await cmd.execute(params, ctx);
-  expect(result.tag).toBe("output");
-  if (result.tag !== "output") throw new Error("Expected output result");
-  const text = result.render.plain(result.value);
-  return { value: result.value, text };
-}
-
-describe("buildCategoriesCommand", () => {
-  it("returns categories with counts", async () => {
-    const ctx = makeCtx();
-    const cmd = buildCategoriesCommand(ctx);
-    const { text } = await executeOutput(cmd, {}, ctx);
-    expect(text).toContain("react (2 standards)");
-    expect(text).toContain("code (1 standard)");
-  });
-
-  it("renders LLM format with --llm", async () => {
-    const ctx = makeCtx({
-      globalFlags: { llm: true, format: "text" as const, verbose: false },
-    });
-    const cmd = buildCategoriesCommand(ctx);
-    const { text } = await executeOutput(cmd, {}, ctx);
-    expect(text).toContain("## Standard Categories");
-    expect(text).toContain("**react**");
-  });
-
-  it("renders JSON output", async () => {
-    const ctx = makeCtx({
-      globalFlags: { llm: false, format: "json" as const, verbose: false },
-    });
-    const cmd = buildCategoriesCommand(ctx);
-    const { text } = await executeOutput(cmd, {}, ctx);
-    const parsed = JSON.parse(text);
-    expect(Array.isArray(parsed)).toBe(true);
-    expect(parsed.some((c: { name: string }) => c.name === "react")).toBe(true);
-  });
-});

package/src/domains/standard/commands/categories.ts

@@ -1,48 +0,0 @@
-/**
- * Wires the `pragma standard categories` CLI command.
- *
- * Lists all standard categories with their standard counts. Throws a
- * structured recovery error when no categories are found.
- */
-
-import {
-  type CommandDefinition,
-  type CommandResult,
-  createOutputResult,
-} from "@canonical/cli-core";
-import { PragmaError } from "#error";
-import type { PragmaContext } from "../../shared/context.js";
-import { selectFormatter } from "../../shared/formatters.js";
-import { categoriesFormatters } from "../formatters/index.js";
-import { listCategories } from "../operations/index.js";
-
-export default function buildCategoriesCommand(
-  ctx: PragmaContext,
-): CommandDefinition {
-  return {
-    path: ["standard", "categories"],
-    description: "List all standard categories with counts",
-    parameters: [],
-    meta: {
-      examples: ["pragma standard categories"],
-    },
-    execute: async (
-      _params: Record<string, unknown>,
-    ): Promise<CommandResult> => {
-      const categories = await listCategories(ctx.store);
-
-      if (categories.length === 0) {
-        throw PragmaError.emptyResults("categories", {
-          recovery: {
-            message:
-              "Ensure code standards packages are installed: bun add -D @canonical/code-standards",
-          },
-        });
-      }
-
-      return createOutputResult(categories, {
-        plain: selectFormatter(ctx, categoriesFormatters),
-      });
-    },
-  };
-}

package/src/domains/standard/commands/index.ts

@@ -1,6 +0,0 @@
-/** @module Re-exports standard command builders (`categories`, `list`, `lookup`, `sample`). */
-
-export { default as categoriesCommand } from "./categories.js";
-export { default as listCommand } from "./list.js";
-export { default as lookupCommand } from "./lookup.js";
-export { default as sampleCommand } from "./sample.js";

package/src/domains/standard/commands/list.test.ts

@@ -1,105 +0,0 @@
-import type { CommandDefinition } from "@canonical/cli-core";
-import type { Store } from "@canonical/ke";
-import { afterAll, beforeAll, describe, expect, it } from "vitest";
-import { PragmaError } from "#error";
-import { createTestStore, DS_ALL_TTL } from "#testing";
-import type { PragmaContext } from "../../shared/context.js";
-import buildListCommand from "./list.js";
-
-let store: Store;
-let cleanup: () => void;
-
-beforeAll(async () => {
-  const result = await createTestStore({ ttl: DS_ALL_TTL });
-  store = result.store;
-  cleanup = result.cleanup;
-});
-
-afterAll(() => cleanup());
-
-function makeCtx(overrides: Partial<PragmaContext> = {}): PragmaContext {
-  return {
-    cwd: "/tmp",
-    globalFlags: { llm: false, format: "text" as const, verbose: false },
-    store,
-    config: { tier: undefined, channel: "prerelease" },
-    ...overrides,
-  };
-}
-
-async function executeOutput(
-  cmd: CommandDefinition,
-  params: Record<string, unknown>,
-  ctx: PragmaContext,
-): Promise<{ value: unknown; text: string }> {
-  const result = await cmd.execute(params, ctx);
-  expect(result.tag).toBe("output");
-  if (result.tag !== "output") throw new Error("Expected output result");
-  const text = result.render.plain(result.value);
-  return { value: result.value, text };
-}
-
-describe("buildListCommand", () => {
-  it("returns output result with all standards", async () => {
-    const ctx = makeCtx();
-    const cmd = buildListCommand(ctx);
-    const { text } = await executeOutput(cmd, {}, ctx);
-    expect(text).toContain("react/component/folder-structure");
-    expect(text).toContain("react/component/props");
-    expect(text).toContain("code/function/purity");
-  });
-
-  it("filters by --category", async () => {
-    const ctx = makeCtx();
-    const cmd = buildListCommand(ctx);
-    const { text } = await executeOutput(cmd, { category: "react" }, ctx);
-    expect(text).toContain("react/component/folder-structure");
-    expect(text).toContain("react/component/props");
-    expect(text).not.toContain("code/function/purity");
-  });
-
-  it("filters by --search", async () => {
-    const ctx = makeCtx();
-    const cmd = buildListCommand(ctx);
-    const { text } = await executeOutput(cmd, { search: "folder" }, ctx);
-    expect(text).toContain("react/component/folder-structure");
-    expect(text).not.toContain("code/function/purity");
-  });
-
-  it("throws EMPTY_RESULTS for non-matching filter", async () => {
-    const ctx = makeCtx();
-    const cmd = buildListCommand(ctx);
-    try {
-      await cmd.execute({ category: "nonexistent" }, ctx);
-      expect.fail("Should have thrown");
-    } catch (e) {
-      expect(e).toBeInstanceOf(PragmaError);
-      expect((e as PragmaError).code).toBe("EMPTY_RESULTS");
-    }
-  });
-
-  it("renders LLM format with --llm", async () => {
-    const ctx = makeCtx({
-      globalFlags: { llm: true, format: "text" as const, verbose: false },
-    });
-    const cmd = buildListCommand(ctx);
-    const { text } = await executeOutput(cmd, {}, ctx);
-    expect(text).toContain("## Standards");
-    expect(text).toContain("**react/component/folder-structure**");
-  });
-
-  it("renders JSON output", async () => {
-    const ctx = makeCtx({
-      globalFlags: { llm: false, format: "json" as const, verbose: false },
-    });
-    const cmd = buildListCommand(ctx);
-    const { text } = await executeOutput(cmd, {}, ctx);
-    const parsed = JSON.parse(text);
-    expect(Array.isArray(parsed)).toBe(true);
-    expect(
-      parsed.some(
-        (s: { name: string }) => s.name === "react/component/folder-structure",
-      ),
-    ).toBe(true);
-  });
-});

package/src/domains/standard/commands/list.ts

@@ -1,11 +0,0 @@
-import type { CommandDefinition } from "@canonical/cli-core";
-import type { PragmaContext } from "../../shared/context.js";
-import { compileReadCommand } from "../../shared/stories/index.js";
-import { standardListStory } from "../stories.js";
-
-/** Wire the `pragma standard list` CLI command from the standard list story. */
-export default function buildListCommand(
-  ctx: PragmaContext,
-): CommandDefinition {
-  return compileReadCommand(ctx, standardListStory);
-}

package/src/domains/standard/commands/lookup.test.ts

@@ -1,135 +0,0 @@
-import type { CommandDefinition } from "@canonical/cli-core";
-import type { Store } from "@canonical/ke";
-import { afterAll, beforeAll, describe, expect, it } from "vitest";
-import { createTestStore, DS_ALL_TTL } from "#testing";
-import type { PragmaContext } from "../../shared/context.js";
-import buildLookupCommand from "./lookup.js";
-
-let store: Store;
-let cleanup: () => void;
-
-beforeAll(async () => {
-  const result = await createTestStore({ ttl: DS_ALL_TTL });
-  store = result.store;
-  cleanup = result.cleanup;
-});
-
-afterAll(() => cleanup());
-
-function makeCtx(overrides: Partial<PragmaContext> = {}): PragmaContext {
-  return {
-    cwd: "/tmp",
-    globalFlags: { llm: false, format: "text" as const, verbose: false },
-    store,
-    config: { tier: undefined, channel: "prerelease" },
-    ...overrides,
-  };
-}
-
-async function executeOutput(
-  cmd: CommandDefinition,
-  params: Record<string, unknown>,
-  ctx: PragmaContext,
-): Promise<{ value: unknown; text: string }> {
-  const result = await cmd.execute(params, ctx);
-  expect(result.tag).toBe("output");
-  if (result.tag !== "output") throw new Error("Expected output result");
-  const text = result.render.plain(result.value);
-  return { value: result.value, text };
-}
-
-describe("buildLookupCommand", () => {
-  it("returns summary by default", async () => {
-    const ctx = makeCtx();
-    const cmd = buildLookupCommand(ctx);
-    const { text } = await executeOutput(
-      cmd,
-      { names: ["react/component/folder-structure"] },
-      ctx,
-    );
-    expect(text).toContain("react/component/folder-structure");
-    expect(text).toContain("Category: react");
-    expect(text).not.toContain("Do:");
-  });
-
-  it("returns dos and donts with --detailed", async () => {
-    const ctx = makeCtx();
-    const cmd = buildLookupCommand(ctx);
-    const { text } = await executeOutput(
-      cmd,
-      { names: ["react/component/folder-structure"], detailed: true },
-      ctx,
-    );
-    expect(text).toContain("Do:");
-    expect(text).toContain("Don't:");
-  });
-
-  it("throws ENTITY_NOT_FOUND for unknown standard", async () => {
-    const ctx = makeCtx();
-    const cmd = buildLookupCommand(ctx);
-    const result = await cmd.execute({ names: ["nonexistent"] }, ctx);
-    expect(result.tag).toBe("output");
-    if (result.tag !== "output") {
-      expect.fail("Expected output result");
-    }
-    expect(result.render.plain(result.value)).toContain("Errors:");
-  });
-
-  it("renders LLM format with --llm", async () => {
-    const ctx = makeCtx({
-      globalFlags: { llm: true, format: "text" as const, verbose: false },
-    });
-    const cmd = buildLookupCommand(ctx);
-    const { text } = await executeOutput(
-      cmd,
-      { names: ["react/component/folder-structure"], detailed: true },
-      ctx,
-    );
-    expect(text).toContain("## react/component/folder-structure");
-    expect(text).toContain("### Do");
-  });
-
-  it("renders JSON with --detailed", async () => {
-    const ctx = makeCtx({
-      globalFlags: { llm: false, format: "json" as const, verbose: false },
-    });
-    const cmd = buildLookupCommand(ctx);
-    const { text } = await executeOutput(
-      cmd,
-      { names: ["react/component/folder-structure"], detailed: true },
-      ctx,
-    );
-    const parsed = JSON.parse(text);
-    expect(parsed.name).toBe("react/component/folder-structure");
-    expect(parsed.dos).toBeDefined();
-    expect(parsed.donts).toBeDefined();
-  });
-
-  it("renders JSON without --detailed (omits dos/donts)", async () => {
-    const ctx = makeCtx({
-      globalFlags: { llm: false, format: "json" as const, verbose: false },
-    });
-    const cmd = buildLookupCommand(ctx);
-    const { text } = await executeOutput(
-      cmd,
-      { names: ["react/component/folder-structure"] },
-      ctx,
-    );
-    const parsed = JSON.parse(text);
-    expect(parsed.name).toBe("react/component/folder-structure");
-    expect(parsed.dos).toBeUndefined();
-    expect(parsed.donts).toBeUndefined();
-  });
-
-  it("renders multiple standards together", async () => {
-    const ctx = makeCtx();
-    const cmd = buildLookupCommand(ctx);
-    const { text } = await executeOutput(
-      cmd,
-      { names: ["react/component/folder-structure", "react/component/props"] },
-      ctx,
-    );
-    expect(text).toContain("react/component/folder-structure");
-    expect(text).toContain("react/component/props");
-  });
-});

package/src/domains/standard/commands/lookup.ts

@@ -1,14 +0,0 @@
-import type { CommandDefinition } from "@canonical/cli-core";
-import type { PragmaContext } from "../../shared/context.js";
-import { compileLookupCommand } from "../../shared/stories/index.js";
-import { standardLookupStory } from "../stories.js";
-
-/**
- * Wire the `pragma standard lookup <name-or-uri...>` CLI command from the
- * standard lookup story.
- */
-export default function buildLookupCommand(
-  ctx: PragmaContext,
-): CommandDefinition {
-  return compileLookupCommand(ctx, standardLookupStory);
-}

package/src/domains/standard/commands/sample.ts

@@ -1,57 +0,0 @@
-/**
- * Wires the `pragma standard sample` CLI command.
- *
- * Returns 1–5 complete standard instances as exemplars so agents
- * can learn the data shape before writing queries.
- */
-
-import {
-  type CommandDefinition,
-  createOutputResult,
-} from "@canonical/cli-core";
-import type { PragmaContext } from "../../shared/context.js";
-import { selectFormatter } from "../../shared/formatters.js";
-import type {
-  SampleOutput,
-  StandardDetailed,
-} from "../../shared/types/index.js";
-import { sampleFormatters } from "../formatters/index.js";
-import { sampleStandards } from "../operations/index.js";
-
-const NEXT_STEPS = [
-  "Use standard_lookup to inspect specific standards by name.",
-  "Use standard_list with --category to filter by category.",
-  "Use standard_categories to see all available categories.",
-];
-
-export default function sampleCommand(ctx: PragmaContext): CommandDefinition {
-  return {
-    path: ["standard", "sample"],
-    description:
-      "Return randomly selected complete standard instances as exemplars for shape discovery",
-    parameters: [
-      {
-        name: "count",
-        type: "string",
-        description: "Number of samples to return (1–5, default 2)",
-        required: false,
-      },
-    ],
-    meta: {
-      examples: ["pragma standard sample", "pragma standard sample --count 3"],
-    },
-    async execute(params) {
-      const count = Number(params.count ?? 2);
-      const result = await sampleStandards(ctx.store, count);
-
-      const output: SampleOutput<StandardDetailed> = {
-        ...result,
-        nextSteps: NEXT_STEPS,
-      };
-
-      return createOutputResult(output, {
-        plain: selectFormatter(ctx, sampleFormatters),
-      });
-    },
-  };
-}