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

fix(deps): update dependency commander to v12 #406

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 3, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
commander ^11.0.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

v11.1.0

Compare Source

Fixed
  • TypeScript: update OptionValueSource to allow any string, to match supported use of custom sources ([#​1983])
  • TypeScript: add that Command.version() can also be used as getter ([#​1982])
  • TypeScript: add null return type to Commands.executableDir(), for when not configured ([#​1965])
  • subcommands with an executable handler and only a short help flag are now handled correctly by the parent's help command ([#​1930])
Added
  • registeredArguments property on Command with the array of defined Argument (like Command.options for Option) ([#​2010])
  • TypeScript declarations for Option properties: envVar, presetArg ([#​2019])
  • TypeScript declarations for Argument properties: argChoices, defaultValue, defaultValueDescription ([#​2019])
  • example file which shows how to configure help to display any custom usage in the list of subcommands ([#​1896])
Changed
  • (developer) refactor TypeScript configs for multiple use-cases, and enable checks in JavaScript files in supporting editors ([#​1969])
Deprecated
  • Command._args was private anyway, but now available as registeredArguments ([#​2010])

Configuration

📅 Schedule: Branch creation - "every weekend" in timezone America/Los_Angeles, 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 requested a review from a team as a code owner February 3, 2024 15:10
Copy link

changeset-bot bot commented Feb 3, 2024

⚠️ No Changeset found

Latest commit: c7d770f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@renovate renovate bot force-pushed the renovate/commander-12.x branch 3 times, most recently from 746ed0a to 8e20302 Compare February 10, 2024 15:17
@renovate renovate bot force-pushed the renovate/commander-12.x branch 2 times, most recently from bdc58c4 to 3cc63df Compare February 24, 2024 09:19
@renovate renovate bot force-pushed the renovate/commander-12.x branch 3 times, most recently from 5698736 to 73fcc22 Compare March 2, 2024 09:48
@renovate renovate bot force-pushed the renovate/commander-12.x branch 2 times, most recently from d493568 to 306c0ed Compare March 9, 2024 09:36
@renovate renovate bot force-pushed the renovate/commander-12.x branch from 306c0ed to be9aad8 Compare March 16, 2024 07:31
@renovate renovate bot force-pushed the renovate/commander-12.x branch 2 times, most recently from 3614cad to 4d69908 Compare March 25, 2024 05:20
@renovate renovate bot force-pushed the renovate/commander-12.x branch 3 times, most recently from 7153d85 to ba9a55d Compare April 6, 2024 12:54
@renovate renovate bot force-pushed the renovate/commander-12.x branch from ba9a55d to ff02a0a Compare April 13, 2024 11:37
@renovate renovate bot force-pushed the renovate/commander-12.x branch 3 times, most recently from bd2cd61 to de0375a Compare May 4, 2024 07:16
@renovate renovate bot force-pushed the renovate/commander-12.x branch 2 times, most recently from 6c550f4 to 7cc514a Compare May 11, 2024 14:21
@renovate renovate bot force-pushed the renovate/commander-12.x branch 2 times, most recently from f87dccd to 3aea5b0 Compare May 18, 2024 22:27
@renovate renovate bot force-pushed the renovate/commander-12.x branch 2 times, most recently from d1625fd to 420826c Compare June 1, 2024 12:57
@renovate renovate bot force-pushed the renovate/commander-12.x branch from 420826c to 55973b9 Compare June 2, 2024 01:04
@renovate renovate bot force-pushed the renovate/commander-12.x branch 3 times, most recently from 3fe1013 to 591e7d7 Compare June 16, 2024 22:42
@renovate renovate bot force-pushed the renovate/commander-12.x branch from 591e7d7 to d8a5e4c Compare August 3, 2024 07:56
@renovate renovate bot force-pushed the renovate/commander-12.x branch from d8a5e4c to c7d770f Compare October 26, 2024 08:03
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.

0 participants