browser4-cli 4.12.2 → 4.12.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browser4-cli",
-  "version": "4.12.2",
+  "version": "4.12.3",
   "description": "Browser automation CLI for AI agents",
   "type": "module",
   "files": [
@@ -13,6 +13,8 @@
     "browser4": "bin/browser4-cli.js"
   },
   "scripts": {
+    "sync:readme": "node scripts/sync-readme.mjs sync",
+    "restore:readme": "node scripts/sync-readme.mjs restore",
     "version:sync": "node ../bin/version.mjs cli sync",
     "version": "npm run version:sync && git add browser4-cli/Cargo.toml browser4-cli/Cargo.lock",
     "build:native": "npm run version:sync && cargo build --release --manifest-path browser4-cli/Cargo.toml && node scripts/copy-native.js",
@@ -21,6 +23,8 @@
     "build:windows": "npm run version:sync && docker compose -f docker/docker-compose.yml run --rm build-windows",
     "build:all-platforms": "npm run version:sync && (npm run build:linux & npm run build:windows & wait)",
     "build:docker": "docker build -t browser4-builder -f docker/Dockerfile.build .",
+    "prepack": "npm run sync:readme",
+    "postpack": "npm run restore:readme",
     "publish:if-needed": "node scripts/publish-if-needed.js",
     "release": "npm run publish:if-needed",
     "postinstall": "node scripts/postinstall.js"

package/scripts/README.md

@@ -89,6 +89,7 @@ Runs a full CLI smoke test suitable for CI and local development:
 | `npm-publish-check.js` | Shared library: reads package metadata and compares local vs npm registry version |
 | `check-npm-publish-needed.js` | CLI wrapper: checks whether a publish is needed and prints the decision |
 | `publish-if-needed.js` | Publishes to npm only when the local version differs from the registry. Uses `--tag next` for prerelease versions (containing `-`). |
+| `sync-readme.mjs` | Temporarily copies the repository root `README.md` to `cli/README.md` for npm pack/publish, then restores the original CLI README in `postpack`. |
 | `postinstall.js` | npm `postinstall` hook: downloads the platform native binary after `npm install` |
 
 ### Version check
@@ -109,6 +110,23 @@ node scripts/publish-if-needed.js --dry-run   # print what would happen
 
 Optional env: `BROWSER4_CLI_NPM_REMOTE_VERSION` to override the remote version for testing.
 
+### README sync for npm package
+
+`cli/package.json` wires the README sync into npm packaging hooks:
+
+```shell
+npm run sync:readme       # copy root README.md over cli/README.md
+npm run restore:readme    # restore the original cli/README.md
+```
+
+During `npm pack` / `npm publish`, npm runs:
+
+1. `prepack` → `npm run sync:readme`
+2. package creation / publish
+3. `postpack` → `npm run restore:readme`
+
+This makes the npm package README match the repository root README without leaving the working tree permanently overwritten after publishing.
+
 ### Postinstall
 
 `postinstall.js` runs automatically after `npm install browser4-cli`. It detects the platform and downloads the matching native binary to `bin/`. On global installs, it also patches npm's bin shims to invoke the native binary directly.

package/scripts/sync-readme.mjs

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+import { copyFileSync, existsSync, unlinkSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const cliRootDir = resolve(__dirname, '..');
+const repoRootDir = resolve(cliRootDir, '..');
+const rootReadme = resolve(repoRootDir, 'README.md');
+const cliReadme = resolve(cliRootDir, 'README.md');
+const backupReadme = resolve(cliRootDir, '.README.prepack.backup.md');
+
+function syncReadme() {
+  if (!existsSync(backupReadme)) {
+    copyFileSync(cliReadme, backupReadme);
+  }
+  copyFileSync(rootReadme, cliReadme);
+  console.log(`Synced ${rootReadme} -> ${cliReadme}`);
+}
+
+function restoreReadme() {
+  if (!existsSync(backupReadme)) {
+    console.log(`No README backup found at ${backupReadme}; nothing to restore.`);
+    return;
+  }
+
+  copyFileSync(backupReadme, cliReadme);
+  unlinkSync(backupReadme);
+  console.log(`Restored ${cliReadme} from ${backupReadme}`);
+}
+
+const mode = process.argv[2] ?? 'sync';
+
+if (mode === 'sync') {
+  syncReadme();
+} else if (mode === 'restore') {
+  restoreReadme();
+} else {
+  console.error(`Unsupported mode: ${mode}. Use "sync" or "restore".`);
+  process.exit(1);
+}