docs: fix unpublish docs to auto generate usage (#4584)

Also add explanation of what `--force` does for unpublish
npm · Mar 17, 2022 · 7c878b9 · 7c878b9
1 parent aec2bfe
commit 7c878b9
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 10 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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!

diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js
@@ -740,6 +740,7 @@ define('force', {
     * 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/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs b/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
@@ -659,6 +659,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/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs b/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs
@@ -490,6 +490,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!