@canonical/pragma-cli 0.29.0 → 0.31.0

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

@@ -1,184 +0,0 @@
-import type { Formatters } from "../../shared/formatters.js";
-import type { CodeBlock, StandardDetailed } from "../../shared/types/index.js";
-import type { StandardListOutput } from "./types.js";
-
-// ---------------------------------------------------------------------------
-// Helpers
-// ---------------------------------------------------------------------------
-
-const DEFAULT_MAX_EXAMPLE_LENGTH = 120;
-
-interface StandardListRow {
-  readonly uri: StandardDetailed["uri"];
-  readonly name: StandardDetailed["name"];
-  readonly category: StandardDetailed["category"];
-  readonly description: StandardDetailed["description"];
-  readonly extends?: StandardDetailed["extends"];
-  readonly example?: string;
-  readonly dos?: StandardDetailed["dos"];
-  readonly donts?: StandardDetailed["donts"];
-}
-
-function truncate(text: string, max: number): string {
-  const oneLine = text.replace(/\n/g, " ").trim();
-  return oneLine.length <= max ? oneLine : `${oneLine.slice(0, max - 1)}…`;
-}
-
-function firstDoExample(
-  detail: StandardDetailed | null | undefined,
-  maxLen: number,
-): string | undefined {
-  if (!detail || detail.dos.length === 0) return undefined;
-  // Safe — length check above guarantees dos[0] exists
-  return truncate((detail.dos[0] as CodeBlock).code, maxLen);
-}
-
-// ---------------------------------------------------------------------------
-// Plain
-// ---------------------------------------------------------------------------
-
-function plain(output: StandardListOutput): string {
-  return buildRows(output)
-    .map((row) => formatPlainRow(row, output.disclosure.level))
-    .join("\n\n");
-}
-
-// ---------------------------------------------------------------------------
-// LLM
-// ---------------------------------------------------------------------------
-
-function llm(output: StandardListOutput): string {
-  const lines = ["## Standards", ""];
-
-  for (const row of buildRows(output)) {
-    lines.push(formatLlmRow(row, output.disclosure.level));
-  }
-
-  return lines.join("\n");
-}
-
-// ---------------------------------------------------------------------------
-// JSON
-// ---------------------------------------------------------------------------
-
-function json({ items, details, disclosure }: StandardListOutput): string {
-  if (disclosure.level === "summary" || !details) {
-    return JSON.stringify(items, null, 2);
-  }
-
-  if (disclosure.level === "digest") {
-    const maxLen = disclosure.maxExampleLength ?? DEFAULT_MAX_EXAMPLE_LENGTH;
-    const enriched = items.map((s, i) => {
-      const example = firstDoExample(details[i], maxLen);
-      return example ? { ...s, example } : s;
-    });
-    return JSON.stringify(enriched, null, 2);
-  }
-
-  // detailed — merge full detail into each item
-  const enriched = items.map((s, i) => {
-    const detail = details[i];
-    return detail ? { ...s, dos: detail.dos, donts: detail.donts } : s;
-  });
-  return JSON.stringify(enriched, null, 2);
-}
-
-// ---------------------------------------------------------------------------
-// Export
-// ---------------------------------------------------------------------------
-
-/** Three-mode formatter for `pragma standard list` output. */
-const formatters: Formatters<StandardListOutput> = { plain, llm, json };
-
-export default formatters;
-
-function buildRows({
-  items,
-  details,
-  disclosure,
-}: StandardListOutput): readonly StandardListRow[] {
-  if (disclosure.level === "summary") {
-    return items;
-  }
-
-  if (disclosure.level === "digest") {
-    const maxLen = disclosure.maxExampleLength ?? DEFAULT_MAX_EXAMPLE_LENGTH;
-    return items.map((item, index) => ({
-      ...item,
-      extends: details?.[index]?.extends,
-      example: firstDoExample(details?.[index], maxLen),
-    }));
-  }
-
-  return items.map((item, index) => ({
-    ...item,
-    extends: details?.[index]?.extends,
-    dos: details?.[index]?.dos,
-    donts: details?.[index]?.donts,
-  }));
-}
-
-function formatPlainRow(
-  row: StandardListRow,
-  level: StandardListOutput["disclosure"]["level"],
-): string {
-  const lines = [formatHeading(row), `  ${row.description}`];
-
-  if (row.extends) {
-    lines.push(`  Extends: ${row.extends}`);
-  }
-
-  if (level === "digest" && row.example) {
-    lines.push(`  Example: ${row.example}`);
-  }
-
-  if (level === "detailed") {
-    if (row.dos && row.dos.length > 0) {
-      lines.push("  Do:");
-      lines.push(...row.dos.map((item) => `    ${item.code}`));
-    }
-
-    if (row.donts && row.donts.length > 0) {
-      lines.push("  Don't:");
-      lines.push(...row.donts.map((item) => `    ${item.code}`));
-    }
-  }
-
-  return lines.join("\n");
-}
-
-function formatLlmRow(
-  row: StandardListRow,
-  level: StandardListOutput["disclosure"]["level"],
-): string {
-  const lines = [
-    `- **${row.name}**${row.category ? ` [${row.category}]` : ""}`,
-  ];
-  lines.push(`  ${row.description}`);
-
-  if (row.extends) {
-    lines.push(`  Extends: ${row.extends}`);
-  }
-
-  if (level === "digest" && row.example) {
-    lines.push(`  Example: \`${row.example}\``);
-  }
-
-  if (level === "detailed") {
-    if (row.dos && row.dos.length > 0) {
-      lines.push("  **Do**:");
-      lines.push(...row.dos.map((item) => `  - ${item.code}`));
-    }
-
-    if (row.donts && row.donts.length > 0) {
-      lines.push("  **Don't**:");
-      lines.push(...row.donts.map((item) => `  - ${item.code}`));
-    }
-  }
-
-  return lines.join("\n");
-}
-
-function formatHeading(row: StandardListRow): string {
-  return row.category ? `${row.name} [${row.category}]` : row.name;
-}

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

@@ -1,95 +0,0 @@
-import type { URI } from "@canonical/ke";
-import { describe, expect, it } from "vitest";
-import type { StandardDetailed } from "../../shared/types/index.js";
-import formatters from "./lookup.js";
-
-const DETAILED: StandardDetailed = {
-  uri: "http://example.com/s1" as URI,
-  name: "react/component/folder-structure",
-  category: "react",
-  description: "Components must follow the standard folder layout",
-  dos: [
-    { language: "typescript", code: "Place files in src/lib/" },
-    { language: "typescript", code: "Include index.ts barrel" },
-  ],
-  donts: [{ language: "typescript", code: "Use flat directory" }],
-};
-
-describe("formatters.plain", () => {
-  it("renders summary without dos/donts by default", () => {
-    const text = formatters.plain({ standard: DETAILED, detailed: false });
-    expect(text).toContain("react/component/folder-structure");
-    expect(text).toContain("URI: http://example.com/s1");
-    expect(text).toContain("Category: react");
-    expect(text).toContain("Description:");
-    expect(text).not.toContain("Do:");
-    expect(text).not.toContain("Don't:");
-  });
-
-  it("renders dos and donts when detailed", () => {
-    const text = formatters.plain({ standard: DETAILED, detailed: true });
-    expect(text).toContain("Do:");
-    expect(text).toContain("  Place files in src/lib/");
-    expect(text).toContain("Don't:");
-    expect(text).toContain("  Use flat directory");
-  });
-
-  it("renders dash for empty category", () => {
-    const text = formatters.plain({
-      standard: { ...DETAILED, category: "" },
-      detailed: false,
-    });
-    expect(text).toContain("Category: —");
-  });
-
-  it("renders extends when present", () => {
-    const text = formatters.plain({
-      standard: { ...DETAILED, extends: "react/component/base" },
-      detailed: false,
-    });
-    expect(text).toContain("Extends: react/component/base");
-  });
-});
-
-describe("formatters.llm", () => {
-  it("renders markdown heading", () => {
-    const text = formatters.llm({ standard: DETAILED, detailed: false });
-    expect(text).toContain("## react/component/folder-structure");
-    expect(text).toContain("URI: http://example.com/s1");
-    expect(text).not.toContain("### Do");
-  });
-
-  it("renders extends in llm output when present", () => {
-    const text = formatters.llm({
-      standard: { ...DETAILED, extends: "cs:react_base" },
-      detailed: false,
-    });
-    expect(text).toContain("Extends: cs:react_base");
-  });
-
-  it("renders do/dont sections when detailed", () => {
-    const text = formatters.llm({ standard: DETAILED, detailed: true });
-    expect(text).toContain("### Do");
-    expect(text).toContain("### Don't");
-    expect(text).toContain("- Place files in src/lib/");
-  });
-});
-
-describe("formatters.json", () => {
-  it("includes dos/donts when detailed", () => {
-    const parsed = JSON.parse(
-      formatters.json({ standard: DETAILED, detailed: true }),
-    );
-    expect(parsed.dos).toHaveLength(2);
-    expect(parsed.donts).toHaveLength(1);
-  });
-
-  it("omits dos/donts when not detailed", () => {
-    const parsed = JSON.parse(
-      formatters.json({ standard: DETAILED, detailed: false }),
-    );
-    expect(parsed.dos).toBeUndefined();
-    expect(parsed.donts).toBeUndefined();
-    expect(parsed.name).toBe("react/component/folder-structure");
-  });
-});

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

@@ -1,101 +0,0 @@
-import type { RenderLookupOptions } from "../../shared/contracts.js";
-import type { Formatters } from "../../shared/formatters.js";
-import { renderLookupLlm, renderLookupPlain } from "../../shared/renderers.js";
-import type { StandardDetailed } from "../../shared/types/index.js";
-import { standardConfig } from "../standardConfig.js";
-import type { StandardLookupInput } from "./types.js";
-
-/** Three-mode formatter for `pragma standard lookup` output. */
-const formatters: Formatters<StandardLookupInput> = {
-  plain: ({ standard, detailed }) =>
-    renderLookupPlain(standard, {
-      title: (entry) => entry.name,
-      fields: [
-        { label: "URI", value: (entry) => entry.uri },
-        { label: "Category", value: (entry) => entry.category || "—" },
-        { label: "Description", value: (entry) => entry.description },
-        { label: "Extends", value: (entry) => entry.extends },
-      ],
-      sections: detailed
-        ? standardConfig.lookupSections.filter(
-            (section) => section.key === "dos" || section.key === "donts",
-          )
-        : [],
-      sectionOverrides: standardSectionOverrides,
-    }),
-
-  llm: ({ standard, detailed }) =>
-    renderLookupLlm(standard, {
-      title: (entry) => entry.name,
-      fields: [
-        { label: "URI", value: (entry) => entry.uri },
-        { label: "Category", value: (entry) => entry.category || "—" },
-        { label: "Description", value: (entry) => entry.description },
-        { label: "Extends", value: (entry) => entry.extends },
-      ],
-      sections: detailed
-        ? standardConfig.lookupSections.filter(
-            (section) => section.key === "dos" || section.key === "donts",
-          )
-        : [],
-      sectionOverrides: standardSectionOverrides,
-    }),
-
-  json({ standard, detailed }) {
-    if (detailed) {
-      return JSON.stringify(standard, null, 2);
-    }
-    const { dos: _dos, donts: _donts, ...summary } = standard;
-    return JSON.stringify(summary, null, 2);
-  },
-};
-
-export default formatters;
-
-/**
- * Build lookup rendering options for the Ink TUI view.
- *
- * @param detailed - whether to include dos/donts sections
- * @returns Options compatible with the LookupView component.
- */
-export function createInkLookupOptions(
-  detailed: boolean,
-): RenderLookupOptions<StandardDetailed> {
-  return {
-    title: (entry) => entry.name,
-    fields: [
-      { label: "URI", value: (entry) => entry.uri },
-      { label: "Category", value: (entry) => entry.category || "—" },
-      { label: "Description", value: (entry) => entry.description },
-      { label: "Extends", value: (entry) => entry.extends },
-    ],
-    sections: detailed
-      ? standardConfig.lookupSections.filter(
-          (section) => section.key === "dos" || section.key === "donts",
-        )
-      : [],
-  };
-}
-
-const standardSectionOverrides = {
-  dos: {
-    plain: (entry: StandardLookupInput["standard"]) =>
-      entry.dos.length > 0
-        ? entry.dos.map((item) => `  ${item.code}`).join("\n")
-        : null,
-    llm: (entry: StandardLookupInput["standard"]) =>
-      entry.dos.length > 0
-        ? entry.dos.map((item) => `- ${item.code}`).join("\n")
-        : null,
-  },
-  donts: {
-    plain: (entry: StandardLookupInput["standard"]) =>
-      entry.donts.length > 0
-        ? entry.donts.map((item) => `  ${item.code}`).join("\n")
-        : null,
-    llm: (entry: StandardLookupInput["standard"]) =>
-      entry.donts.length > 0
-        ? entry.donts.map((item) => `- ${item.code}`).join("\n")
-        : null,
-  },
-};

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

@@ -1,15 +0,0 @@
-/**
- * Sample formatter for the standard domain.
- *
- * Delegates to the shared factory, rendering each item via the
- * existing standard lookup formatter.
- */
-
-import createSampleFormatters from "../../shared/sampleFormatters.js";
-import type { StandardDetailed } from "../../shared/types/index.js";
-import lookupFormatters from "./lookup.js";
-
-export default createSampleFormatters<StandardDetailed>(
-  "standards",
-  (standard, mode) => lookupFormatters[mode]({ standard, detailed: true }),
-);

package/src/domains/standard/formatters/types.ts

@@ -1,31 +0,0 @@
-/**
- * Formatter input types for standard commands.
- *
- * Composite types that bundle the data with display options,
- * so formatters conform to the `Formatters<T>` contract.
- */
-
-import type {
-  Disclosure,
-  StandardDetailed,
-  StandardSummary,
-} from "../../shared/types/index.js";
-
-/** Input payload for the standard-lookup formatter, pairing data with a detail flag. */
-export interface StandardLookupInput {
-  readonly standard: StandardDetailed;
-  readonly detailed: boolean;
-}
-
-/**
- * Input for the list formatter with progressive disclosure.
- *
- * - summary: items only (name + category + description)
- * - digest: items enriched with first do example
- * - detailed: items enriched with full dos/donts
- */
-export interface StandardListOutput {
-  readonly items: readonly StandardSummary[];
-  readonly details?: readonly (StandardDetailed | null)[];
-  readonly disclosure: Disclosure;
-}

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";