@canonical/pragma-cli 0.30.0 → 0.31.0

package/src/domains/standard/index.ts

@@ -1,40 +0,0 @@
-/**
- * @module Standard domain — CLI commands and operations.
- *
- * Commands: `pragma standard list`, `pragma standard lookup <name>`,
- *           `pragma standard categories`.
- * Operations: {@link lookupStandard}, {@link listStandards}, {@link listCategories}.
- */
-
-import type { CommandDefinition } from "@canonical/cli-core";
-import type { PragmaContext } from "../shared/context.js";
-import {
-  categoriesCommand,
-  listCommand,
-  lookupCommand,
-  sampleCommand,
-} from "./commands/index.js";
-
-export function commands(ctx: PragmaContext): CommandDefinition[] {
-  return [
-    listCommand(ctx),
-    lookupCommand(ctx),
-    categoriesCommand(ctx),
-    sampleCommand(ctx),
-  ];
-}
-
-export { specs as mcpSpecs } from "./mcp/index.js";
-export {
-  listCategories,
-  listStandards,
-  lookupStandard,
-  sampleStandards,
-} from "./operations/index.js";
-export {
-  buildStandardFilters,
-  resolveStandardList,
-  resolveStandardLookup,
-  standardEmptyError,
-} from "./orchestration/index.js";
-export { standardConfig } from "./standardConfig.js";

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

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

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

@@ -1,89 +0,0 @@
-/**
- * MCP tool specs for the standard domain — standard_list, standard_lookup,
- * standard_categories, standard_sample.
- *
- * The list and lookup tools are compiled from the standard read stories in
- * `../stories.ts`; categories and sample are spec'd by hand. The adapter
- * layer converts these into registered MCP tools via `registerFromSpec()`.
- */
-
-import {
-  compileLookupTool,
-  compileReadTool,
-  condense,
-} from "../../shared/stories/index.js";
-import type { ToolSpec } from "../../shared/ToolSpec.js";
-import {
-  categoriesFormatters as standardCatFmt,
-  sampleFormatters as standardSampleFmt,
-} from "../formatters/index.js";
-import { listCategories, sampleStandards } from "../operations/index.js";
-import { standardListStory, standardLookupStory } from "../stories.js";
-
-const specs: readonly ToolSpec[] = [
-  compileReadTool(standardListStory),
-  compileLookupTool(standardLookupStory),
-  {
-    name: "standard_categories",
-    description: "List all code standard categories.",
-    params: {
-      condensed: {
-        type: "boolean",
-        description: "Token-optimized output",
-        optional: true,
-      },
-    },
-    readOnly: true,
-    async execute(rt, { condensed }) {
-      const result = await listCategories(rt.store);
-
-      if (condensed) {
-        return condense(standardCatFmt.llm(result));
-      }
-
-      return { data: result, meta: { count: result.length } };
-    },
-  },
-  {
-    name: "standard_sample",
-    description:
-      "Return 1–5 randomly selected complete code standard instances as exemplars. Use BEFORE writing queries to see actual data shapes, property names, and value formats. Each call returns different instances.",
-    params: {
-      count: {
-        type: "string",
-        description: "Number of samples (1–5, default 2)",
-        optional: true,
-      },
-      condensed: {
-        type: "boolean",
-        description: "Token-optimized output",
-        optional: true,
-      },
-    },
-    readOnly: true,
-    async execute(rt, { count, condensed }) {
-      const n = Number(count ?? 2);
-      const result = await sampleStandards(rt.store, n);
-      const nextSteps = [
-        `These are ${result.samples.length} of ${result.totalCount} total standards.`,
-        "Use standard_lookup to inspect specific standards by name.",
-        "Use standard_list with category param to filter by category.",
-      ];
-
-      if (condensed) {
-        return condense(standardSampleFmt.llm({ ...result, nextSteps }));
-      }
-
-      return {
-        data: {
-          samples: result.samples,
-          totalCount: result.totalCount,
-          nextSteps,
-        },
-        meta: { count: result.samples.length },
-      };
-    },
-  },
-] as const;
-
-export default specs;

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

