docs: clarify version field can be omitted in package-lock #8790
+1
−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
owlstronaut
approved these changes
Dec 1, 2025
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 clarifies that the version field in package-lock.json dependency objects can be omitted in certain cases, specifically for peer dependencies and optional dependencies that are not installed.
Changes
Fixes
Closes #4796
Context
The current documentation states that dependency objects have a version field but doesn't mention that this field can be absent in some cases. Users encountering package-lock.json files with entries without a version field were confused because the documentation implied the field is always present. This change makes it clear that the version field may be omitted for peer/optional dependencies that are not installed.
Type of Change