Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGar <gar+gh@danger.computer>2022-03-17 21:43:44 +0300
committerGitHub <noreply@github.com>2022-03-17 21:43:44 +0300
commit7c878b9781be2e2151f41bd29d46c33e421aeb10 (patch)
tree40882593bab738c7b7b42f228956b47a91da3470 /docs
parentaec2bfecca4ad3ee7db4481cf068add9c42e7160 (diff)
docs: fix unpublish docs to auto generate usage (#4584)
Also add explanation of what `--force` does for unpublish
Diffstat (limited to 'docs')
-rw-r--r--docs/content/commands/npm-audit.md1
-rw-r--r--docs/content/commands/npm-init.md1
-rw-r--r--docs/content/commands/npm-pkg.md1
-rw-r--r--docs/content/commands/npm-unpublish.md22
-rw-r--r--docs/content/using-npm/config.md1
5 files changed, 16 insertions, 10 deletions
diff --git a/docs/content/commands/npm-audit.md b/docs/content/commands/npm-audit.md
index ae2afa840..24b700ff5 100644
--- a/docs/content/commands/npm-audit.md
+++ b/docs/content/commands/npm-audit.md
@@ -246,6 +246,7 @@ mistakes, unnecessary performance degradation, and malicious input.
* Allow conflicting peerDependencies to be installed in the root project.
* Implicitly set `--yes` during `npm init`.
* Allow clobbering existing values in `npm pkg`
+* Allow unpublishing of entire packages (not just a single version).
If you don't have a clear idea of what you want to do, it is strongly
recommended that you do not use this option!
diff --git a/docs/content/commands/npm-init.md b/docs/content/commands/npm-init.md
index d9c03aef4..71109cd36 100644
--- a/docs/content/commands/npm-init.md
+++ b/docs/content/commands/npm-init.md
@@ -199,6 +199,7 @@ mistakes, unnecessary performance degradation, and malicious input.
* Allow conflicting peerDependencies to be installed in the root project.
* Implicitly set `--yes` during `npm init`.
* Allow clobbering existing values in `npm pkg`
+* Allow unpublishing of entire packages (not just a single version).
If you don't have a clear idea of what you want to do, it is strongly
recommended that you do not use this option!
diff --git a/docs/content/commands/npm-pkg.md b/docs/content/commands/npm-pkg.md
index c41f2a76d..576e1335e 100644
--- a/docs/content/commands/npm-pkg.md
+++ b/docs/content/commands/npm-pkg.md
@@ -199,6 +199,7 @@ mistakes, unnecessary performance degradation, and malicious input.
* Allow conflicting peerDependencies to be installed in the root project.
* Implicitly set `--yes` during `npm init`.
* Allow clobbering existing values in `npm pkg`
+* Allow unpublishing of entire packages (not just a single version).
If you don't have a clear idea of what you want to do, it is strongly
recommended that you do not use this option!
diff --git a/docs/content/commands/npm-unpublish.md b/docs/content/commands/npm-unpublish.md
index 13589a03e..a4c481ea5 100644
--- a/docs/content/commands/npm-unpublish.md
+++ b/docs/content/commands/npm-unpublish.md
@@ -6,21 +6,22 @@ description: Remove a package from the registry
### Synopsis
-To learn more about how the npm registry treats unpublish, see our <a
-href="https://docs.npmjs.com/policies/unpublish" target="_blank"
-rel="noopener noreferrer"> unpublish policies</a>
-
-#### Unpublishing a single version of a package
+<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/commands/unpublish.js -->
```bash
-npm unpublish [<@scope>/]<pkg>@<version>
+npm unpublish [<@scope>/]<pkg>[@<version>]
```
-#### Unpublishing an entire package
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/commands/unpublish.js -->
+
+<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
-```bash
-npm unpublish [<@scope>/]<pkg> --force
-```
+To learn more about how the npm registry treats unpublish, see our <a
+href="https://docs.npmjs.com/policies/unpublish" target="_blank"
+rel="noopener noreferrer"> unpublish policies</a>
### Warning
@@ -87,6 +88,7 @@ mistakes, unnecessary performance degradation, and malicious input.
* Allow conflicting peerDependencies to be installed in the root project.
* Implicitly set `--yes` during `npm init`.
* Allow clobbering existing values in `npm pkg`
+* Allow unpublishing of entire packages (not just a single version).
If you don't have a clear idea of what you want to do, it is strongly
recommended that you do not use this option!
diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md
index b2e60a742..df259715f 100644
--- a/docs/content/using-npm/config.md
+++ b/docs/content/using-npm/config.md
@@ -616,6 +616,7 @@ mistakes, unnecessary performance degradation, and malicious input.
* Allow conflicting peerDependencies to be installed in the root project.
* Implicitly set `--yes` during `npm init`.
* Allow clobbering existing values in `npm pkg`
+* Allow unpublishing of entire packages (not just a single version).
If you don't have a clear idea of what you want to do, it is strongly
recommended that you do not use this option!