Repository navigation
fix(build): strip devDependencies from published shrinkwrap #1783
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| #!/usr/bin/env node | ||
| // Remove dev-only packages from the shrinkwrap that ships in the published package. | ||
| // | ||
| // npm generates the lockfile from the package.json manifest, so `npm prune --omit=dev` | ||
| // does NOT strip dev entries from it — prune only touches node_modules, not the lockfile. | ||
| // A published npm-shrinkwrap.json therefore vendors dev-only packages, including | ||
| // platform-specific optionals (e.g. @esbuild/* pulled in via tsx). When a consumer's | ||
| // lockfile is generated with npm 11, npm can fold that subtree in and drop the | ||
| // "optional" flag, so `npm ci` then fails everywhere with EBADPLATFORM. See #1780, #1782. | ||
| // | ||
| // This enforces the invariant that the published shrinkwrap describes only the production | ||
| // tree a consumer installs: every package reachable solely through devDependencies is | ||
| // marked "dev": true, so removing those (plus the root devDependencies block) leaves | ||
| // production and prod-optional (devOptional) entries untouched. | ||
| // | ||
| // Usage: node build-tools/prune-shrinkwrap-dev.mjs [npm-shrinkwrap.json] | ||
| import { readFileSync, writeFileSync } from 'node:fs'; | ||
|
|
||
| const file = process.argv[2] ?? 'npm-shrinkwrap.json'; | ||
| const lock = JSON.parse(readFileSync(file, 'utf8')); | ||
|
|
||
| if (lock.lockfileVersion !== 3 || !lock.packages) { | ||
| throw new Error(`unsupported lockfileVersion ${lock.lockfileVersion}; expected 3 with a "packages" map`); | ||
| } | ||
|
|
||
| let removed = 0; | ||
| for (const key of Object.keys(lock.packages)) { | ||
| if (key === '') continue; // root manifest node | ||
| if (lock.packages[key].dev === true) { | ||
| delete lock.packages[key]; | ||
| removed++; | ||
| } | ||
| } | ||
| if (lock.packages['']?.devDependencies) delete lock.packages[''].devDependencies; | ||
|
|
||
| writeFileSync(file, JSON.stringify(lock, null, 2) + '\n'); | ||
| console.log(`Pruned ${removed} dev-only entries from ${file}`); | ||
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.
Uh oh!
There was an error while loading. Please reload this page.