Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authornlf <quitlahok@gmail.com>2022-07-20 21:33:25 +0300
committerGitHub <noreply@github.com>2022-07-20 21:33:25 +0300
commit8ab5fcabbf9317df096bc727c49a98cf87dda560 (patch)
treed8968f5f907932fc04ee4ec10aa2d2e5b5050491 /docs
parent2fa3271ba37a58767307cf0105424b3c0b4ba7fe (diff)
docs: correct bundledDependencies -> bundleDependencies (#5171)
arborist normalizes `bundledDependencies` to `bundleDependencies`, this change corrects the documentation to match that reality
Diffstat (limited to 'docs')
-rw-r--r--docs/content/configuring-npm/folders.md2
-rw-r--r--docs/content/configuring-npm/package-json.md10
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/content/configuring-npm/folders.md b/docs/content/configuring-npm/folders.md
index 218870765..5bab80ec1 100644
--- a/docs/content/configuring-npm/folders.md
+++ b/docs/content/configuring-npm/folders.md
@@ -202,7 +202,7 @@ For a graphical breakdown of what is installed where, use `npm ls`.
#### Publishing
Upon publishing, npm will look in the `node_modules` folder. If any of
-the items there are not in the `bundledDependencies` array, then they will
+the items there are not in the `bundleDependencies` array, then they will
not be included in the package tarball.
This allows a package maintainer to install all of their dependencies
diff --git a/docs/content/configuring-npm/package-json.md b/docs/content/configuring-npm/package-json.md
index 826f10ce8..f0315d60e 100644
--- a/docs/content/configuring-npm/package-json.md
+++ b/docs/content/configuring-npm/package-json.md
@@ -829,14 +829,14 @@ if the `soy-milk` package is not installed on the host. This allows you to
integrate and interact with a variety of host packages without requiring
all of them to be installed.
-### bundledDependencies
+### bundleDependencies
This defines an array of package names that will be bundled when publishing
the package.
In cases where you need to preserve npm packages locally or have them
available through a single file download, you can bundle the packages in a
-tarball file by specifying the package names in the `bundledDependencies`
+tarball file by specifying the package names in the `bundleDependencies`
array and executing `npm pack`.
For example:
@@ -847,7 +847,7 @@ If we define a package.json like this:
{
"name": "awesome-web-framework",
"version": "1.0.0",
- "bundledDependencies": [
+ "bundleDependencies": [
"renderized",
"super-streams"
]
@@ -860,9 +860,9 @@ can be installed in a new project by executing `npm install
awesome-web-framework-1.0.0.tgz`. Note that the package names do not
include any versions, as that information is specified in `dependencies`.
-If this is spelled `"bundleDependencies"`, then that is also honored.
+If this is spelled `"bundledDependencies"`, then that is also honored.
-Alternatively, `"bundledDependencies"` can be defined as a boolean value. A
+Alternatively, `"bundleDependencies"` can be defined as a boolean value. A
value of `true` will bundle all dependencies, a value of `false` will bundle
none.