This repository has been archived by the owner on Jan 20, 2022. It is now read-only.
fix: package.json saving optional deps #221
Merged
Conversation
This file contains 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
ruyadorno
approved these changes
Feb 4, 2021
ruyadorno
added a commit
to ruyadorno/init-package-json
that referenced
this pull request
Feb 4, 2021
When saving over existing files that contains optionalDependencies it
should avoid also saving that dep to dependencies, respecting our docs
recommendation on it:
Entries in optionalDependencies will override entries of the same
name in dependencies, so it's usually best to only put in one place.
This patches this UX problem by adding an extra check that will avoid
adding a dependency to the package.json `dependencies` object in case
that package is already listed under `optionalDependencies`.
Relates to: npm/arborist#221
Fixes: npm/cli#724
ruyadorno
added a commit
to ruyadorno/init-package-json
that referenced
this pull request
Feb 4, 2021
When saving over existing files that contains optionalDependencies it
should avoid also saving that dep to dependencies, respecting our docs
recommendation on it:
Entries in optionalDependencies will override entries of the same
name in dependencies, so it's usually best to only put in one place.
This patches this UX problem by adding an extra check that will avoid
adding a dependency to the package.json `dependencies` object in case
that package is already listed under `optionalDependencies`.
Relates to: npm/arborist#221
Fixes: npm/cli#724
ruyadorno
added a commit
to ruyadorno/init-package-json
that referenced
this pull request
Feb 4, 2021
When saving over existing files that contains optionalDependencies it
should avoid also saving that dep to dependencies, respecting our docs
recommendation on it:
Entries in optionalDependencies will override entries of the same
name in dependencies, so it's usually best to only put in one place.
This patches this UX problem by adding an extra check that will avoid
adding a dependency to the package.json `dependencies` object in case
that package is already listed under `optionalDependencies`.
Relates to: npm/arborist#221
Fixes: npm/cli#724
PR-URL: npm#109
Credit: @ruyadorno
Close: npm#109
Reviewed-by: @nlf, @wraithgar
Reify currently duplicates entries listed as optionalDependencies in the
users' package.json files. While it's working as expected this is
unexpected to a number of users and it also contradicts our own docs on
it:
Entries in optionalDependencies will override entries of the same
name in dependencies, so it's usually best to only put in one place.
This patches this UX problem by adding an extra check that will avoid
adding a dependency to the package.json `dependencies` object in case
that package is already listed under `optionalDependencies`.
Fixes: npm/cli#2203
Fixes: npm/cli#1886
Fixes: npm/cli#724
EDIT(isaacs): Moved this into updateRootPackageJson in pairing session
PR-URL: #221
Credit: @isaacs
Close: #221
Reviewed-by: @ruyadorno
ruyadorno
force-pushed
the
isaacs-and-ruyadorno/do-not-repeat-optional-dependencies
branch
from
7624528
to
03d453c
Compare
isaacs
deleted the
isaacs-and-ruyadorno/do-not-repeat-optional-dependencies
branch
18 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Reify currently duplicates entries listed as optionalDependencies in the
users' package.json files. While it's working as expected this is
unexpected to a number of users and it also contradicts our own docs on
it:
This patches this UX problem by adding an extra check that will avoid
adding a dependency to the package.json
dependenciesobject in casethat package is already listed under
optionalDependencies.Fixes: npm/cli#2203
Fixes: npm/cli#1886
Fixes: npm/cli#724
EDIT(isaacs): Moved this into updateRootPackageJson in pairing session
Alternative approach for #219
References