From b1aeeb67f464769fad6e2d1449fdddf2a874e249 Mon Sep 17 00:00:00 2001
From: Caleb Sacks <16855387+clabe45@users.noreply.github.com>
Date: Sun, 19 Jan 2020 12:59:25 -0500
Subject: [PATCH] docs: mention --no-optional in package-json

PR-URL: https://github.com/npm/cli/pull/705
Credit: @clabe45
Close: #705
Reviewed-by: @mikemimik
---
 docs/content/configuring-npm/package-json.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/content/configuring-npm/package-json.md b/docs/content/configuring-npm/package-json.md
index b7759f482f914..ccdbe041fb063 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: