@canonical/pragma-cli 0.30.0 → 0.31.0

package/src/domains/standard/orchestration/resolveStandardLookup.ts

@@ -1,33 +0,0 @@
-import type { LookupContract, LookupResult } from "../../shared/contracts.js";
-import lookupMany from "../../shared/lookupMany.js";
-import type { PragmaRuntime } from "../../shared/runtime.js";
-import { expandLookupQueries } from "../../shared/suggestions/index.js";
-import type { StandardDetailed } from "../../shared/types/index.js";
-import { lookupStandard } from "../operations/index.js";
-
-export default async function resolveStandardLookup(
-  store: Pick<PragmaRuntime, "store">["store"],
-  queries: readonly string[],
-): Promise<LookupContract<StandardDetailed>> {
-  const { names, globErrors } = await expandLookupQueries(
-    queries,
-    store,
-    "standard",
-  );
-
-  const lookupResult: LookupResult<StandardDetailed> =
-    names.length > 0
-      ? await lookupMany(names, (query) => lookupStandard(store, query))
-      : { results: [], errors: [], meta: { internalErrorCount: 0 } };
-
-  const result: LookupResult<StandardDetailed> = {
-    results: lookupResult.results,
-    errors: [...lookupResult.errors, ...globErrors],
-    meta: lookupResult.meta ?? { internalErrorCount: 0 },
-  };
-
-  return {
-    params: { names: queries },
-    result,
-  };
-}

package/src/domains/standard/orchestration/standardEmptyError.test.ts

@@ -1,33 +0,0 @@
-import { describe, expect, it } from "vitest";
-import standardEmptyError from "./standardEmptyError.js";
-
-describe("standardEmptyError", () => {
-  it("filter-narrowing: a category/search was active → clear filters and re-list", () => {
-    const err = standardEmptyError({ category: "react", search: "fold" });
-
-    expect(err.filters).toEqual({ category: "react", search: "fold" });
-    expect(err.recovery).toEqual({
-      message: "List all standards without filters.",
-      cli: "pragma standard list",
-      mcp: { tool: "standard_list" },
-    });
-  });
-
-  it("store-empty: no filter active → install, not a self-looping list", () => {
-    const err = standardEmptyError({});
-
-    expect(err.filters).toBeUndefined();
-    // Must NOT suggest `pragma standard list` again — that just re-returns empty.
-    expect(err.recovery).toEqual({
-      message: "Install the code standards packages that provide standards.",
-      cli: "bun add -D @canonical/code-standards",
-    });
-    expect(err.recovery?.mcp).toBeUndefined();
-  });
-
-  it("install branch cites the code-standards package", () => {
-    const err = standardEmptyError({});
-    expect(err.recovery?.cli).toContain("@canonical/code-standards");
-    expect(err.recovery?.cli).not.toContain("ds-global");
-  });
-});

package/src/domains/standard/orchestration/standardEmptyError.ts

@@ -1,29 +0,0 @@
-import { PragmaError } from "#error";
-import type { StandardListFilters } from "../../shared/types/index.js";
-
-export default function standardEmptyError(
-  filters: StandardListFilters,
-): PragmaError {
-  const active: Record<string, string> = {};
-  if (filters.category) active.category = filters.category;
-  if (filters.search) active.search = filters.search;
-  const hasFilter = Object.keys(active).length > 0;
-
-  return PragmaError.emptyResults("standard", {
-    filters: hasFilter ? active : undefined,
-    recovery: hasFilter
-      ? {
-          // Filter-narrowing: clear the active category/search and re-list.
-          message: "List all standards without filters.",
-          cli: "pragma standard list",
-          mcp: { tool: "standard_list" },
-        }
-      : {
-          // Store-empty with no filter active: suggesting `standard list`
-          // again would just re-return empty, so route to the install.
-          message:
-            "Install the code standards packages that provide standards.",
-          cli: "bun add -D @canonical/code-standards",
-        },
-  });
-}

package/src/domains/standard/standardConfig.ts

@@ -1,42 +0,0 @@
-import type { EntityDisplayConfig } from "../shared/contracts.js";
-import { P } from "../shared/prefixes.js";
-import type {
-  FilterConfig,
-  StandardDetailed,
-  StandardDigest,
-  StandardSummary,
-} from "../shared/types/index.js";
-
-/** Display-contract configuration for code-standard entities. */
-export const standardConfig: EntityDisplayConfig<
-  StandardSummary,
-  StandardDigest,
-  StandardDetailed
-> = {
-  domain: "standard",
-  entityName: "standard",
-  rdfTypes: [`${P.cs}CodeStandard`],
-  listColumns: [
-    { key: "uri", label: "IRI" },
-    { key: "name", label: "Name" },
-    { key: "category", label: "Category" },
-    { key: "description", label: "Description" },
-  ],
-  digestColumns: [{ key: "extends", label: "Extends", showWhenEmpty: false }],
-  lookupSections: [
-    { key: "description", heading: "Description", kind: "field" },
-    { key: "extends", heading: "Extends", kind: "field", showWhenEmpty: false },
-    { key: "dos", heading: "Do", kind: "table", showWhenEmpty: false },
-    { key: "donts", heading: "Don't", kind: "table", showWhenEmpty: false },
-  ],
-  emptyRecovery: (_filters: FilterConfig) => ({
-    message: "List available standards.",
-    cli: "pragma standard list",
-    mcp: { tool: "standard_list" },
-  }),
-  notFoundRecovery: (_query: string) => ({
-    message: "List available standards.",
-    cli: "pragma standard list",
-    mcp: { tool: "standard_list" },
-  }),
-};

package/src/domains/standard/stories.test.ts

@@ -1,24 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { standardListStory, standardLookupStory } from "./stories.js";
-
-describe("standardListStory", () => {
-  it("renders the ink list view", () => {
-    const view = standardListStory.renderInk?.({
-      items: [],
-      details: undefined,
-      disclosure: { level: "summary" },
-    });
-    expect(typeof view).toBe("string");
-    expect(view).toContain("Standards");
-  });
-});
-
-describe("standardLookupStory", () => {
-  it("renders the ink lookup view", () => {
-    const view = standardLookupStory.renderInk?.(
-      { results: [], errors: [] },
-      { surface: "cli", detailed: false, params: {} },
-    );
-    expect(typeof view).toBe("string");
-  });
-});

package/src/domains/standard/stories.ts

@@ -1,151 +0,0 @@
-/**
- * Standard read stories — the single declaration of `standard list` and
- * `standard lookup` for both surfaces.
- *
- * The story kernel compiles these into the CLI commands and MCP tools,
- * so descriptions, parameters, resolution, and rendering live here once.
- */
-
-import { createListView, createLookupView } from "#tui";
-import type { LookupStory, ReadStory } from "../shared/stories/index.js";
-import type { StandardDetailed } from "../shared/types/index.js";
-import {
-  createInkLookupOptions,
-  listFormatters,
-  lookupFormatters,
-  type StandardListOutput,
-  type StandardLookupInput,
-} from "./formatters/index.js";
-import {
-  resolveStandardList,
-  resolveStandardLookup,
-} from "./orchestration/index.js";
-import { standardConfig } from "./standardConfig.js";
-import type { StandardListResolution } from "./types.js";
-
-/** The `standard list` / `standard_list` read story. */
-export const standardListStory: ReadStory<
-  StandardListResolution,
-  StandardListOutput
-> = {
-  noun: "standard",
-  verb: "list",
-  description: "List all code standards",
-  toolDescription:
-    "List code standards. Optionally filter by category or search term. Use digest/detailed for progressive disclosure.",
-  params: [
-    {
-      name: "category",
-      type: "string",
-      description: "Filter by category",
-      toolDescription: "Filter by category name",
-    },
-    {
-      name: "search",
-      type: "string",
-      description: "Search in name and description",
-    },
-    {
-      name: "digest",
-      type: "boolean",
-      description: "Show description and first example for each standard",
-      default: false,
-    },
-    {
-      name: "detailed",
-      type: "boolean",
-      description: "Show full dos/donts for each standard",
-      default: false,
-    },
-  ],
-  examples: [
-    "pragma standard list",
-    "pragma standard list --category react",
-    'pragma standard list --search "folder"',
-    "pragma standard list --digest",
-    "pragma standard list --detailed",
-    "pragma standard list --llm",
-  ],
-  resolve: (rt, params) =>
-    resolveStandardList(rt, {
-      category: params.category as string | undefined,
-      search: params.search as string | undefined,
-      digest: params.digest === true,
-      detailed: params.detailed === true,
-    }),
-  toOutput: (resolution) => ({
-    items: resolution.items,
-    details: resolution.details,
-    disclosure: resolution.disclosure,
-  }),
-  formatters: listFormatters,
-  toEnvelope: (resolution) => {
-    if (resolution.disclosure.level === "summary") {
-      return {
-        data: resolution.items,
-        meta: { count: resolution.items.length },
-      };
-    }
-    const output: StandardListOutput = {
-      items: resolution.items,
-      details: resolution.details,
-      disclosure: resolution.disclosure,
-    };
-    return {
-      data: JSON.parse(listFormatters.json(output)),
-      meta: {
-        count: resolution.items.length,
-        disclosure: resolution.disclosure.level,
-      },
-    };
-  },
-  renderInk: (output) =>
-    createListView({
-      heading: "Standards",
-      domain: "standard",
-      items: output.items,
-      columns: standardConfig.listColumns,
-    }),
-};
-
-/** The `standard lookup` / `standard_lookup` read story. */
-export const standardLookupStory: LookupStory<
-  StandardDetailed,
-  StandardLookupInput
-> = {
-  noun: "standard",
-  description: "Look up detailed information for a standard by name or IRI",
-  toolDescription:
-    "Get detailed information about one or more code standards including dos and donts with code examples.",
-  namesDescription: "Standard names or IRIs",
-  namesToolDescription: "Standard names or IRIs to look up",
-  detailedParam: {
-    description: "Include dos and donts with code blocks",
-    toolDescription:
-      "Return full details with dos/donts (default: true for MCP)",
-  },
-  examples: [
-    "pragma standard lookup react/component/folder-structure",
-    "pragma standard lookup react/component/folder-structure react/component/props",
-    "pragma standard lookup react/component/folder-structure --detailed",
-    "pragma standard lookup react/component/folder-structure --llm",
-    "pragma standard lookup cs:react_props",
-  ],
-  resolve: async (rt, names) => {
-    const contract = await resolveStandardLookup(rt.store, names);
-    return contract.result;
-  },
-  toFmtInput: (standard, view) => ({ standard, detailed: view.detailed }),
-  formatters: lookupFormatters,
-  project: (standard) => {
-    const { uri, name, category, description } = standard;
-    return { uri, name, category, description };
-  },
-  renderInk: (result, view) =>
-    createLookupView({
-      results: result.results,
-      errors: result.errors,
-      domain: "standard",
-      options: createInkLookupOptions(view.detailed),
-    }),
-};

package/src/domains/standard/types.ts

@@ -1,15 +0,0 @@
-import type { ListParams } from "../shared/contracts.js";
-import type {
-  Disclosure,
-  StandardDetailed,
-  StandardListFilters,
-  StandardSummary,
-} from "../shared/types/index.js";
-
-export interface StandardListResolution {
-  readonly params: ListParams & StandardListFilters;
-  readonly items: readonly StandardSummary[];
-  readonly filters: StandardListFilters;
-  readonly disclosure: Disclosure;
-  readonly details?: readonly (StandardDetailed | null)[];
-}

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

@@ -1,3 +0,0 @@
-/** @module Re-exports tier command builders (`list`). */
-
-export { default as listCommand } from "./list.js";

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

@@ -1,67 +0,0 @@
-import type { CommandOutputResult } 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 listCommand 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["globalFlags"]>,
-): PragmaContext {
-  return {
-    cwd: "/tmp",
-    store,
-    config: { tier: undefined, channel: "normal" },
-    globalFlags: {
-      llm: false,
-      format: "text",
-      verbose: false,
-      ...overrides,
-    },
-  };
-}
-
-describe("tier list command", () => {
-  it("returns tiers with hierarchy", async () => {
-    const ctx = makeCtx();
-    const cmd = listCommand(ctx);
-    const result = await cmd.execute({}, ctx);
-    expect(result.tag).toBe("output");
-
-    const output = result as CommandOutputResult;
-    const text = output.render.plain(output.value);
-    expect(text).toContain("global");
-    expect(text).toContain("apps");
-    expect(text).toContain("apps/lxd");
-  });
-
-  it("renders flat tier list without parent references", async () => {
-    const ctx = makeCtx();
-    const cmd = listCommand(ctx);
-    const result = await cmd.execute({}, ctx);
-    const output = result as CommandOutputResult;
-    const text = output.render.plain(output.value);
-    expect(text).not.toContain("(parent:");
-  });
-
-  it("renders LLM format with --llm", async () => {
-    const ctx = makeCtx({ llm: true });
-    const cmd = listCommand(ctx);
-    const result = await cmd.execute({}, ctx);
-    const output = result as CommandOutputResult;
-    const text = output.render.plain(output.value);
-    expect(text).toContain("## Tiers");
-    expect(text).toContain("**global**");
-  });
-});

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

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

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

@@ -1,3 +0,0 @@
-/** @module Re-exports tier formatters (`listFormatters`). */
-
-export { default as listFormatters } from "./list.js";

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

@@ -1,33 +0,0 @@
-import type { URI } from "@canonical/ke";
-import { describe, expect, it } from "vitest";
-import type { TierEntry } from "../../shared/types/index.js";
-import formatters from "./list.js";
-
-const TIERS: TierEntry[] = [
-  { uri: "http://example.com/t1" as URI, path: "apps", depth: 0 },
-  { uri: "http://example.com/t2" as URI, path: "apps/lxd", depth: 0 },
-  { uri: "http://example.com/t3" as URI, path: "global", depth: 0 },
-];
-
-describe("tier list formatters", () => {
-  it("plain renders flat tier names", () => {
-    const text = formatters.plain(TIERS);
-    expect(text).toContain("global");
-    expect(text).toContain("apps");
-    expect(text).toContain("apps/lxd");
-  });
-
-  it("plain renders one tier per line", () => {
-    const text = formatters.plain(TIERS);
-    const lines = text.split("\n").filter(Boolean);
-    expect(lines).toHaveLength(3);
-  });
-
-  it("llm renders markdown heading and bold paths", () => {
-    const text = formatters.llm(TIERS);
-    expect(text).toContain("## Tiers");
-    expect(text).toContain("- **global**");
-    expect(text).toContain("- **apps**");
-    expect(text).toContain("- **apps/lxd**");
-  });
-});

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

@@ -1,45 +0,0 @@
-import compactUri from "../../shared/compactUri.js";
-import type { Formatters } from "../../shared/formatters.js";
-import { PREFIX_MAP } from "../../shared/prefixes.js";
-import type { TierEntry } from "../../shared/types/index.js";
-
-/**
- * Three-mode formatter for `pragma tier list` output.
- *
- * - **plain** — indented terminal text showing tier hierarchy with
- *   optional parent annotations.
- * - **llm** — condensed Markdown consumed by LLM agents and reused
- *   by the MCP adapter when `condensed: true`.
- * - **json** — structured JSON array for programmatic consumption.
- */
-const formatters: Formatters<TierEntry[]> = {
-  plain: (tiers) => {
-    const lines: string[] = [];
-    for (const t of tiers) {
-      const indent = "  ".repeat(t.depth);
-      const parent = t.parent ? ` (parent: ${t.parent})` : "";
-      lines.push(
-        `${compactUri(t.uri, PREFIX_MAP)}  ${indent}${t.path}${parent}`,
-      );
-    }
-    return lines.join("\n");
-  },
-
-  llm: (tiers) => {
-    const lines: string[] = [];
-    lines.push("## Tiers");
-    lines.push("");
-    for (const t of tiers) {
-      const indent = "  ".repeat(t.depth);
-      const parent = t.parent ? ` (parent: ${t.parent})` : "";
-      lines.push(
-        `${indent}- **${t.path}** \`${compactUri(t.uri, PREFIX_MAP)}\`${parent}`,
-      );
-    }
-    return lines.join("\n");
-  },
-
-  json: (tiers) => JSON.stringify(tiers, null, 2),
-};
-
-export default formatters;

