Skip to content
Permalink
Browse files
docs: add --dry-run to install and pack (#41)
PR-URL: #41
Credit: @reconbot
Reviewed-By: @zkat
  • Loading branch information
reconbot authored and zkat committed Aug 20, 2018
1 parent 08ecde2 commit de956405d8b72354f98579d00c6dd30ac3b9bddf
Showing with 13 additions and 7 deletions.
  1. +4 −1 doc/cli/npm-pack.md
  2. +7 −4 doc/cli/npm-publish.md
  3. +1 −1 lib/pack.js
  4. +1 −1 lib/publish.js
@@ -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)
@@ -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

@@ -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
@@ -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'

0 comments on commit de95640

Please sign in to comment.