diff options
| author | Michael Garvin <gar+gh@danger.computer> | 2021-01-11 22:17:42 +0300 |
|---|---|---|
| committer | Michael Garvin <gar+gh@danger.computer> | 2021-01-15 00:18:59 +0300 |
| commit | cfdcf32fd7628501712b8cad4a541c6b8e7b66bc (patch) | |
| tree | 315fdfd9c0ff49b2f2338f9c3cceb7cdfa4e26b9 /docs | |
| parent | a3c1274460e16d1edbdca6a0cee86ef313fdd961 (diff) | |
fix(docs): clean up `npm unpublish` docs
Mostly grammar fixes, also adds not about needing to
be logged in, as per comment in https://github.com/npm/cli/issues/1880
PR-URL: https://github.com/npm/cli/pull/2474
Credit: @wraithgar
Close: #2474
Reviewed-by: @darcyclarke
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/commands/npm-unpublish.md | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/docs/content/commands/npm-unpublish.md b/docs/content/commands/npm-unpublish.md index b39a7c09e..e9d6e9045 100644 --- a/docs/content/commands/npm-unpublish.md +++ b/docs/content/commands/npm-unpublish.md @@ -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 @@ -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 @@ -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) |