@checkstack/scripts 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/scripts",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Checkstack tooling: plugin scaffolding, codegen, and the plugin-pack CLI used by external plugin authors.",
   "license": "Elastic-2.0",
   "type": "module",
@@ -22,19 +22,13 @@
     "typecheck": "tsgo -b"
   },
   "dependencies": {
-    "@checkstack/common": "0.7.0",
-    "@checkstack/backend": "0.8.2",
-    "@checkstack/frontend": "0.4.2",
-    "@checkstack/frontend-api": "0.4.1",
-    "@checkstack/ui": "1.7.0",
-    "@vitejs/plugin-react": "^4.3.4",
+    "@checkstack/common": "0.8.0",
     "inquirer": "^13.4.1",
     "handlebars": "^4.7.8",
-    "tar": "^7.4.3",
-    "vite": "^5.4.0"
+    "tar": "^7.4.3"
   },
   "devDependencies": {
-    "@checkstack/tsconfig": "0.0.6",
+    "@checkstack/tsconfig": "0.0.7",
     "@types/inquirer": "^8.2.10",
     "@types/handlebars": "^4.1.0",
     "typescript": "^5.0.0"

package/src/cli.ts

@@ -11,7 +11,6 @@ if (!command) {
   console.log("  sync          - Synchronize package configurations");
   console.log("  generate      - Generate migrations and strip public schema");
   console.log("  plugin-pack   - Pack a plugin (or bundle) into a .tgz for distribution");
-  console.log("  dev           - Run a local Checkstack dev server with the current directory's plugin loaded");
   console.log("  typecheck     - Run TypeScript type checking");
   console.log("  lint          - Run linting checks");
   process.exit(1);
@@ -67,16 +66,6 @@ if (command === "plugin-pack") {
   process.exit(result.status ?? 0);
 }
 
-if (command === "dev") {
-  const scriptPath = path.resolve(
-    new URL("commands/dev-server.ts", import.meta.url).pathname,
-  );
-  const result = spawnSync("bun", ["run", scriptPath, ...process.argv.slice(3)], {
-    stdio: "inherit",
-  });
-  process.exit(result.status ?? 0);
-}
-
 // Fallback for other scripts if we want to centralize their execution logic
 console.error(`Unknown command: ${command}`);
 process.exit(1);

package/src/templates/backend/package.json.hbs

@@ -14,7 +14,7 @@
     "pluginId": "{{pluginBaseName}}"
   },
   "scripts": {
-    "dev": "bunx @checkstack/scripts dev",
+    "dev": "checkstack-dev",
     "pack": "bunx @checkstack/scripts plugin-pack",
     "typecheck": "tsgo -b",
     "lint": "bun run lint:code",
@@ -30,6 +30,8 @@
   },
   "devDependencies": {
     "@checkstack/scripts": "workspace:*",
+    "@checkstack/dev-server": "workspace:*",
+    "@checkstack/backend": "workspace:*",
     "@checkstack/tsconfig": "workspace:*",
     "@checkstack/drizzle-helper": "workspace:*",
     "@checkstack/test-utils-backend": "workspace:*",

package/src/templates/frontend/package.json.hbs

@@ -14,7 +14,7 @@
     "pluginId": "{{pluginBaseName}}"
   },
   "scripts": {
-    "dev": "bunx @checkstack/scripts dev",
+    "dev": "checkstack-dev",
     "pack": "bunx @checkstack/scripts plugin-pack",
     "typecheck": "tsgo -b",
     "lint": "bun run lint:code",
@@ -32,6 +32,8 @@
   },
   "devDependencies": {
     "@checkstack/scripts": "workspace:*",
+    "@checkstack/dev-server": "workspace:*",
+    "@checkstack/frontend": "workspace:*",
     "@checkstack/tsconfig": "workspace:*",
     "@checkstack/test-utils-frontend": "workspace:*",
     "@types/react": "^18.3.1",

package/src/templates.test.ts

@@ -4,7 +4,7 @@ import {
   prepareTemplateData,
   registerHelpers,
 } from "./utils/template";
-import { validatePluginPackageJson } from "./commands/dev-internals";
+import { installPackageMetadataSchema } from "@checkstack/common";
 import { execSync } from "node:child_process";
 import { rmSync, existsSync, mkdirSync, readFileSync } from "node:fs";
 import path from "node:path";
@@ -138,42 +138,60 @@ describe("CLI Template Scaffolding", () => {
       // because they only inspect static metadata.
       // ────────────────────────────────────────────────────────────
 
-      it("renders a package.json that the dev-server's validator accepts", () => {
-        const result = validatePluginPackageJson({ cwd: targetDir });
-        if (!result.ok) {
+      it("renders a package.json that the install-time validator accepts", () => {
+        // Validate against the same schema dev-server and the runtime
+        // plugin installer use. Inlined here (rather than imported from
+        // dev-server) so `@checkstack/scripts` doesn't take a dep on
+        // `@checkstack/dev-server`.
+        const pkgJsonPath = path.join(targetDir, "package.json");
+        const raw = JSON.parse(readFileSync(pkgJsonPath, "utf8")) as unknown;
+        const result = installPackageMetadataSchema.safeParse(raw);
+        if (!result.success) {
           throw new Error(
-            `Generated package.json fails dev-server validation:\n${
-              "issues" in result
-                ? result.issues.join("\n")
-                : "package.json missing"
-            }`,
+            `Generated package.json fails install-time validation:\n${result.error.issues
+              .map((issue) => `${issue.path.join(".")}: ${issue.message}`)
+              .join("\n")}`,
           );
         }
         // Sanity-check the metadata shape so a later schema change
         // surfaces here too.
-        expect(result.metadata.name).toBe(`@checkstack/${pluginName}`);
-        expect(result.metadata.checkstack.type).toBe(pluginType);
-        expect(result.metadata.checkstack.pluginId).toBe(TEST_BASE_NAME);
-        expect(result.metadata.author).toBeDefined();
-        expect(result.metadata.license).toBe("Elastic-2.0");
+        expect(result.data.name).toBe(`@checkstack/${pluginName}`);
+        expect(result.data.checkstack.type).toBe(pluginType);
+        expect(result.data.checkstack.pluginId).toBe(TEST_BASE_NAME);
+        expect(result.data.author).toBeDefined();
+        expect(result.data.license).toBe("Elastic-2.0");
       });
 
-      it("includes the @checkstack/scripts devDependency so bunx resolves the dev/pack commands", () => {
+      it("includes the @checkstack/scripts devDependency so `bunx @checkstack/scripts plugin-pack` resolves", () => {
         const pkg = JSON.parse(
           readFileSync(path.join(targetDir, "package.json"), "utf8"),
         ) as { devDependencies?: Record<string, string> };
         expect(pkg.devDependencies?.["@checkstack/scripts"]).toBeDefined();
       });
 
+      it("includes @checkstack/dev-server (backend/frontend only) so the local dev loop is one-click", () => {
+        const pkg = JSON.parse(
+          readFileSync(path.join(targetDir, "package.json"), "utf8"),
+        ) as { devDependencies?: Record<string, string> };
+        if (pluginType === "common") {
+          // Common packages have no runtime, so the dev server makes no
+          // sense for them.
+          expect(pkg.devDependencies?.["@checkstack/dev-server"]).toBeUndefined();
+        } else {
+          expect(pkg.devDependencies?.["@checkstack/dev-server"]).toBeDefined();
+        }
+      });
+
       it("includes the `pack` script (and the `dev` script for backend/frontend)", () => {
         const pkg = JSON.parse(
           readFileSync(path.join(targetDir, "package.json"), "utf8"),
         ) as { scripts?: Record<string, string> };
         expect(pkg.scripts?.pack).toBe("bunx @checkstack/scripts plugin-pack");
         if (pluginType !== "common") {
-          // Common packages have no runtime, so a dev server makes no
-          // sense for them — but backend/frontend must be one-click.
-          expect(pkg.scripts?.dev).toBe("bunx @checkstack/scripts dev");
+          // Backend/frontend templates pin the dev script to the
+          // `checkstack-dev` bin (provided by `@checkstack/dev-server`,
+          // which the template adds as a devDependency).
+          expect(pkg.scripts?.dev).toBe("checkstack-dev");
         }
       });
     });

package/src/commands/dev-deps-resolver.test.ts

@@ -1,411 +0,0 @@
-import { describe, it, expect } from "bun:test";
-import path from "node:path";
-import { resolveCorePluginDeps } from "./dev-deps-resolver";
-
-/**
- * In-memory fixture for a virtual node_modules tree. Maps a fully
- * qualified file path to its file contents (typically package.json
- * stringified JSON).
- */
-type Fs = Record<string, string>;
-
-const ROOT = "/plugin-author/repo";
-const NM = `${ROOT}/node_modules`;
-
-function makeFs(packages: Record<string, unknown>): Fs {
-  const out: Fs = {};
-  for (const [name, pkg] of Object.entries(packages)) {
-    out[`${NM}/${name}/package.json`] = JSON.stringify(pkg);
-  }
-  return out;
-}
-
-function makeResolver(fs: Fs) {
-  return (_from: string, request: string): string | undefined => {
-    // Only handle requests of the form `<pkg>/package.json` — that's all
-    // resolveCorePluginDeps issues. A real `createRequire` resolves any
-    // entry, but we don't need that fidelity here.
-    if (!request.endsWith("/package.json")) return undefined;
-    const pkgName = request.replace(/\/package\.json$/, "");
-    const candidate = `${NM}/${pkgName}/package.json`;
-    return fs[candidate] === undefined ? undefined : candidate;
-  };
-}
-
-function readFileFromFs(fs: Fs) {
-  return (p: string): string => {
-    const text = fs[p];
-    if (text === undefined) throw new Error(`ENOENT: ${p}`);
-    return text;
-  };
-}
-
-describe("resolveCorePluginDeps", () => {
-  it("returns only the auto-included providers for a plugin with no @checkstack/* backend deps", () => {
-    const fs: Fs = {
-      [`${ROOT}/package.json`]: JSON.stringify({
-        name: "@my-org/widget-backend",
-        dependencies: {
-          "@checkstack/backend-api": "^1.0.0",
-          lodash: "^4.0.0",
-        },
-        checkstack: { type: "backend", pluginId: "widget" },
-      }),
-      ...makeFs({
-        "@checkstack/backend-api": {
-          name: "@checkstack/backend-api",
-          checkstack: { type: "common" },
-        },
-        "@checkstack/queue-memory-backend": {
-          name: "@checkstack/queue-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "queue-memory" },
-        },
-        "@checkstack/cache-memory-backend": {
-          name: "@checkstack/cache-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "cache-memory" },
-        },
-      }),
-    };
-
-    const resolved = resolveCorePluginDeps({
-      pluginDir: ROOT,
-      readFile: readFileFromFs(fs),
-      resolveFrom: makeResolver(fs),
-    });
-
-    const names = resolved.map((r) => r.name).toSorted();
-    expect(names).toEqual([
-      "@checkstack/cache-memory-backend",
-      "@checkstack/queue-memory-backend",
-    ]);
-  });
-
-  it("includes a single backend dep declared in dependencies", () => {
-    const fs: Fs = {
-      [`${ROOT}/package.json`]: JSON.stringify({
-        name: "@my-org/healthcheck-rcon-backend",
-        dependencies: {
-          "@checkstack/healthcheck-backend": "^1.0.0",
-        },
-        checkstack: { type: "backend", pluginId: "healthcheck-rcon" },
-      }),
-      ...makeFs({
-        "@checkstack/healthcheck-backend": {
-          name: "@checkstack/healthcheck-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "healthcheck" },
-          dependencies: {},
-        },
-        "@checkstack/queue-memory-backend": {
-          name: "@checkstack/queue-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "queue-memory" },
-        },
-        "@checkstack/cache-memory-backend": {
-          name: "@checkstack/cache-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "cache-memory" },
-        },
-      }),
-    };
-
-    const resolved = resolveCorePluginDeps({
-      pluginDir: ROOT,
-      readFile: readFileFromFs(fs),
-      resolveFrom: makeResolver(fs),
-    });
-
-    expect(resolved.map((r) => r.name).toSorted()).toEqual([
-      "@checkstack/cache-memory-backend",
-      "@checkstack/healthcheck-backend",
-      "@checkstack/queue-memory-backend",
-    ]);
-
-    const hc = resolved.find((r) => r.name === "@checkstack/healthcheck-backend");
-    expect(hc?.modulePath).toBe(
-      path.resolve(`${NM}/@checkstack/healthcheck-backend/src/index.ts`),
-    );
-  });
-
-  it("walks transitive @checkstack/* backend deps", () => {
-    // Plugin → notification-discord-backend → notification-backend → catalog-backend
-    const fs: Fs = {
-      [`${ROOT}/package.json`]: JSON.stringify({
-        name: "@my-org/widget-backend",
-        dependencies: {
-          "@checkstack/notification-discord-backend": "^1.0.0",
-        },
-        checkstack: { type: "backend", pluginId: "widget" },
-      }),
-      ...makeFs({
-        "@checkstack/notification-discord-backend": {
-          name: "@checkstack/notification-discord-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "notification-discord" },
-          dependencies: {
-            "@checkstack/notification-backend": "^1.0.0",
-          },
-        },
-        "@checkstack/notification-backend": {
-          name: "@checkstack/notification-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "notification" },
-          dependencies: {
-            "@checkstack/catalog-backend": "^1.0.0",
-          },
-        },
-        "@checkstack/catalog-backend": {
-          name: "@checkstack/catalog-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "catalog" },
-        },
-        "@checkstack/queue-memory-backend": {
-          name: "@checkstack/queue-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "queue-memory" },
-        },
-        "@checkstack/cache-memory-backend": {
-          name: "@checkstack/cache-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "cache-memory" },
-        },
-      }),
-    };
-
-    const resolved = resolveCorePluginDeps({
-      pluginDir: ROOT,
-      readFile: readFileFromFs(fs),
-      resolveFrom: makeResolver(fs),
-    });
-
-    expect(resolved.map((r) => r.name).toSorted()).toEqual([
-      "@checkstack/cache-memory-backend",
-      "@checkstack/catalog-backend",
-      "@checkstack/notification-backend",
-      "@checkstack/notification-discord-backend",
-      "@checkstack/queue-memory-backend",
-    ]);
-  });
-
-  it("walks through common-type packages to find transitive backend deps", () => {
-    // Plugin → my-shared-common (type: common) → healthcheck-backend
-    // (Unusual but possible; common packages can list runtime deps.)
-    const fs: Fs = {
-      [`${ROOT}/package.json`]: JSON.stringify({
-        name: "@my-org/widget-backend",
-        dependencies: {
-          "@checkstack/widget-common": "^1.0.0",
-        },
-        checkstack: { type: "backend", pluginId: "widget" },
-      }),
-      ...makeFs({
-        "@checkstack/widget-common": {
-          name: "@checkstack/widget-common",
-          checkstack: { type: "common" },
-          dependencies: {
-            "@checkstack/healthcheck-backend": "^1.0.0",
-          },
-        },
-        "@checkstack/healthcheck-backend": {
-          name: "@checkstack/healthcheck-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "healthcheck" },
-        },
-        "@checkstack/queue-memory-backend": {
-          name: "@checkstack/queue-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "queue-memory" },
-        },
-        "@checkstack/cache-memory-backend": {
-          name: "@checkstack/cache-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "cache-memory" },
-        },
-      }),
-    };
-
-    const resolved = resolveCorePluginDeps({
-      pluginDir: ROOT,
-      readFile: readFileFromFs(fs),
-      resolveFrom: makeResolver(fs),
-    });
-
-    expect(resolved.map((r) => r.name)).toContain(
-      "@checkstack/healthcheck-backend",
-    );
-    // The common pkg itself isn't loaded as a plugin
-    expect(resolved.map((r) => r.name)).not.toContain(
-      "@checkstack/widget-common",
-    );
-  });
-
-  it("excludes the plugin under dev itself even when listed transitively", () => {
-    const fs: Fs = {
-      [`${ROOT}/package.json`]: JSON.stringify({
-        name: "@my-org/widget-backend",
-        dependencies: {
-          "@checkstack/healthcheck-backend": "^1.0.0",
-        },
-        checkstack: { type: "backend", pluginId: "widget" },
-      }),
-      ...makeFs({
-        "@checkstack/healthcheck-backend": {
-          name: "@checkstack/healthcheck-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "healthcheck" },
-          // Pretend the platform plugin pulls back into the user's plugin
-          // (this would never happen in practice, but the resolver must
-          // never try to load the plugin under dev as a sibling).
-          dependencies: {
-            "@my-org/widget-backend": "^1.0.0",
-          },
-        },
-        "@checkstack/queue-memory-backend": {
-          name: "@checkstack/queue-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "queue-memory" },
-        },
-        "@checkstack/cache-memory-backend": {
-          name: "@checkstack/cache-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "cache-memory" },
-        },
-      }),
-    };
-
-    const resolved = resolveCorePluginDeps({
-      pluginDir: ROOT,
-      readFile: readFileFromFs(fs),
-      resolveFrom: makeResolver(fs),
-    });
-    expect(resolved.map((r) => r.name)).not.toContain("@my-org/widget-backend");
-  });
-
-  it("skips queue-memory auto-include when bullmq is already in the dep graph", () => {
-    const fs: Fs = {
-      [`${ROOT}/package.json`]: JSON.stringify({
-        name: "@my-org/widget-backend",
-        dependencies: {
-          "@checkstack/queue-bullmq-backend": "^1.0.0",
-        },
-        checkstack: { type: "backend", pluginId: "widget" },
-      }),
-      ...makeFs({
-        "@checkstack/queue-bullmq-backend": {
-          name: "@checkstack/queue-bullmq-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "queue-bullmq" },
-        },
-        "@checkstack/queue-memory-backend": {
-          name: "@checkstack/queue-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "queue-memory" },
-        },
-        "@checkstack/cache-memory-backend": {
-          name: "@checkstack/cache-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "cache-memory" },
-        },
-      }),
-    };
-
-    const resolved = resolveCorePluginDeps({
-      pluginDir: ROOT,
-      readFile: readFileFromFs(fs),
-      resolveFrom: makeResolver(fs),
-    });
-    const names = resolved.map((r) => r.name);
-    expect(names).toContain("@checkstack/queue-bullmq-backend");
-    expect(names).not.toContain("@checkstack/queue-memory-backend");
-  });
-
-  it("does not include @checkstack/* frontend or tooling packages", () => {
-    const fs: Fs = {
-      [`${ROOT}/package.json`]: JSON.stringify({
-        name: "@my-org/widget-backend",
-        dependencies: {
-          "@checkstack/healthcheck-backend": "^1.0.0",
-          "@checkstack/healthcheck-frontend": "^1.0.0",
-          "@checkstack/scripts": "^0.1.0",
-        },
-        checkstack: { type: "backend", pluginId: "widget" },
-      }),
-      ...makeFs({
-        "@checkstack/healthcheck-backend": {
-          name: "@checkstack/healthcheck-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "healthcheck" },
-        },
-        "@checkstack/healthcheck-frontend": {
-          name: "@checkstack/healthcheck-frontend",
-          main: "src/index.tsx",
-          checkstack: { type: "frontend", pluginId: "healthcheck" },
-        },
-        "@checkstack/scripts": {
-          name: "@checkstack/scripts",
-          checkstack: { type: "tooling" },
-        },
-        "@checkstack/queue-memory-backend": {
-          name: "@checkstack/queue-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "queue-memory" },
-        },
-        "@checkstack/cache-memory-backend": {
-          name: "@checkstack/cache-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "cache-memory" },
-        },
-      }),
-    };
-
-    const resolved = resolveCorePluginDeps({
-      pluginDir: ROOT,
-      readFile: readFileFromFs(fs),
-      resolveFrom: makeResolver(fs),
-    });
-    const names = resolved.map((r) => r.name);
-    expect(names).toContain("@checkstack/healthcheck-backend");
-    expect(names).not.toContain("@checkstack/healthcheck-frontend");
-    expect(names).not.toContain("@checkstack/scripts");
-  });
-
-  it("silently skips a declared dep that isn't actually installed", () => {
-    const fs: Fs = {
-      [`${ROOT}/package.json`]: JSON.stringify({
-        name: "@my-org/widget-backend",
-        dependencies: {
-          "@checkstack/missing-backend": "^1.0.0",
-        },
-        checkstack: { type: "backend", pluginId: "widget" },
-      }),
-      ...makeFs({
-        "@checkstack/queue-memory-backend": {
-          name: "@checkstack/queue-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "queue-memory" },
-        },
-        "@checkstack/cache-memory-backend": {
-          name: "@checkstack/cache-memory-backend",
-          main: "src/index.ts",
-          checkstack: { type: "backend", pluginId: "cache-memory" },
-        },
-      }),
-    };
-
-    const resolved = resolveCorePluginDeps({
-      pluginDir: ROOT,
-      readFile: readFileFromFs(fs),
-      resolveFrom: makeResolver(fs),
-    });
-    expect(resolved.map((r) => r.name)).not.toContain(
-      "@checkstack/missing-backend",
-    );
-    // Auto-included providers still present — boot needs them.
-    expect(resolved.map((r) => r.name).toSorted()).toEqual([
-      "@checkstack/cache-memory-backend",
-      "@checkstack/queue-memory-backend",
-    ]);
-  });
-});