Skip to content

Update dependency commander to v4#11

Open
renovate[bot] wants to merge 1 commit intomainfrom
renovate/commander-4.x
Open

Update dependency commander to v4#11
renovate[bot] wants to merge 1 commit intomainfrom
renovate/commander-4.x

Conversation

@renovate
Copy link

@renovate renovate bot commented Mar 21, 2023

This PR contains the following updates:

Package Change Age Confidence
commander 2.20.34.1.1 age confidence

Release Notes

tj/commander.js (commander)

v4.1.1

Compare Source

Fixed
  • TypeScript definition for .action() should include Promise for async ([#​1157])

v4.1.0

Compare Source

Added
  • two routines to change how option values are handled, and eliminate name clashes with command properties ([#​933] [#​1102])
    • see storeOptionsAsProperties and passCommandToAction in README
  • .parseAsync to use instead of .parse if supply async action handlers ([#​806] [#​1118])
Fixed
  • Remove trailing blanks from wrapped help text ([#​1096])
Changed
  • update dependencies
  • extend security coverage for Commander 2.x to 2020-02-03
  • improvements to README
  • improvements to TypeScript definition documentation
  • move old versions out of main CHANGELOG
  • removed explicit use of ts-node in tests

v4.0.1

Compare Source

Fixed
  • broken markdown link in README ([#​2369])
Changed
  • improve code readability by using optional chaining ([#​2394])
  • use more idiomatic code with object spread instead of Object.assign() ([#​2395])
  • improve code readability using string.endsWith() instead of string.slice() ([#​2396])
  • refactor .parseOptions() to process args array in-place ([#​2409])
  • change private variadic support routines from ._concatValue() to ._collectValue() (change code from array.concat() to array.push()) ([#​2410])
  • update (dev) dependencies

v4.0.0

Compare Source

Added
  • support for groups of options and commands in the help using low-level .helpGroup() on Option and Command, and higher-level .optionsGroup() and .commandsGroup() which can be used in chaining way to specify group title for following options/commands ([#​2328])
  • support for unescaped negative numbers as option-arguments and command-arguments ([#​2339])
  • TypeScript: add parseArg property to Argument class ([#​2359])
Fixed
  • remove bogus leading space in help when option has default value but not a description ([#​2348])
  • .configureOutput() now makes copy of settings instead of modifying in-place, fixing side-effects ([#​2350])
Changed
  • Breaking: Commander 14 requires Node.js v20 or higher
  • internal refactor of Help class adding .formatItemList() and .groupItems() methods ([#​2328])

v3.0.2

Compare Source

Fixed
  • Improve tracking of executable subcommands.
Changed
  • update development dependencies

v3.0.1

Compare Source

Added
  • .name and .usage to README ([#​1010])
  • Table of Contents to README ([#​1010])
  • TypeScript definition for executableFile in CommandOptions ([#​1028])
Changed
  • consistently use const rather than var in README ([#​1026])
Fixed
  • help for sub commands with custom executableFile ([#​1018])

v3.0.0

Compare Source

Added
  • support multiple calls to .parse() with default settings ([#​2299])
  • add .saveStateBeforeParse() and .restoreStateBeforeParse() for use by subclasses ([#​2299])
  • style routines like styleTitle() to add color to help using .configureHelp() or Help subclass ([#​2251])
  • color related support in .configureOutput() for getOutHasColors(), getErrHasColors(), and stripColor() ([#​2251])
  • Help property for minWidthToWrap ([#​2251])
  • Help methods for displayWidth(), boxWrap(), preformatted() et al ([#​2251])
Changed
  • Breaking: excess command-arguments cause an error by default, see migration tips ([#​2223])
  • Breaking: throw during Option construction for unsupported option flags, like multiple characters after single - ([#​2270])
    • note: support for dual long option flags added in Commander 13.1
  • Breaking: throw on multiple calls to .parse() if storeOptionsAsProperties: true ([#​2299])
  • TypeScript: include implicit this in parameters for action handler callback ([#​2197])
Deleted
  • Breaking: Help.wrap() refactored into formatItem() and boxWrap() ([#​2251])
Migration Tips

Excess command-arguments

It is now an error for the user to specify more command-arguments than are expected. (allowExcessArguments is now false by default.)

Old code:

program.option('-p, --port <number>', 'port number');
program.action((options) => {
  console.log(program.args);
});

Now shows an error:

$ node example.js a b c
error: too many arguments. Expected 0 arguments but got 3.

You can declare the expected arguments. The help will then be more accurate too. Note that declaring
new arguments will change what is passed to the action handler.

program.option('-p, --port <number>', 'port number');
program.argument('[args...]', 'remote command and arguments'); // expecting zero or more arguments
program.action((args, options) => {
  console.log(args);
});

Or you could suppress the error, useful for minimising changes in legacy code.

program.option('-p, --port', 'port number');
program.allowExcessArguments();
program.action((options) => {
  console.log(program.args);
});

Stricter option flag parsing

Commander now throws an error for option flag combinations that are not supported.
In particular, a short flag with multiple characters is now an error.

program.option('-ws, --workspace'); // throws error

A short option has a single character:

program.option('-w, --workspace');

Or from Commander 13.1 you can have an extra long flag instead of a short flag to allow a more memorable shortcut for the full name:

program.option('--ws, --workspace');

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot changed the title Update dependency commander to v4 Update dependency commander to v4 - autoclosed Apr 4, 2023
@renovate renovate bot closed this Apr 4, 2023
@renovate renovate bot deleted the renovate/commander-4.x branch April 4, 2023 00:16
@renovate renovate bot changed the title Update dependency commander to v4 - autoclosed Update dependency commander to v4 Apr 4, 2023
@renovate renovate bot reopened this Apr 4, 2023
@renovate renovate bot restored the renovate/commander-4.x branch April 4, 2023 08:12
@renovate renovate bot force-pushed the renovate/commander-4.x branch from aac5c1d to 7c9cb0a Compare August 11, 2025 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants