docs: add foreground-scripts and ignore-scripts to commands

I think this gets them all
npm · Mar 17, 2022 · 18b8322 · 18b8322
1 parent f95396a
commit 18b8322
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 32 deletions.
diff --git a/lib/commands/audit.js b/lib/commands/audit.js
@@ -14,6 +14,8 @@ class Audit extends ArboristWorkspaceCmd {
     'json',
     'package-lock-only',
     'omit',
+    'foreground-scripts',
+    'ignore-scripts',
     ...super.params,
   ]
 

diff --git a/lib/commands/ci.js b/lib/commands/ci.js
@@ -24,6 +24,7 @@ class CI extends ArboristWorkspaceCmd {
   static name = 'ci'
   static params = [
     'audit',
+    'foreground-scripts',
     'ignore-scripts',
     'script-shell',
   ]

diff --git a/lib/commands/install.js b/lib/commands/install.js
@@ -14,15 +14,18 @@ const ArboristWorkspaceCmd = require('../arborist-cmd.js')
 class Install extends ArboristWorkspaceCmd {
   static description = 'Install a package'
   static name = 'install'
+
+  // These are in the order they will show up in when running "-h"
   static params = [
     'save',
     'save-exact',
     'global',
     'global-style',
     'legacy-bundling',
+    'omit',
     'strict-peer-deps',
     'package-lock',
-    'omit',
+    'foreground-scripts',
     'ignore-scripts',
     'audit',
     'bin-links',

diff --git a/lib/commands/prune.js b/lib/commands/prune.js
@@ -6,7 +6,15 @@ const ArboristWorkspaceCmd = require('../arborist-cmd.js')
 class Prune extends ArboristWorkspaceCmd {
   static description = 'Remove extraneous packages'
   static name = 'prune'
-  static params = ['omit', 'dry-run', 'json', ...super.params]
+  static params = [
+    'omit',
+    'dry-run',
+    'json',
+    'foreground-scripts',
+    'ignore-scripts',
+    ...super.params,
+  ]
+
   static usage = ['[[<@scope>/]<pkg>...]']
 
   async exec () {

diff --git a/lib/commands/rebuild.js b/lib/commands/rebuild.js
@@ -11,6 +11,7 @@ class Rebuild extends ArboristWorkspaceCmd {
   static params = [
     'global',
     'bin-links',
+    'foreground-scripts',
     'ignore-scripts',
     ...super.params,
   ]

diff --git a/lib/commands/update.js b/lib/commands/update.js
@@ -10,14 +10,16 @@ const ArboristWorkspaceCmd = require('../arborist-cmd.js')
 class Update extends ArboristWorkspaceCmd {
   static description = 'Update packages'
   static name = 'update'
+
   static params = [
+    'save',
     'global',
     'global-style',
     'legacy-bundling',
+    'omit',
     'strict-peer-deps',
     'package-lock',
-    'save',
-    'omit',
+    'foreground-scripts',
     'ignore-scripts',
     'audit',
     'bin-links',

diff --git a/tap-snapshots/test/lib/load-all-commands.js.test.cjs b/tap-snapshots/test/lib/load-all-commands.js.test.cjs
@@ -55,6 +55,7 @@ Options:
 [--audit-level <info|low|moderate|high|critical|none>] [--dry-run] [-f|--force]
 [--json] [--package-lock-only]
 [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
+[--foreground-scripts] [--ignore-scripts]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
 [-ws|--workspaces] [--include-workspace-root]
 
@@ -121,7 +122,8 @@ Usage:
 npm ci
 
 Options:
-[--no-audit] [--ignore-scripts] [--script-shell <script-shell>]
+[--no-audit] [--foreground-scripts] [--ignore-scripts]
+[--script-shell <script-shell>]
 
 aliases: clean-install, ic, install-clean, isntall-clean
 
@@ -449,9 +451,9 @@ npm install <github username>/<github project>
 Options:
 [-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
 [-E|--save-exact] [-g|--global] [--global-style] [--legacy-bundling]
-[--strict-peer-deps] [--no-package-lock]
-[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
-[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
+[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
+[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
+[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
 [-ws|--workspaces] [--include-workspace-root]
 
@@ -469,7 +471,8 @@ Usage:
 npm install-ci-test
 
 Options:
-[--no-audit] [--ignore-scripts] [--script-shell <script-shell>]
+[--no-audit] [--foreground-scripts] [--ignore-scripts]
+[--script-shell <script-shell>]
 
 alias: cit
 
@@ -496,9 +499,9 @@ npm install-test <github username>/<github project>
 Options:
 [-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
 [-E|--save-exact] [-g|--global] [--global-style] [--legacy-bundling]
-[--strict-peer-deps] [--no-package-lock]
-[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
-[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
+[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
+[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
+[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
 [-ws|--workspaces] [--include-workspace-root]
 
@@ -742,7 +745,8 @@ npm prune [[<@scope>/]<pkg>...]
 
 Options:
 [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--dry-run]
-[--json] [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
+[--json] [--foreground-scripts] [--ignore-scripts]
+[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
 [-ws|--workspaces] [--include-workspace-root]
 
 Run "npm help prune" for more info
@@ -773,7 +777,7 @@ Usage:
 npm rebuild [[<@scope>/]<name>[@<version>] ...]
 
 Options:
-[-g|--global] [--no-bin-links] [--ignore-scripts]
+[-g|--global] [--no-bin-links] [--foreground-scripts] [--ignore-scripts]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
 [-ws|--workspaces] [--include-workspace-root]
 
@@ -1063,11 +1067,11 @@ Usage:
 npm update [<pkg>...]
 
 Options:
-[-g|--global] [--global-style] [--legacy-bundling] [--strict-peer-deps]
-[--no-package-lock]
 [-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
-[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
-[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
+[-g|--global] [--global-style] [--legacy-bundling]
+[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
+[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
+[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
 [-ws|--workspaces] [--include-workspace-root]
 

diff --git a/tap-snapshots/test/lib/utils/npm-usage.js.test.cjs b/tap-snapshots/test/lib/utils/npm-usage.js.test.cjs
@@ -210,6 +210,7 @@ All commands:
                     [--audit-level <info|low|moderate|high|critical|none>] [--dry-run] [-f|--force]
                     [--json] [--package-lock-only]
                     [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
+                    [--foreground-scripts] [--ignore-scripts]
                     [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
                     [-ws|--workspaces] [--include-workspace-root]
                     
@@ -268,7 +269,8 @@ All commands:
                     npm ci
                     
                     Options:
-                    [--no-audit] [--ignore-scripts] [--script-shell <script-shell>]
+                    [--no-audit] [--foreground-scripts] [--ignore-scripts]
+                    [--script-shell <script-shell>]
                     
                     aliases: clean-install, ic, install-clean, isntall-clean
                     
@@ -558,9 +560,9 @@ All commands:
                     Options:
                     [-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
                     [-E|--save-exact] [-g|--global] [--global-style] [--legacy-bundling]
-                    [--strict-peer-deps] [--no-package-lock]
-                    [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
-                    [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
+                    [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
+                    [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
+                    [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
                     [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
                     [-ws|--workspaces] [--include-workspace-root]
                     
@@ -576,7 +578,8 @@ All commands:
                     npm install-ci-test
                     
                     Options:
-                    [--no-audit] [--ignore-scripts] [--script-shell <script-shell>]
+                    [--no-audit] [--foreground-scripts] [--ignore-scripts]
+                    [--script-shell <script-shell>]
                     
                     alias: cit
                     
@@ -601,9 +604,9 @@ All commands:
                     Options:
                     [-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
                     [-E|--save-exact] [-g|--global] [--global-style] [--legacy-bundling]
-                    [--strict-peer-deps] [--no-package-lock]
-                    [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
-                    [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
+                    [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
+                    [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
+                    [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
                     [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
                     [-ws|--workspaces] [--include-workspace-root]
                     
@@ -819,7 +822,8 @@ All commands:
                     
                     Options:
                     [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--dry-run]
-                    [--json] [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
+                    [--json] [--foreground-scripts] [--ignore-scripts]
+                    [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
                     [-ws|--workspaces] [--include-workspace-root]
                     
                     Run "npm help prune" for more info
@@ -846,7 +850,7 @@ All commands:
                     npm rebuild [[<@scope>/]<name>[@<version>] ...]
                     
                     Options:
-                    [-g|--global] [--no-bin-links] [--ignore-scripts]
+                    [-g|--global] [--no-bin-links] [--foreground-scripts] [--ignore-scripts]
                     [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
                     [-ws|--workspaces] [--include-workspace-root]
                     
@@ -1098,11 +1102,11 @@ All commands:
                     npm update [<pkg>...]
                     
                     Options:
-                    [-g|--global] [--global-style] [--legacy-bundling] [--strict-peer-deps]
-                    [--no-package-lock]
                     [-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
-                    [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
-                    [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
+                    [-g|--global] [--global-style] [--legacy-bundling]
+                    [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
+                    [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
+                    [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
                     [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
                     [-ws|--workspaces] [--include-workspace-root]