Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/gittensory-miner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ From a local checkout:
```sh
npm install
npm --workspace @jsonbored/gittensory-miner run build
npm link --workspace @jsonbored/gittensory-miner
```

## Commands
Expand Down
70 changes: 70 additions & 0 deletions test/unit/miner-package-skeleton.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import { execFileSync } from "node:child_process";
import { readFileSync } from "node:fs";
import { join } from "node:path";
import { describe, expect, it } from "vitest";

import { runCapture } from "./support/miner-cli-harness.js";

const minerRoot = join(process.cwd(), "packages/gittensory-miner");
const mcpRoot = join(process.cwd(), "packages/gittensory-mcp");
const readmePath = join(minerRoot, "README.md");

type PackageJson = {
name: string;
license: string;
type: string;
bin: Record<string, string>;
files: string[];
publishConfig: { access: string };
dependencies: Record<string, string>;
engines: { node: string };
scripts: { build: string };
};

function readPackageJson(root: string): PackageJson {
return JSON.parse(readFileSync(join(root, "package.json"), "utf8")) as PackageJson;
}

describe("gittensory-miner package skeleton (#2287)", () => {
it("mirrors gittensory-mcp packaging conventions", () => {
const miner = readPackageJson(minerRoot);
const mcp = readPackageJson(mcpRoot);

expect(miner.name).toBe("@jsonbored/gittensory-miner");
expect(miner.license).toBe("AGPL-3.0-only");
expect(miner.type).toBe("module");
expect(miner.bin).toEqual({ "gittensory-miner": "bin/gittensory-miner.js" });
expect(miner.publishConfig).toEqual(mcp.publishConfig);
expect(miner.dependencies["@jsonbored/gittensory-engine"]).toBeDefined();
expect(miner.engines.node).toMatch(/^>=22(?:\.\d+){0,2}$/);
expect(miner.files).toEqual(expect.arrayContaining(["bin", "lib"]));
expect(miner.scripts.build.startsWith("node --check bin/gittensory-miner.js")).toBe(true);
});

it("starts the CLI bin with a node shebang", () => {
const bin = readFileSync(join(minerRoot, "bin/gittensory-miner.js"), "utf8");
expect(bin.startsWith("#!/usr/bin/env node\n")).toBe(true);
});

it("is discoverable from the repo root workspace", () => {
const listing = execFileSync(
"npm",
["ls", "--workspace", "@jsonbored/gittensory-miner", "--depth=0"],
{ cwd: process.cwd(), encoding: "utf8" },
);
expect(listing).toContain("@jsonbored/gittensory-miner@");
});

it("serves --help and --version from the bin entry", () => {
expect(runCapture(["--help", "--no-update-check"])).toContain("gittensory-miner --help");
expect(runCapture(["--version", "--no-update-check"])).toContain("@jsonbored/gittensory-miner/");
});

it("documents foundation scope and local checkout install paths in the README", () => {
const readme = readFileSync(readmePath, "utf8");
expect(readme).toContain("foundation phase");
expect(readme).toContain("npm link --workspace @jsonbored/gittensory-miner");
expect(readme).toContain("gittensory-miner --help");
expect(readme).toContain("gittensory-miner --version");
});
});
Loading