@serverkgg/bridge 0.1.2 → 0.1.4

package/src/catalogs/curseforge.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import type { BridgeContext, BridgeRequestOptions } from "../context";
 import { BridgeFailureCode, BridgeFailureError, BridgeNetError, BridgeSecretError } from "../core";
 import { BridgeHttpMethod } from "../protocol";
@@ -39,7 +39,7 @@ const file = (overrides: Partial<CurseforgeFile> = {}): CurseforgeFile => {
 };
 
 describe("curseforgeSha1", () => {
-	test("finds the sha1 hash and lowercases it", () => {
+	it("finds the sha1 hash and lowercases it", () => {
 		expect(
 			curseforgeSha1(
 				file({
@@ -58,13 +58,13 @@ describe("curseforgeSha1", () => {
 		).toBe("aabb");
 	});
 
-	test("returns null when the file carries no sha1", () => {
+	it("returns null when the file carries no sha1", () => {
 		expect(curseforgeSha1(file())).toBeNull();
 	});
 });
 
 describe("curseforgeDownloadUrl", () => {
-	test("re-encodes the path of a curseforge cdn url", () => {
+	it("re-encodes the path of a curseforge cdn url", () => {
 		expect(
 			curseforgeDownloadUrl(
 				file({
@@ -74,7 +74,7 @@ describe("curseforgeDownloadUrl", () => {
 		).toBe("https://edge.forgecdn.net/files/4711/12/my%20mod.jar");
 	});
 
-	test("refuses a url that is not on the curseforge cdn", () => {
+	it("refuses a url that is not on the curseforge cdn", () => {
 		expect(
 			curseforgeDownloadUrl(
 				file({
@@ -84,7 +84,7 @@ describe("curseforgeDownloadUrl", () => {
 		).toBeNull();
 	});
 
-	test("keeps a name curseforge already escaped escaped once", () => {
+	it("keeps a name curseforge already escaped escaped once", () => {
 		expect(
 			curseforgeDownloadUrl(
 				file({
@@ -94,7 +94,7 @@ describe("curseforgeDownloadUrl", () => {
 		).toBe("https://edge.forgecdn.net/files/1234/567/Some%20Mod%20%5B1.20%5D.jar");
 	});
 
-	test("refuses a path carrying a broken escape", () => {
+	it("refuses a path carrying a broken escape", () => {
 		expect(
 			curseforgeDownloadUrl(
 				file({
@@ -104,7 +104,7 @@ describe("curseforgeDownloadUrl", () => {
 		).toBeNull();
 	});
 
-	test("refuses plain http and a missing url", () => {
+	it("refuses plain http and a missing url", () => {
 		expect(
 			curseforgeDownloadUrl(
 				file({
@@ -123,15 +123,15 @@ describe("curseforgeDownloadUrl", () => {
 });
 
 describe("curseforgeFallbackUrl", () => {
-	test("splits a modern file id into four and the rest", () => {
+	it("splits a modern file id into four and the rest", () => {
 		expect(curseforgeFallbackUrl(4_711_123, "mod.jar")).toBe(`${CURSEFORGE_DOWNLOAD}/files/4711/123/mod.jar`);
 	});
 
-	test("divides a legacy file id by a thousand", () => {
+	it("divides a legacy file id by a thousand", () => {
 		expect(curseforgeFallbackUrl(123_456, "mod.jar")).toBe(`${CURSEFORGE_DOWNLOAD}/files/123/123456/mod.jar`);
 	});
 
-	test("percent encodes a file name carrying spaces and brackets", () => {
+	it("percent encodes a file name carrying spaces and brackets", () => {
 		expect(curseforgeFallbackUrl(4_711_123, "Butchersdelight beta 1.20.1 2.1.0.jar")).toBe(
 			`${CURSEFORGE_DOWNLOAD}/files/4711/123/Butchersdelight%20beta%201.20.1%202.1.0.jar`,
 		);
@@ -142,7 +142,7 @@ describe("curseforgeFallbackUrl", () => {
 });
 
 describe("isCurseforgeServerFile", () => {
-	test("accepts a file tagged server", () => {
+	it("accepts a file tagged server", () => {
 		expect(
 			isCurseforgeServerFile(
 				file({
@@ -155,7 +155,7 @@ describe("isCurseforgeServerFile", () => {
 		).toBe(true);
 	});
 
-	test("refuses a file tagged client only", () => {
+	it("refuses a file tagged client only", () => {
 		expect(
 			isCurseforgeServerFile(
 				file({
@@ -167,7 +167,7 @@ describe("isCurseforgeServerFile", () => {
 		).toBe(false);
 	});
 
-	test("accepts a file with no side tag", () => {
+	it("accepts a file with no side tag", () => {
 		expect(
 			isCurseforgeServerFile(
 				file({
@@ -179,7 +179,7 @@ describe("isCurseforgeServerFile", () => {
 		).toBe(true);
 	});
 
-	test("reads the side tags whatever their casing", () => {
+	it("reads the side tags whatever their casing", () => {
 		expect(
 			isCurseforgeServerFile(
 				file({
@@ -203,7 +203,7 @@ describe("isCurseforgeServerFile", () => {
 });
 
 describe("selectCurseforgeFile", () => {
-	test("returns null when nothing is available", () => {
+	it("returns null when nothing is available", () => {
 		expect(
 			selectCurseforgeFile([
 				file({
@@ -214,7 +214,7 @@ describe("selectCurseforgeFile", () => {
 		expect(selectCurseforgeFile([])).toBeNull();
 	});
 
-	test("prefers the newest file", () => {
+	it("prefers the newest file", () => {
 		expect(
 			selectCurseforgeFile([
 				file({
@@ -230,7 +230,7 @@ describe("selectCurseforgeFile", () => {
 		).toBe(9);
 	});
 
-	test("prefers a file matching the game version", () => {
+	it("prefers a file matching the game version", () => {
 		expect(
 			selectCurseforgeFile(
 				[
@@ -254,7 +254,7 @@ describe("selectCurseforgeFile", () => {
 		).toBe(2);
 	});
 
-	test("falls back to the newest when the game version is nowhere", () => {
+	it("falls back to the newest when the game version is nowhere", () => {
 		expect(
 			selectCurseforgeFile(
 				[
@@ -272,7 +272,7 @@ describe("selectCurseforgeFile", () => {
 		).toBe(9);
 	});
 
-	test("keeps stable releases when asked and falls back when there are none", () => {
+	it("keeps stable releases when asked and falls back when there are none", () => {
 		const files = [
 			file({
 				id: 9,
@@ -301,7 +301,7 @@ describe("selectCurseforgeFile", () => {
 		).toBe(9);
 	});
 
-	test("drops client-only files when asked for a server file", () => {
+	it("drops client-only files when asked for a server file", () => {
 		expect(
 			selectCurseforgeFile(
 				[
@@ -393,7 +393,7 @@ const batchIds = (calls: CatalogCall[], index: number) => {
 };
 
 describe("createCurseforgeCatalog", () => {
-	test("sends the key as a header and the search cache window", async () => {
+	it("sends the key as a header and the search cache window", async () => {
 		const { catalog, calls } = catalogContext();
 
 		await catalog.search();
@@ -405,7 +405,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(searchParams(calls).get("gameId")).toBe("432");
 	});
 
-	test("leaves the sort order out when no sort is asked for", async () => {
+	it("leaves the sort order out when no sort is asked for", async () => {
 		const { catalog, calls } = catalogContext();
 
 		await catalog.search();
@@ -413,7 +413,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(searchParams(calls).has("sortOrder")).toBe(false);
 	});
 
-	test("sorts a popularity search descending", async () => {
+	it("sorts a popularity search descending", async () => {
 		const { catalog, calls } = catalogContext();
 
 		await catalog.search({
@@ -424,7 +424,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(searchParams(calls).get("sortOrder")).toBe(CurseforgeSortOrder.Desc);
 	});
 
-	test("sorts a name search ascending", async () => {
+	it("sorts a name search ascending", async () => {
 		const { catalog, calls } = catalogContext();
 
 		await catalog.search({
@@ -434,7 +434,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(searchParams(calls).get("sortOrder")).toBe(CurseforgeSortOrder.Asc);
 	});
 
-	test("sorts an author search ascending", async () => {
+	it("sorts an author search ascending", async () => {
 		const { catalog, calls } = catalogContext();
 
 		await catalog.search({
@@ -444,7 +444,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(searchParams(calls).get("sortOrder")).toBe(CurseforgeSortOrder.Asc);
 	});
 
-	test("keeps an explicit sort order", async () => {
+	it("keeps an explicit sort order", async () => {
 		const { catalog, calls } = catalogContext();
 
 		await catalog.search({
@@ -455,7 +455,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(searchParams(calls).get("sortOrder")).toBe(CurseforgeSortOrder.Desc);
 	});
 
-	test("drops empty and absent filters but keeps a zero index", async () => {
+	it("drops empty and absent filters but keeps a zero index", async () => {
 		const { catalog, calls } = catalogContext();
 
 		await catalog.search({
@@ -472,7 +472,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(params.get("index")).toBe("0");
 	});
 
-	test("asks for the files of a mod without a query string", async () => {
+	it("asks for the files of a mod without a query string", async () => {
 		const { catalog, calls } = catalogContext();
 
 		await catalog.modFiles(4711);
@@ -480,7 +480,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(calls[0]?.url).toBe(`${CURSEFORGE_API}/mods/4711/files`);
 	});
 
-	test("passes every mod file filter through", async () => {
+	it("passes every mod file filter through", async () => {
 		const { catalog, calls } = catalogContext();
 
 		await catalog.modFiles(4711, {
@@ -498,7 +498,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(params.get("pageSize")).toBe("50");
 	});
 
-	test("caches categories for a day rather than for the project window", async () => {
+	it("caches categories for a day rather than for the project window", async () => {
 		const { catalog, calls } = catalogContext({
 			options: {
 				projectCacheSeconds: 5,
@@ -511,7 +511,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(searchParams(calls).get("classId")).toBe("6");
 	});
 
-	test("dedupes, sorts and batches file ids into posted bodies", async () => {
+	it("dedupes, sorts and batches file ids into posted bodies", async () => {
 		const { catalog, calls } = catalogContext();
 
 		await catalog.files([
@@ -536,7 +536,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(second.at(-1)).toBe(150);
 	});
 
-	test("refuses to work without a key", async () => {
+	it("refuses to work without a key", async () => {
 		const { catalog, calls } = catalogContext({
 			key: null,
 		});
@@ -546,7 +546,7 @@ describe("createCurseforgeCatalog", () => {
 		expect(calls).toHaveLength(0);
 	});
 
-	test("turns a rejected key into a secret error", async () => {
+	it("turns a rejected key into a secret error", async () => {
 		for (const status of [
 			401,
 			403,
@@ -559,7 +559,7 @@ describe("createCurseforgeCatalog", () => {
 		}
 	});
 
-	test("turns throttling into a rate limited failure", async () => {
+	it("turns throttling into a rate limited failure", async () => {
 		for (const status of [
 			429,
 			503,

package/src/catalogs/thunderstore.test.ts

@@ -1,20 +1,20 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import { parseThunderstoreManifest, thunderstoreDependency, thunderstoreDownloadUrl } from "./thunderstore";
 
 describe("thunderstoreDownloadUrl", () => {
-	test("points straight at the cdn so no redirect has to be followed", () => {
+	it("points straight at the cdn so no redirect has to be followed", () => {
 		expect(thunderstoreDownloadUrl("denikson-BepInExPack_Valheim-5.4.2202")).toBe(
 			"https://gcdn.thunderstore.io/live/repository/packages/denikson-BepInExPack_Valheim-5.4.2202.zip",
 		);
 	});
 
-	test("escapes a package name", () => {
+	it("escapes a package name", () => {
 		expect(thunderstoreDownloadUrl("a b-c-1.0.0")).toContain("a%20b-c-1.0.0.zip");
 	});
 });
 
 describe("parseThunderstoreManifest", () => {
-	test("reads name, version and dependencies", () => {
+	it("reads name, version and dependencies", () => {
 		expect(
 			parseThunderstoreManifest(
 				JSON.stringify({
@@ -36,7 +36,7 @@ describe("parseThunderstoreManifest", () => {
 		});
 	});
 
-	test("defaults missing dependencies to an empty list", () => {
+	it("defaults missing dependencies to an empty list", () => {
 		expect(
 			parseThunderstoreManifest(
 				JSON.stringify({
@@ -47,7 +47,7 @@ describe("parseThunderstoreManifest", () => {
 		).toEqual([]);
 	});
 
-	test("drops entries that are not strings", () => {
+	it("drops entries that are not strings", () => {
 		expect(
 			parseThunderstoreManifest(
 				JSON.stringify({
@@ -64,7 +64,7 @@ describe("parseThunderstoreManifest", () => {
 		]);
 	});
 
-	test("returns null for anything that is not a manifest", () => {
+	it("returns null for anything that is not a manifest", () => {
 		expect(parseThunderstoreManifest("")).toBeNull();
 		expect(parseThunderstoreManifest("[]")).toBeNull();
 		expect(
@@ -78,7 +78,7 @@ describe("parseThunderstoreManifest", () => {
 });
 
 describe("thunderstoreDependency", () => {
-	test("splits a dependency reference into its three parts", () => {
+	it("splits a dependency reference into its three parts", () => {
 		expect(thunderstoreDependency("denikson-BepInExPack_Valheim-5.4.2202")).toEqual({
 			namespace: "denikson",
 			name: "BepInExPack_Valheim",
@@ -87,7 +87,7 @@ describe("thunderstoreDependency", () => {
 		});
 	});
 
-	test("returns null for a reference it cannot split", () => {
+	it("returns null for a reference it cannot split", () => {
 		expect(thunderstoreDependency("denikson-BepInExPack")).toBeNull();
 		expect(thunderstoreDependency("a-b-c-d")).toBeNull();
 	});

package/src/cli/detectTable.test.ts

@@ -1,4 +1,4 @@
-import { afterEach, beforeEach, describe, expect, spyOn, test } from "bun:test";
+import { afterEach, beforeEach, describe, expect, it, spyOn } from "bun:test";
 import { mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
 import { tmpdir } from "node:os";
 import { join } from "node:path";
@@ -25,7 +25,7 @@ describe("serverk-bridge detect-table", () => {
 		});
 	});
 
-	test("writes the table the launchers read, then passes its own check", async () => {
+	it("writes the table the launchers read, then passes its own check", async () => {
 		const out = join(root, "detect.json");
 
 		await runDetectTable([
@@ -42,7 +42,7 @@ describe("serverk-bridge detect-table", () => {
 		]);
 	});
 
-	test("fails the check on a stale or missing table", async () => {
+	it("fails the check on a stale or missing table", async () => {
 		const out = join(root, "detect.json");
 
 		await expect(

package/src/cli/link.test.ts

@@ -1,4 +1,4 @@
-import { afterEach, beforeEach, describe, expect, test } from "bun:test";
+import { afterEach, beforeEach, describe, expect, it } from "bun:test";
 import {
 	existsSync,
 	lstatSync,
@@ -60,7 +60,7 @@ describe("link", () => {
 		});
 	});
 
-	test("skips when CI is set", () => {
+	it("skips when CI is set", () => {
 		writePackage(source, "@serverkgg/bridge", "0.0.3");
 		writePackage(target, "@serverkgg/bridge", "0.0.2");
 
@@ -76,14 +76,14 @@ describe("link", () => {
 		expect(lstatSync(target).isSymbolicLink()).toBe(false);
 	});
 
-	test("skips when the local checkout is missing", () => {
+	it("skips when the local checkout is missing", () => {
 		expect(link()).toMatchObject({
 			kind: "skipped",
 			reason: "source-missing",
 		});
 	});
 
-	test("skips when the local checkout is another package", () => {
+	it("skips when the local checkout is another package", () => {
 		writePackage(source, "@serverkgg/minecraft", "0.0.0");
 
 		expect(link()).toMatchObject({
@@ -92,7 +92,7 @@ describe("link", () => {
 		});
 	});
 
-	test("replaces the registry directory with a symlink", () => {
+	it("replaces the registry directory with a symlink", () => {
 		writePackage(source, "@serverkgg/bridge", "0.0.3");
 		writePackage(target, "@serverkgg/bridge", "0.0.2");
 		writeFileSync(join(target, "installed.txt"), "registry");
@@ -109,7 +109,7 @@ describe("link", () => {
 		expect(existsSync(join(source, "package.json"))).toBe(true);
 	});
 
-	test("creates the scope directory when nothing is installed", () => {
+	it("creates the scope directory when nothing is installed", () => {
 		writePackage(source, "@serverkgg/bridge", "0.0.3");
 
 		expect(link()).toMatchObject({
@@ -119,7 +119,7 @@ describe("link", () => {
 		expect(realpathSync(target)).toBe(source);
 	});
 
-	test("is idempotent once linked", () => {
+	it("is idempotent once linked", () => {
 		writePackage(source, "@serverkgg/bridge", "0.0.3");
 
 		expect(link()).toMatchObject({
@@ -134,7 +134,7 @@ describe("link", () => {
 		expect(realpathSync(target)).toBe(source);
 	});
 
-	test("relinks a symlink pointing somewhere else", () => {
+	it("relinks a symlink pointing somewhere else", () => {
 		const other = join(root, "other");
 
 		writePackage(source, "@serverkgg/bridge", "0.0.3");
@@ -153,7 +153,7 @@ describe("link", () => {
 		expect(existsSync(join(other, "package.json"))).toBe(true);
 	});
 
-	test("unlink removes the symlink and keeps the checkout", () => {
+	it("unlink removes the symlink and keeps the checkout", () => {
 		writePackage(source, "@serverkgg/bridge", "0.0.3");
 		link();
 
@@ -166,7 +166,7 @@ describe("link", () => {
 		expect(existsSync(join(source, "package.json"))).toBe(true);
 	});
 
-	test("unlink leaves a registry install alone", () => {
+	it("unlink leaves a registry install alone", () => {
 		writePackage(target, "@serverkgg/bridge", "0.0.2");
 
 		expect(unlinkBridge(cwd)).toEqual({
@@ -176,7 +176,7 @@ describe("link", () => {
 		expect(existsSync(join(target, "package.json"))).toBe(true);
 	});
 
-	test("check reports every state", () => {
+	it("check reports every state", () => {
 		expect(checkBridge(cwd)).toEqual({
 			kind: "missing",
 		});

package/src/cli/main.ts

@@ -4,6 +4,7 @@ import { errorText } from "../runtime/bridgeLog";
 import { runCompile } from "./compile";
 import { runDetectTable } from "./detectTable";
 import { runLink } from "./link";
+import { runRules } from "./rules";
 import { runSchema } from "./schema";
 import { runValidate } from "./validate";
 
@@ -15,6 +16,7 @@ commands:
   detect-table   write the bot detection table the launchers read
   compile        compile the bridge binary for amd64
   link           use a local bridge checkout while developing
+  rules          write the conventions for package code into .claude/rules
 
 run "serverk-bridge <command> --help" for options`;
 
@@ -52,6 +54,12 @@ try {
 			break;
 		}
 
+		case "rules": {
+			await runRules(args);
+
+			break;
+		}
+
 		case undefined:
 		case "--help": {
 			console.log(USAGE);