akm-cli 0.7.0-rc1 → 0.7.1

package/dist/tests/metadata.test.js

@@ -1,313 +0,0 @@
-import { afterAll, expect, test } from "bun:test";
-import fs from "node:fs";
-import os from "node:os";
-import path from "node:path";
-import { extractDescriptionFromComments, extractPackageMetadata, extractTagsFromPath, fileNameToDescription, generateMetadata, loadStashFile, validateStashEntry, writeStashFile, } from "../src/indexer/metadata";
-// Renderers auto-register via ensureBuiltinsRegistered in file-context.ts
-const createdTmpDirs = [];
-function tmpDir() {
-    const dir = fs.mkdtempSync(path.join(os.tmpdir(), "akm-meta-"));
-    createdTmpDirs.push(dir);
-    return dir;
-}
-afterAll(() => {
-    for (const dir of createdTmpDirs) {
-        fs.rmSync(dir, { recursive: true, force: true });
-    }
-});
-function writeFile(filePath, content = "") {
-    fs.mkdirSync(path.dirname(filePath), { recursive: true });
-    fs.writeFileSync(filePath, content);
-}
-// ── loadStashFile ───────────────────────────────────────────────────────────
-test("loadStashFile reads valid .stash.json", () => {
-    const dir = tmpDir();
-    const stash = {
-        entries: [
-            {
-                name: "docker-build",
-                type: "script",
-                description: "build docker images",
-                tags: ["docker", "build"],
-                filename: "docker-build.ts",
-            },
-        ],
-    };
-    writeFile(path.join(dir, ".stash.json"), JSON.stringify(stash));
-    const result = loadStashFile(dir);
-    expect(result).not.toBeNull();
-    expect(result?.entries).toHaveLength(1);
-    expect(result?.entries[0].name).toBe("docker-build");
-    expect(result?.entries[0].description).toBe("build docker images");
-    expect(result?.entries[0].tags).toEqual(["docker", "build"]);
-});
-test("loadStashFile returns null for missing file", () => {
-    const dir = tmpDir();
-    expect(loadStashFile(dir)).toBeNull();
-});
-test("loadStashFile returns null for invalid JSON", () => {
-    const dir = tmpDir();
-    writeFile(path.join(dir, ".stash.json"), "not json");
-    expect(loadStashFile(dir)).toBeNull();
-});
-test("loadStashFile returns null for missing entries array", () => {
-    const dir = tmpDir();
-    writeFile(path.join(dir, ".stash.json"), '{"foo": "bar"}');
-    expect(loadStashFile(dir)).toBeNull();
-});
-test("loadStashFile parses intent field", () => {
-    const dir = tmpDir();
-    const stash = {
-        entries: [
-            {
-                name: "deploy",
-                type: "script",
-                intent: { when: "user needs to deploy", input: "service name", output: "deployment status" },
-                filename: "deploy.sh",
-            },
-        ],
-    };
-    writeFile(path.join(dir, ".stash.json"), JSON.stringify(stash));
-    const result = loadStashFile(dir);
-    expect(result?.entries[0].intent).toEqual({
-        when: "user needs to deploy",
-        input: "service name",
-        output: "deployment status",
-    });
-});
-// ── writeStashFile ──────────────────────────────────────────────────────────
-test("writeStashFile persists .stash.json to disk", () => {
-    const dir = tmpDir();
-    const stash = {
-        entries: [{ name: "test", type: "script", quality: "generated" }],
-    };
-    writeStashFile(dir, stash);
-    const raw = fs.readFileSync(path.join(dir, ".stash.json"), "utf8");
-    const parsed = JSON.parse(raw);
-    expect(parsed.entries[0].name).toBe("test");
-    expect(parsed.entries[0].quality).toBe("generated");
-});
-// ── validateStashEntry ──────────────────────────────────────────────────────
-test("validateStashEntry rejects entries without name", () => {
-    expect(validateStashEntry({ type: "script" })).toBeNull();
-});
-test("validateStashEntry rejects entries without valid type", () => {
-    expect(validateStashEntry({ name: "x", type: "invalid" })).toBeNull();
-});
-test("validateStashEntry accepts minimal valid entry", () => {
-    const result = validateStashEntry({ name: "x", type: "script" });
-    expect(result).not.toBeNull();
-    expect(result?.name).toBe("x");
-    expect(result?.type).toBe("script");
-});
-test("validateStashEntry parses quality, confidence, source, and aliases", () => {
-    const result = validateStashEntry({
-        name: "lint",
-        type: "script",
-        quality: "curated",
-        confidence: 2,
-        source: "manual",
-        aliases: ["Lint", "linters"],
-    });
-    expect(result).not.toBeNull();
-    expect(result?.quality).toBe("curated");
-    expect(result?.confidence).toBe(1);
-    expect(result?.source).toBe("manual");
-    // R4.6: de-pluralization heuristic removed; FTS5 porter stemmer handles stemming.
-    // "linters" is preserved as-is; "linter" is no longer generated.
-    expect(result?.aliases).toEqual(["lint", "linters"]);
-});
-// ── extractDescriptionFromComments ──────────────────────────────────────────
-test("extractDescriptionFromComments parses JSDoc block comment", () => {
-    const dir = tmpDir();
-    const file = path.join(dir, "tool.ts");
-    writeFile(file, `/**\n * Generate docker compose stacks\n */\nconsole.log("hi")\n`);
-    const desc = extractDescriptionFromComments(file);
-    expect(desc).toBe("Generate docker compose stacks");
-});
-test("extractDescriptionFromComments parses hash comments after shebang", () => {
-    const dir = tmpDir();
-    const file = path.join(dir, "tool.sh");
-    writeFile(file, `#!/usr/bin/env bash\n# Deploy to production\n# Handles rollback\necho deploy\n`);
-    const desc = extractDescriptionFromComments(file);
-    expect(desc).toBe("Deploy to production Handles rollback");
-});
-test("extractDescriptionFromComments returns null for no comments", () => {
-    const dir = tmpDir();
-    const file = path.join(dir, "tool.ts");
-    writeFile(file, `console.log("no comments")\n`);
-    expect(extractDescriptionFromComments(file)).toBeNull();
-});
-// ── extractPackageMetadata ──────────────────────────────────────────────────
-test("extractPackageMetadata reads package.json fields", () => {
-    const dir = tmpDir();
-    writeFile(path.join(dir, "package.json"), JSON.stringify({ name: "my-tool", description: "A useful tool", keywords: ["deploy", "ci"] }));
-    const meta = extractPackageMetadata(dir);
-    expect(meta).not.toBeNull();
-    expect(meta?.name).toBe("my-tool");
-    expect(meta?.description).toBe("A useful tool");
-    expect(meta?.keywords).toEqual(["deploy", "ci"]);
-});
-test("extractPackageMetadata returns null when no package.json", () => {
-    const dir = tmpDir();
-    expect(extractPackageMetadata(dir)).toBeNull();
-});
-// ── fileNameToDescription ───────────────────────────────────────────────────
-test("fileNameToDescription converts dashes and underscores to spaces", () => {
-    expect(fileNameToDescription("docker-compose-generator")).toBe("docker compose generator");
-    expect(fileNameToDescription("my_script_tool")).toBe("my script tool");
-});
-test("fileNameToDescription handles camelCase", () => {
-    expect(fileNameToDescription("dockerBuild")).toBe("docker build");
-});
-// ── extractTagsFromPath ─────────────────────────────────────────────────────
-test("extractTagsFromPath extracts tokens from path segments", () => {
-    const root = "/stash/scripts";
-    const file = path.join(root, "docker", "compose-generator.ts");
-    const tags = extractTagsFromPath(file, root);
-    expect(tags).toContain("docker");
-    expect(tags).toContain("compose");
-    expect(tags).toContain("generator");
-});
-// ── generateMetadata ────────────────────────────────────────────────────────
-test("generateMetadata creates entries from script files with filename heuristics", async () => {
-    const dir = tmpDir();
-    const tool1 = path.join(dir, "summarize-diff.ts");
-    writeFile(tool1, `console.log("summarize")\n`);
-    const stash = await generateMetadata(dir, "script", [tool1]);
-    expect(stash.entries).toHaveLength(1);
-    expect(stash.entries[0].name).toBe("summarize-diff.ts");
-    expect(stash.entries[0].type).toBe("script");
-    expect(stash.entries[0].description).toBe("summarize diff");
-    expect(stash.entries[0].quality).toBe("generated");
-    expect(stash.entries[0].source).toBe("filename");
-    expect(stash.entries[0].confidence).toBe(0.55);
-    expect(stash.entries[0].aliases).toContain("summarize diff");
-    expect(stash.entries[0].filename).toBe("summarize-diff.ts");
-});
-test("generateMetadata extracts description from code comments", async () => {
-    const dir = tmpDir();
-    const tool1 = path.join(dir, "deploy.sh");
-    writeFile(tool1, `#!/usr/bin/env bash\n# Deploy services to production\necho deploy\n`);
-    const stash = await generateMetadata(dir, "script", [tool1]);
-    expect(stash.entries[0].description).toBe("Deploy services to production");
-    expect(stash.entries[0].source).toBe("comments");
-});
-test("generateMetadata extracts metadata from package.json", async () => {
-    const dir = tmpDir();
-    const tool1 = path.join(dir, "run.ts");
-    writeFile(tool1, `console.log("run")\n`);
-    writeFile(path.join(dir, "package.json"), JSON.stringify({ description: "Git diff summarizer", keywords: ["git", "diff"] }));
-    const stash = await generateMetadata(dir, "script", [tool1]);
-    expect(stash.entries[0].description).toBe("Git diff summarizer");
-    expect(stash.entries[0].source).toBe("package");
-    expect(stash.entries[0].confidence).toBe(0.8);
-    expect(stash.entries[0].tags).toEqual(["git", "diff"]);
-});
-test("generateMetadata skips non-script extensions for script type", async () => {
-    const dir = tmpDir();
-    const mdFile = path.join(dir, "README.md");
-    writeFile(mdFile, "# Readme\n");
-    const stash = await generateMetadata(dir, "script", [mdFile]);
-    expect(stash.entries).toHaveLength(0);
-});
-test("generateMetadata handles multi-script directories", async () => {
-    const dir = tmpDir();
-    const tool1 = path.join(dir, "docker-build.ts");
-    const tool2 = path.join(dir, "docker-compose.ts");
-    writeFile(tool1, `/**\n * Build docker images\n */\n`);
-    writeFile(tool2, `/**\n * Generate docker compose stacks\n */\n`);
-    const stash = await generateMetadata(dir, "script", [tool1, tool2]);
-    expect(stash.entries).toHaveLength(2);
-    expect(stash.entries[0].name).toBe("docker-build.ts");
-    expect(stash.entries[0].description).toBe("Build docker images");
-    expect(stash.entries[1].name).toBe("docker-compose.ts");
-    expect(stash.entries[1].description).toBe("Generate docker compose stacks");
-});
-// ── validateStashEntry with searchHints ─────────────────────────────────────────
-test("validateStashEntry accepts entries with searchHints array", () => {
-    const result = validateStashEntry({
-        name: "test",
-        type: "script",
-        searchHints: ["summarize commits", "explain changes"],
-    });
-    expect(result).not.toBeNull();
-    expect(result?.searchHints).toEqual(["summarize commits", "explain changes"]);
-});
-test("validateStashEntry filters non-string elements from searchHints", () => {
-    const result = validateStashEntry({
-        name: "test",
-        type: "script",
-        searchHints: ["valid", 42, "", "also valid", null],
-    });
-    expect(result).not.toBeNull();
-    expect(result?.searchHints).toEqual(["valid", "also valid"]);
-});
-test("validateStashEntry omits searchHints if all filtered out", () => {
-    const result = validateStashEntry({
-        name: "test",
-        type: "script",
-        searchHints: ["", "  "],
-    });
-    expect(result).not.toBeNull();
-    expect(result?.searchHints).toBeUndefined();
-});
-test("validateStashEntry accepts usage as string", () => {
-    const result = validateStashEntry({
-        name: "test",
-        type: "script",
-        usage: "Run after checking branch state",
-    });
-    expect(result).not.toBeNull();
-    expect(result?.usage).toEqual(["Run after checking branch state"]);
-});
-test("validateStashEntry normalizes usage array", () => {
-    const result = validateStashEntry({
-        name: "test",
-        type: "script",
-        usage: ["  First step  ", "", "Second step", 2, null],
-    });
-    expect(result).not.toBeNull();
-    expect(result?.usage).toEqual(["First step", "Second step"]);
-});
-test("loadStashFile parses usage field", () => {
-    const dir = tmpDir();
-    const stash = {
-        entries: [
-            {
-                name: "git-diff",
-                type: "script",
-                usage: ["Run after fetching main", "Use --stat for quick output"],
-                filename: "run.ts",
-            },
-        ],
-    };
-    writeFile(path.join(dir, ".stash.json"), JSON.stringify(stash));
-    const result = loadStashFile(dir);
-    expect(result?.entries[0].usage).toEqual(["Run after fetching main", "Use --stat for quick output"]);
-});
-test("loadStashFile parses searchHints field", () => {
-    const dir = tmpDir();
-    const stash = {
-        entries: [
-            {
-                name: "git-diff",
-                type: "script",
-                searchHints: ["summarize git commits", "explain what changed"],
-                filename: "run.ts",
-            },
-        ],
-    };
-    writeFile(path.join(dir, ".stash.json"), JSON.stringify(stash));
-    const result = loadStashFile(dir);
-    expect(result?.entries[0].searchHints).toEqual(["summarize git commits", "explain what changed"]);
-});
-// ── generateMetadata populates searchHints ──────────────────────────────────────
-test("generateMetadata does not generate heuristic searchHints (LLM-only)", async () => {
-    const dir = tmpDir();
-    const tool = path.join(dir, "summarize-diff.ts");
-    writeFile(tool, `/**\n * Summarize git diff changes\n */\n`);
-    const stash = await generateMetadata(dir, "script", [tool]);
-    // Search hints are only generated when LLM is configured, not heuristically
-    expect(stash.entries[0].searchHints).toBeUndefined();
-});

package/dist/tests/migration-help.test.js

@@ -1,89 +0,0 @@
-import { describe, expect, test } from "bun:test";
-import fs from "node:fs";
-import os from "node:os";
-import path from "node:path";
-import { listBundledReleaseVersions, renderMigrationHelp } from "../src/commands/migration-help";
-const PROJECT_ROOT = path.resolve(import.meta.dirname, "..");
-const RELEASE_NOTES_DIR = path.join(PROJECT_ROOT, "docs", "migration", "release-notes");
-describe("migration help", () => {
-    test("renders bundled migration guidance when changelog is unavailable", () => {
-        const result = renderMigrationHelp("0.5.0", undefined);
-        expect(result).toContain("Migration notes for akm v0.5.0");
-        expect(result).toContain("akm wiki");
-    });
-    test("normalizes v-prefixed prerelease versions to the stable release notes", () => {
-        const result = renderMigrationHelp("v0.5.0-rc1");
-        expect(result).toContain("Migration notes for akm v0.5.0");
-        expect(result).toContain("## [0.5.0]");
-    });
-    test("supports latest alias when changelog text is available", () => {
-        const result = renderMigrationHelp("latest");
-        expect(result).toContain("## [0.7.0]");
-    });
-    test("ensures published static files exist in the repo", () => {
-        const packageJson = JSON.parse(fs.readFileSync(path.join(PROJECT_ROOT, "package.json"), "utf8"));
-        const staticFiles = (packageJson.files ?? []).filter((entry) => entry !== "dist");
-        expect(staticFiles).toContain("CHANGELOG.md");
-        expect(staticFiles).toContain("docs/migration/release-notes");
-        for (const entry of staticFiles) {
-            expect(fs.existsSync(path.join(PROJECT_ROOT, entry))).toBe(true);
-        }
-    });
-    test("every bundled release-notes file is surfaced by the loader", () => {
-        const bundled = listBundledReleaseVersions();
-        expect(bundled.length).toBeGreaterThan(0);
-        // Sanity: every known prior release has a note. Adding a new file to
-        // docs/migration/release-notes/ should be all it takes to extend this.
-        for (const version of ["0.0.13", "0.1.0", "0.2.0", "0.3.0", "0.5.0", "0.6.0"]) {
-            expect(bundled).toContain(version);
-            const result = renderMigrationHelp(version, undefined);
-            expect(result).toContain(`Migration notes for akm v${version}`);
-        }
-    });
-    test("renders dedicated message when no bundled note or changelog entry exists", () => {
-        const result = renderMigrationHelp("9.9.9", undefined);
-        expect(result).toContain("No dedicated migration note");
-        expect(result).toContain("9.9.9");
-        // Fallback lists the bundled versions so users can pick one that exists.
-        expect(result).toContain("Available bundled notes:");
-        expect(result).toContain("0.6.0");
-    });
-    test("rejects unsafe version components (path traversal guard)", () => {
-        // Any of these would escape the release-notes directory if passed
-        // directly to fs.readFileSync; the loader must refuse them and fall
-        // through to the no-note fallback.
-        for (const bad of ["../../etc/passwd", "..", "0.6.0/../secret", "0.6.0\0"]) {
-            const result = renderMigrationHelp(bad, undefined);
-            expect(result).toContain("No dedicated migration note");
-        }
-    });
-    test("dist build resolves release-notes relative to the compiled module", () => {
-        // Simulate the published layout: a `<pkg>/dist` directory alongside
-        // `<pkg>/docs/migration/release-notes`. The loader derives its path
-        // from `import.meta.dir`, so we rebuild that relationship in a temp
-        // directory and assert the expected file resolves.
-        const tempPkg = fs.mkdtempSync(path.join(os.tmpdir(), "akm-pkg-layout-"));
-        try {
-            fs.mkdirSync(path.join(tempPkg, "dist"));
-            fs.mkdirSync(path.join(tempPkg, "docs", "migration", "release-notes"), { recursive: true });
-            const notePath = path.join(tempPkg, "docs", "migration", "release-notes", "0.6.0.md");
-            fs.writeFileSync(notePath, "Migration notes for akm v0.6.0\n- stub body for test\n", "utf8");
-            // Resolve exactly the way migration-help does (path.resolve(<mod>, "../docs/migration/release-notes")).
-            const moduleDir = path.join(tempPkg, "dist");
-            const resolved = path.resolve(moduleDir, "../docs/migration/release-notes", "0.6.0.md");
-            expect(fs.existsSync(resolved)).toBe(true);
-            expect(fs.readFileSync(resolved, "utf8")).toContain("Migration notes for akm v0.6.0");
-        }
-        finally {
-            fs.rmSync(tempPkg, { recursive: true, force: true });
-        }
-    });
-    test("every release-notes filename matches a published version shape", () => {
-        const files = fs.readdirSync(RELEASE_NOTES_DIR).filter((name) => name.endsWith(".md") && name !== "README.md");
-        for (const file of files) {
-            const version = file.slice(0, -".md".length);
-            // Accept semver-ish strings the loader is willing to serve.
-            expect(version).toMatch(/^[A-Za-z0-9._+-]+$/);
-        }
-    });
-});

package/dist/tests/origin-resolve.test.js

@@ -1,124 +0,0 @@
-import { afterEach, describe, expect, test } from "bun:test";
-import fs from "node:fs";
-import os from "node:os";
-import path from "node:path";
-import { isRemoteOrigin, resolveSourcesForOrigin } from "../src/registry/origin-resolve";
-// ── Helpers ─────────────────────────────────────────────────────────────────
-let tmpDirs = [];
-function makeTmpDir() {
-    const dir = fs.mkdtempSync(path.join(os.tmpdir(), "akm-origin-test-"));
-    tmpDirs.push(dir);
-    return dir;
-}
-function makeSource(overrides) {
-    return {
-        path: overrides?.path ?? makeTmpDir(),
-        registryId: overrides?.registryId,
-    };
-}
-afterEach(() => {
-    for (const dir of tmpDirs) {
-        fs.rmSync(dir, { recursive: true, force: true });
-    }
-    tmpDirs = [];
-});
-// ── resolveSourcesForOrigin ─────────────────────────────────────────────────
-describe("resolveSourcesForOrigin", () => {
-    test("returns all sources when origin is undefined", () => {
-        const sources = [makeSource(), makeSource()];
-        const result = resolveSourcesForOrigin(undefined, sources);
-        expect(result).toEqual(sources);
-    });
-    test("returns first source for 'local' origin", () => {
-        const sources = [makeSource(), makeSource(), makeSource()];
-        const result = resolveSourcesForOrigin("local", sources);
-        expect(result).toHaveLength(1);
-        expect(result[0]).toBe(sources[0]);
-    });
-    test("returns empty array for 'local' origin with no sources", () => {
-        const result = resolveSourcesForOrigin("local", []);
-        expect(result).toEqual([]);
-    });
-    test("matches by exact registryId", () => {
-        const target = makeSource({ registryId: "npm:@scope/pkg" });
-        const other = makeSource({ registryId: "github:owner/repo" });
-        const sources = [makeSource(), target, other];
-        const result = resolveSourcesForOrigin("npm:@scope/pkg", sources);
-        expect(result).toHaveLength(1);
-        expect(result[0]).toBe(target);
-    });
-    test("falls through to empty when parseRegistryRef throws for invalid shorthand", () => {
-        // "owner/repo" looks path-like and fails statSync, so parseRegistryRef throws.
-        // The catch block in resolveSourcesForOrigin swallows the error, and path matching
-        // also fails since the path doesn't exist. Result: empty array.
-        const target = makeSource({ registryId: "github:owner/repo" });
-        const sources = [makeSource(), target];
-        const result = resolveSourcesForOrigin("owner/repo", sources);
-        expect(result).toEqual([]);
-    });
-    test("matches by exact registryId with full prefix form", () => {
-        const target = makeSource({ registryId: "github:owner/repo" });
-        const sources = [makeSource(), target];
-        // Full prefix "github:owner/repo" matches exact registryId
-        const result = resolveSourcesForOrigin("github:owner/repo", sources);
-        expect(result).toHaveLength(1);
-        expect(result[0]).toBe(target);
-    });
-    test("matches by resolved path", () => {
-        const dir = makeTmpDir();
-        const source = makeSource({ path: dir });
-        const sources = [makeSource(), source];
-        const result = resolveSourcesForOrigin(dir, sources);
-        expect(result).toHaveLength(1);
-        expect(result[0]).toBe(source);
-    });
-    test("returns empty array when no match found", () => {
-        const sources = [makeSource(), makeSource()];
-        const result = resolveSourcesForOrigin("nonexistent:thing", sources);
-        expect(result).toEqual([]);
-    });
-    test("returns empty array for empty sources list with a non-local origin", () => {
-        const result = resolveSourcesForOrigin("npm:@scope/pkg", []);
-        expect(result).toEqual([]);
-    });
-    test("exact registryId match takes priority over path match", () => {
-        const dir = makeTmpDir();
-        const byId = makeSource({ registryId: dir });
-        const byPath = makeSource({ path: dir });
-        const sources = [byId, byPath];
-        // The origin matches byId's registryId exactly
-        const result = resolveSourcesForOrigin(dir, sources);
-        expect(result).toHaveLength(1);
-        expect(result[0]).toBe(byId);
-    });
-    test("returns multiple sources if multiple registryIds match", () => {
-        const a = makeSource({ registryId: "npm:@scope/pkg" });
-        const b = makeSource({ registryId: "npm:@scope/pkg" });
-        const sources = [makeSource(), a, b];
-        const result = resolveSourcesForOrigin("npm:@scope/pkg", sources);
-        expect(result).toHaveLength(2);
-    });
-});
-// ── isRemoteOrigin ──────────────────────────────────────────────────────────
-describe("isRemoteOrigin", () => {
-    test("returns false for 'local' origin", () => {
-        expect(isRemoteOrigin("local", [])).toBe(false);
-    });
-    test("returns true when origin matches no sources", () => {
-        const sources = [makeSource()];
-        expect(isRemoteOrigin("npm:@nonexistent/pkg", sources)).toBe(true);
-    });
-    test("returns false when origin matches a source by registryId", () => {
-        const source = makeSource({ registryId: "npm:@scope/pkg" });
-        expect(isRemoteOrigin("npm:@scope/pkg", [source])).toBe(false);
-    });
-    test("returns false when origin matches a source by path", () => {
-        const dir = makeTmpDir();
-        const source = makeSource({ path: dir });
-        expect(isRemoteOrigin(dir, [source])).toBe(false);
-    });
-    test("returns true for an uninstalled GitHub ref", () => {
-        const sources = [makeSource()];
-        expect(isRemoteOrigin("github:unknown/repo", sources)).toBe(true);
-    });
-});