From de956405d8b72354f98579d00c6dd30ac3b9bddf Mon Sep 17 00:00:00 2001
From: Francis Gulotta <wizard@roborooter.com>
Date: Mon, 20 Aug 2018 15:28:15 -0700
Subject: [PATCH] docs: add --dry-run to install and pack (#41)

PR-URL: https://github.com/npm/cli/pull/41
Credit: @reconbot
Reviewed-By: @zkat
---
 doc/cli/npm-pack.md    |  5 ++++-
 doc/cli/npm-publish.md | 11 +++++++----
 lib/pack.js            |  2 +-
 lib/publish.js         |  2 +-
 4 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/doc/cli/npm-pack.md b/doc/cli/npm-pack.md
index f44f5e3620c2a..807663ac210fe 100644
--- a/doc/cli/npm-pack.md
+++ b/doc/cli/npm-pack.md
@@ -3,7 +3,7 @@ npm-pack(1) -- Create a tarball from a package
 
 ## SYNOPSIS
 
-    npm pack [[<@scope>/]<pkg>...]
+    npm pack [[<@scope>/]<pkg>...] [--dry-run]
 
 ## DESCRIPTION
 
@@ -18,6 +18,9 @@ overwritten the second time.
 
 If no arguments are supplied, then npm packs the current package folder.
 
+The `--dry-run` argument will do everything that pack usually does without
+actually packing anything. Reports on what would have gone into the tarball.
+
 ## SEE ALSO
 
 * npm-cache(1)
diff --git a/doc/cli/npm-publish.md b/doc/cli/npm-publish.md
index 7e173ec00aff2..a317ff45e1487 100644
--- a/doc/cli/npm-publish.md
+++ b/doc/cli/npm-publish.md
@@ -4,7 +4,7 @@ npm-publish(1) -- Publish a package
 
 ## SYNOPSIS
 
-    npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>] [--otp otpcode]
+    npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>] [--otp otpcode] [--dry-run]
 
     Publishes '.' if no argument supplied
     Sets tag 'latest' if no --tag specified
@@ -46,6 +46,10 @@ specifying a different default registry or using a `npm-scope(7)` in the name
   then you can provide a code from your authenticator with this. If you
   don't include this and you're running from a TTY then you'll be prompted.
 
+* `[--dry-run]`
+  Does everything publish would do except actually publishing to the registry.
+  Reports the details of what would have been published.
+
 Fails if the package name and version combination already exists in
 the specified registry.
 
@@ -57,9 +61,8 @@ As of `npm@5`, both a sha1sum and an integrity field with a sha512sum of the
 tarball will be submitted to the registry during publication. Subsequent
 installs will use the strongest supported algorithm to verify downloads.
 
-For a "dry run" that does everything except actually publishing to the
-registry, see `npm-pack(1)`, which figures out the files to be included and
-packs them into a tarball to be uploaded to the registry.
+Similar to `--dry-run` see `npm-pack(1)`, which figures out the files to be
+included and packs them into a tarball to be uploaded to the registry.
 
 ## SEE ALSO
 
diff --git a/lib/pack.js b/lib/pack.js
index 93c21ad55971c..974c3e08183d5 100644
--- a/lib/pack.js
+++ b/lib/pack.js
@@ -32,7 +32,7 @@ const tar = require('tar')
 const packlist = require('npm-packlist')
 const ssri = require('ssri')
 
-pack.usage = 'npm pack [[<@scope>/]<pkg>...]'
+pack.usage = 'npm pack [[<@scope>/]<pkg>...] [--dry-run]'
 
 // if it can be installed, it can be packed.
 pack.completion = install.completion
diff --git a/lib/publish.js b/lib/publish.js
index bff8e161b14b1..1ae87d7900fa1 100644
--- a/lib/publish.js
+++ b/lib/publish.js
@@ -20,7 +20,7 @@ const readUserInfo = require('./utils/read-user-info.js')
 const semver = require('semver')
 const statAsync = BB.promisify(require('graceful-fs').stat)
 
-publish.usage = 'npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>]' +
+publish.usage = 'npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>] [--dry-run]' +
                 "\n\nPublishes '.' if no argument supplied" +
                 '\n\nSets tag `latest` if no --tag specified'