akm-cli 0.6.0 → 0.7.0-rc1

package/dist/tests/output-baseline.test.js

@@ -0,0 +1,217 @@
+import { afterEach, describe, expect, test } from "bun:test";
+import { spawn, spawnSync } from "node:child_process";
+import fs from "node:fs";
+import http from "node:http";
+import os from "node:os";
+import path from "node:path";
+const CLI = path.join(__dirname, "..", "src", "cli.ts");
+const tempDirs = [];
+function makeTempDir(prefix) {
+    const dir = fs.mkdtempSync(path.join(os.tmpdir(), prefix));
+    tempDirs.push(dir);
+    return dir;
+}
+function writeFile(filePath, content) {
+    fs.mkdirSync(path.dirname(filePath), { recursive: true });
+    fs.writeFileSync(filePath, content);
+}
+function writeConfig(configDir, config) {
+    const configPath = path.join(configDir, "akm", "config.json");
+    fs.mkdirSync(path.dirname(configPath), { recursive: true });
+    fs.writeFileSync(configPath, `${JSON.stringify(config, null, 2)}\n`);
+}
+function runCli(stashDir, args, config) {
+    const xdgCache = makeTempDir("akm-output-cache-");
+    const xdgConfig = makeTempDir("akm-output-config-");
+    if (config)
+        writeConfig(xdgConfig, config);
+    const result = spawnSync("bun", [CLI, ...args], {
+        encoding: "utf8",
+        timeout: 30_000,
+        env: {
+            ...process.env,
+            AKM_STASH_DIR: stashDir,
+            XDG_CACHE_HOME: xdgCache,
+            XDG_CONFIG_HOME: xdgConfig,
+        },
+    });
+    expect(result.status).toBe(0);
+    return result.stdout.trim();
+}
+async function runCliAsync(stashDir, args, config) {
+    const xdgCache = makeTempDir("akm-output-cache-");
+    const xdgConfig = makeTempDir("akm-output-config-");
+    if (config)
+        writeConfig(xdgConfig, config);
+    const child = spawn("bun", [CLI, ...args], {
+        stdio: ["ignore", "pipe", "pipe"],
+        env: {
+            ...process.env,
+            AKM_STASH_DIR: stashDir,
+            XDG_CACHE_HOME: xdgCache,
+            XDG_CONFIG_HOME: xdgConfig,
+        },
+    });
+    let stdout = "";
+    let stderr = "";
+    child.stdout.on("data", (chunk) => {
+        stdout += String(chunk);
+    });
+    child.stderr.on("data", (chunk) => {
+        stderr += String(chunk);
+    });
+    const exitCode = await new Promise((resolve, reject) => {
+        child.on("error", reject);
+        child.on("close", (code) => resolve(code ?? 1));
+    });
+    expect(exitCode).toBe(0);
+    if (stderr.trim()) {
+        expect(stderr.trim()).toBe("");
+    }
+    return stdout.trim();
+}
+afterEach(() => {
+    for (const dir of tempDirs.splice(0)) {
+        fs.rmSync(dir, { recursive: true, force: true });
+    }
+});
+describe("output baseline", () => {
+    test("search default JSON brief shape stays stable", () => {
+        const stashDir = makeTempDir("akm-output-stash-");
+        writeFile(path.join(stashDir, "agents", "architect.md"), "---\ndescription: This is a deliberately long agent description that should be truncated in brief search output so the default response stays compact and easy to scan for both humans and agents.\n---\nYou are an architect.\n");
+        const output = runCli(stashDir, ["search", "architect", "--format=json"]);
+        const json = JSON.parse(output);
+        // hits is always present; warnings may appear when semantic search is pending
+        expect(Object.keys(json)).toContain("hits");
+        expect(Object.keys(json.hits[0] ?? {}).sort()).toEqual(["action", "estimatedTokens", "name", "type"]);
+    });
+    test("search normal detail includes description capped at 250 characters", () => {
+        const stashDir = makeTempDir("akm-output-stash-");
+        const description = "This is a deliberately long agent description that should be truncated at the normal detail level. It contains enough words to exceed two hundred and fifty characters so we can verify the cap is applied correctly by the CLI output shaping logic and does not let full descriptions through.";
+        writeFile(path.join(stashDir, "agents", "architect.md"), `---\ndescription: ${description}\n---\nYou are an architect.\n`);
+        const output = runCli(stashDir, ["search", "architect", "--format=json", "--detail=normal"]);
+        const json = JSON.parse(output);
+        expect(json.hits[0]?.score).toBeDefined();
+        expect(typeof json.hits[0]?.description).toBe("string");
+        expect(String(json.hits[0]?.description).length).toBeLessThanOrEqual(253); // 250 + "..."
+        expect(Object.keys(json.hits[0] ?? {})).not.toContain("ref");
+    });
+    test("search text output includes score for local hits at normal detail", () => {
+        const stashDir = makeTempDir("akm-output-stash-");
+        writeFile(path.join(stashDir, "scripts", "deploy.sh"), "#!/usr/bin/env bash\necho deploy\n");
+        const output = runCli(stashDir, ["search", "deploy", "--format=text", "--detail=normal"]);
+        expect(output).toContain("score:");
+        expect(output).toContain("action: akm show");
+    });
+    test("show default JSON shape stays stable", () => {
+        const stashDir = makeTempDir("akm-output-stash-");
+        writeFile(path.join(stashDir, "commands", "release.md"), "---\ndescription: Release\n---\nRun release {{version}}\n");
+        const output = runCli(stashDir, ["show", "command:release.md", "--format=json"]);
+        const json = JSON.parse(output);
+        // QA #7: path and editable are now always projected in JSON shape
+        expect(Object.keys(json).sort()).toEqual([
+            "action",
+            "description",
+            "editable",
+            "name",
+            "origin",
+            "parameters",
+            "path",
+            "template",
+            "type",
+        ]);
+        expect(json.origin).toBeNull();
+    });
+    test("show text output includes null origin for local assets", () => {
+        const stashDir = makeTempDir("akm-output-stash-");
+        writeFile(path.join(stashDir, "scripts", "deploy.sh"), "#!/usr/bin/env bash\necho deploy\n");
+        const output = runCli(stashDir, ["show", "script:deploy.sh", "--format=text"]);
+        expect(output).toContain("# origin: null");
+        expect(output).toContain("run:");
+    });
+    test("show shaped output includes action across all asset types", () => {
+        const stashDir = makeTempDir("akm-output-stash-");
+        writeFile(path.join(stashDir, "scripts", "deploy.sh"), "#!/usr/bin/env bash\necho deploy\n");
+        writeFile(path.join(stashDir, "skills", "ops", "SKILL.md"), "# Ops\nFollow this.\n");
+        writeFile(path.join(stashDir, "commands", "release.md"), "---\ndescription: Release\n---\nRun release {{version}}\n");
+        writeFile(path.join(stashDir, "agents", "coach.md"), "---\ndescription: Coach\n---\nYou are a coach.\n");
+        writeFile(path.join(stashDir, "knowledge", "guide.md"), "# Guide\nUse this.\n");
+        const refs = ["script:deploy.sh", "skill:ops", "command:release.md", "agent:coach.md", "knowledge:guide.md"];
+        for (const ref of refs) {
+            const output = runCli(stashDir, ["show", ref, "--format=json"]);
+            const json = JSON.parse(output);
+            expect(json.origin).toBeNull();
+            expect(typeof json.action).toBe("string");
+            expect(String(json.action).length).toBeGreaterThan(0);
+        }
+    });
+    test("show full JSON shape keeps schemaVersion gated to full detail", () => {
+        const stashDir = makeTempDir("akm-output-stash-");
+        writeFile(path.join(stashDir, "scripts", "deploy.sh"), "#!/usr/bin/env bash\necho deploy\n");
+        const output = runCli(stashDir, ["show", "script:deploy.sh", "--format=json", "--detail=full"]);
+        const json = JSON.parse(output);
+        expect(json.schemaVersion).toBe(1);
+        expect(Object.keys(json)).toContain("path");
+        expect(Object.keys(json)).toContain("editable");
+    });
+    test("config defaults drive output mode and CLI flags override them", () => {
+        const stashDir = makeTempDir("akm-output-stash-");
+        writeFile(path.join(stashDir, "scripts", "deploy.sh"), "#!/usr/bin/env bash\necho deploy\n");
+        const config = { output: { format: "text", detail: "normal" } };
+        const configDriven = runCli(stashDir, ["search", "deploy"], config);
+        expect(configDriven).toContain("score:");
+        const overridden = runCli(stashDir, ["search", "deploy", "--format=json", "--detail=brief"], config);
+        const json = JSON.parse(overridden);
+        // hits is always present; warnings may appear when semantic search is pending
+        expect(Object.keys(json)).toContain("hits");
+        expect(Object.keys(json.hits[0] ?? {})).not.toContain("origin");
+    });
+    test("search shaped output includes action for local and registry hits", async () => {
+        const stashDir = makeTempDir("akm-output-stash-");
+        const registryDir = makeTempDir("akm-output-registry-");
+        writeFile(path.join(stashDir, "scripts", "deploy.sh"), "#!/usr/bin/env bash\necho deploy\n");
+        writeFile(path.join(registryDir, "index.json"), JSON.stringify({
+            version: 3,
+            updatedAt: "2026-03-11T00:00:00Z",
+            stashes: [
+                {
+                    id: "npm:@scope/deploy-stash",
+                    name: "deploy-stash",
+                    description: "Registry deploy stash",
+                    ref: "@scope/deploy-stash",
+                    source: "npm",
+                    tags: ["deploy"],
+                },
+            ],
+        }));
+        const server = http.createServer((req, res) => {
+            if (req.url === "/index.json") {
+                res.writeHead(200, { "Content-Type": "application/json" });
+                res.end(fs.readFileSync(path.join(registryDir, "index.json"), "utf8"));
+                return;
+            }
+            res.writeHead(404);
+            res.end("not found");
+        });
+        await new Promise((resolve) => server.listen(0, "127.0.0.1", () => resolve()));
+        const address = server.address();
+        if (!address || typeof address === "string") {
+            throw new Error("Failed to start test registry server");
+        }
+        try {
+            const output = await runCliAsync(stashDir, ["search", "deploy", "--format=json", "--detail=brief", "--source=both"], {
+                registries: [{ url: `http://127.0.0.1:${address.port}/index.json` }],
+            });
+            const json = JSON.parse(output);
+            // Brief local hits have type; registry hits are in registryHits
+            const localHit = json.hits.find((hit) => hit.type === "script");
+            const registryHit = (json.registryHits ?? []).find((hit) => hit.name === "deploy-stash");
+            expect(localHit?.action).toBeTruthy();
+            // QA #28: registry brief no longer includes action (use installRef instead)
+            expect(registryHit?.name).toBeTruthy();
+        }
+        finally {
+            await new Promise((resolve, reject) => server.close((error) => (error ? reject(error) : resolve())));
+        }
+    });
+});