npm - castle-web-cli - Versions diffs - 0.4.38 → 0.4.39 - Mend

castle-web-cli 0.4.38 → 0.4.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/index.js +0 -8
package/dist/init.d.ts +0 -18
package/dist/init.js +145 -167
package/package.json +1 -1
package/kits/basic-2d/published-deck.tgz +0 -0
package/kits/basic-3d/published-deck.tgz +0 -0

package/dist/index.js CHANGED Viewed

@@ -135,14 +135,6 @@ async function main() {
         case 'login':
             await login();
             break;
-        case 'build-archives': {
-            // Dev/publish tool: generate the prebuilt per-kit deck archives that
-            // `init` extracts in published mode. Run after `npm run build -w cli`.
-            const { buildKitArchives } = await import('./buildArchive.js');
-            const only = getFlagValue('--kit');
-            buildKitArchives(only ? [only] : undefined);
-            break;
-        }
         default:
             usage();
     }

package/dist/init.d.ts CHANGED Viewed

@@ -1,22 +1,4 @@
-export declare const PUBLISHED_SDK_VERSION = "0.4.4";
-export declare const KIT_COPY_EXCLUDE: Set<string>;
-export declare const ARCHIVE_NAME = "published-deck.tgz";
-export declare function getKitArchivePath(kit: string): string;
-export declare function copyKitSource(kitDir: string, dest: string, extraExclude?: Set<string>): void;
-export declare function rewriteKitPackageJson(pkg: {
-    name?: string;
-    dependencies?: Record<string, string>;
-    scripts?: Record<string, string>;
-}, name: string, refs: ReturnType<typeof resolveScaffoldRefs>): void;
-declare function resolveScaffoldRefs(): {
-    workspaceMode: boolean;
-    sdkRef: string;
-    cliCommand: string;
-    cliDistAbs: string | null;
-    sdkPathPosix: string | null;
-};
 export declare function init(dir: string, opts?: {
     kit?: string;
     serve?: boolean;
 }): Promise<void>;
-export {};

package/dist/init.js CHANGED Viewed

@@ -1,9 +1,9 @@
-import { execFileSync, execSync } from 'child_process';
-import * as fs from 'fs';
-import * as path from 'path';
-import { COMMON_INSTRUCTIONS } from './commonInstructions.js';
-import { getCliEntryPath, getKitsDir, getRepoRoot, getSdkPackagePath, toPosixPath } from './localPaths.js';
-import { serve } from './serve.js';
+import { execSync } from "child_process";
+import * as fs from "fs";
+import * as path from "path";
+import { COMMON_INSTRUCTIONS } from "./commonInstructions.js";
+import { getCliEntryPath, getKitsDir, getRepoRoot, getSdkPackagePath, toPosixPath, } from "./localPaths.js";
+import { serve } from "./serve.js";
 const INDEX_HTML = `<!DOCTYPE html>
 <html>
 <head>
@@ -31,66 +31,20 @@ card.appendChild(el);
 `;
 // Default kit copied by `init` when no --kit is given. `none`/`bare` skip the
 // kit and produce the minimal index.html + game.js stub above.
-const DEFAULT_KIT = 'basic-2d';
+const DEFAULT_KIT = "basic-2d";
 // Registry version of castle-web-sdk to inject when scaffolding from a
 // globally-installed castle-web (not from inside the workspace). Bumped
 // alongside cli/sdk version bumps.
-export const PUBLISHED_SDK_VERSION = '0.4.4';
+const PUBLISHED_SDK_VERSION = "0.4.4";
 // Never copied into a fresh deck: build/dependency junk, and castle.json (a
 // fresh deck has no deckId until its first save-deck).
