diff options
| author | Caleb Sacks <16855387+clabe45@users.noreply.github.com> | 2020-01-19 20:59:25 +0300 |
|---|---|---|
| committer | Michael Perrotte <mike@npmjs.com> | 2020-01-23 22:33:54 +0300 |
| commit | b1aeeb67f464769fad6e2d1449fdddf2a874e249 (patch) | |
| tree | 83b5f568cdfc1728f6128b4519cbc0c2dfae2f40 /docs | |
| parent | 88cfb889383b8f139aa16812fb787287364bbaee (diff) | |
docs: mention --no-optional in package-json
PR-URL: https://github.com/npm/cli/pull/705
Credit: @clabe45
Close: #705
Reviewed-by: @mikemimik
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/configuring-npm/package-json.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/content/configuring-npm/package-json.md b/docs/content/configuring-npm/package-json.md index b7759f482..ccdbe041f 100644 --- a/docs/content/configuring-npm/package-json.md +++ b/docs/content/configuring-npm/package-json.md @@ -740,7 +740,8 @@ If a dependency can be used, but you would like npm to proceed if it cannot be found or fails to install, then you may put it in the `optionalDependencies` object. This is a map of package name to version or url, just like the `dependencies` object. The difference is that build failures do not cause -installation to fail. +installation to fail. Running `npm install --no-optional` will prevent these +dependencies from being installed. It is still your program's responsibility to handle the lack of the dependency. For example, something like this: |