Adopt path-class throughout.

Author: lgarron

Makefile

@@ -229,7 +229,7 @@ test-dist-lib-build-size: build-lib-js
 
 .PHONY: test-dist-sites-twizzle
 test-dist-sites-twizzle: playwright-install build-sites
-	${NODE} ./script/test/dist/sites/alpha.twizzle.net/main.js
+	${BUN_RUN} ./script/test/dist/sites/alpha.twizzle.net/main.ts
 
 .PHONY: test-dist-bin
 test-dist-bin: test-dist-bin-shebang test-dist-bin-npm-exec

bun.lock

@@ -29,6 +29,7 @@
         "esbuild": "^0.25.0",
         "jszip": "^3.10.1",
         "mocha": "^10.7.3",
+        "path-class": "^0.6.0",
         "playwright": "^1.47.2",
         "printable-shell-command": "^1.1.3",
         "tsup": "^8.3.0",
@@ -830,6 +831,8 @@
 
     "parseurl": ["[email protected]", "", {}, "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ=="],
 
+    "path-class": ["[email protected]", "", { "dependencies": { "@types/node": "^24.7.1", "xdg-basedir": "^5.1.0" } }, "sha512-oActRKhpRcGkJ9lrzrhf+eXV3x19qczBr6gjiAkENY9c28StGJJE71+4CAGEIyRi7N30cM7rWZrZMC/iB2gifg=="],
+
     "path-exists": ["[email protected]", "", {}, "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w=="],
 
     "path-is-absolute": ["[email protected]", "", {}, "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg=="],
@@ -1060,6 +1063,8 @@
 
     "ws": ["[email protected]", "", { "peerDependencies": { "bufferutil": "^4.0.1", "utf-8-validate": "^5.0.2" }, "optionalPeers": ["bufferutil", "utf-8-validate"] }, "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ=="],
 
+    "xdg-basedir": ["[email protected]", "", {}, "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ=="],
+
     "y18n": ["[email protected]", "", {}, "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA=="],
 
     "yaml": ["[email protected]", "", { "bin": { "yaml": "bin.mjs" } }, "sha512-lcYcMxX2PO9XMGvAJkJ3OsNMw+/7FKes7/hgerGUYWIoWu5j/+YQqcZr5JnPZWzOsEBgMbSbiSTn/dv/69Mkpw=="],
@@ -1126,6 +1131,8 @@
 
     "log-symbols/chalk": ["[email protected]", "", { "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" } }, "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA=="],
 
+    "path-class/@types/node": ["@types/[email protected]", "", { "dependencies": { "undici-types": "~7.16.0" } }, "sha512-QoiaXANRkSXK6p0Duvt56W208du4P9Uye9hWLWgGMDTEoKPhuenzNcC4vGUmrNkiOKTlIrBoyNQYNpSwfEZXSg=="],
+
     "path-scurry/lru-cache": ["[email protected]", "", {}, "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ=="],
 
     "proxy-agent/lru-cache": ["[email protected]", "", {}, "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA=="],
@@ -1186,6 +1193,8 @@
 
     "log-symbols/chalk/supports-color": ["[email protected]", "", { "dependencies": { "has-flag": "^4.0.0" } }, "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw=="],
 
+    "path-class/@types/node/undici-types": ["[email protected]", "", {}, "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw=="],
+
     "raw-body/http-errors/statuses": ["[email protected]", "", {}, "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ=="],
 
     "resolve-path/http-errors/depd": ["[email protected]", "", {}, "sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ=="],

package.json

@@ -81,6 +81,7 @@
     "esbuild": "^0.25.0",
     "jszip": "^3.10.1",
     "mocha": "^10.7.3",
+    "path-class": "^0.6.0",
     "playwright": "^1.47.2",
     "printable-shell-command": "^1.1.3",
     "tsup": "^8.3.0",

script/bin/screenshot.ts

@@ -28,7 +28,7 @@ import type {
   TwistyPlayerConfig,
   VisualizationFormat,
 } from "../../src/cubing/twisty/index.js";
-import { startServer } from "../lib/experiments-server/index.js";
+import { startServer } from "../lib/experiments-server";
 
 const DEBUG = false;
 const PAGE_URL =

script/build/common/paths.ts

@@ -0,0 +1,3 @@
+import { Path } from "path-class";
+
+export const tempPath = new Path("./.temp");

script/build/lib/build-lib-js.ts

@@ -1,6 +1,6 @@
-import { mkdir, writeFile } from "node:fs/promises";
 import { type BuildOptions, build } from "esbuild";
 import { packageEntryPointsWithSearchWorkerEntry } from "../common/package-info";
+import { tempPath } from "../common/paths";
 
 // In theory we could set `packages: "external"` here and rely on `make
 // test-src-import-restrictions`, but this is safer.
@@ -24,8 +24,4 @@ export const esmOptions: BuildOptions = {
 
 const result = await build(esmOptions);
 
-await mkdir("./.temp", { recursive: true });
-await writeFile(
-  "./.temp/esbuild-metafile.json",
-  JSON.stringify(result.metafile),
-);
+await tempPath.join("esbuild-metafile.json").writeJSON(result.metafile);

script/build/lib/build-lib-types.ts

@@ -1,5 +1,5 @@
-import { mkdir, writeFile } from "node:fs/promises";
 import { join } from "node:path";
+import { Path } from "path-class";
 import { PrintableShellCommand } from "printable-shell-command";
 import { packageNames } from "../common/package-info";
 
@@ -12,24 +12,21 @@ export const SRC_CUBING = "./src/cubing";
 export const TYPESCRIPT_INDEX = "index.ts";
 export const TYPESCRIPT_DECLARATION_INDEX = "index.d.ts";
 
-const tsupCommand = new PrintableShellCommand("bun", [
+await new PrintableShellCommand("bun", [
   ["x", "tsup"],
   ...packageNames.map((packageName) =>
     join(SRC_CUBING, packageName, TYPESCRIPT_INDEX),
   ),
   "--dts-only",
   ["--format", "esm"],
   ["--out-dir", "dist/lib/cubing"],
-]);
-await tsupCommand.shellOutBun();
+]).shellOutBun();
 
 // TODO: remove this once TypeScript resolves types from the `package.json` exports out of the box (by default).
 for (const packageName of packageNames) {
-  await mkdir(packageName, { recursive: true });
-  const indexFileName = join(packageName, TYPESCRIPT_DECLARATION_INDEX);
-  await writeFile(
-    indexFileName,
-    `export * from ${JSON.stringify(
+  await new Path(packageName)
+    .join(TYPESCRIPT_DECLARATION_INDEX)
+    .write(`export * from ${JSON.stringify(
       join(
         "..",
         "dist",
@@ -39,7 +36,5 @@ for (const packageName of packageNames) {
         TYPESCRIPT_DECLARATION_INDEX,
       ),
     )};
-`,
-    "utf-8",
-  );
+`);
 }

script/build/lib/clean-types.ts

@@ -1,13 +1,15 @@
 import { existsSync } from "node:fs";
-import { rm, rmdir } from "node:fs/promises";
-import { join } from "node:path";
+import { rmdir } from "node:fs/promises";
+import { Path } from "path-class";
 import { packageNames } from "../common/package-info";
 
 export const TYPESCRIPT_DECLARATION_INDEX = "index.d.ts";
 
 for (const packageName of packageNames) {
-  const indexFileName = join(packageName, TYPESCRIPT_DECLARATION_INDEX);
-  await rm(indexFileName, { force: true });
+  const indexFileName = new Path(packageName).join(
+    TYPESCRIPT_DECLARATION_INDEX,
+  );
+  await indexFileName.rm({ force: true });
   if (existsSync(packageName)) {
     await rmdir(packageName);
   }

script/build/sites/barelyServeSite.ts

@@ -1,16 +1,13 @@
 import { exec } from "node:child_process";
-import { writeFile } from "node:fs/promises";
 import { join } from "node:path";
-import { fileURLToPath } from "node:url";
 import { barelyServe } from "barely-a-dev-server";
 import { $ } from "bun";
 import type { Plugin } from "esbuild";
+import { Path } from "path-class";
 import { needPath } from "../../lib/needPath";
 
 needPath(
-  fileURLToPath(
-    new URL("../../../node_modules/barely-a-dev-server", import.meta.url),
-  ),
+  Path.resolve("../../../node_modules/barely-a-dev-server", import.meta.url),
   "make setup",
 );
 
@@ -54,7 +51,7 @@ export interface VersionJSON {
   commitGitHubURL: string;
 }
 
-async function writeVersionJSON(siteFolder: string) {
+async function writeVersionJSON(siteFolder: Path) {
   // https://git-scm.com/docs/git-describe
   const gitDescribeVersion = (
     await $`git describe --tags || echo v0.0.0`.text()
@@ -64,27 +61,20 @@ async function writeVersionJSON(siteFolder: string) {
   const commitHash = (await $`git rev-parse HEAD`.text()).trim();
   const commitGitHubURL = `https://github.com/cubing/cubing.js/commit/${commitHash}`;
 
-  await writeFile(
-    join(siteFolder, "version.json"),
-    JSON.stringify(
-      {
-        gitDescribeVersion,
-        gitBranch,
-        date,
-        commitHash,
-        commitGitHubURL,
-      } satisfies VersionJSON,
-      null,
-      "  ",
-    ),
-  );
+  await siteFolder.join("version.json").writeJSON({
+    gitDescribeVersion,
+    gitBranch,
+    date,
+    commitHash,
+    commitGitHubURL,
+  } satisfies VersionJSON);
 }
 
 export async function barelyServeSite(srcFolder: string, dev: boolean) {
-  const outDir = dev ? join(".temp/dev", srcFolder) : join("dist", srcFolder);
+  const outDir = new Path(dev ? ".temp/dev" : "dist").join(srcFolder);
   await barelyServe({
     entryRoot: join("src", srcFolder),
-    outDir,
+    outDir: outDir.path, // TODO: accept `Path` arg in the `barelyServe(…)` signature?
     dev,
     devDomain: "cubing.localhost",
     port: 3333,
@@ -96,6 +86,6 @@ export async function barelyServeSite(srcFolder: string, dev: boolean) {
   });
   if (!dev) {
     // TODO: Include this in the custom build process.
-    await writeVersionJSON("dist/sites/alpha.twizzle.net");
+    await writeVersionJSON(new Path("dist/sites/alpha.twizzle.net"));
   }
 }

script/deploy/twizzle.ts

@@ -1,6 +1,6 @@
 import * as assert from "node:assert";
-import { readFile } from "node:fs/promises";
 import { $ } from "bun";
+import { Path } from "path-class";
 import { PrintableShellCommand } from "printable-shell-command";
 import type { VersionJSON } from "../build/sites/barelyServeSite";
 import { rsync } from "./rsync";
@@ -37,9 +37,9 @@ await new PrintableShellCommand("ssh", [
 const response = await fetch("https://alpha.twizzle.net/version.json");
 const responseJSON = (await response.json()) as VersionJSON;
 
-const distVersionJSON = JSON.parse(
-  await readFile("./dist/sites/alpha.twizzle.net/version.json", "utf-8"),
-);
+const distVersionJSON = await new Path(
+  "./dist/sites/alpha.twizzle.net/version.json",
+).readJSON<VersionJSON>();
 assert.equal(
   distVersionJSON.gitDescribeVersion,
   responseJSON.gitDescribeVersion,