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:
authorWassim Chegham <1699357+manekinekko@users.noreply.github.com>2022-02-17 01:53:50 +0300
committerGitHub <noreply@github.com>2022-02-17 01:53:50 +0300
commit20c83fae76ff4a051e4f6542a328f1c00cf071bb (patch)
treeb88df7d91de9c2367fcc4d4d30b05463bc2f98e6 /docs
parent20a981890ba96d946036419f0ac124fe598663b7 (diff)
docs: update docs for npm install <folder> (#4428)
npm install <folder> doesn't install dependencies if <folder> is outside of root project. Fixes #3358
Diffstat (limited to 'docs')
-rw-r--r--docs/content/commands/npm-install.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/docs/content/commands/npm-install.md b/docs/content/commands/npm-install.md
index 83b9af1e4..b4f8da837 100644
--- a/docs/content/commands/npm-install.md
+++ b/docs/content/commands/npm-install.md
@@ -78,11 +78,20 @@ into a tarball (b).
* `npm install <folder>`:
- Install the package in the directory as a symlink in the current
- project. Its dependencies will be installed before it's linked. If
- `<folder>` sits inside the root of your project, its dependencies may
+ If `<folder>` sits inside the root of your project, its dependencies will be installed and may
be hoisted to the top-level `node_modules` as they would for other
- types of dependencies.
+ types of dependencies. If `<folder>` sits outside the root of your project,
+ *npm will not install the package dependencies* in the directory `<folder>`,
+ but it will create a symlink to `<folder>`.
+
+ > NOTE: If you want to install the content of a directory like a package from the registry instead of creating a link, you would need to use [`npm pack`](/commands/npm-pack) while in the `<folder>` directory, and then install the resulting tarball instead of the `<folder>` using `npm install <tarball file>`
+
+ Example:
+
+ ```bash
+ npm install ../../other-package
+ npm install ./sub-package
+ ```
* `npm install <tarball file>`: