Skip to content

Commit

Permalink
docs: Add semver link and note on empty string format to deprecate
Browse files Browse the repository at this point in the history
…doc (#68)

PR-URL: #68
Credit: @neverett
Reviewed-By: @zkat
  • Loading branch information
neverett authored and zkat committed Nov 26, 2018
1 parent 1b2fabc commit 6cc70cc
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions doc/cli/npm-deprecate.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,17 @@ npm-deprecate(1) -- Deprecate a version of a package
This command will update the npm registry entry for a package, providing
a deprecation warning to all who attempt to install it.

It works on version ranges as well as specific versions, so you can do
something like this:
It works on [version ranges](https://semver.npmjs.com/) as well as specific
versions, so you can do something like this:

npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"

Note that you must be the package owner to deprecate something. See the
`owner` and `adduser` help topics.

To un-deprecate a package, specify an empty string (`""`) for the `message` argument.
To un-deprecate a package, specify an empty string (`""`) for the `message`
argument. Note that you must use double quotes with no space between them to
format an empty string.

## SEE ALSO

Expand Down

0 comments on commit 6cc70cc

Please sign in to comment.