@univerkit/verso 1.0.0-alpha.0 → 1.0.0-alpha.1

package/README.md

@@ -0,0 +1,83 @@
+# @univerkit/verso
+
+Verso is a focused release CLI for JavaScript workspaces that publish multiple
+packages at the same version. It updates package manifests, writes an
+Angular-style changelog, creates a release commit and tag, and pushes with
+`git push --follow-tags`.
+
+This npm package is the JavaScript wrapper for the native Verso binary. The
+matching binary is installed through an optional platform package such as
+`@univerkit/verso-darwin-arm64`, `@univerkit/verso-linux-x64`, or
+`@univerkit/verso-win32-x64`.
+
+## Supported Platforms
+
+| Platform | CPU | Package |
+| --- | --- | --- |
+| macOS | arm64 | `@univerkit/verso-darwin-arm64` |
+| macOS | x64 | `@univerkit/verso-darwin-x64` |
+| Linux | arm64 | `@univerkit/verso-linux-arm64` |
+| Linux | x64 | `@univerkit/verso-linux-x64` |
+| Windows | x64 | `@univerkit/verso-win32-x64` |
+
+## Installation
+
+Requires Node.js 22.18.0 or newer.
+
+```sh
+pnpm add -D @univerkit/verso
+```
+
+Add a release script:
+
+```json
+{
+  "scripts": {
+    "release": "verso"
+  }
+}
+```
+
+Create `verso.toml` in the project root:
+
+```toml
+[workspaces]
+patterns = ["packages/*"]
+```
+
+Then run:
+
+```sh
+pnpm release
+pnpm release -- --dry-run
+pnpm release -- --version 1.2.3 --yes
+pnpm release -- -V
+```
+
+## Troubleshooting
+
+If running `verso` prints `Could not find Verso platform binary`, the native
+optional dependency for your operating system was not installed or is not
+available for your platform.
+
+Check these first:
+
+- install `@univerkit/verso`, not a platform package directly
+- make sure optional dependencies are enabled in your package manager
+- confirm your machine is one of the supported platform and CPU pairs above
+- reinstall from a fresh lockfile if the lockfile was created on a different
+  operating system or with optional dependencies disabled
+
+If running `verso` prints `Failed to launch Verso binary`, the platform package
+was found but the native executable could not be started. On macOS and Linux,
+the wrapper repairs missing executable bits before spawning the native binary.
+Upgrade `@univerkit/verso`, reinstall dependencies, and include the error's
+cause line in bug reports if the failure continues.
+
+An unsupported platform needs a new native package before the wrapper can run.
+For bug reports, include the output of `pnpm release -- -V`. The wrapper handles
+that command before loading the native binary, so it still works when the
+platform optional dependency is missing.
+
+See the repository README for the full configuration reference and release
+workflow details: https://github.com/dream-num/verso

package/dist/bin.js

@@ -1,5 +1,6 @@
 import { spawnSync } from 'node:child_process';
 import { createRequire } from 'node:module';
+import { ensureExecutable, formatLaunchError, isToolVersionRequest, normalizeCliArgs, } from './launcher.js';
 import { resolvePlatformBinary } from './resolve.js';
 const require = createRequire(import.meta.url);
 function resolveInstalledBinaryPath({ packageName, binaryName }) {
@@ -11,16 +12,27 @@ function resolveInstalledBinaryPath({ packageName, binaryName }) {
             `The optional dependency ${packageName} may not be installed for this platform.`, { cause });
     }
 }
+function wrapperVersion() {
+    const manifest = require('../package.json');
+    if (typeof manifest.version !== 'string') {
+        throw new Error('Could not read @univerkit/verso package version.');
+    }
+    return manifest.version;
+}
 function main() {
+    const args = process.argv.slice(2);
+    if (isToolVersionRequest(args)) {
+        console.log(wrapperVersion());
+        process.exit(0);
+    }
     const platformBinary = resolvePlatformBinary();
     const binaryPath = resolveInstalledBinaryPath(platformBinary);
-    const result = spawnSync(binaryPath, process.argv.slice(2), {
+    ensureExecutable(binaryPath);
+    const result = spawnSync(binaryPath, normalizeCliArgs(args), {
         stdio: 'inherit',
     });
     if (result.error !== undefined) {
-        throw new Error(`Failed to launch Verso binary at ${binaryPath}.`, {
-            cause: result.error,
-        });
+        throw new Error(formatLaunchError(binaryPath, result.error));
     }
     if (result.signal !== null) {
         process.kill(process.pid, result.signal);
@@ -33,5 +45,8 @@ try {
 catch (error) {
     const message = error instanceof Error ? error.message : String(error);
     console.error(message);
+    if (error instanceof Error && error.cause instanceof Error) {
+        console.error(error.cause.message);
+    }
     process.exit(1);
 }

package/dist/launcher.d.ts

@@ -0,0 +1,6 @@
+export declare function normalizeCliArgs(args: string[]): string[];
+export declare function isToolVersionRequest(args: string[]): boolean;
+export declare function hasExecutableBit(mode: number): boolean;
+export declare function ensureExecutable(binaryPath: string, platform?: NodeJS.Platform): void;
+export declare function formatLaunchError(binaryPath: string, error: Error): string;
+//# sourceMappingURL=launcher.d.ts.map

package/dist/launcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAEA,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAEzD;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAM5D;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEtD;AAED,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAM,CAAC,QAA2B,GAAG,IAAI,CAWvG;AAED,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,CAc1E"}

package/dist/launcher.js

@@ -0,0 +1,33 @@
+import { chmodSync, statSync } from 'node:fs';
+export function normalizeCliArgs(args) {
+    return args[0] === '--' ? args.slice(1) : args;
+}
+export function isToolVersionRequest(args) {
+    const normalizedArgs = normalizeCliArgs(args);
+    return (normalizedArgs.length === 1 &&
+        (normalizedArgs[0] === '-V' || normalizedArgs[0] === '--tool-version'));
+}
+export function hasExecutableBit(mode) {
+    return (mode & 0o111) !== 0;
+}
+export function ensureExecutable(binaryPath, platform = process.platform) {
+    if (platform === 'win32') {
+        return;
+    }
+    const mode = statSync(binaryPath).mode;
+    if (hasExecutableBit(mode)) {
+        return;
+    }
+    chmodSync(binaryPath, mode | 0o111);
+}
+export function formatLaunchError(binaryPath, error) {
+    const lines = [`Failed to launch Verso binary at ${binaryPath}.`];
+    const reason = error.message.trim();
+    if (reason.length > 0) {
+        lines.push(`Reason: ${reason}`);
+    }
+    if (error.code === 'EACCES') {
+        lines.push('The binary is not executable. Reinstall @univerkit/verso, then check that your package manager installs optional dependencies and preserves executable file modes.');
+    }
+    return lines.join('\n');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerkit/verso",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.1",
   "description": "A focused release CLI for JavaScript workspace packages.",
   "license": "MIT",
   "author": "DreamNum Co., Ltd. <developer@univer.ai>",
@@ -13,6 +13,9 @@
   "bugs": {
     "url": "https://github.com/dream-num/verso/issues"
   },
+  "engines": {
+    "node": ">=22.18.0"
+  },
   "keywords": [
     "release",
     "changelog",
@@ -37,12 +40,16 @@
     "package.json",
     "README.md"
   ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "optionalDependencies": {
-    "@univerkit/verso-darwin-arm64": "1.0.0-alpha.0",
-    "@univerkit/verso-darwin-x64": "1.0.0-alpha.0",
-    "@univerkit/verso-linux-arm64": "1.0.0-alpha.0",
-    "@univerkit/verso-linux-x64": "1.0.0-alpha.0",
-    "@univerkit/verso-win32-x64": "1.0.0-alpha.0"
+    "@univerkit/verso-darwin-arm64": "1.0.0-alpha.1",
+    "@univerkit/verso-darwin-x64": "1.0.0-alpha.1",
+    "@univerkit/verso-linux-x64": "1.0.0-alpha.1",
+    "@univerkit/verso-linux-arm64": "1.0.0-alpha.1",
+    "@univerkit/verso-win32-x64": "1.0.0-alpha.1"
   },
   "devDependencies": {
     "@types/node": "^26.0.0",