otherplane 0.1.0 → 0.1.1

package/bin/otherplane.mjs

@@ -30,7 +30,7 @@ import {
   readdirSync, statSync, mkdirSync, copyFileSync, cpSync, rmSync, existsSync, readFileSync, writeFileSync,
 } from 'node:fs';
 import { createServer } from 'node:http';
-import { join, dirname } from 'node:path';
+import { join, dirname, sep } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { createRequire } from 'node:module';
 
@@ -57,14 +57,56 @@ function resolveEngine() {
   }
 }
 const ENGINE = resolveEngine();
-const PUBLIC = join(ENGINE, 'public');
 const CONTENT_DIRS = ['rooms', 'worlds', 'music'];
 const CONFIG_PATH = join(PROJECT, 'otherplane.config.json');
-// Next writes its export into the engine dir; the deployable belongs in the
-// PROJECT (the engine may be an installed package elsewhere). We copy it there.
-const ENGINE_OUT = join(ENGINE, 'out');
 const OUT = join(PROJECT, 'out');
 
+// When installed, the engine lives inside node_modules — but Next/Turbopack won't
+// transpile app source under node_modules. So for an installed engine we build a
+// COPY staged outside it (in the project's .otherplane/), with its own real
+// node_modules. In this repo's sibling layout we build in place.
+const INSTALLED = ENGINE.split(sep).includes('node_modules');
+let BUILD_ENGINE = ENGINE;                 // where Next actually runs
+const publicDir = () => join(BUILD_ENGINE, 'public');
+const engineOut = () => join(BUILD_ENGINE, 'out');
+
+// Install the engine's deps into `dir` if missing (real node_modules, not a
+// symlink — Turbopack can't resolve `next` through a symlinked node_modules).
+function ensureDepsIn(dir) {
+  if (existsSync(join(dir, 'node_modules', 'next'))) return;
+  console.log('installing the engine’s dependencies (one-time per project, ~a minute)…');
+  run('npm', ['--prefix', dir, 'install', '--no-audit', '--no-fund']);
+}
+
+// Pick where Next runs and make sure its deps are there.
+//  • sibling (this repo): build in place.
+//  • installed: the engine sits inside node_modules, but Next won't transpile app
+//    source under node_modules — so stage a copy in PROJECT/.otherplane/engine and
+//    install deps THERE (kept across builds; `otherplane clean` drops it).
+function prepareEngine() {
+  if (!INSTALLED) { BUILD_ENGINE = ENGINE; ensureDepsIn(ENGINE); return; }
+  const work = join(PROJECT, '.otherplane', 'engine');
+  // Refresh source every run (cheap); keep node_modules (expensive) across builds.
+  if (existsSync(work)) {
+    for (const e of readdirSync(work)) {
+      if (e !== 'node_modules') rmSync(join(work, e), { recursive: true, force: true });
+    }
+  } else {
+    mkdirSync(work, { recursive: true });
+  }
+  cpSync(ENGINE, work, {
+    recursive: true,
+    filter: (src) => {
+      const rel = src.slice(ENGINE.length);
+      return !rel.startsWith(`${sep}node_modules`)
+        && !rel.startsWith(`${sep}.next`)
+        && !rel.startsWith(`${sep}out`);
+    },
+  });
+  BUILD_ENGINE = work;
+  ensureDepsIn(work);
+}
+
 // Env passed to every engine (Next) invocation so it reads THIS project's config
 // and content — not whatever happens to sit beside the engine dir.
 const engineEnv = (extra = {}) => ({ ...process.env, OTHERPLANE_PROJECT: PROJECT, ...extra });
@@ -100,16 +142,9 @@ function syncDir(src, dest) {
 }
 
 function sync() {
-  for (const d of CONTENT_DIRS) syncDir(join(PROJECT, d), join(PUBLIC, d));
+  for (const d of CONTENT_DIRS) syncDir(join(PROJECT, d), join(publicDir(), d));
 }
 
