fix: rename npm-shrinkwrap.json to package-lock.json - #1129
Open
MikeMcC399 wants to merge 1 commit into
Open
Conversation
npm 12 does not support npm-shrinkwrap.json semver-major change since npm install -g citgm will install dependencies according to the published package.json, ensuring consistency independent of npm version used. package-lock.json is only used for repo development and test. Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1129 +/- ##
=======================================
Coverage 96.20% 96.20%
=======================================
Files 29 29
Lines 2213 2213
=======================================
Hits 2129 2129
Misses 84 84 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
MikeMcC399
marked this pull request as ready for review
August 19, 2026 11:46
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.
npm-shrinkwrap.json#1117Situation
npm 12 drops
npm-shrinkwrap.jsonused in this repo as a published lockfile.The npm 12.0.0 changelog states:
npm installunder npm 12 installs dependencies according to theirSemVerrange specified inpackage.jsonand ignores the lower locked versions specified innpm-shrinkwrap.json.Change
To ensure that dependencies are consistently installed by downstream consumers of citgm, whichever version of npm is being used to execute the Installation instructions
npm install -g citgm, rename:npm-shrinkwrap.json to
package-lock.json.This should be considered a breaking change (semver-major) when the next release is cut.
Checklist
npm testpasses (for currently bundled versions of npm 10.x & 11.x)here