Skip to content

add "before" to help output for some commands #8447

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

Merged
merged 2 commits into from
Jul 21, 2025
Merged

add "before" to help output for some commands #8447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f48d80c
fix: add --before param to command help output
wraithgar Jul 21, 2025
8d1ae89
fix: add better hint for `before` and clean up description
wraithgar Jul 21, 2025
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/install.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class Install extends ArboristWorkspaceCmd {
'foreground-scripts',
'ignore-scripts',
'audit',
'before',
'bin-links',
'fund',
'dry-run',
Expand Down
1 change: 1 addition & 0 deletions lib/commands/outdated.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ class Outdated extends ArboristWorkspaceCmd {
'parseable',
'global',
'workspace',
'before',
]

#tree
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 @@ -20,6 +20,7 @@ class Update extends ArboristWorkspaceCmd {
'foreground-scripts',
'ignore-scripts',
'audit',
'before',
'bin-links',
'fund',
'dry-run',
Expand Down
24 changes: 16 additions & 8 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 @@ -263,9 +263,9 @@ config is given, this value will always be set to \`legacy\`.
* Type: null or Date

If passed to \`npm install\`, will rebuild the npm tree such that only
versions that were available **on or before** the \`--before\` time get
installed. If there's no versions available for the current set of direct
dependencies, the command will error.
versions that were available **on or before** the given date are installed.
If there are no versions available for the current set of dependencies, the
command will error.

If the requested version is a \`dist-tag\` and the given tag does not pass the
\`--before\` filter, the most recent version less than or equal to that tag
Expand Down Expand Up @@ -3301,8 +3301,9 @@ Options:
[--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>] [--libc <libc>]
[--foreground-scripts] [--ignore-scripts] [--no-audit] [--before <date>]
[--no-bin-links] [--no-fund] [--dry-run] [--cpu <cpu>] [--os <os>]
[--libc <libc>]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[--workspaces] [--include-workspace-root] [--install-links]

Expand Down Expand Up @@ -3331,6 +3332,7 @@ aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall
#### \`foreground-scripts\`
#### \`ignore-scripts\`
#### \`audit\`
#### \`before\`
#### \`bin-links\`
#### \`fund\`
#### \`dry-run\`
Expand Down Expand Up @@ -3399,8 +3401,9 @@ Options:
[--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>] [--libc <libc>]
[--foreground-scripts] [--ignore-scripts] [--no-audit] [--before <date>]
[--no-bin-links] [--no-fund] [--dry-run] [--cpu <cpu>] [--os <os>]
[--libc <libc>]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[--workspaces] [--include-workspace-root] [--install-links]

Expand Down Expand Up @@ -3429,6 +3432,7 @@ alias: it
#### \`foreground-scripts\`
#### \`ignore-scripts\`
#### \`audit\`
#### \`before\`
#### \`bin-links\`
#### \`fund\`
#### \`dry-run\`
Expand Down Expand Up @@ -3675,6 +3679,7 @@ npm outdated [<package-spec> ...]
Options:
[-a|--all] [--json] [-l|--long] [-p|--parseable] [-g|--global]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[--before <date>]

Run "npm help outdated" for more info

Expand All @@ -3688,6 +3693,7 @@ npm outdated [<package-spec> ...]
#### \`parseable\`
#### \`global\`
#### \`workspace\`
#### \`before\`
`

exports[`test/lib/docs.js TAP usage owner > must match snapshot 1`] = `
Expand Down Expand Up @@ -4433,7 +4439,8 @@ Options:
[--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]
[--ignore-scripts] [--no-audit] [--before <date>] [--no-bin-links] [--no-fund]
[--dry-run]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[--workspaces] [--include-workspace-root] [--install-links]

Expand All @@ -4459,6 +4466,7 @@ aliases: up, upgrade, udpate
#### \`foreground-scripts\`
#### \`ignore-scripts\`
#### \`audit\`
#### \`before\`
#### \`bin-links\`
#### \`fund\`
#### \`dry-run\`
Expand Down
7 changes: 4 additions & 3 deletions workspaces/config/lib/definitions/definitions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,12 +230,13 @@ const definitions = {
}),
before: new Definition('before', {
default: null,
hint: '<date>',
type: [null, Date],
description: `
If passed to \`npm install\`, will rebuild the npm tree such that only
versions that were available **on or before** the \`--before\` time get
installed. If there's no versions available for the current set of
direct dependencies, the command will error.
versions that were available **on or before** the given date are
installed. If there are no versions available for the current set of
dependencies, the command will error.

If the requested version is a \`dist-tag\` and the given tag does not
pass the \`--before\` filter, the most recent version less than or equal
Expand Down
Loading