Skip to content

Commit

Permalink
docs: mention --no-optional in package-json
Browse files Browse the repository at this point in the history
PR-URL: #705
Credit: @clabe45
Close: #705
Reviewed-by: @mikemimik
  • Loading branch information
clabe45 authored and Michael Perrotte committed Jan 23, 2020
1 parent 88cfb88 commit b1aeeb6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/content/configuring-npm/package-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit b1aeeb6

Please sign in to comment.