From 3ac703c95e7bb851d0f6145f1d612749ed479fef Mon Sep 17 00:00:00 2001 From: siemhesda <143130929+siemhesda@users.noreply.github.com> Date: Tue, 26 Sep 2023 12:22:34 -0700 Subject: [PATCH] docs: add `include `param to commands that have `omit` param (#6831) --- lib/commands/audit.js | 1 + lib/commands/ci.js | 1 + lib/commands/dedupe.js | 1 + lib/commands/find-dupes.js | 1 + lib/commands/install.js | 1 + lib/commands/link.js | 1 + lib/commands/ls.js | 1 + lib/commands/prune.js | 1 + lib/commands/update.js | 1 + .../tap-snapshots/test/index.js.test.cjs | 1 + tap-snapshots/test/lib/docs.js.test.cjs | 48 ++++++++++++++----- 11 files changed, 46 insertions(+), 12 deletions(-) diff --git a/lib/commands/audit.js b/lib/commands/audit.js index 2a40d541c20db..c95d992c05c99 100644 --- a/lib/commands/audit.js +++ b/lib/commands/audit.js @@ -406,6 +406,7 @@ class Audit extends ArboristWorkspaceCmd { 'package-lock-only', 'package-lock', 'omit', + 'include', 'foreground-scripts', 'ignore-scripts', ...super.params, diff --git a/lib/commands/ci.js b/lib/commands/ci.js index e662379278e03..706b77ac361cf 100644 --- a/lib/commands/ci.js +++ b/lib/commands/ci.js @@ -16,6 +16,7 @@ class CI extends ArboristWorkspaceCmd { 'legacy-bundling', 'global-style', 'omit', + 'include', 'strict-peer-deps', 'foreground-scripts', 'ignore-scripts', diff --git a/lib/commands/dedupe.js b/lib/commands/dedupe.js index d4e8d0e8c80c3..0d0e26621b227 100644 --- a/lib/commands/dedupe.js +++ b/lib/commands/dedupe.js @@ -13,6 +13,7 @@ class Dedupe extends ArboristWorkspaceCmd { 'strict-peer-deps', 'package-lock', 'omit', + 'include', 'ignore-scripts', 'audit', 'bin-links', diff --git a/lib/commands/find-dupes.js b/lib/commands/find-dupes.js index b1a3120860366..2e06e8b6bd93f 100644 --- a/lib/commands/find-dupes.js +++ b/lib/commands/find-dupes.js @@ -11,6 +11,7 @@ class FindDupes extends ArboristWorkspaceCmd { 'strict-peer-deps', 'package-lock', 'omit', + 'include', 'ignore-scripts', 'audit', 'bin-links', diff --git a/lib/commands/install.js b/lib/commands/install.js index 3983c8d26c841..6687ec4371dd8 100644 --- a/lib/commands/install.js +++ b/lib/commands/install.js @@ -24,6 +24,7 @@ class Install extends ArboristWorkspaceCmd { 'legacy-bundling', 'global-style', 'omit', + 'include', 'strict-peer-deps', 'prefer-dedupe', 'package-lock', diff --git a/lib/commands/link.js b/lib/commands/link.js index a81450a247ed6..0c0929115a557 100644 --- a/lib/commands/link.js +++ b/lib/commands/link.js @@ -27,6 +27,7 @@ class Link extends ArboristWorkspaceCmd { 'strict-peer-deps', 'package-lock', 'omit', + 'include', 'ignore-scripts', 'audit', 'bin-links', diff --git a/lib/commands/ls.js b/lib/commands/ls.js index 92300b1c404a3..3f9775cf12504 100644 --- a/lib/commands/ls.js +++ b/lib/commands/ls.js @@ -32,6 +32,7 @@ class LS extends ArboristWorkspaceCmd { 'global', 'depth', 'omit', + 'include', 'link', 'package-lock-only', 'unicode', diff --git a/lib/commands/prune.js b/lib/commands/prune.js index 12136e20e4943..189fc29cb8bc3 100644 --- a/lib/commands/prune.js +++ b/lib/commands/prune.js @@ -7,6 +7,7 @@ class Prune extends ArboristWorkspaceCmd { static name = 'prune' static params = [ 'omit', + 'include', 'dry-run', 'json', 'foreground-scripts', diff --git a/lib/commands/update.js b/lib/commands/update.js index caa69dd317ca6..43d031c7ada3f 100644 --- a/lib/commands/update.js +++ b/lib/commands/update.js @@ -16,6 +16,7 @@ class Update extends ArboristWorkspaceCmd { 'legacy-bundling', 'global-style', 'omit', + 'include', 'strict-peer-deps', 'package-lock', 'foreground-scripts', diff --git a/smoke-tests/tap-snapshots/test/index.js.test.cjs b/smoke-tests/tap-snapshots/test/index.js.test.cjs index 5ba8778109226..a6a84d13f158e 100644 --- a/smoke-tests/tap-snapshots/test/index.js.test.cjs +++ b/smoke-tests/tap-snapshots/test/index.js.test.cjs @@ -57,6 +57,7 @@ npm ERR! npm ERR! Options: npm ERR! [--install-strategy ] [--legacy-bundling] npm ERR! [--global-style] [--omit [--omit ...]] +npm ERR! [--include [--include ...]] npm ERR! [--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit] npm ERR! [--no-bin-links] [--no-fund] [--dry-run] npm ERR! [-w|--workspace [-w|--workspace ...]] diff --git a/tap-snapshots/test/lib/docs.js.test.cjs b/tap-snapshots/test/lib/docs.js.test.cjs index a7be7240b0bdd..8cca448c7f4a5 100644 --- a/tap-snapshots/test/lib/docs.js.test.cjs +++ b/tap-snapshots/test/lib/docs.js.test.cjs @@ -2554,6 +2554,7 @@ Options: [--audit-level ] [--dry-run] [-f|--force] [--json] [--package-lock-only] [--no-package-lock] [--omit [--omit ...]] +[--include [--include ...]] [--foreground-scripts] [--ignore-scripts] [-w|--workspace [-w|--workspace ...]] [-ws|--workspaces] [--include-workspace-root] [--install-links] @@ -2571,6 +2572,7 @@ npm audit [fix|signatures] #### \`package-lock-only\` #### \`package-lock\` #### \`omit\` +#### \`include\` #### \`foreground-scripts\` #### \`ignore-scripts\` #### \`workspace\` @@ -2642,6 +2644,7 @@ npm ci Options: [--install-strategy ] [--legacy-bundling] [--global-style] [--omit [--omit ...]] +[--include [--include ...]] [--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run] [-w|--workspace [-w|--workspace ...]] @@ -2661,6 +2664,7 @@ aliases: clean-install, ic, install-clean, isntall-clean #### \`legacy-bundling\` #### \`global-style\` #### \`omit\` +#### \`include\` #### \`strict-peer-deps\` #### \`foreground-scripts\` #### \`ignore-scripts\` @@ -2739,8 +2743,9 @@ npm dedupe Options: [--install-strategy ] [--legacy-bundling] [--global-style] [--strict-peer-deps] [--no-package-lock] -[--omit [--omit ...]] [--ignore-scripts] -[--no-audit] [--no-bin-links] [--no-fund] [--dry-run] +[--omit [--omit ...]] +[--include [--include ...]] +[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run] [-w|--workspace [-w|--workspace ...]] [-ws|--workspaces] [--include-workspace-root] [--install-links] @@ -2760,6 +2765,7 @@ alias: ddp #### \`strict-peer-deps\` #### \`package-lock\` #### \`omit\` +#### \`include\` #### \`ignore-scripts\` #### \`audit\` #### \`bin-links\` @@ -3010,8 +3016,9 @@ npm find-dupes Options: [--install-strategy ] [--legacy-bundling] [--global-style] [--strict-peer-deps] [--no-package-lock] -[--omit [--omit ...]] [--ignore-scripts] -[--no-audit] [--no-bin-links] [--no-fund] +[--omit [--omit ...]] +[--include [--include ...]] +[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [-w|--workspace [-w|--workspace ...]] [-ws|--workspaces] [--include-workspace-root] [--install-links] @@ -3027,6 +3034,7 @@ npm find-dupes #### \`strict-peer-deps\` #### \`package-lock\` #### \`omit\` +#### \`include\` #### \`ignore-scripts\` #### \`audit\` #### \`bin-links\` @@ -3202,6 +3210,7 @@ Options: [-E|--save-exact] [-g|--global] [--install-strategy ] [--legacy-bundling] [--global-style] [--omit [--omit ...]] +[--include [--include ...]] [--strict-peer-deps] [--prefer-dedupe] [--no-package-lock] [--package-lock-only] [--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run] [--cpu ] [--os ] @@ -3225,6 +3234,7 @@ aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall #### \`legacy-bundling\` #### \`global-style\` #### \`omit\` +#### \`include\` #### \`strict-peer-deps\` #### \`prefer-dedupe\` #### \`package-lock\` @@ -3252,6 +3262,7 @@ npm install-ci-test Options: [--install-strategy ] [--legacy-bundling] [--global-style] [--omit [--omit ...]] +[--include [--include ...]] [--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run] [-w|--workspace [-w|--workspace ...]] @@ -3271,6 +3282,7 @@ aliases: cit, clean-install-test, sit #### \`legacy-bundling\` #### \`global-style\` #### \`omit\` +#### \`include\` #### \`strict-peer-deps\` #### \`foreground-scripts\` #### \`ignore-scripts\` @@ -3295,6 +3307,7 @@ Options: [-E|--save-exact] [-g|--global] [--install-strategy ] [--legacy-bundling] [--global-style] [--omit [--omit ...]] +[--include [--include ...]] [--strict-peer-deps] [--prefer-dedupe] [--no-package-lock] [--package-lock-only] [--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run] [--cpu ] [--os ] @@ -3318,6 +3331,7 @@ alias: it #### \`legacy-bundling\` #### \`global-style\` #### \`omit\` +#### \`include\` #### \`strict-peer-deps\` #### \`prefer-dedupe\` #### \`package-lock\` @@ -3347,8 +3361,9 @@ Options: [-E|--save-exact] [-g|--global] [--install-strategy ] [--legacy-bundling] [--global-style] [--strict-peer-deps] [--no-package-lock] -[--omit [--omit ...]] [--ignore-scripts] -[--no-audit] [--no-bin-links] [--no-fund] [--dry-run] +[--omit [--omit ...]] +[--include [--include ...]] +[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run] [-w|--workspace [-w|--workspace ...]] [-ws|--workspaces] [--include-workspace-root] [--install-links] @@ -3371,6 +3386,7 @@ alias: ln #### \`strict-peer-deps\` #### \`package-lock\` #### \`omit\` +#### \`include\` #### \`ignore-scripts\` #### \`audit\` #### \`bin-links\` @@ -3390,8 +3406,9 @@ npm ll [[<@scope>/] ...] Options: [-a|--all] [--json] [-l|--long] [-p|--parseable] [-g|--global] [--depth ] -[--omit [--omit ...]] [--link] -[--package-lock-only] [--unicode] +[--omit [--omit ...]] +[--include [--include ...]] +[--link] [--package-lock-only] [--unicode] [-w|--workspace [-w|--workspace ...]] [-ws|--workspaces] [--include-workspace-root] [--install-links] @@ -3412,6 +3429,7 @@ alias: la #### \`global\` #### \`depth\` #### \`omit\` +#### \`include\` #### \`link\` #### \`package-lock-only\` #### \`unicode\` @@ -3472,8 +3490,9 @@ npm ls Options: [-a|--all] [--json] [-l|--long] [-p|--parseable] [-g|--global] [--depth ] -[--omit [--omit ...]] [--link] -[--package-lock-only] [--unicode] +[--omit [--omit ...]] +[--include [--include ...]] +[--link] [--package-lock-only] [--unicode] [-w|--workspace [-w|--workspace ...]] [-ws|--workspaces] [--include-workspace-root] [--install-links] @@ -3494,6 +3513,7 @@ alias: list #### \`global\` #### \`depth\` #### \`omit\` +#### \`include\` #### \`link\` #### \`package-lock-only\` #### \`unicode\` @@ -3744,8 +3764,9 @@ Usage: npm prune [[<@scope>/]...] Options: -[--omit [--omit ...]] [--dry-run] -[--json] [--foreground-scripts] [--ignore-scripts] +[--omit [--omit ...]] +[--include [--include ...]] +[--dry-run] [--json] [--foreground-scripts] [--ignore-scripts] [-w|--workspace [-w|--workspace ...]] [-ws|--workspaces] [--include-workspace-root] [--install-links] @@ -3756,6 +3777,7 @@ npm prune [[<@scope>/]...] \`\`\` #### \`omit\` +#### \`include\` #### \`dry-run\` #### \`json\` #### \`foreground-scripts\` @@ -4265,6 +4287,7 @@ Options: [-g|--global] [--install-strategy ] [--legacy-bundling] [--global-style] [--omit [--omit ...]] +[--include [--include ...]] [--strict-peer-deps] [--no-package-lock] [--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run] [-w|--workspace [-w|--workspace ...]] @@ -4286,6 +4309,7 @@ aliases: up, upgrade, udpate #### \`legacy-bundling\` #### \`global-style\` #### \`omit\` +#### \`include\` #### \`strict-peer-deps\` #### \`package-lock\` #### \`foreground-scripts\`