@aksp/opencrew 1.2.2 → 1.3.1

package/src/commands/update.js

@@ -1,77 +1,87 @@
-import path from 'node:path';
-import { promises as fs } from 'node:fs';
-import { templatesDir, packageJsonPath } from '../lib/paths.js';
-import { copyDir, exists, writeFileSafe, readJson } from '../lib/fsx.js';
-import { c, log, info, ok, warn, step } from '../lib/ui.js';
-
-// Update refreshes ONLY the framework. It never touches:
-//   crews/, _opencrew/_memory/, _opencrew/_browser_profile/, .env, IDE bridges.
-// Note: catalog skills (skills/<name>/ that ship with the package) ARE fully
-// overwritten below — user edits to a catalog skill's own files are not preserved.
-// Only skill directories that don't exist in the package's templates/skills/ at all
-// (i.e. custom/user-authored skills) are left untouched.
-export async function update(opts = {}) {
-  const target = process.cwd();
-  const pkg = await readJson(packageJsonPath);
-  const version = pkg.version;
-
-  if (!(await exists(path.join(target, '_opencrew', 'core')))) {
-    warn('No opencrew workspace found here.');
-    info(`Run ${c.cyan('npx @aksp/opencrew init')} first.`);
-    return;
-  }
-
-  const versionFile = path.join(target, '_opencrew', '.opencrew-version');
-  const current = (await exists(versionFile))
-    ? (await fs.readFile(versionFile, 'utf8')).trim()
-    : 'unknown';
-
-  log(`\n${c.bold(c.cyan('opencrew update'))}`);
-  log(c.dim(`Installed: ${current}  →  Package: ${version}\n`));
-
-  if (opts.check) {
-    if (current === version) {
-      ok(`Up to date (v${version}).`);
-    } else {
-      info(`Update available: v${current} → v${version}.`);
-      info(`Run ${c.cyan('npx @aksp/opencrew update')} to apply.`);
-      process.exitCode = 1;
-    }
-    return;
-  }
-
-  if (current === version) {
-    ok('Already up to date. Refreshing framework files anyway.');
-  }
-
-  // Refresh core framework: _opencrew/core is fully overwritten (it is not user data).
-  step('Refreshing framework');
-  let n = 0;
-  await copyDir(path.join(templatesDir, '_opencrew', 'core'), path.join(target, '_opencrew', 'core'), {
-    overwrite: true,
-    onCopy: () => (n += 1),
-  });
-  ok(`_opencrew/core refreshed (${n} files)`);
-
-  // Refresh catalog skills: every skill shipped in templates/skills/ is fully
-  // overwritten (edits to a catalog skill's files do not survive an update).
-  // Skill directories that only exist in the user's project — i.e. not part of
-  // the catalog — are never touched, since copyDir only visits paths that exist
-  // in the source (templates/skills/).
-  step('Refreshing catalog skills');
-  warn('Catalog skills are fully overwritten — your edits to any built-in skill files will be lost.');
-  let s = 0;
-  await copyDir(path.join(templatesDir, 'skills'), path.join(target, 'skills'), {
-    overwrite: true,
-    onCopy: () => (s += 1),
-  });
-  ok(`Catalog skills refreshed (${s} files)`);
-
-  // Canonical system doc.
-  await writeFileSafe(path.join(target, 'AGENTS.md'), await fs.readFile(path.join(templatesDir, 'AGENTS.md'), 'utf8'));
-  ok('AGENTS.md refreshed');
-
-  await fs.writeFile(versionFile, version + '\n');
-  log(`\n${c.green(c.bold('Updated to v' + version))}.`);
-  log(c.dim('Your crews, memory, IDE bridges and .env were left untouched.\n'));
-}
+import path from 'node:path';
+import { promises as fs } from 'node:fs';
+import { templatesDir, packageJsonPath } from '../lib/paths.js';
+import { copyDir, exists, writeFileSafe, readJson, writeBridgeFile } from '../lib/fsx.js';
+import { c, log, info, ok, warn, step } from '../lib/ui.js';
+
+// Update refreshes ONLY the framework. It never touches:
+//   crews/, _opencrew/_memory/, _opencrew/_browser_profile/, .env, IDE bridges.
+// Note: catalog skills (skills/<name>/ that ship with the package) ARE fully
+// overwritten below — user edits to a catalog skill's own files are not preserved.
+// Only skill directories that don't exist in the package's templates/skills/ at all
+// (i.e. custom/user-authored skills) are left untouched.
+export async function update(opts = {}) {
+  const target = process.cwd();
+  const pkg = await readJson(packageJsonPath);
+  const version = pkg.version;
+
+  if (!(await exists(path.join(target, '_opencrew', 'core')))) {
+    warn('No opencrew workspace found here.');
+    info(`Run ${c.cyan('npx @aksp/opencrew init')} first.`);
+    return;
+  }
+
+  const versionFile = path.join(target, '_opencrew', '.opencrew-version');
+  const current = (await exists(versionFile))
+    ? (await fs.readFile(versionFile, 'utf8')).trim()
+    : 'unknown';
+
+  log(`\n${c.bold(c.cyan('opencrew update'))}`);
+  log(c.dim(`Installed: ${current}  →  Package: ${version}\n`));
+
+  if (opts.check) {
+    if (current === version) {
+      ok(`Up to date (v${version}).`);
+    } else {
+      info(`Update available: v${current} → v${version}.`);
+      info(`Run ${c.cyan('npx @aksp/opencrew update')} to apply.`);
+      process.exitCode = 1;
+    }
+    return;
+  }
+
+  if (current === version) {
+    ok('Already up to date. Refreshing framework files anyway.');
+  }
+
+  // Refresh core framework: _opencrew/core is fully overwritten (it is not user data).
+  step('Refreshing framework');
+  let n = 0;
+  await copyDir(path.join(templatesDir, '_opencrew', 'core'), path.join(target, '_opencrew', 'core'), {
+    overwrite: true,
+    onCopy: () => (n += 1),
+  });
+  ok(`_opencrew/core refreshed (${n} files)`);
+
+  // Refresh catalog skills: every skill shipped in templates/skills/ is fully
+  // overwritten (edits to a catalog skill's files do not survive an update).
+  // Skill directories that only exist in the user's project — i.e. not part of
+  // the catalog — are never touched, since copyDir only visits paths that exist
+  // in the source (templates/skills/).
+  step('Refreshing catalog skills');
+  warn('Catalog skills are fully overwritten — your edits to any built-in skill files will be lost.');
+  let s = 0;
+  await copyDir(path.join(templatesDir, 'skills'), path.join(target, 'skills'), {
+    overwrite: true,
+    onCopy: () => (s += 1),
+  });
+  ok(`Catalog skills refreshed (${s} files)`);
+
+  // System doc — full definition in _opencrew/core/, thin bridge at root.
+  const systemContent = await fs.readFile(path.join(templatesDir, 'AGENTS.md'), 'utf8');
+  await writeFileSafe(path.join(target, '_opencrew', 'core', 'system.md'), systemContent);
+  ok('_opencrew/core/system.md refreshed');
+
+  const agentsBridge = '# opencrew\n\n'
+    + 'The opencrew system definition lives at `_opencrew/core/system.md`.\n'
+    + 'Read that file and adopt the opencrew system role — follow all initialization,\n'
+    + 'command routing, and workflow instructions defined there.\n\n'
+    + 'Type `/opencrew` to open the main menu.\n';
+
+  await writeBridgeFile(path.join(target, 'AGENTS.md'), agentsBridge);
+  ok('AGENTS.md refreshed');
+
+  await fs.writeFile(versionFile, version + '\n');
+  log(`\n${c.green(c.bold('Updated to v' + version))}.`);
+  log(c.dim('Your crews, memory, IDE bridges and .env were left untouched.\n'));
+}

