@decohere/ci-tools 0.0.1-dev.122 → 0.0.1-dev.123

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decohere/ci-tools",
-  "version": "0.0.1-dev.122",
+  "version": "0.0.1-dev.123",
   "description": "CI utility scripts for badge generation, coverage reporting, pages artifact assembly, and GitHub API tooling",
   "keywords": [
     "typescript",
@@ -10,6 +10,15 @@
     "github-actions",
     "decohere"
   ],
+  "homepage": "https://github.com/typesmiths/decohere/tree/main/projects/ci-tools#readme",
+  "bugs": {
+    "url": "https://github.com/typesmiths/decohere/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/typesmiths/decohere.git",
+    "directory": "projects/ci-tools"
+  },
   "license": "ISC",
   "author": "Typesmiths",
   "type": "module",

package/tests/github/package-metadata.test.mjs

@@ -0,0 +1,69 @@
+import { join, relative } from "node:path";
+import { fileURLToPath } from "node:url";
+import { vol } from "memfs";
+import { afterEach, describe, expect, it, vi } from "vitest";
+import { listPublishablePackages } from "../../src/github/publish-verify.mjs";
+
+const fs = await vi.importActual("node:fs");
+const REPO_ROOT = fileURLToPath(new URL("../../../../", import.meta.url));
+const REPO = "https://github.com/typesmiths/decohere";
+
+/** The repo's real package.json files, loaded into the in-memory fs the tests run on. */
+function loadRealManifests() {
+	/** @type {Record<string, string>} */
+	const files = {};
+	const walk = (dir) => {
+		for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+			const path = join(dir, entry.name);
+			if (entry.isDirectory() && !["node_modules", "dist"].includes(entry.name)) {
+				walk(path);
+			} else if (entry.name === "package.json") {
+				files[join("/repo", relative(REPO_ROOT, path))] = fs.readFileSync(path, "utf8");
+			}
+		}
+	};
+	walk(join(REPO_ROOT, "projects"));
+	return files;
+}
+
+afterEach(() => {
+	vol.reset();
+});
+
+// npm shows these on each package's page, and Trusted Publishing's provenance is
+// checked against `repository.url`, so a package without it fails to publish.
+describe("published package metadata", () => {
+	vol.fromJSON(loadRealManifests());
+	const packages = listPublishablePackages("/repo").map((pkg) => ({
+		...pkg,
+		json: JSON.parse(String(vol.readFileSync(`/repo/projects/${pkg.dir}/package.json`))),
+	}));
+	vol.reset();
+
+	it("finds the publishable packages", () => {
+		expect(packages.length).toBeGreaterThan(0);
+	});
+
+	it.each(packages.map((pkg) => [pkg.name, pkg]))(
+		"%s links back to the repo",
+		(_name, pkg) => {
+			expect(pkg.json.repository).toEqual({
+				type: "git",
+				url: `git+${REPO}.git`,
+				directory: `projects/${pkg.dir}`,
+			});
+			expect(pkg.json.homepage).toBe(`${REPO}/tree/main/projects/${pkg.dir}#readme`);
+			expect(pkg.json.bugs).toEqual({ url: `${REPO}/issues` });
+		},
+	);
+
+	it.each(packages.map((pkg) => [pkg.name, pkg]))(
+		"%s has a description, keywords, license and author",
+		(_name, pkg) => {
+			expect(pkg.json.description).toBeTruthy();
+			expect(pkg.json.keywords?.length).toBeGreaterThan(0);
+			expect(pkg.json.license).toBe("ISC");
+			expect(pkg.json.author).toBeTruthy();
+		},
+	);
+});