Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add include param to commands that have omit param #6831

Merged
merged 5 commits into from
Sep 26, 2023
Merged

docs: add include param to commands that have omit param #6831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1c384bc
add option to
siemhesda Sep 22, 2023
a3d1cd6
'docs: run
siemhesda Sep 22, 2023
d082e5a
docs: add flag to sections containint the flag
siemhesda Sep 25, 2023
50639e4
docs: run build docs and run 'npm run snap'
siemhesda Sep 25, 2023
e43b24b
docs: run 'npm run snap -w smoke-tests'
siemhesda Sep 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/commands/audit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,7 @@ class Audit extends ArboristWorkspaceCmd {
'package-lock-only',
'package-lock',
'omit',
'include',
'foreground-scripts',
'ignore-scripts',
...super.params,
Expand Down
1 change: 1 addition & 0 deletions lib/commands/ci.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ class CI extends ArboristWorkspaceCmd {
'legacy-bundling',
'global-style',
'omit',
'include',
'strict-peer-deps',
'foreground-scripts',
'ignore-scripts',
Expand Down
1 change: 1 addition & 0 deletions lib/commands/dedupe.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ class Dedupe extends ArboristWorkspaceCmd {
'strict-peer-deps',
'package-lock',
'omit',
'include',
'ignore-scripts',
'audit',
'bin-links',
Expand Down
1 change: 1 addition & 0 deletions lib/commands/find-dupes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ class FindDupes extends ArboristWorkspaceCmd {
'strict-peer-deps',
'package-lock',
'omit',
'include',
'ignore-scripts',
'audit',
'bin-links',
Expand Down
1 change: 1 addition & 0 deletions lib/commands/install.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class Install extends ArboristWorkspaceCmd {
'legacy-bundling',
'global-style',
'omit',
'include',
'strict-peer-deps',
'prefer-dedupe',
'package-lock',
Expand Down
1 change: 1 addition & 0 deletions lib/commands/link.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ class Link extends ArboristWorkspaceCmd {
'strict-peer-deps',
'package-lock',
'omit',
'include',
'ignore-scripts',
'audit',
'bin-links',
Expand Down
1 change: 1 addition & 0 deletions lib/commands/ls.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ class LS extends ArboristWorkspaceCmd {
'global',
'depth',
'omit',
'include',
'link',
'package-lock-only',
'unicode',
Expand Down
1 change: 1 addition & 0 deletions lib/commands/prune.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ class Prune extends ArboristWorkspaceCmd {
static name = 'prune'
static params = [
'omit',
'include',
'dry-run',
'json',
'foreground-scripts',
Expand Down
1 change: 1 addition & 0 deletions lib/commands/update.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ class Update extends ArboristWorkspaceCmd {
'legacy-bundling',
'global-style',
'omit',
'include',
'strict-peer-deps',
'package-lock',
'foreground-scripts',
Expand Down
1 change: 1 addition & 0 deletions smoke-tests/tap-snapshots/test/index.js.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ npm ERR!
npm ERR! Options:
npm ERR! [--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
npm ERR! [--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
npm ERR! [--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
npm ERR! [--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit]
npm ERR! [--no-bin-links] [--no-fund] [--dry-run]
npm ERR! [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
Expand Down
48 changes: 36 additions & 12 deletions tap-snapshots/test/lib/docs.js.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2554,6 +2554,7 @@ Options:
[--audit-level <info|low|moderate|high|critical|none>] [--dry-run] [-f|--force]
[--json] [--package-lock-only] [--no-package-lock]
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--foreground-scripts] [--ignore-scripts]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--install-links]
Expand All @@ -2571,6 +2572,7 @@ npm audit [fix|signatures]
#### \`package-lock-only\`
#### \`package-lock\`
#### \`omit\`
#### \`include\`
#### \`foreground-scripts\`
#### \`ignore-scripts\`
#### \`workspace\`
Expand Down Expand Up @@ -2642,6 +2644,7 @@ npm ci
Options:
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit]
[--no-bin-links] [--no-fund] [--dry-run]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
Expand All @@ -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\`
Expand Down Expand Up @@ -2739,8 +2743,9 @@ npm dedupe
Options:
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
[--global-style] [--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> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--install-links]

Expand All @@ -2760,6 +2765,7 @@ alias: ddp
#### \`strict-peer-deps\`
#### \`package-lock\`
#### \`omit\`
#### \`include\`
#### \`ignore-scripts\`
#### \`audit\`
#### \`bin-links\`
Expand Down Expand Up @@ -3010,8 +3016,9 @@ npm find-dupes
Options:
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
[--global-style] [--strict-peer-deps] [--no-package-lock]
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
[--no-audit] [--no-bin-links] [--no-fund]
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--install-links]

Expand All @@ -3027,6 +3034,7 @@ npm find-dupes
#### \`strict-peer-deps\`
#### \`package-lock\`
#### \`omit\`
#### \`include\`
#### \`ignore-scripts\`
#### \`audit\`
#### \`bin-links\`
Expand Down Expand Up @@ -3195,6 +3203,7 @@ Options:
[-E|--save-exact] [-g|--global]
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--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 <cpu>] [--os <os>]
Expand All @@ -3218,6 +3227,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\`
Expand Down Expand Up @@ -3245,6 +3255,7 @@ npm install-ci-test
Options:
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit]
[--no-bin-links] [--no-fund] [--dry-run]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
Expand All @@ -3264,6 +3275,7 @@ aliases: cit, clean-install-test, sit
#### \`legacy-bundling\`
#### \`global-style\`
#### \`omit\`
#### \`include\`
#### \`strict-peer-deps\`
#### \`foreground-scripts\`
#### \`ignore-scripts\`
Expand All @@ -3288,6 +3300,7 @@ Options:
[-E|--save-exact] [-g|--global]
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--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 <cpu>] [--os <os>]
Expand All @@ -3311,6 +3324,7 @@ alias: it
#### \`legacy-bundling\`
#### \`global-style\`
#### \`omit\`
#### \`include\`
#### \`strict-peer-deps\`
#### \`prefer-dedupe\`
#### \`package-lock\`
Expand Down Expand Up @@ -3340,8 +3354,9 @@ Options:
[-E|--save-exact] [-g|--global]
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
[--global-style] [--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> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--install-links]

Expand All @@ -3364,6 +3379,7 @@ alias: ln
#### \`strict-peer-deps\`
#### \`package-lock\`
#### \`omit\`
#### \`include\`
#### \`ignore-scripts\`
#### \`audit\`
#### \`bin-links\`
Expand All @@ -3383,8 +3399,9 @@ npm ll [[<@scope>/]<pkg> ...]

Options:
[-a|--all] [--json] [-l|--long] [-p|--parseable] [-g|--global] [--depth <depth>]
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--link]
[--package-lock-only] [--unicode]
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--link] [--package-lock-only] [--unicode]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--install-links]

Expand All @@ -3405,6 +3422,7 @@ alias: la
#### \`global\`
#### \`depth\`
#### \`omit\`
#### \`include\`
#### \`link\`
#### \`package-lock-only\`
#### \`unicode\`
Expand Down Expand Up @@ -3465,8 +3483,9 @@ npm ls <package-spec>

Options:
[-a|--all] [--json] [-l|--long] [-p|--parseable] [-g|--global] [--depth <depth>]
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--link]
[--package-lock-only] [--unicode]
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--link] [--package-lock-only] [--unicode]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--install-links]

Expand All @@ -3487,6 +3506,7 @@ alias: list
#### \`global\`
#### \`depth\`
#### \`omit\`
#### \`include\`
#### \`link\`
#### \`package-lock-only\`
#### \`unicode\`
Expand Down Expand Up @@ -3737,8 +3757,9 @@ Usage:
npm prune [[<@scope>/]<pkg>...]

Options:
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--dry-run]
[--json] [--foreground-scripts] [--ignore-scripts]
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
[--dry-run] [--json] [--foreground-scripts] [--ignore-scripts]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--install-links]

Expand All @@ -3749,6 +3770,7 @@ npm prune [[<@scope>/]<pkg>...]
\`\`\`

#### \`omit\`
#### \`include\`
#### \`dry-run\`
#### \`json\`
#### \`foreground-scripts\`
Expand Down Expand Up @@ -4258,6 +4280,7 @@ Options:
[-g|--global] [--install-strategy <hoisted|nested|shallow|linked>]
[--legacy-bundling] [--global-style]
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--include <prod|dev|optional|peer> [--include <prod|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> ...]]
Expand All @@ -4279,6 +4302,7 @@ aliases: up, upgrade, udpate
#### \`legacy-bundling\`
#### \`global-style\`
#### \`omit\`
#### \`include\`
#### \`strict-peer-deps\`
#### \`package-lock\`
#### \`foreground-scripts\`
Expand Down
Loading