Skip to content

Commit 8ab5fca

Browse files
authored
docs: correct bundledDependencies -> bundleDependencies (#5171)
arborist normalizes `bundledDependencies` to `bundleDependencies`, this change corrects the documentation to match that reality
1 parent 2fa3271 commit 8ab5fca

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/content/configuring-npm/folders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ For a graphical breakdown of what is installed where, use `npm ls`.
202202
#### Publishing
203203
204204
Upon publishing, npm will look in the `node_modules` folder. If any of
205-
the items there are not in the `bundledDependencies` array, then they will
205+
the items there are not in the `bundleDependencies` array, then they will
206206
not be included in the package tarball.
207207
208208
This allows a package maintainer to install all of their dependencies

docs/content/configuring-npm/package-json.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -829,14 +829,14 @@ if the `soy-milk` package is not installed on the host. This allows you to
829829
integrate and interact with a variety of host packages without requiring
830830
all of them to be installed.
831831

832-
### bundledDependencies
832+
### bundleDependencies
833833

834834
This defines an array of package names that will be bundled when publishing
835835
the package.
836836

837837
In cases where you need to preserve npm packages locally or have them
838838
available through a single file download, you can bundle the packages in a
839-
tarball file by specifying the package names in the `bundledDependencies`
839+
tarball file by specifying the package names in the `bundleDependencies`
840840
array and executing `npm pack`.
841841

842842
For example:
@@ -847,7 +847,7 @@ If we define a package.json like this:
847847
{
848848
"name": "awesome-web-framework",
849849
"version": "1.0.0",
850-
"bundledDependencies": [
850+
"bundleDependencies": [
851851
"renderized",
852852
"super-streams"
853853
]
@@ -860,9 +860,9 @@ can be installed in a new project by executing `npm install
860860
awesome-web-framework-1.0.0.tgz`. Note that the package names do not
861861
include any versions, as that information is specified in `dependencies`.
862862

863-
If this is spelled `"bundleDependencies"`, then that is also honored.
863+
If this is spelled `"bundledDependencies"`, then that is also honored.
864864

865-
Alternatively, `"bundledDependencies"` can be defined as a boolean value. A
865+
Alternatively, `"bundleDependencies"` can be defined as a boolean value. A
866866
value of `true` will bundle all dependencies, a value of `false` will bundle
867867
none.
868868

0 commit comments

Comments
 (0)