Skip to content

Commit

Permalink
docs: update docs for npm install <folder> (#4428)
Browse files Browse the repository at this point in the history
npm install <folder> doesn't install dependencies if <folder> is outside of root project.

Fixes #3358
  • Loading branch information
manekinekko authored Feb 16, 2022
1 parent 20a9818 commit 20c83fa
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/content/commands/npm-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>`:

Expand Down

0 comments on commit 20c83fa

Please sign in to comment.