cannwork-rehearsal 0.2.1 → 0.3.1

package/README.md

@@ -41,6 +41,16 @@ Notes:
   ```
 - `cannwork-rehearsal` is the **trial-period release name**: it is published and installable on purpose so real users can try it while the official `@zhoufangchaojs/cannwork` name is not released yet. It will be retired (unpublished/deprecated) once the official name is published.
 
+### Automatic update check
+
+When you run `cannwork` in an interactive terminal, the launcher asks the npm registry whether a newer version exists. If one does, it prompts before the TUI starts:
+
+- `[1] 更新` — runs `npm install -g <package>@latest` in place, then asks you to run `cannwork` again
+- `[2] 跳过` — skips this time only; the same version will be offered again next launch
+- `[3] 跳过此版本` — remembers this version and stops prompting for it (a newer version still prompts)
+
+The check is skipped entirely for `cannwork -v` / `cannwork --version`, on non-interactive terminals (stdin or stdout not a TTY), or when `CANNWORK_NO_UPDATE_CHECK=1` is set. Network failures never block startup — the launcher simply continues with the installed version.
+
 ## Getting Started (from source)
 
 Install dependencies:
@@ -77,7 +87,7 @@ Releases are published manually to <https://registry.npmjs.org/> in two phases:
 
 ### Phase 1 — unscoped trial release (kept live)
 
-1. Set `name` to `cannwork-rehearsal` and `version` to `0.2.0` in the root `package.json` (single source of truth).
+1. Set `name` to `cannwork-rehearsal` and `version` to `0.3.0` in the root `package.json` (single source of truth).
 2. `npm login` (any account with publish rights).
 3. `bun run release` — runs typecheck + tests, cross-compiles, then publishes the 5 platform packages followed by the main package. Add `--dry-run` to pack and verify without uploading.
 4. Check each package on the registry (`npm view <pkg> version`). A `0.0.0-stage` value means npm staged the version for review; wait for it to go live (or approve it on npmjs.com) before smoke-testing.
@@ -99,7 +109,8 @@ Rollback: `npm unpublish` the affected version within the allowed window; afterw
 
 ```
 ├── bin/
-│   └── cannwork.js # Node-compatible launcher shipped in the npm main package
+│   ├── cannwork.js     # Node-compatible launcher shipped in the npm main package
+│   └── update-check.js # Pre-launch version check, prompt and global install
 ├── scripts/        # cross-platform build and publish tooling
 ├── src/
 │   └── index.tsx   # App entry, renders the TUI with @opentui/react

package/bin/cannwork.js

@@ -4,6 +4,16 @@ import { spawn } from "node:child_process";
 import { accessSync, chmodSync, constants, realpathSync } from "node:fs";
 import { resolve } from "node:path";
 import { fileURLToPath } from "node:url";
+import {
+  askUpdateChoice,
+  checkForUpdate,
+  DISABLE_UPDATE_CHECK_ENV,
+  formatUpdateNotice,
+  manualInstallCommand,
+  readSkippedVersion,
+  runGlobalInstall,
+  writeSkippedVersion,
+} from "./update-check.js";
 
 export const SUPPORTED_TARGETS = Object.freeze([
   "win32-x64",
@@ -82,32 +92,75 @@ export function spawnBinary(binaryPath, args) {
   });
 }
 
-export async function run(argv = process.argv.slice(2)) {
+export async function run(argv = process.argv.slice(2), options = {}) {
   const { platform: os, arch } = process;
+  const stdin = options.stdin ?? process.stdin;
+  const stdout = options.stdout ?? process.stdout;
+  const stderr = options.stderr ?? process.stderr;
+  const env = options.env ?? process.env;
 
   const requireFromHere = createRequire(import.meta.url);
   let manifest;
   try {
     manifest = requireFromHere("../package.json");
   } catch {
-    process.stderr.write("cannwork: 无法读取自身包清单，安装可能已损坏。\n");
+    stderr.write("cannwork: 无法读取自身包清单，安装可能已损坏。\n");
     return 1;
   }
   const mainName = manifest.name;
 
   if (argv.includes("-v") || argv.includes("--version")) {
-    process.stdout.write(`${manifest.version}\n`);
+    stdout.write(`${manifest.version}\n`);
     return 0;
   }
 
-  const binaryPath = resolveBinaryPath(mainName, os, arch, requireFromHere);
+  const interactive = stdin.isTTY === true && stdout.isTTY === true;
+  if (!options.skipUpdateCheck && interactive && env[DISABLE_UPDATE_CHECK_ENV] !== "1") {
+    try {
+      const result = await checkForUpdate({
+        name: mainName,
+        localVersion: manifest.version,
+        manifest,
+        fetchImpl: options.fetchImpl,
+        timeoutMs: options.timeoutMs,
+      });
+      if (result.updateAvailable) {
+        const stateDir = options.stateDir;
+        if (readSkippedVersion(stateDir) !== result.latestVersion) {
+          const notice = formatUpdateNotice({
+            name: mainName,
+            current: manifest.version,
+            latest: result.latestVersion,
+          });
+          const ask = options.askChoice ?? askUpdateChoice;
+          const choice = await ask({ notice, stdin, stdout });
+          if (choice === "update") {
+            const install = options.installGlobal ?? runGlobalInstall;
+            if (install(mainName)) {
+              stdout.write(`\n已更新到 ${result.latestVersion}，请重新执行 cannwork。\n`);
+              return 0;
+            }
+            stderr.write(`\n更新失败。请手动执行：${manualInstallCommand(mainName)}\n\n`);
+          } else if (choice === "skip-version") {
+            writeSkippedVersion(result.latestVersion, stateDir);
+          }
+        }
+      }
+    } catch {
+      // 升级检查是可选增强：任何异常都静默放行，绝不阻断启动
+    }
+  }
+
+  const resolveBinary = options.resolveBinary ?? resolveBinaryPath;
+  const binaryPath = resolveBinary(mainName, os, arch, requireFromHere);
   if (binaryPath === null) {
-    process.stderr.write(missingPackageMessage(mainName, os, arch));
+    stderr.write(missingPackageMessage(mainName, os, arch));
     return 1;
   }
 
   ensureExecutable(binaryPath, os);
-  return await spawnBinary(binaryPath, argv);
+  const spawnChild = options.spawnBinary ?? spawnBinary;
+  return await spawnChild(binaryPath, argv);
 }
 
 export const ENTRYPOINT_UNDETERMINED_MESSAGE =

package/bin/update-check.js

@@ -0,0 +1,206 @@
+import { spawnSync } from "node:child_process";
+import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { homedir } from "node:os";
+import { join } from "node:path";
+
+export const DEFAULT_REGISTRY = "https://registry.npmjs.org/";
+export const UPDATE_CHECK_TIMEOUT_MS = 1500;
+export const DISABLE_UPDATE_CHECK_ENV = "CANNWORK_NO_UPDATE_CHECK";
+export const SKIP_FILE_NAME = "upgrade.json";
+
+const VERSION_PATTERN = /^v?(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z.-]+))?(?:\+[0-9A-Za-z.-]+)?$/u;
+
+export function parseVersion(raw) {
+  if (typeof raw !== "string") return null;
+  const match = VERSION_PATTERN.exec(raw.trim());
+  if (match === null) return null;
+  return {
+    major: Number(match[1]),
+    minor: Number(match[2]),
+    patch: Number(match[3]),
+    prerelease: match[4] ?? null,
+  };
+}
+
+function comparePrerelease(left, right) {
+  const leftIds = left.split(".");
+  const rightIds = right.split(".");
+  const length = Math.min(leftIds.length, rightIds.length);
+  for (let index = 0; index < length; index += 1) {
+    const leftId = leftIds[index] ?? "";
+    const rightId = rightIds[index] ?? "";
+    const leftNumeric = /^\d+$/u.test(leftId);
+    const rightNumeric = /^\d+$/u.test(rightId);
+    if (leftNumeric && rightNumeric) {
+      const diff = Number(leftId) - Number(rightId);
+      if (diff !== 0) return diff > 0 ? 1 : -1;
+      continue;
+    }
+    if (leftNumeric) return -1;
+    if (rightNumeric) return 1;
+    if (leftId !== rightId) return leftId < rightId ? -1 : 1;
+  }
+  if (leftIds.length === rightIds.length) return 0;
+  return leftIds.length < rightIds.length ? -1 : 1;
+}
+
+export function compareVersions(left, right) {
+  const a = parseVersion(left);
+  const b = parseVersion(right);
+  if (a === null || b === null) return null;
+  for (const key of ["major", "minor", "patch"]) {
+    if (a[key] !== b[key]) return a[key] > b[key] ? 1 : -1;
+  }
+  if (a.prerelease === null && b.prerelease === null) return 0;
+  if (a.prerelease === null) return 1;
+  if (b.prerelease === null) return -1;
+  return comparePrerelease(a.prerelease, b.prerelease);
+}
+
+export function isUpdateAvailable(localVersion, latestVersion) {
+  return compareVersions(latestVersion, localVersion) === 1;
+}
+
+export function resolveRegistry(manifest) {
+  const configured = manifest?.publishConfig?.registry;
+  return typeof configured === "string" && configured.trim().length > 0
+    ? configured.trim()
+    : DEFAULT_REGISTRY;
+}
+
+export function encodePackageName(name) {
+  return encodeURI(name).replace(/\//gu, "%2F");
+}
+
+export function packageLatestUrl(name, registry = DEFAULT_REGISTRY) {
+  const base =
+    typeof registry === "string" && registry.trim().length > 0 ? registry.trim() : DEFAULT_REGISTRY;
+  const withSlash = base.endsWith("/") ? base : `${base}/`;
+  return `${withSlash}${encodePackageName(name)}/latest`;
+}
+
+export async function fetchLatestVersion(name, options = {}) {
+  const {
+    registry = DEFAULT_REGISTRY,
+    timeoutMs = UPDATE_CHECK_TIMEOUT_MS,
+    fetchImpl = globalThis.fetch,
+  } = options;
+  if (typeof fetchImpl !== "function" || typeof name !== "string" || name.length === 0) {
+    return null;
+  }
+  const controller = new AbortController();
+  const timer = setTimeout(() => controller.abort(), Math.max(1, Number(timeoutMs) || 1));
+  try {
+    const response = await fetchImpl(packageLatestUrl(name, registry), {
+      headers: { Accept: "application/json" },
+      signal: controller.signal,
+    });
+    if (response === null || typeof response !== "object" || response.ok !== true) return null;
+    const body = await response.json();
+    const version = body?.version;
+    return typeof version === "string" && version.trim().length > 0 ? version.trim() : null;
+  } catch {
+    return null;
+  } finally {
+    clearTimeout(timer);
+  }
+}
+
+export async function checkForUpdate(options = {}) {
+  const {
+    name,
+    localVersion,
+    manifest,
+    fetchImpl,
+    timeoutMs = UPDATE_CHECK_TIMEOUT_MS,
+  } = options;
+  const latestVersion = await fetchLatestVersion(name, {
+    registry: resolveRegistry(manifest),
+    timeoutMs,
+    fetchImpl,
+  });
+  return {
+    latestVersion,
+    updateAvailable: latestVersion !== null && isUpdateAvailable(localVersion, latestVersion),
+  };
+}
+
+export function upgradeStateDir() {
+  return join(homedir(), ".cannwork-tui");
+}
+
+export function upgradeStatePath(dir = upgradeStateDir()) {
+  return join(dir, SKIP_FILE_NAME);
+}
+
+export function readSkippedVersion(dir = upgradeStateDir()) {
+  try {
+    const parsed = JSON.parse(readFileSync(upgradeStatePath(dir), "utf8"));
+    const value = parsed?.skippedVersion;
+    return typeof value === "string" && value.trim().length > 0 ? value.trim() : null;
+  } catch {
+    return null;
+  }
+}
+
+export function writeSkippedVersion(version, dir = upgradeStateDir()) {
+  if (typeof version !== "string" || version.trim().length === 0) return false;
+  try {
+    mkdirSync(dir, { recursive: true });
+    writeFileSync(
+      upgradeStatePath(dir),
+      `${JSON.stringify({ skippedVersion: version.trim() }, null, 2)}\n`,
+      "utf8",
+    );
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+export function parseUpdateChoice(raw) {
+  const value = typeof raw === "string" ? raw.trim().toLowerCase() : "";
+  if (value === "1" || value === "u" || value === "y") return "update";
+  if (value === "3" || value === "v") return "skip-version";
+  return "skip";
+}
+
+export function formatUpdateNotice({ name, current, latest }) {
+  return [
+    `发现 cannwork 新版本：${current} -> ${latest}`,
+    `  [1] 更新（执行 npm install -g ${name}@latest）`,
+    "  [2] 跳过（仅本次）",
+    "  [3] 跳过此版本（不再提示该版本）",
+  ].join("\n");
+}
+
+export async function askUpdateChoice({ notice, stdin = process.stdin, stdout = process.stdout }) {
+  const readline = await import("node:readline/promises");
+  const rl = readline.createInterface({ input: stdin, output: stdout });
+  try {
+    const answer = await rl.question(`${notice}\n请选择 [1/2/3]: `);
+    return parseUpdateChoice(answer);
+  } catch {
+    return "skip";
+  } finally {
+    rl.close();
+  }
+}
+
+export function manualInstallCommand(name) {
+  return `npm install -g ${name}@latest`;
+}
+
+export function runGlobalInstall(name, options = {}) {
+  const { spawnImpl = spawnSync, platform = process.platform } = options;
+  if (typeof name !== "string" || name.trim().length === 0) return false;
+  try {
+    const result = spawnImpl("npm", ["install", "-g", `${name.trim()}@latest`], {
+      stdio: "inherit",
+      shell: platform === "win32",
+    });
+    return result?.status === 0;
+  } catch {
+    return false;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cannwork-rehearsal",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "type": "module",
   "bin": {
     "cannwork": "bin/cannwork.js"
@@ -10,11 +10,11 @@
     "README.md"
   ],
   "optionalDependencies": {
-    "cannwork-rehearsal-win32-x64": "0.2.1",
-    "cannwork-rehearsal-linux-x64": "0.2.1",
-    "cannwork-rehearsal-linux-arm64": "0.2.1",
-    "cannwork-rehearsal-darwin-x64": "0.2.1",
-    "cannwork-rehearsal-darwin-arm64": "0.2.1"
+    "cannwork-rehearsal-win32-x64": "0.3.1",
+    "cannwork-rehearsal-linux-x64": "0.3.1",
+    "cannwork-rehearsal-linux-arm64": "0.3.1",
+    "cannwork-rehearsal-darwin-x64": "0.3.1",
+    "cannwork-rehearsal-darwin-arm64": "0.3.1"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",