@@ -1,61 +0,0 @@
-import type { Store } from "@canonical/ke";
-import { afterAll, beforeAll, describe, expect, it } from "vitest";
-import { createTestStore, DS_ALL_TTL } from "#testing";
-import { PREFIX_MAP } from "../../shared/prefixes.js";
-import listCategories 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());
-
-describe("listCategories", () => {
-  it("returns categories with standard counts", async () => {
-    const result = await listCategories(store);
-    expect(result.length).toBe(2);
-
-    const react = result.find((c) => c.name === "react");
-    expect(react?.standardCount).toBe(2);
-
-    const code = result.find((c) => c.name === "code");
-    expect(code?.standardCount).toBe(1);
-  });
-
-  it("returns sorted by name", async () => {
-    const result = await listCategories(store);
-    const names = result.map((c) => c.name);
-    const sorted = [...names].sort();
-    expect(names).toEqual(sorted);
-  });
-
-  it("includes categories with zero standards", async () => {
-    const ttlWithEmptyCategory = `
-      @prefix cs: <${PREFIX_MAP.cs}> .
-      cs:empty_cat a cs:Category ; cs:slug "empty" .
-      cs:filled_cat a cs:Category ; cs:slug "filled" .
-      cs:s1 a cs:CodeStandard ;
-        cs:name "filled/one" ;
-        cs:hasCategory cs:filled_cat ;
-        cs:description "A standard" .
-    `;
-    const { store: testStore, cleanup: testCleanup } = await createTestStore({
-      ttl: ttlWithEmptyCategory,
-    });
-    try {
-      const result = await listCategories(testStore);
-      const empty = result.find((c) => c.name === "empty");
-      expect(empty).toBeDefined();
-      expect(empty?.standardCount).toBe(0);
-      const filled = result.find((c) => c.name === "filled");
-      expect(filled?.standardCount).toBe(1);
-    } finally {
-      testCleanup();
-    }
-  });
-});

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

@@ -1,38 +0,0 @@
-/**
- * Lists all standard categories with the number of standards in each.
- *
- * @param store - ke store to query
- * @returns array of category summaries ordered by name, empty when none exist
- * @note Queries ke store
- */
-
-import type { Store } from "@canonical/ke";
-import { buildQuery } from "../../shared/buildQuery.js";
-import { P } from "../../shared/prefixes.js";
-import type { CategorySummary } from "../../shared/types/index.js";
-
-export default async function listCategories(
-  store: Store,
-): Promise<CategorySummary[]> {
-  const result = await store.query(
-    buildQuery(`
-      SELECT ?categoryName (COUNT(?standard) AS ?count)
-      WHERE {
-        ?cat a ${P.cs}Category ;
-             ${P.cs}slug ?categoryName .
-        OPTIONAL {
-          ?standard a ${P.cs}CodeStandard ;
-                    ${P.cs}hasCategory ?cat .
-        }
-      }
-      GROUP BY ?categoryName
-      ORDER BY ?categoryName
-    `),
-  );
-
-  if (result.type !== "select") return [];
-  return result.bindings.map((b) => ({
-    name: b.categoryName ?? "",
-    standardCount: Number.parseInt(b.count ?? "0", 10) || 0,
-  }));
-}

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

@@ -1,6 +0,0 @@
-/** @module Re-exports standard operations (`listCategories`, `listStandards`, `lookupStandard`, `sampleStandards`). */
-
-export { default as listCategories } from "./categories.js";
-export { default as listStandards } from "./list.js";
-export { default as lookupStandard } from "./lookup.js";
-export { default as sampleStandards } from "./sample.js";

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

@@ -1,75 +0,0 @@
-import type { Store } from "@canonical/ke";
-import { afterAll, beforeAll, describe, expect, it } from "vitest";
-import { createTestStore, DS_ALL_TTL } from "#testing";
-import listStandards 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("listStandards", () => {
-  it("returns all standards", async () => {
-    const result = await listStandards(store);
-    expect(result.length).toBe(3);
-    const names = result.map((s) => s.name);
-    expect(names).toContain("react/component/folder-structure");
-    expect(names).toContain("react/component/props");
-    expect(names).toContain("code/function/purity");
-  });
-
-  it("includes category names", async () => {
-    const result = await listStandards(store);
-    const folder = result.find(
-      (s) => s.name === "react/component/folder-structure",
-    );
-    expect(folder?.category).toBe("react");
-  });
-
-  it("returns sorted by name", async () => {
-    const result = await listStandards(store);
-    const names = result.map((s) => s.name);
-    const sorted = [...names].sort();
-    expect(names).toEqual(sorted);
-  });
-
-  it("filters by category", async () => {
-    const result = await listStandards(store, { category: "react" });
-    expect(result.length).toBe(2);
-    for (const s of result) {
-      expect(s.category).toBe("react");
-    }
-  });
-
-  it("filters by search term in name", async () => {
-    const result = await listStandards(store, { search: "folder" });
-    expect(result.length).toBe(1);
-    expect(result[0]?.name).toBe("react/component/folder-structure");
-  });
-
-  it("filters by search term in description", async () => {
-    const result = await listStandards(store, { search: "pure" });
-    expect(result.length).toBe(1);
-    expect(result[0]?.name).toBe("code/function/purity");
-  });
-
-  it("returns empty for non-matching category", async () => {
-    const result = await listStandards(store, { category: "nonexistent" });
-    expect(result.length).toBe(0);
-  });
-
-  it("combines category and search filters", async () => {
-    const result = await listStandards(store, {
-      category: "react",
-      search: "props",
-    });
-    expect(result.length).toBe(1);
-    expect(result[0]?.name).toBe("react/component/props");
-  });
-});

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

@@ -1,64 +0,0 @@
-/**
- * Lists all code standards, optionally filtered by category or search term.
- *
- * @param store - ke store to query
- * @param filters - optional category and/or search text filters
- * @returns array of standard summaries ordered by name, empty when none match
- * @note Queries ke store
- */
-
-import type { Store, URI } from "@canonical/ke";
-import { escapeSparqlValue } from "@canonical/ke";
-import { buildQuery } from "../../shared/buildQuery.js";
-import { P } from "../../shared/prefixes.js";
-import type {
-  StandardListFilters,
-  StandardSummary,
-} from "../../shared/types/index.js";
-
-export default async function listStandards(
-  store: Store,
-  filters?: StandardListFilters,
-): Promise<StandardSummary[]> {
-  const filterClauses: string[] = [];
-
-  if (filters?.category) {
-    const escaped = escapeSparqlValue(filters.category.toLowerCase());
-    filterClauses.push(
-      `?standard ${P.cs}hasCategory ?filterCat . ?filterCat ${P.cs}slug ?catSlug . FILTER(?catSlug = ${escaped})`,
-    );
-  }
-
-  if (filters?.search) {
-    const escaped = escapeSparqlValue(filters.search.toLowerCase());
-    filterClauses.push(
-      `FILTER(CONTAINS(LCASE(?name), ${escaped}) || CONTAINS(LCASE(?description), ${escaped}))`,
-    );
-  }
-
-  const result = await store.query(
-    buildQuery(`
-      SELECT ?standard ?name ?categoryName ?description
-      WHERE {
-        ?standard a ${P.cs}CodeStandard ;
-                  ${P.cs}name ?name ;
-                  ${P.cs}description ?description .
-        OPTIONAL {
-          ?standard ${P.cs}hasCategory ?cat .
-          ?cat ${P.cs}slug ?categoryName .
-        }
-        ${filterClauses.join("\n        ")}
-      }
-      ORDER BY ?name
-    `),
-  );
-
-  if (result.type !== "select") return [];
-
-  return result.bindings.map((b) => ({
-    uri: (b.standard ?? "") as URI,
-    name: b.name ?? "",
-    category: b.categoryName ?? "",
-    description: b.description ?? "",
-  }));
-}

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

@@ -1,58 +0,0 @@
-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 lookupStandard 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());
-
-describe("lookupStandard", () => {
-  it("returns detailed data with dos and donts", async () => {
-    const result = await lookupStandard(
-      store,
-      "react/component/folder-structure",
-    );
-    expect(result.name).toBe("react/component/folder-structure");
-    expect(result.category).toBe("react");
-    expect(result.dos.length).toBeGreaterThan(0);
-    expect(result.donts.length).toBeGreaterThan(0);
-  });
-
-  it("throws PragmaError.notFound for unknown standard", async () => {
-    await expect(lookupStandard(store, "nonexistent")).rejects.toThrow(
-      PragmaError,
-    );
-
-    try {
-      await lookupStandard(store, "nonexistent");
-    } catch (e) {
-      expect((e as PragmaError).code).toBe("ENTITY_NOT_FOUND");
-    }
-  });
-
-  it("resolves prefixed IRIs and compacts extends", async () => {
-    const result = await lookupStandard(store, "cs:react_props");
-    expect(result.name).toBe("react/component/props");
-    expect(result.extends).toBe("cs:react_folder");
-  });
-
-  it("resolves full IRIs", async () => {
-    const result = await lookupStandard(
-      store,
-      "http://pragma.canonical.com/codestandards#react_props",
-    );
-    expect(result.name).toBe("react/component/props");
-    expect(result.uri).toBe(
-      "http://pragma.canonical.com/codestandards#react_props",
-    );
-  });
-});

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

