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.

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

Update dependency commander to v13 #390

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 30, 2024

This PR contains the following updates:

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

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 is behind base branch, 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 added the renovate label Dec 30, 2024
Copy link
Contributor Author

renovate bot commented Dec 30, 2024

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: package-lock.json
npm error code ERESOLVE
npm error ERESOLVE could not resolve
npm error
npm error While resolving: @commander-js/[email protected]
npm error Found: [email protected]
npm error node_modules/commander
npm error   commander@"13.1.0" from the root project
npm error
npm error Could not resolve dependency:
npm error peer commander@"~12.1.0" from @commander-js/[email protected]
npm error node_modules/@commander-js/extra-typings
npm error   @commander-js/extra-typings@"12.1.0" from the root project
npm error
npm error Conflicting peer dependency: [email protected]
npm error node_modules/commander
npm error   peer commander@"~12.1.0" from @commander-js/[email protected]
npm error   node_modules/@commander-js/extra-typings
npm error     @commander-js/extra-typings@"12.1.0" from the root project
npm error
npm error Fix the upstream dependency conflict, or retry
npm error this command with --force or --legacy-peer-deps
npm error to accept an incorrect (and potentially broken) dependency resolution.
npm error
npm error
npm error For a full report see:
npm error /tmp/renovate/cache/others/npm/_logs/2025-02-14T02_36_28_256Z-eresolve-report.txt
npm error A complete log of this run can be found in: /tmp/renovate/cache/others/npm/_logs/2025-02-14T02_36_28_256Z-debug-0.log

@renovate renovate bot force-pushed the renovate/commander-13.x branch 6 times, most recently from bfd16bb to 4dde47d Compare January 6, 2025 12:36
@renovate renovate bot force-pushed the renovate/commander-13.x branch 9 times, most recently from fe47c6c to 1e0324a Compare January 15, 2025 10:39
@renovate renovate bot force-pushed the renovate/commander-13.x branch 5 times, most recently from 0d1d8cc to 2bee009 Compare January 22, 2025 12:38
@renovate renovate bot force-pushed the renovate/commander-13.x branch 6 times, most recently from ecb011d to 62c427b Compare January 28, 2025 08:35
@renovate renovate bot force-pushed the renovate/commander-13.x branch 2 times, most recently from 8a51d26 to b8448a9 Compare February 1, 2025 00:28
@renovate renovate bot force-pushed the renovate/commander-13.x branch 5 times, most recently from 62a924c to 2c82335 Compare February 10, 2025 13:41
@renovate renovate bot force-pushed the renovate/commander-13.x branch 3 times, most recently from af07a2f to 7ded8ec Compare February 13, 2025 19:34
@renovate renovate bot force-pushed the renovate/commander-13.x branch from 7ded8ec to 0b366c2 Compare February 14, 2025 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants