@canonical/pragma-cli 0.29.0 → 0.31.0

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

@@ -1,35 +0,0 @@
-/**
- * Returns a small number of complete standard instances as exemplars.
- *
- * Composes the existing list and lookup operations to avoid duplicating
- * any SPARQL logic. Agents use this to learn the data shape before querying.
- *
- * @param store - ke store to query
- * @param count - number of samples (clamped 1–5, default 2)
- * @returns sample result with detailed standards and total count
- * @note Queries ke store
- */
-
-import type { Store } from "@canonical/ke";
-import pickRandom from "../../shared/pickRandom.js";
-import type {
-  SampleResult,
-  StandardDetailed,
-} from "../../shared/types/index.js";
-import listStandards from "./list.js";
-import lookupStandard from "./lookup.js";
-
-export default async function sampleStandards(
-  store: Store,
-  count = 2,
-): Promise<SampleResult<StandardDetailed>> {
-  const clamped = Math.max(1, Math.min(5, count));
-  const all = await listStandards(store);
-  const selected = pickRandom(all, clamped);
-
-  const samples = await Promise.all(
-    selected.map((s) => lookupStandard(store, s.name)),
-  );
-
-  return { samples, totalCount: all.length };
-}

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

@@ -1,11 +0,0 @@
-import type { StandardListFilters } from "../../shared/types/index.js";
-
-export default function buildStandardFilters(params: {
-  category?: string;
-  search?: string;
-}): StandardListFilters {
-  return {
-    category: params.category,
-    search: params.search,
-  };
-}

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

@@ -1,4 +0,0 @@
-export { default as buildStandardFilters } from "./buildStandardFilters.js";
-export { default as resolveStandardList } from "./resolveStandardList.js";
-export { default as resolveStandardLookup } from "./resolveStandardLookup.js";
-export { default as standardEmptyError } from "./standardEmptyError.js";

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

@@ -1,45 +0,0 @@
-import type { ListParams } from "../../shared/contracts.js";
-import type { PragmaRuntime } from "../../shared/runtime.js";
-import type {
-  Disclosure,
-  StandardListFilters,
-} from "../../shared/types/index.js";
-import { listStandards, lookupStandard } from "../operations/index.js";
-import type { StandardListResolution } from "../types.js";
-import buildStandardFilters from "./buildStandardFilters.js";
-import standardEmptyError from "./standardEmptyError.js";
-
-export default async function resolveStandardList(
-  rt: Pick<PragmaRuntime, "store">,
-  params: ListParams & StandardListFilters,
-): Promise<StandardListResolution> {
-  const filters = buildStandardFilters(params);
-  const items = await listStandards(rt.store, filters);
-
-  if (items.length === 0) {
-    throw standardEmptyError(filters);
-  }
-
-  const disclosure: Disclosure = params.detailed
-    ? { level: "detailed" }
-    : params.digest
-      ? { level: "digest" }
-      : { level: "summary" };
-
-  const details =
-    disclosure.level === "summary"
-      ? undefined
-      : await Promise.all(
-          items.map((item) =>
-            lookupStandard(rt.store, item.name).catch(() => null),
-          ),
-        );
-
-  return {
-    params,
-    items,
-    filters,
-    disclosure,
-    details,
-  };
-}

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

@@ -1,32 +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: [] };
-
-  const result: LookupResult<StandardDetailed> = {
-    results: lookupResult.results,
-    errors: [...lookupResult.errors, ...globErrors],
-  };
-
-  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/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,59 +0,0 @@
-/**
- * Wires the `pragma tier list` CLI command.
- *
- * Lists all tiers defined in the design system ontology. Throws a
- * structured recovery error when no tiers are found.
- */
-
-import {
-  type CommandDefinition,
-  createOutputResult,
-} from "@canonical/cli-core";
-import { PragmaError } from "#error";
-import { createListView } from "#tui";
-import type { PragmaContext } from "../../shared/context.js";
-import type { ColumnDef } from "../../shared/contracts.js";
-import { selectFormatter } from "../../shared/formatters.js";
-import type { TierEntry } from "../../shared/types/tier.js";
-import { listFormatters } from "../formatters/index.js";
-import { listTiers } from "../operations/index.js";
-
-const tierListColumns: readonly ColumnDef<TierEntry>[] = [
-  { key: "uri", label: "IRI" },
-  { key: "path", label: "Path" },
-  { key: "parent", label: "Parent" },
-];
-
-export default function listCommand(ctx: PragmaContext): CommandDefinition {
-  return {
-    path: ["tier", "list"],
-    description: "List all tiers in the design system ontology",
-    parameters: [],
-    meta: {
-      examples: ["pragma tier list", "pragma tier list --llm"],
-    },
-    async execute() {
-      const tiers = await listTiers(ctx.store);
-
-      if (tiers.length === 0) {
-        throw PragmaError.emptyResults("tier", {
-          recovery: {
-            message:
-              "Ensure design system packages are installed: bun add -D @canonical/ds-global",
-          },
-        });
-      }
-
-      return createOutputResult(tiers, {
-        plain: selectFormatter(ctx, listFormatters),
-        ink: (data) =>
-          createListView({
-            heading: "Tiers",
-            domain: "tier",
-            items: data,
-            columns: tierListColumns,
-          }),
-      });
-    },
-  };
-}

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,38 +0,0 @@
-/**
- * MCP tool specs for the tier domain.
- */
-
-import type { ToolSpec } from "../../shared/ToolSpec.js";
-import { listFormatters as tierListFmt } from "../formatters/index.js";
-import { listTiers } from "../operations/index.js";
-
-const specs: readonly ToolSpec[] = [
-  {
-    name: "tier_list",
-    description: "List all tiers in the design system ontology with hierarchy.",
-    params: {
-      condensed: {
-        type: "boolean",
-        description: "Token-optimized output",
-        optional: true,
-      },
-    },
-    readOnly: true,
-    async execute(rt, { condensed }) {
-      const result = await listTiers(rt.store);
-
-      if (condensed) {
-        const text = tierListFmt.llm(result);
-        return {
-          condensed: true,
-          text,
-          tokens: `~${Math.ceil(text.length / 4)}`,
-        };
-      }
-
-      return { data: result, meta: { count: result.length } };
-    },
-  },
-];
-
-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,
-  }));
-}