docs(npm-install): explain package-lock.json behavior #8797
+10
−0
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
wraithgar
reviewed
Dec 1, 2025
|
|
||
| When you run `npm install` without arguments, npm verifies that `package.json` and `package-lock.json` are in sync: | ||
|
|
||
| * **If they match:** npm installs the exact versions specified in `package-lock.json`, ensuring reproducible builds across environments. This is similar to `npm ci` but also updates `package-lock.json` if needed. |
Member
There was a problem hiding this comment.
This seems to contradict itself, it does not install the exact versions in package-lock if the package-lock needs to be updated.
Contributor
Author
There was a problem hiding this comment.
Thanks for catching that! You're absolutely right - that was contradictory. I've updated the text to remove the confusing statement about updating package-lock.json from the "If they match" scenario, since that's already covered in the "If they don't match" case. The text now simply says npm "uses the versions specified in package-lock.json" without the contradictory language.
MaxBlack-dev
force-pushed
the
docs/4866-package-lock-behavior
branch
from
11a4332 to
610564a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR adds documentation explaining how
npm installbehaves with respect topackage.jsonandpackage-lock.json, a common source of confusion for npm users.Changes
npm installusespackage-lock.json" to thenpm installdocumentationpackage.jsonandpackage-lock.jsonare in sync: exact versions from lockfile are installedpackage.jsonwins andpackage-lock.jsonis updatedpackage.jsonis the source of truth for version ranges, whilepackage-lock.jsonlocks to specific versionsnpm cibehaviorContext
The npm install documentation previously didn't explain how it handles the interaction between
package.jsonandpackage-lock.json. Users were confused about when versions from the lockfile are used versus when they're updated. This PR incorporates the explanation from Kat Marchán that was referenced in the issue to provide clear guidance.Closes #4866