package/src/lib/fsx.js

@@ -1,76 +1,127 @@
-// Filesystem helpers (no external deps).
-import { promises as fs } from 'node:fs';
-import path from 'node:path';
-
-export async function exists(p) {
-  try {
-    await fs.access(p);
-    return true;
-  } catch {
-    return false;
-  }
-}
-
-export async function ensureDir(p) {
-  await fs.mkdir(p, { recursive: true });
-}
-
-/**
- * Recursively copy `src` into `dest`.
- * @param {object} opts
- * @param {boolean} opts.overwrite  Overwrite existing files (default false).
- * @param {(rel:string)=>boolean} opts.skip  Return true to skip a relative path.
- * @param {(rel:string)=>void} opts.onCopy  Called for each file copied.
- */
-export async function copyDir(src, dest, opts = {}) {
-  const { overwrite = false, skip = () => false, onCopy, _root = src } = opts;
-  await ensureDir(dest);
-  const entries = await fs.readdir(src, { withFileTypes: true });
-  for (const entry of entries) {
-    const from = path.join(src, entry.name);
-    const to = path.join(dest, entry.name);
-    const rel = path.relative(_root, from).split(path.sep).join('/');
-    if (skip(rel)) continue;
-    if (entry.isDirectory()) {
-      await copyDir(from, to, { ...opts, _root });
-    } else {
-      const present = await exists(to);
-      if (present && !overwrite) continue;
-      await ensureDir(path.dirname(to));
-      await fs.copyFile(from, to);
-      if (onCopy) onCopy(rel);
-    }
-  }
-}
-
-export async function writeFileSafe(p, content, { overwrite = true } = {}) {
-  if (!overwrite && (await exists(p))) return false;
-  await ensureDir(path.dirname(p));
-  await fs.writeFile(p, content);
-  return true;
-}
-
-/**
- * Remove a directory and all its contents.
- * Does nothing silently if the path does not exist.
- * @param {string} p  Directory path to remove.
- * @returns {Promise<boolean>} true if something was deleted, false if it didn't exist.
- */
-export async function deleteDir(p) {
-  if (!(await exists(p))) return false;
-  try {
-    await fs.rm(p, { recursive: true, force: true });
-    return true;
-  } catch {
-    return false;
-  }
-}
-
-export async function readJson(p) {
-  try {
-    return JSON.parse(await fs.readFile(p, 'utf8'));
-  } catch (e) {
-    const reason = e.code === 'ENOENT' ? 'file not found' : e.message;
-    throw new Error(`Failed to read ${p}: ${reason}`);
-  }
-}
+// Filesystem helpers (no external deps).
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
+
+export async function exists(p) {
+  try {
+    await fs.access(p);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+export async function ensureDir(p) {
+  await fs.mkdir(p, { recursive: true });
+}
+
+/**
+ * Recursively copy `src` into `dest`.
+ * @param {object} opts
+ * @param {boolean} opts.overwrite  Overwrite existing files (default false).
+ * @param {(rel:string)=>boolean} opts.skip  Return true to skip a relative path.
+ * @param {(rel:string)=>void} opts.onCopy  Called for each file copied.
+ */
+export async function copyDir(src, dest, opts = {}) {
+  const { overwrite = false, skip = () => false, onCopy, _root = src } = opts;
+  await ensureDir(dest);
+  const entries = await fs.readdir(src, { withFileTypes: true });
+  for (const entry of entries) {
+    const from = path.join(src, entry.name);
+    const to = path.join(dest, entry.name);
+    const rel = path.relative(_root, from).split(path.sep).join('/');
+    if (skip(rel)) continue;
+    if (entry.isDirectory()) {
+      await copyDir(from, to, { ...opts, _root });
+    } else {
+      const present = await exists(to);
+      if (present && !overwrite) continue;
+      await ensureDir(path.dirname(to));
+      await fs.copyFile(from, to);
+      if (onCopy) onCopy(rel);
+    }
+  }
+}
+
+export async function writeFileSafe(p, content, { overwrite = true } = {}) {
+  if (!overwrite && (await exists(p))) return false;
+  await ensureDir(path.dirname(p));
+  await fs.writeFile(p, content);
+  return true;
+}
+
+/**
+ * Write a bridge file using marked-block strategy.
+ * - File doesn't exist → creates with content wrapped in HTML markers
+ * - File exists with markers → replaces only the block between markers
+ * - File exists without markers → prepends marked block, preserves existing content
+ *
+ * @param {string}   p       File path
+ * @param {string}   block   Content to place between markers
+ * @param {object}   opts
+ * @param {string}   opts.marker  Marker name (default: 'opencrew')
+ * @returns {Promise<{written: boolean, merged: boolean}>}
+ */
+export async function writeBridgeFile(p, block, { marker = 'opencrew' } = {}) {
+  const start = `<!-- ${marker}:start -->`;
+  const end = `<!-- ${marker}:end -->`;
+  const marked = `${start}\n${block.trimEnd()}\n${end}`;
+
+  if (!(await exists(p))) {
+    await ensureDir(path.dirname(p));
+    await fs.writeFile(p, marked + '\n');
+    return { written: true, merged: false };
+  }
+
+  const existing = await fs.readFile(p, 'utf8');
+
+  // Already has markers → replace just the block, keep everything else
+  if (existing.includes(start) && existing.includes(end)) {
+    const updated = existing.replace(
+      new RegExp(escapeRx(start) + '[\\s\\S]*?' + escapeRx(end), 'g'),
+      marked,
+    );
+    if (updated !== existing) {
+      await fs.writeFile(p, updated);
+      return { written: true, merged: false };
+    }
+    return { written: false, merged: false };
+  }
+
+  // User content exists → prepend block, preserve everything
+  await fs.writeFile(p, marked + '\n\n' + existing.trimStart());
+  return { written: true, merged: true };
+}
+
+function escapeRx(s) {
+  return s.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+export async function readFile(p) {
+  return fs.readFile(p, 'utf8');
+}
+
+/**
+ * Remove a directory and all its contents.
+ * Does nothing silently if the path does not exist.
+ * @param {string} p  Directory path to remove.
+ * @returns {Promise<boolean>} true if something was deleted, false if it didn't exist.
+ */
+export async function deleteDir(p) {
+  if (!(await exists(p))) return false;
+  try {
+    await fs.rm(p, { recursive: true, force: true });
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+export async function readJson(p) {
+  try {
+    return JSON.parse(await fs.readFile(p, 'utf8'));
+  } catch (e) {
+    const reason = e.code === 'ENOENT' ? 'file not found' : e.message;
+    throw new Error(`Failed to read ${p}: ${reason}`);
+  }
+}

package/templates/.mcp.json

@@ -1,9 +1,9 @@
-{
-  "_comment": "The Playwright MCP version is pinned for stability. To upgrade: npx @playwright/mcp@latest --version, then update the version below and run 'npx @aksp/opencrew update' to refresh.",
-  "mcpServers": {
-    "playwright": {
-      "command": "npx",
-      "args": ["@playwright/mcp@0.0.78", "--config", "_opencrew/config/playwright.config.json"]
-    }
-  }
-}
+{
+  "_comment": "The Playwright MCP version is pinned for stability. To upgrade: npx @playwright/mcp@latest --version, then update the version below and run 'npx @aksp/opencrew update' to refresh.",
+  "mcpServers": {
+    "playwright": {
+      "command": "npx",
+      "args": ["@playwright/mcp@0.0.78", "--config", "_opencrew/config/playwright.config.json"]
+    }
+  }
+}