Skip to content

Commit f5857e2

Browse files
john-osullivanisaacs
authored andcommitted
Clarify usage of bundledDependencies
I spent a couple hours debugging the fact that package names in that key aren't supposed to include their versions! Assumed that it would need to have the same syntax as when running `npm install`. Thought this would be a good contribution for future readers.
1 parent 8d4effb commit f5857e2

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/files/package.json.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -648,7 +648,8 @@ If we define a package.json like this:
648648
we can obtain `awesome-web-framework-1.0.0.tgz` file by running `npm pack`.
649649
This file contains the dependencies `renderized` and `super-streams` which
650650
can be installed in a new project by executing `npm install
651-
awesome-web-framework-1.0.0.tgz`.
651+
awesome-web-framework-1.0.0.tgz`. Note that the package names do not include
652+
any versions, as that information is specified in `dependencies`.
652653

653654
If this is spelled `"bundleDependencies"`, then that is also honored.
654655

0 commit comments

Comments
 (0)