From 10099b3edaab8fceed0f3018994960a14b76dbfd Mon Sep 17 00:00:00 2001 From: Michael Garvin Date: Mon, 11 Jan 2021 11:17:42 -0800 Subject: [PATCH 1/2] 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 --- docs/content/commands/npm-unpublish.md | 27 +++++++++++++++++--------- lib/unpublish.js | 2 +- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/content/commands/npm-unpublish.md b/docs/content/commands/npm-unpublish.md index b39a7c09eb6e4..161062615e57b 100644 --- a/docs/content/commands/npm-unpublish.md +++ b/docs/content/commands/npm-unpublish.md @@ -20,22 +20,30 @@ npm unpublish [<@scope>/] --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. +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. +The npm registry will return an error if you are not [logged +in](/commands/npm-login). -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. +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. -To learn more about how unpublish is treated on the npm registry, see our unpublish policies. +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. +To learn more about how the npm registry treats unpublish, see our unpublish policies ### See Also @@ -44,3 +52,4 @@ To learn more about how unpublish is treated on the npm registry, see our { 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 From 79b2c91b5add16c5b9871c814ce4cc02876373cf Mon Sep 17 00:00:00 2001 From: Michael Garvin Date: Thu, 14 Jan 2021 12:42:24 -0800 Subject: [PATCH 2/2] fix(docs): move unpublish policy to top delineate package name --- docs/content/commands/npm-unpublish.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/content/commands/npm-unpublish.md b/docs/content/commands/npm-unpublish.md index 161062615e57b..e9d6e9045c6f9 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 unpublish policies + #### Unpublishing a single version of a package ```bash @@ -20,7 +24,7 @@ npm unpublish [<@scope>/] --force ### Warning -Consider using the [deprecate](/commands/npm-deprecate) command instead, +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. @@ -41,10 +45,6 @@ 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. -To learn more about how the npm registry treats unpublish, see our unpublish policies - ### See Also * [npm deprecate](/commands/npm-deprecate)