Conversation

nlf

arborist normalizes bundledDependencies to bundleDependencies, this change corrects the documentation to match that reality

closes #5167

arborist normalizes `bundledDependencies` to `bundleDependencies`, this change corrects the documentation to match that reality
@nlfnlf requested a review from a team as a code owner July 14, 2022 16:09
@ljharb

seems strange to me; "bundled dependencies" is what they are, they're not "dependencies for a bundle"

@nlf

if you consider the package that is bundling the dependencies to be a "bundle" then they are bundle dependencies.

the main reason for correcting docs here is that arborist has been normalizing it the other way for a very long time, which means a whole lot of the packuments in the registry have been changed to bundleDependencies. changing it back to bundledDependencies is certainly possible, but making docs match reality is always the lowest risk approach to these things

@ljharb

I agree this change makes the most sense, but I think arborist chose the wrong normalization.

@fritzyfritzy merged commit 8ab5fca into latest Jul 20, 2022
@fritzyfritzy deleted the nlf/bundle-deps-docs branch July 20, 2022 18:33
@fritzyfritzy mentioned this pull request Jul 20, 2022
mbtools added a commit to mbtools/schemastore that referenced this pull request Jun 11, 2024
`arborist` normalizes `bundledDependencies` to `bundleDependencies`. The same is documented by [npm](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bundledependencies). This change corrects the description of the preferred value to match that reality. 

Ref npm/cli#5171
Sign up for free to join this conversation on . Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

[DOCS] Improve BundleDependencies