feat: unify Docker entrypoint

2026-06-29 11:27:47 +00:00
parent 4a1136eac2
commit bd28c93cfe
35 changed files with 2316 additions and 118 deletions
@@ -0,0 +1,44 @@
+import { readFile } from "node:fs/promises";
+import { dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { describe, expect, it } from "vitest";
+import { PI_WEB_DOCKER_USER_COMMANDS } from "./piWebDockerCommandPlan.js";
+
+const repoRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..", "..");
+const dockerOneLine = "curl -fsSL https://raw.githubusercontent.com/jmfederico/pi-web/main/docker/install.sh | sh";
+
+describe("pi-web-docker documentation", () => {
+  it("documents the Docker one-line install in the Docker guide, root README, and install page", async () => {
+    const [dockerReadme, rootReadme, installPage] = await Promise.all([
+      readRepoFile("docker/README.md"),
+      readRepoFile("README.md"),
+      readRepoFile("docs/install.html"),
+    ]);
+
+    expect(dockerReadme).toContain(dockerOneLine);
+    expect(dockerReadme).toContain("does not require Node.js or npm on the host");
+    expect(rootReadme).toContain(dockerOneLine);
+    expect(installPage).toContain(dockerOneLine);
+  });
+
+  it("keeps the Docker command matrix aligned with the canonical user command surface", async () => {
+    const [dockerReadme, dockerEntrypoint] = await Promise.all([
+      readRepoFile("docker/README.md"),
+      readRepoFile("docker/pi-web-docker"),
+    ]);
+
+    for (const command of PI_WEB_DOCKER_USER_COMMANDS) {
+      expect(dockerReadme).toContain(`| \`${command}\` |`);
+      expect(dockerEntrypoint).toContain(command);
+    }
+
+    expect(dockerReadme).toContain("`pi-web-docker --dev status`");
+    expect(dockerReadme).toContain("`./docker/pi-web-docker --dev start`");
+    expect(dockerReadme).not.toContain("pi-web-docker-control");
+    expect(dockerReadme).not.toContain("docker/scripts/docker-compose-dev");
+  });
+});
+
+async function readRepoFile(relativePath: string): Promise<string> {
+  return await readFile(join(repoRoot, relativePath), "utf8");
+}