package/src/domains/tier/index.ts

@@ -1,17 +0,0 @@
-/**
- * @module Tier domain — CLI commands and operations.
- *
- * Commands: `pragma tier list`.
- * Operations: {@link listTiers}.
- */
-
-import type { CommandDefinition } from "@canonical/cli-core";
-import type { PragmaContext } from "../shared/context.js";
-import { listCommand } from "./commands/index.js";
-
-export function commands(ctx: PragmaContext): CommandDefinition[] {
-  return [listCommand(ctx)];
-}
-
-export { specs as mcpSpecs } from "./mcp/index.js";
-export { listTiers } from "./operations/index.js";

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

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

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

@@ -1,12 +0,0 @@
-/**
- * MCP tool specs for the tier domain — tier_list, compiled from the tier
- * read story in `../stories.ts`.
- */
-
-import { compileReadTool } from "../../shared/stories/index.js";
-import type { ToolSpec } from "../../shared/ToolSpec.js";
-import { tierListStory } from "../stories.js";
-
-const specs: readonly ToolSpec[] = [compileReadTool(tierListStory)];
-
-export default specs;

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

@@ -1,3 +0,0 @@
-/** @module Re-exports tier operations (`listTiers`). */
-
-export { default as listTiers } from "./list.js";

package/src/domains/tier/operations/list.test.ts

@@ -1,32 +0,0 @@
-import type { Store } from "@canonical/ke";
-import { afterAll, beforeAll, describe, expect, it } from "vitest";
-import { createTestStore, DS_ALL_TTL } from "#testing";
-import listTiers 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());
-
-describe("listTiers", () => {
-  it("returns all tiers from the ontology", async () => {
-    const result = await listTiers(store);
-    const paths = result.map((t) => t.path);
-    expect(paths).toContain("global");
-    expect(paths).toContain("apps");
-    expect(paths).toContain("apps/lxd");
-  });
-
-  it("returns sorted by name", async () => {
-    const result = await listTiers(store);
-    const paths = result.map((t) => t.path);
-    const sorted = [...paths].sort();
-    expect(paths).toEqual(sorted);
-  });
-});

package/src/domains/tier/operations/list.ts

@@ -1,33 +0,0 @@
-/**
- * Lists all tiers defined in the design system ontology, ordered by name.
- *
- * @param store - ke store to query
- * @returns array of tier entries, empty when none exist
- * @note Queries ke store
- */
-
-import type { Store, URI } from "@canonical/ke";
-import { buildQuery } from "../../shared/buildQuery.js";
-import { P } from "../../shared/prefixes.js";
-import type { TierEntry } from "../../shared/types/index.js";
-
-export default async function listTiers(store: Store): Promise<TierEntry[]> {
-  const result = await store.query(
-    buildQuery(`
-      SELECT ?tier ?name
-      WHERE {
-        ?tier a ${P.ds}Tier ;
-              ${P.ds}name ?name .
-      }
-      ORDER BY ?name
-    `),
-  );
-
-  if (result.type !== "select") return [];
-
-  return result.bindings.map((b) => ({
-    uri: (b.tier ?? "") as URI,
-    path: b.name ?? "",
-    depth: 0,
-  }));
-}

package/src/domains/tier/stories.test.ts

@@ -1,22 +0,0 @@
-import type { URI } from "@canonical/ke";
-import { describe, expect, it } from "vitest";
-import { tierListStory } from "./stories.js";
-
-const tier = {
-  uri: "https://ds.example/global" as URI,
-  path: "global",
-  depth: 0,
-};
-
-describe("tierListStory", () => {
-  it("renders the ink list view", () => {
-    const view = tierListStory.renderInk?.([tier]);
-    expect(typeof view).toBe("string");
-    expect(view).toContain("Tiers");
-  });
-
-  it("rejects only empty results", () => {
-    expect(tierListStory.emptyError?.([], {})).toBeDefined();
-    expect(tierListStory.emptyError?.([tier], {})).toBeUndefined();
-  });
-});