@@ -1,151 +0,0 @@
-/**
- * Look up detailed information for a single code standard by name.
- *
- * Queries the base standard data plus its dos and donts code blocks,
- * then assembles a {@link StandardDetailed} object.
- *
- * @param store - ke store to query
- * @param name - standard name (e.g. "react/component/folder-structure")
- * @returns full standard detail including dos/donts code blocks
- * @throws PragmaError.notFound if the standard does not exist
- * @note Queries ke store
- */
-
-import type { Store, URI } from "@canonical/ke";
-import { escapeSparqlValue } from "@canonical/ke";
-import { PragmaError } from "#error";
-import resolveUri from "../../graph/helpers/resolveUri.js";
-import { buildQuery } from "../../shared/buildQuery.js";
-import compactUri from "../../shared/compactUri.js";
-import { P } from "../../shared/prefixes.js";
-import {
-  detectCrossDomain,
-  listDomainNames,
-  suggestNames,
-} from "../../shared/suggestions/index.js";
-import type { CodeBlock, StandardDetailed } from "../../shared/types/index.js";
-
-export default async function lookupStandard(
-  store: Store,
-  nameOrUri: string,
-): Promise<StandardDetailed> {
-  const subjectClause = buildLookupSubjectClause(nameOrUri, store.prefixes);
-  const bindClause =
-    subjectClause === null ? "" : `BIND(${subjectClause} AS ?standard)`;
-  const matchClause =
-    subjectClause === null
-      ? `?standard ${P.cs}name ${escapeSparqlValue(nameOrUri)} .`
-      : "";
-
-  const baseResult = await store.query(
-    buildQuery(`
-      SELECT ?standard ?name ?categoryName ?description ?extends
-      WHERE {
-        ${bindClause}
-        ?standard a ${P.cs}CodeStandard ;
-                  ${P.cs}name ?name ;
-                  ${P.cs}description ?description .
-        ${matchClause}
-        OPTIONAL {
-          ?standard ${P.cs}hasCategory ?cat .
-          ?cat ${P.cs}slug ?categoryName .
-        }
-        OPTIONAL { ?standard ${P.cs}extends ?extends }
-      }
-      LIMIT 1
-    `),
-  );
-
-  if (baseResult.type !== "select" || baseResult.bindings.length === 0) {
-    const candidates = await listDomainNames(store, "standard");
-    const crossDomain = await detectCrossDomain(nameOrUri, "standard", store);
-    throw PragmaError.notFound("standard", nameOrUri, {
-      suggestions: suggestNames(nameOrUri, candidates),
-      recovery: {
-        message: "List available standards.",
-        cli: "pragma standard list",
-        mcp: { tool: "standard_list" },
-      },
-      crossDomain: crossDomain ?? undefined,
-    });
-  }
-
-  // Safe: length check above guarantees bindings[0] exists
-  const base = baseResult.bindings[0] as (typeof baseResult.bindings)[number];
-  const standardUri = base.standard;
-
-  // Fetch dos (cs:do → cs:Example with cs:description, cs:language, cs:code)
-  const dosResult = await store.query(
-    buildQuery(`
-      SELECT ?description ?language ?code
-      WHERE {
-        <${standardUri}> ${P.cs}do ?example .
-        OPTIONAL { ?example ${P.cs}description ?description }
-        OPTIONAL { ?example ${P.cs}language ?language }
-        OPTIONAL { ?example ${P.cs}code ?code }
-      }
-    `),
-  );
-
-  const dos: CodeBlock[] =
-    dosResult.type === "select"
-      ? dosResult.bindings.map((b) => ({
-          language: b.language ?? "typescript",
-          code: b.code ?? "",
-          caption: b.description,
-        }))
-      : [];
-
-  // Fetch donts (cs:dont → cs:Example with cs:description, cs:language, cs:code)
-  const dontsResult = await store.query(
-    buildQuery(`
-      SELECT ?description ?language ?code
-      WHERE {
-        <${standardUri}> ${P.cs}dont ?example .
-        OPTIONAL { ?example ${P.cs}description ?description }
-        OPTIONAL { ?example ${P.cs}language ?language }
-        OPTIONAL { ?example ${P.cs}code ?code }
-      }
-    `),
-  );
-
-  const donts: CodeBlock[] =
-    dontsResult.type === "select"
-      ? dontsResult.bindings.map((b) => ({
-          language: b.language ?? "typescript",
-          code: b.code ?? "",
-          caption: b.description,
-        }))
-      : [];
-
-  return {
-    uri: (standardUri ?? "") as URI,
-    name: base.name ?? nameOrUri,
-    category: base.categoryName ?? "",
-    description: base.description ?? "",
-    extends: base.extends
-      ? compactUri(base.extends, store.prefixes)
-      : undefined,
-    dos,
-    donts,
-  };
-}
-
-function buildLookupSubjectClause(
-  query: string,
-  prefixes: Readonly<Record<string, string>>,
-): string | null {
-  if (!looksLikeUri(query)) {
-    return null;
-  }
-
-  return `<${resolveUri(query, prefixes)}>`;
-}
-
-function looksLikeUri(query: string): boolean {
-  return (
-    query.startsWith("http://") ||
-    query.startsWith("https://") ||
-    query.includes(":")
-  );
-}

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,
-  };
-}