fix: Add shebang to npm bundle for global installs #101
+123
−1
Conversation
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
The npm bundle was missing the Node.js shebang line, causing Unix shells to interpret JavaScript as shell commands when running globally installed CLI (e.g., `npm install -g sentry && sentry auth login`). - Add esbuild banner option to prepend `#!/usr/bin/env node` - Remove redundant shebang from source (now added by esbuild) - Add smoke tests to verify bundle executes correctly
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. Bug Fixes 🐛
🤖 This preview updates automatically when you update the PR. |
Codecov Results 📊✅ Patch coverage is 100.00%. Project has 1756 uncovered lines. Files with missing lines (24)
Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 66.66% 66.66% —%
==========================================
Files 45 45 —
Lines 5267 5267 —
Branches 0 0 —
==========================================
+ Hits 3511 3511 —
- Misses 1756 1756 —
- Partials 0 0 —Generated by Codecov Action |
Use --version instead of --help and don't require exit code 0 since the CLI may have config-related errors in test environments.
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.
Summary
Fixes a bug where the npm package failed to execute on Unix systems with:
The npm bundle (
dist/bin.cjs) was missing the#!/usr/bin/env nodeshebang line. When users installed the package globally and ransentry auth login, Unix shells tried to interpret the JavaScript code as shell commands.Changes
banneroption to prepend the Node.js shebang to the bundlesrc/bin.ts(was being duplicated in output)