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 v12 #28

Merged
merged 1 commit into from
Jun 5, 2024
Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 13, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
commander ^11.1.0 -> ^12.0.0 age adoption passing confidence

Release Notes

tj/commander.js (commander)

v12.1.0

Compare Source

Added

v12.0.0

Compare Source

Added
  • .addHelpOption() as another way of configuring built-in help option ([#​2006])
  • .helpCommand() for configuring built-in help command ([#​2087])
Fixed
  • Breaking: use non-zero exit code when spawned executable subcommand terminates due to a signal ([#​2023])
  • Breaking: check passThroughOptions constraints when using .addCommand and throw if parent command does not have .enablePositionalOptions() enabled ([#​1937])
Changed
  • Breaking: Commander 12 requires Node.js v18 or higher ([#​2027])
  • Breaking: throw an error if add an option with a flag which is already in use ([#​2055])
  • Breaking: throw an error if add a command with name or alias which is already in use ([#​2059])
  • Breaking: throw error when calling .storeOptionsAsProperties() after setting an option value ([#​1928])
  • replace non-standard JSDoc of @api private with documented @private ([#​1949])
  • .addHelpCommand() now takes a Command (passing string or boolean still works as before but deprecated) ([#​2087])
  • refactor internal implementation of built-in help option ([#​2006])
  • refactor internal implementation of built-in help command ([#​2087])
Deprecated
  • .addHelpCommand() passing string or boolean (use .helpCommand() or pass a Command) ([#​2087])
Removed
  • Breaking: removed default export of a global Command instance from CommonJS (use the named program export instead) ([#​2017])
Migration Tips

global program

If you are using the deprecated default import of the global Command object, you need to switch to using a named import (or create a new Command).

// const program = require('commander');
const { program } = require('commander');

option and command clashes

A couple of configuration problems now throw an error, which will pick up issues in existing programs:

  • adding an option which uses the same flag as a previous option
  • adding a command which uses the same name or alias as a previous command

Configuration

📅 Schedule: Branch creation - "before 4am on Monday" (UTC), 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 has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot force-pushed the renovate/commander-12.x branch 4 times, most recently from e2a147e to caa31c5 Compare May 13, 2024 20:51
@renovate renovate bot force-pushed the renovate/commander-12.x branch 2 times, most recently from e812884 to 471570a Compare June 5, 2024 09:18
@renovate renovate bot force-pushed the renovate/commander-12.x branch from 471570a to c7667d6 Compare June 5, 2024 09:38
@DanielleHuisman DanielleHuisman merged commit 8c98a50 into main Jun 5, 2024
1 check passed
@DanielleHuisman DanielleHuisman deleted the renovate/commander-12.x branch June 5, 2024 09:45
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.

1 participant