Skip to content

chore(deps): update dependency commander to v13#123

Merged
ScharfViktor merged 1 commit into
mainfrom
renovate/commander-13.x
Feb 10, 2025
Merged

chore(deps): update dependency commander to v13#123
ScharfViktor merged 1 commit into
mainfrom
renovate/commander-13.x

Conversation

@renovate

@renovate renovate Bot commented Feb 7, 2025

Copy link
Copy Markdown
Contributor

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
commander 12.1.0 -> 13.1.0 age adoption passing confidence

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.


Release Notes

tj/commander.js (commander)

v13.1.0

Compare Source

Added
  • support a pair of long option flags to allow a memorable shortened flag, like .option('--ws, --workspace') ([#​2312])

v13.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])
  • 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);
});

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.

@JammingBen

Copy link
Copy Markdown
Member

@ScharfViktor I guess you know the commander dependency best since you've implemented it via the QA activity report. Could you please check if everything runs as expected with this version bump?

@renovate renovate Bot force-pushed the renovate/commander-13.x branch from bdd7e59 to 965835d Compare February 10, 2025 09:45
@ScharfViktor

Copy link
Copy Markdown
Contributor

@ScharfViktor I guess you know the commander dependency best since you've implemented it via the QA activity report. Could you please check if everything runs as expected with this version bump?

checked. works correct

@ScharfViktor ScharfViktor merged commit a623710 into main Feb 10, 2025
@ScharfViktor ScharfViktor deleted the renovate/commander-13.x branch February 10, 2025 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants