fix: skip postinstall/prepare scripts when installed as npm package#3
Open
simongdavies wants to merge 1 commit intohyperlight-dev:mainfrom
Open
fix: skip postinstall/prepare scripts when installed as npm package#3simongdavies wants to merge 1 commit intohyperlight-dev:mainfrom
simongdavies wants to merge 1 commit intohyperlight-dev:mainfrom
Conversation
The postinstall and prepare hooks reference scripts in scripts/ which are not included in the published npm package (files: ['dist/'] only). This caused 'npm install -g @hyperlight-dev/hyperagent' to fail with MODULE_NOT_FOUND. Use '[ ! -f script ] || command' pattern so hooks skip gracefully when scripts don't exist (published package) but still fail loudly when they do exist and error (dev context). Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adjust npm lifecycle hooks so global installs from the published package (which ships only dist/) don’t fail when scripts/* is absent, while preserving the existing behavior in a source/dev checkout.
Changes:
- Update
prepareto no-op whenscripts/build-modules.jsis not present. - Update
postinstallto no-op whenscripts/patch-vscode-jsonrpc.jsis not present, otherwise run the existing patch + runtime check.
Comment on lines
+28
to
+29
| "prepare": "[ ! -f scripts/build-modules.js ] || npm run build:modules", | ||
| "postinstall": "[ ! -f scripts/patch-vscode-jsonrpc.js ] || (node scripts/patch-vscode-jsonrpc.js && node scripts/check-native-runtime.js)" |
There was a problem hiding this comment.
The new prepare/postinstall guards use POSIX [ ... ] tests and subshell syntax, which will fail (or behave incorrectly) when npm runs scripts under cmd.exe on Windows. If Windows installs are expected now or in the future, consider switching to a Node-based existence check (e.g., a tiny JS entrypoint in dist/ that checks fs.existsSync(...) before running the real script) so the hooks are cross-platform while still skipping cleanly in the published tarball.
Suggested change
| "prepare": "[ ! -f scripts/build-modules.js ] || npm run build:modules", | |
| "postinstall": "[ ! -f scripts/patch-vscode-jsonrpc.js ] || (node scripts/patch-vscode-jsonrpc.js && node scripts/check-native-runtime.js)" | |
| "prepare": "node -e \"const fs = require('fs'); const { spawnSync } = require('child_process'); if (!fs.existsSync('scripts/build-modules.js')) process.exit(0); const npmCmd = process.platform === 'win32' ? 'npm.cmd' : 'npm'; const result = spawnSync(npmCmd, ['run', 'build:modules'], { stdio: 'inherit' }); process.exit(result.status == null ? 0 : result.status);\"", | |
| "postinstall": "node -e \"const fs = require('fs'); const { spawnSync } = require('child_process'); if (!fs.existsSync('scripts/patch-vscode-jsonrpc.js')) process.exit(0); const nodePath = process.execPath; let r = spawnSync(nodePath, ['scripts/patch-vscode-jsonrpc.js'], { stdio: 'inherit' }); if (r.status) process.exit(r.status); r = spawnSync(nodePath, ['scripts/check-native-runtime.js'], { stdio: 'inherit' }); process.exit(r.status == null ? 0 : r.status);\"" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The postinstall and prepare hooks reference scripts in scripts/ which are not included in the published npm package (files: ['dist/'] only). This caused 'npm install -g @hyperlight-dev/hyperagent' to fail with MODULE_NOT_FOUND.
Use '[ ! -f script ] || command' pattern so hooks skip gracefully when scripts don't exist (published package) but still fail loudly when they do exist and error (dev context).