Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
fix(docs): clean up npm unpublish docs
Mostly grammar fixes, also adds not about needing to
be logged in, as per comment in #1880

PR-URL: #2474
Credit: @wraithgar
Close: #2474
Reviewed-by: @darcyclarke
  • Loading branch information
wraithgar committed Jan 14, 2021
1 parent a3c1274 commit cfdcf32
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 11 deletions.
29 changes: 19 additions & 10 deletions docs/content/commands/npm-unpublish.md
Expand Up @@ -6,6 +6,10 @@ description: Remove a package from the registry

### Synopsis

To learn more about how the npm registry treats unpublish, see our <a
href="https://www.npmjs.com/policies/unpublish" target="_blank"
rel="noopener noreferrer"> unpublish policies</a>

#### Unpublishing a single version of a package

```bash
Expand All @@ -20,22 +24,26 @@ npm unpublish [<@scope>/]<pkg> --force

### Warning

Consider using the `deprecate` command instead, if your intent is to encourage users to upgrade, or if you no longer want to maintain a package.
Consider using the [`deprecate`](/commands/npm-deprecate) command instead,
if your intent is to encourage users to upgrade, or if you no longer
want to maintain a package.

### Description

This removes a package version from the registry, deleting its
entry and removing the tarball.

If no version is specified, or if all versions are removed then
the root package entry is removed from the registry entirely.
This removes a package version from the registry, deleting its entry and
removing the tarball.

Even if a package version is unpublished, that specific name and
version combination can never be reused. In order to publish the
package again, a new version number must be used. If you unpublish the entire package, you may not publish any new versions of that package until 24 hours have passed.
The npm registry will return an error if you are not [logged
in](/commands/npm-login).

To learn more about how unpublish is treated on the npm registry, see our <a href="https://www.npmjs.com/policies/unpublish" target="_blank" rel="noopener noreferrer"> unpublish policies</a>.
If you do not specify a version or if you remove all of a package's
versions then the registry will remove the root package entry entirely.

Even if you unpublish a package version, that specific name and version
combination can never be reused. In order to publish the package again,
you must use a new version number. If you unpublish the entire package,
you may not publish any new versions of that package until 24 hours have
passed.

### See Also

Expand All @@ -44,3 +52,4 @@ To learn more about how unpublish is treated on the npm registry, see our <a hre
* [npm registry](/using-npm/registry)
* [npm adduser](/commands/npm-adduser)
* [npm owner](/commands/npm-owner)
* [npm login](/commands/npm-login)
2 changes: 1 addition & 1 deletion lib/unpublish.js
Expand Up @@ -35,7 +35,7 @@ const completionFn = async (args) => {
const access = await libaccess.lsPackages(username, opts)
// do a bit of filtering at this point, so that we don't need
// to fetch versions for more than one thing, but also don't
// accidentally a whole project
// accidentally unpublish a whole project
let pkgs = Object.keys(access || {})
if (!partialWord || !pkgs.length)
return pkgs
Expand Down

0 comments on commit cfdcf32

Please sign in to comment.