-export const KIT_COPY_EXCLUDE = new Set(['node_modules', '.castle', 'dist', '.git', 'castle.json']);
-// A globally-installed castle-web ships one prebuilt, ready-to-serve archive
-// per kit (kit source + installed node_modules + published-mode package.json),
-// gzipped. `init` in published mode extracts it instead of cp + `npm install`.
-// Lives inside each bundled kit dir (cli/kits/<kit>/), generated by
-// `build-archives` (see buildArchive.ts). Workspace mode never uses it.
-export const ARCHIVE_NAME = 'published-deck.tgz';
-export function getKitArchivePath(kit) {
-    return path.join(getKitsDir(), kit, ARCHIVE_NAME);
-}
-// Copy a framework kit into `dest`, dropping build/dependency junk + castle.json
-// (and any caller-supplied extra names, e.g. a stale archive). Shared by the
-// live scaffold and archive generation so the two stay in sync.
-export function copyKitSource(kitDir, dest, extraExclude) {
-    fs.cpSync(kitDir, dest, {
-        recursive: true,
-        // Keep symlinks verbatim so the kit's AGENTS.md -> CLAUDE.md stays a link.
-        verbatimSymlinks: true,
-        filter: (src) => src === kitDir ||
-            (!KIT_COPY_EXCLUDE.has(path.basename(src)) && !extraExclude?.has(path.basename(src))),
-    });
-}
-// Rewrite a kit's package.json (in place) so the scaffolded deck references the
-// sdk + cli per the resolved mode. Workspace mode points at the local checkout
-// (file: sdk + node <abs cli dist>); published mode points at the registry sdk
-// + the `castle-web` binary. Shared by the live scaffold and archive generation.
-export function rewriteKitPackageJson(pkg, name, refs) {
-    pkg.name = name;
-    const { workspaceMode, sdkRef, cliDistAbs, sdkPathPosix } = refs;
-    if (pkg.dependencies &&
-        typeof pkg.dependencies['castle-web-sdk'] === 'string' &&
-        pkg.dependencies['castle-web-sdk'].startsWith('file:')) {
-        pkg.dependencies['castle-web-sdk'] = sdkRef;
-    }
-    if (!pkg.scripts)
-        return;
-    for (const k of Object.keys(pkg.scripts)) {
-        if (typeof pkg.scripts[k] !== 'string')
-            continue;
-        if (workspaceMode) {
-            pkg.scripts[k] = pkg.scripts[k]
-                .replace(/\.\.\/\.\.\/cli\/dist/g, cliDistAbs)
-                .replace(/\.\.\/\.\.\/sdk/g, sdkPathPosix);
-        }
-        else {
-            // Globally-installed: route through the `castle-web` binary on PATH.
-            pkg.scripts[k] = pkg.scripts[k]
-                .replace(/node\s+\.\.\/\.\.\/cli\/dist\/index\.js/g, 'castle-web')
-                .replace(/await import\((['"])\.\.\/\.\.\/cli\/dist\/bundle\.js\1\)/g, "await import('castle-web-cli/dist/bundle.js')")
-                .replace(/\.\.\/\.\.\/sdk/g, '');
-        }
-    }
-}
+const KIT_COPY_EXCLUDE = new Set([
+    "node_modules",
+    ".castle",
+    "dist",
+    ".git",
+    "castle.json",
+]);
 // Resolve how a scaffolded deck should reference the sdk + cli. Both the bare
 // and kit scaffold paths go through here so they stay in sync.
 //   workspace mode (sdk/ sits next to cli/, i.e. running from a checkout):
@@ -104,11 +58,17 @@ function resolveScaffoldRefs() {
     // npm package and need the published refs + `castle-web` binary.
     const workspaceMode = fs.existsSync(sdkPath);
     const sdkPathPosix = workspaceMode ? toPosixPath(sdkPath) : null;
-    const cliDistAbs = workspaceMode ? toPosixPath(path.dirname(getCliEntryPath())) : null;
+    const cliDistAbs = workspaceMode
+        ? toPosixPath(path.dirname(getCliEntryPath()))
+        : null;
     return {
         workspaceMode,
-        sdkRef: workspaceMode ? `file:${sdkPathPosix}` : `^${PUBLISHED_SDK_VERSION}`,
-        cliCommand: workspaceMode ? `node ${toPosixPath(getCliEntryPath())}` : 'castle-web',
+        sdkRef: workspaceMode
+            ? `file:${sdkPathPosix}`
+            : `^${PUBLISHED_SDK_VERSION}`,
+        cliCommand: workspaceMode
+            ? `node ${toPosixPath(getCliEntryPath())}`
+            : "castle-web",
         cliDistAbs,
         sdkPathPosix,
     };
@@ -118,9 +78,9 @@ function makeClaudeMd() {
     // castle-experimental-web checkout, but breaks when the scaffold lives
     // outside the repo (the relative path no longer resolves).
     const repoRoot = getRepoRoot();
-    const upstream = path.join(repoRoot, 'CLAUDE.md');
+    const upstream = path.join(repoRoot, "CLAUDE.md");
     try {
-        return fs.readFileSync(upstream, 'utf8').trimEnd() + '\n';
+        return fs.readFileSync(upstream, "utf8").trimEnd() + "\n";
     }
     catch {
         return `# Castle Experimental Web\n\nSee https://github.com/castle-xyz/castle-experimental-web for the agent guide.\n`;
@@ -130,13 +90,15 @@ function makeClaudeMd() {
 // the kit's (or bare) CLAUDE.md is written; the AGENTS.md symlink picks the
 // appended content up for free.
 function appendCommonInstructions(projectDir) {
-    const claudePath = path.join(projectDir, 'CLAUDE.md');
-    const existing = fs.existsSync(claudePath) ? fs.readFileSync(claudePath, 'utf8').trimEnd() + '\n\n' : '';
+    const claudePath = path.join(projectDir, "CLAUDE.md");
+    const existing = fs.existsSync(claudePath)
+        ? fs.readFileSync(claudePath, "utf8").trimEnd() + "\n\n"
+        : "";
     fs.writeFileSync(claudePath, existing + COMMON_INSTRUCTIONS);
 }
 function tryMakeAgentsSymlink(agentsPath) {
     try {
-        fs.symlinkSync('CLAUDE.md', agentsPath);
+        fs.symlinkSync("CLAUDE.md", agentsPath);
     }
     catch {
         // symlink already exists / unsupported FS — non-fatal
@@ -147,79 +109,45 @@ function makePackageJson(projectDir) {
     return {
         name: path.basename(projectDir),
         private: true,
-        type: 'module',
+        type: "module",
         scripts: {
             restart: `${cliCommand} restart .`,
             screenshot: `${cliCommand} screenshot .`,
-            'save-deck': `${cliCommand} save-deck .`,
+            "save-deck": `${cliCommand} save-deck .`,
         },
         dependencies: {
-            'castle-web-sdk': sdkRef,
+            "castle-web-sdk": sdkRef,
         },
     };
 }
 // Some coding agents read AGENTS.md by convention. Symlink so they get the
 // same guidance without a duplicate copy.
 function ensureAgentsSymlink(projectDir) {
-    const agentsPath = path.join(projectDir, 'AGENTS.md');
+    const agentsPath = path.join(projectDir, "AGENTS.md");
     if (fs.lstatSync(agentsPath, { throwIfNoEntry: false }))
         return;
     // Don't create a dangling link — only symlink when CLAUDE.md is present.
-    if (!fs.existsSync(path.join(projectDir, 'CLAUDE.md')))
+    if (!fs.existsSync(path.join(projectDir, "CLAUDE.md")))
         return;
     tryMakeAgentsSymlink(agentsPath);
 }
 // Bare scaffold: a plain code-only deck with no kit framework.
 function scaffoldBare(projectDir) {
     fs.mkdirSync(projectDir, { recursive: true });
-    fs.writeFileSync(path.join(projectDir, 'index.html'), INDEX_HTML);
-    fs.writeFileSync(path.join(projectDir, 'game.js'), GAME_JS);
-    fs.writeFileSync(path.join(projectDir, 'CLAUDE.md'), makeClaudeMd());
+    fs.writeFileSync(path.join(projectDir, "index.html"), INDEX_HTML);
+    fs.writeFileSync(path.join(projectDir, "game.js"), GAME_JS);
+    fs.writeFileSync(path.join(projectDir, "CLAUDE.md"), makeClaudeMd());
     appendCommonInstructions(projectDir);
     ensureAgentsSymlink(projectDir);
-    fs.writeFileSync(path.join(projectDir, 'package.json'), JSON.stringify(makePackageJson(projectDir), null, 2) + '\n');
-}
-// Finalize a deck whose files are already on disk (mirroring scaffoldFromKit's
-// tail): ensure a CLAUDE.md, append the cli-owned common guidance, and create
-// the AGENTS.md symlink. Used by both the cp path and the archive-extract path.
-function finalizeDeckDocs(projectDir) {
-    // Every deck needs a CLAUDE.md so coding agents know how castle-web works.
-    // Keep the kit's own if it ships one; otherwise generate from the upstream.
-    const claudePath = path.join(projectDir, 'CLAUDE.md');
-    if (!fs.existsSync(claudePath)) {
-        fs.writeFileSync(claudePath, makeClaudeMd());
-    }
-    appendCommonInstructions(projectDir);
-    ensureAgentsSymlink(projectDir);
-}
-// Published fast path: extract the prebuilt, ready-to-serve archive into the
-// deck dir (no cp, no `npm install`). The archive carries the kit source +
-// installed node_modules + a published-mode package.json with a generic name;
-// rename it to the deck dir, then run the shared doc finalization.
-function extractKitArchive(archivePath, projectDir) {
-    fs.mkdirSync(projectDir, { recursive: true });
-    execFileSync('tar', ['-xzf', archivePath, '-C', projectDir], { stdio: 'inherit' });
-    const pkgPath = path.join(projectDir, 'package.json');
-    if (fs.existsSync(pkgPath)) {
-        try {
-            const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
-            pkg.name = path.basename(projectDir);
-            fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
-        }
-        catch {
-            // archived an unparseable package.json — leave it for the user to fix
-        }
-    }
-    finalizeDeckDocs(projectDir);
+    fs.writeFileSync(path.join(projectDir, "package.json"), JSON.stringify(makePackageJson(projectDir), null, 2) + "\n");
 }
 // Copy a framework kit from kits/<kit>/ into the new deck dir, dropping
-// build/dependency junk and castle.json. Returns whether deps are already
-// installed (true only on the published archive-extract fast path).
+// build/dependency junk and castle.json.
 function scaffoldFromKit(kit, projectDir) {
     const kitDir = path.join(getKitsDir(), kit);
     if (!fs.existsSync(kitDir) || !fs.statSync(kitDir).isDirectory()) {
         console.error(`Kit "${kit}" not found at ${kitDir}.`);
-        console.error('Available kits:');
+        console.error("Available kits:");
         try {
             const kits = fs
                 .readdirSync(getKitsDir())
@@ -228,43 +156,103 @@ function scaffoldFromKit(kit, projectDir) {
                 for (const name of kits)
                     console.error(`  ${name}`);
             else
-                console.error('  (none)');
+                console.error("  (none)");
         }
         catch {
-            console.error('  (none — kits/ directory is missing)');
+            console.error("  (none — kits/ directory is missing)");
         }
-        console.error('Or use `--kit none` for a bare code-only deck.');
+        console.error("Or use `--kit none` for a bare code-only deck.");
         process.exit(1);
     }
-    // Published mode (globally-installed castle-web, no sibling sdk/) extracts a
-    // prebuilt archive when one ships for this kit -- skipping cp + `npm install`.
-    // Workspace mode always does the live cp so local sdk edits stay live.
-    const refs = resolveScaffoldRefs();
-    const archivePath = getKitArchivePath(kit);
-    if (!refs.workspaceMode && fs.existsSync(archivePath)) {
-        console.log('Extracting prebuilt deck (deps included)...');
-        extractKitArchive(archivePath, projectDir);
-        return { depsInstalled: true };
-    }
-    copyKitSource(kitDir, projectDir);
+    fs.cpSync(kitDir, projectDir, {
+        recursive: true,
+        // Keep symlinks verbatim so the kit's AGENTS.md -> CLAUDE.md stays a link.
+        verbatimSymlinks: true,
+        filter: (src) => src === kitDir || !KIT_COPY_EXCLUDE.has(path.basename(src)),
+    });
     // The kit's package.json carries the kit's name; rename it to the deck dir.
     // Kit-relative refs to `../../sdk` and `../../cli/dist` only resolve when the
     // deck lives at castle-experimental-web/decks/<name>/. Rewrite both to
     // absolute paths so the scaffolded deck works anywhere -- including under
     // /tmp where macOS's /tmp -> /private/tmp symlink breaks relative-path math.
-    const pkgPath = path.join(projectDir, 'package.json');
+    const pkgPath = path.join(projectDir, "package.json");
     if (fs.existsSync(pkgPath)) {
         try {
-            const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
-            rewriteKitPackageJson(pkg, path.basename(projectDir), refs);
-            fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
+            const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+            pkg.name = path.basename(projectDir);
+            // Local-dev paths (`file:../../sdk` / `node ../../cli/dist/index.js`) only
+            // work when the deck lives inside the castle-experimental-web workspace.
+            // For a deck scaffolded from a globally-installed castle-web, rewrite to
+            // the published packages instead. Same workspace-vs-published resolution
+            // the bare scaffold path uses.
+            const { workspaceMode, sdkRef, cliDistAbs, sdkPathPosix } = resolveScaffoldRefs();
+            if (pkg.dependencies &&
+                typeof pkg.dependencies["castle-web-sdk"] === "string" &&
+                pkg.dependencies["castle-web-sdk"].startsWith("file:")) {
+                pkg.dependencies["castle-web-sdk"] = sdkRef;
+            }
+            if (pkg.scripts) {
+                for (const k of Object.keys(pkg.scripts)) {
+                    if (typeof pkg.scripts[k] !== "string")
+                        continue;
+                    if (workspaceMode) {
+                        pkg.scripts[k] = pkg.scripts[k]
+                            .replace(/\.\.\/\.\.\/cli\/dist/g, cliDistAbs)
+                            .replace(/\.\.\/\.\.\/sdk/g, sdkPathPosix);
+                    }
+                    else {
+                        // Globally-installed: route through the `castle-web` binary on PATH.
+                        pkg.scripts[k] = pkg.scripts[k]
+                            .replace(/node\s+\.\.\/\.\.\/cli\/dist\/index\.js/g, "castle-web")
+                            .replace(/await import\((['"])\.\.\/\.\.\/cli\/dist\/bundle\.js\1\)/g, "await import('castle-web-cli/dist/bundle.js')")
+                            .replace(/\.\.\/\.\.\/sdk/g, "");
+                    }
+                }
+            }
+            fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
         }
         catch {
             // kit shipped an unparseable package.json — leave it for the user to fix
         }
     }
-    finalizeDeckDocs(projectDir);
-    return { depsInstalled: false };
+    // Every deck needs a CLAUDE.md so coding agents know how castle-web works.
+    // Keep the kit's own if it ships one; otherwise generate from the upstream.
+    const claudePath = path.join(projectDir, "CLAUDE.md");
+    if (!fs.existsSync(claudePath)) {
+        fs.writeFileSync(claudePath, makeClaudeMd());
+    }
+    appendCommonInstructions(projectDir);
+    ensureAgentsSymlink(projectDir);
+}
+function hasPnpm() {
+    try {
+        execSync("pnpm --version", { stdio: "ignore" });
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+// Install the scaffolded deck's deps. Prefer pnpm -- in the e2b template a pnpm
+// store is baked in, so `pnpm install` is near-instant (hardlinks from the
+// store, no download). Fall back to npm when pnpm isn't on PATH (e.g. a local
+// laptop that never installed it). --prefer-offline uses the store/cache first
+// and only hits the network for anything missing.
+function installDeps(projectDir) {
+    if (hasPnpm()) {
+        console.log("Installing deps (pnpm)...");
+        execSync("pnpm install --prefer-offline", {
+            cwd: projectDir,
+            stdio: "inherit",
+        });
+    }
+    else {
+        console.log("Installing deps (npm)...");
+        execSync("npm install --no-audit --no-fund --loglevel=error", {
+            cwd: projectDir,
+            stdio: "inherit",
+        });
+    }
 }
 export async function init(dir, opts = {}) {
     const projectDir = path.resolve(dir);
@@ -273,54 +261,44 @@ export async function init(dir, opts = {}) {
         process.exit(1);
     }
     const kit = opts.kit ?? DEFAULT_KIT;
-    const bare = kit === 'none' || kit === 'bare';
-    // depsInstalled is true only when the published archive fast-path ran, which
-    // already ships node_modules -- so we can skip `npm install` below.
-    let depsInstalled = false;
+    const bare = kit === "none" || kit === "bare";
     if (bare) {
         scaffoldBare(projectDir);
     }
     else {
-        ({ depsInstalled } = scaffoldFromKit(kit, projectDir));
+        scaffoldFromKit(kit, projectDir);
+    }
+    console.log(`Created project in ${projectDir}/${bare ? "" : ` (from kit "${kit}")`}`);
+    // Always install deps so the deck is ready to serve/edit immediately. The
+    // serve step is what `--no-serve` skips (callers like the cloud launcher run
+    // their own serve), but they still want the deps in place.
+    console.log("");
+    let installed = false;
+    try {
+        installDeps(projectDir);
+        installed = true;
+    }
+    catch {
+        console.error("dependency install failed; re-run `pnpm install` (or `npm install`) in the deck.");
     }
-    console.log(`Created project in ${projectDir}/${bare ? '' : ` (from kit "${kit}")`}`);
-    // Auto-run npm install + serve so the page is up the moment the
-    // agent / user starts editing. Pass --no-serve to skip.
     const autoServe = opts.serve !== false;
-    if (autoServe) {
-        console.log('');
-        if (!depsInstalled) {
-            console.log('Installing deps + serving (pass --no-serve to skip)...');
-            try {
-                execSync('npm install --no-audit --no-fund --loglevel=error', {
-                    cwd: projectDir,
-                    stdio: 'inherit',
-                });
-            }
-            catch {
-                console.error('npm install failed; skipping serve. Re-run yourself with `npm install && castle-web serve .` (& in your shell to background it).');
-                return;
-            }
-        }
-        else {
-            console.log('Serving (deps prebuilt)...');
-        }
+    if (autoServe && installed) {
         // Call serve() with detach so init returns once the server is up. serve()
         // handles the background spawn internally; init doesn't shell out.
         // Bind all interfaces by default so a tailnet / LAN browser can reach
         // the served page; users can override host on a subsequent serve call.
         // Open in the user's default browser unless we're clearly headless (SSH
         // session) or the user has opted out via CASTLE_WEB_CLI_NO_OPEN=1.
-        const noOpen = process.env.CASTLE_WEB_CLI_NO_OPEN === '1' ||
+        const noOpen = process.env.CASTLE_WEB_CLI_NO_OPEN === "1" ||
             !!process.env.SSH_CONNECTION ||
             !!process.env.SSH_TTY;
-        await serve(projectDir, { host: '0.0.0.0', detach: true, open: !noOpen });
+        await serve(projectDir, { host: "0.0.0.0", detach: true, open: !noOpen });
         return;
     }
-    console.log('');
-    console.log('Next steps:');
+    console.log("");
+    console.log("Next steps:");
     console.log(`  cd ${dir}`);
-    if (!depsInstalled)
-        console.log('  npm install');
-    console.log('  castle-web serve .   # & in your shell to background it');
+    if (!installed)
+        console.log("  pnpm install   # or: npm install");
+    console.log("  castle-web serve .   # & in your shell to background it");
 }

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "castle-web-cli",
-  "version": "0.4.38",
+  "version": "0.4.39",
   "type": "module",
   "bin": {
     "castle-web": "./dist/index.js"

package/kits/basic-2d/published-deck.tgz DELETED Viewed

Binary file

package/kits/basic-3d/published-deck.tgz DELETED Viewed

Binary file