Skip to content

Commit

Permalink
docs: add --dry-run to npm install
Browse files Browse the repository at this point in the history
  • Loading branch information
reconbot committed Aug 8, 2018
1 parent 14bd214 commit a66d576
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
10 changes: 6 additions & 4 deletions doc/cli/npm-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -46,6 +46,9 @@ 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.

Fails if the package name and version combination already exists in
the specified registry.

Expand All @@ -57,9 +60,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

Expand Down
2 changes: 1 addition & 1 deletion lib/publish.js
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand Down

0 comments on commit a66d576

Please sign in to comment.