Files
zero/bin/zero.js
Abdias J b5a78dca6f docs(install): document Bun install and improve missing-binary error (#418)
Bun does not run dependency lifecycle scripts by default, so the npm
wrapper's postinstall (which fetches the native Zero binary from GitHub
Releases) is silently skipped. The first run then fails with an
unhelpful "No native binary found" message that points at a source-only
build command, leaving Bun users stuck.

Add a Bun section to README.md and docs/INSTALL.md with the two working
install paths (run postinstall.mjs manually, or add the package to the
project's trustedDependencies). Rewrite the wrapper's missing-binary
error to give an actionable fix for everyone and a Bun-specific hint
when run under Bun, instead of only suggesting a source checkout.
2026-07-03 07:38:25 +08:00

103 lines
3.1 KiB
JavaScript
Executable File

#!/usr/bin/env node
import { spawnSync } from 'node:child_process';
import { existsSync } from 'node:fs';
import { dirname, join } from 'node:path';
import { fileURLToPath } from 'node:url';
function zeroBinaryName(platform = process.platform) {
return platform === 'win32' ? 'zero.exe' : 'zero';
}
function helperShimNames(name, platform = process.platform) {
if (platform === 'win32') {
return [`${name}.cmd`, `${name}.exe`, name];
}
return [name];
}
function commandForShim(path, platform = process.platform) {
if (platform === 'win32' && path.toLowerCase().endsWith('.cmd')) {
return {
command: process.env.ComSpec || 'cmd.exe',
prefixArgs: ['/d', '/s', '/c', `"${path.replace(/"/g, '""')}"`],
};
}
return { command: path, prefixArgs: [] };
}
function resolveHelper(packageRoot, name) {
const binDir = join(packageRoot, 'node_modules', '.bin');
for (const shimName of helperShimNames(name)) {
const candidate = join(binDir, shimName);
if (!existsSync(candidate)) continue;
return {
...commandForShim(candidate),
pathPrepend: [binDir],
};
}
return null;
}
function localControlHelperManifest(packageRoot) {
const helpers = {};
for (const name of ['agent-browser', 'tuistory']) {
const helper = resolveHelper(packageRoot, name);
if (helper) helpers[name] = helper;
}
if (Object.keys(helpers).length === 0) return '';
return JSON.stringify({ version: 1, helpers });
}
const packageRoot = dirname(dirname(fileURLToPath(import.meta.url)));
const nativePath = join(packageRoot, zeroBinaryName());
const localControlHelpers = localControlHelperManifest(packageRoot);
if (!existsSync(nativePath)) {
const postinstallScript = join(packageRoot, 'scripts', 'postinstall.mjs');
const ranByBun = process.execPath.includes('bun') || !!process.versions?.bun;
console.error(
'[zero] No native binary found next to the npm wrapper.\n' +
'The platform binary is fetched at install time by a postinstall script,\n' +
'which did not run (or was skipped) for this install.\n' +
'\n' +
'Fix it now by running the installer manually:\n' +
` node "${postinstallScript}"\n` +
'\n' +
(ranByBun
? 'You installed with Bun, which does not run dependency lifecycle scripts\n' +
'by default. To let it run on future installs, add zero to your\n' +
'project\'s trustedDependencies:\n' +
' "trustedDependencies": ["@gitlawb/zero"]\n' +
'then reinstall.\n' +
'\n'
: '') +
'If that fails, build from source: https://github.com/Gitlawb/zero\n' +
'(go run ./cmd/zero, requires Go 1.25+).',
);
process.exit(1);
}
const env = { ...process.env };
if (localControlHelpers) {
env.ZERO_LOCAL_CONTROL_HELPERS = localControlHelpers;
} else {
delete env.ZERO_LOCAL_CONTROL_HELPERS;
}
const child = spawnSync(nativePath, process.argv.slice(2), {
stdio: 'inherit',
env,
});
if (child.error) {
console.error(`[zero] Failed to launch wrapper target: ${child.error.message}`);
process.exit(1);
}
if (child.signal) {
process.kill(process.pid, child.signal);
}
process.exit(child.status ?? 1);