-// Install the engine's deps on first use (so `npx otherplane` / a global install
-// works with no separate setup step). No-op once node_modules exists.
-function ensureEngineDeps() {
-  if (existsSync(join(ENGINE, 'node_modules'))) return;
-  console.log('installing the engine’s dependencies (one-time, ~a minute)…');
-  run('npm', ['--prefix', ENGINE, 'install']);
-}
 
 // How many rooms the project actually has (a folder with a room.json).
 function roomCount() {
@@ -124,7 +159,7 @@ function roomCount() {
 function syncRoom(slug) {
   const src = join(PROJECT, 'rooms', slug, 'room.json');
   if (!existsSync(src)) return;
-  const destDir = join(PUBLIC, 'rooms', slug);
+  const destDir = join(publicDir(), 'rooms', slug);
   mkdirSync(destDir, { recursive: true });
   copyFileSync(src, join(destDir, 'room.json'));
 }
@@ -353,7 +388,7 @@ function startEditServer() {
 // (not spawnSync) so the writer's event loop keeps serving while Next runs.
 function runEdit() {
   const server = startEditServer();
-  const child = spawn('npm', ['--prefix', ENGINE, 'run', 'edit'], {
+  const child = spawn('npm', ['--prefix', BUILD_ENGINE, 'run', 'edit'], {
     stdio: 'inherit',
     cwd: PROJECT,
     env: engineEnv({ NEXT_PUBLIC_EDIT_API: `http://localhost:${EDIT_PORT}` }),
@@ -423,15 +458,15 @@ function buildEngine(base) {
     console.error('no rooms yet — add one with `otherplane new` or create rooms/<slug>/room.json, then build.');
     process.exit(1);
   }
-  ensureEngineDeps();
+  prepareEngine();
   check();
   sync();
-  run('npm', ['--prefix', ENGINE, 'run', 'build'], {
+  run('npm', ['--prefix', BUILD_ENGINE, 'run', 'build'], {
     env: engineEnv(base != null ? { OTHERPLANE_BASE_PATH: base } : {}),
   });
-  if (ENGINE_OUT !== OUT) {
+  if (engineOut() !== OUT) {
     rmSync(OUT, { recursive: true, force: true });
-    cpSync(ENGINE_OUT, OUT, { recursive: true });
+    cpSync(engineOut(), OUT, { recursive: true });
     console.log(`✓ exported to ${OUT}`);
   }
 }
@@ -446,12 +481,12 @@ switch (cmd) {
     sync();
     break;
   case 'dev':
-    ensureEngineDeps();
+      prepareEngine();
     sync();
-    run('npm', ['--prefix', ENGINE, 'run', 'dev'], { env: engineEnv() });
+    run('npm', ['--prefix', BUILD_ENGINE, 'run', 'dev'], { env: engineEnv() });
     break;
   case 'edit':
-    ensureEngineDeps();
+      prepareEngine();
     sync();
     runEdit();
     break;
@@ -469,11 +504,14 @@ switch (cmd) {
     run('python3', ['-m', 'http.server', '8000'], { cwd: OUT });
     break;
   case 'clean':
+    // Remove build output in both layouts: the in-place engine (dev sibling), the
+    // staged copy (installed), and the project's out/.
     rmSync(join(ENGINE, '.next'), { recursive: true, force: true });
-    rmSync(ENGINE_OUT, { recursive: true, force: true });
+    rmSync(join(ENGINE, 'out'), { recursive: true, force: true });
+    for (const d of CONTENT_DIRS) rmSync(join(ENGINE, 'public', d), { recursive: true, force: true });
+    rmSync(join(PROJECT, '.otherplane'), { recursive: true, force: true });
     rmSync(OUT, { recursive: true, force: true });
-    for (const d of CONTENT_DIRS) rmSync(join(PUBLIC, d), { recursive: true, force: true });
-    console.log('cleaned build output (.next, out) and the synced mirror');
+    console.log('cleaned build output (.next, out, .otherplane) and the synced mirror');
     break;
   case 'setup':
     run('npm', ['--prefix', ENGINE, 'install']);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "otherplane",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A static site generator for walkable Gaussian-splat museums. Generate a 3D room per section, link rooms with doorways, publish a static walkable site.",
   "keywords": [
     "gaussian-splatting",