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

chore(deps): update dependency commander to v12 #1809

Merged
merged 2 commits into from
Apr 29, 2024
Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Apr 29, 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.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 - "after 4:00 am on Friday on the 1st through 7th day of the month every 3 month" in timezone Australia/Melbourne, 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 requested review from bchew and xiaofan2406 April 29, 2024 01:13
@codecov-commenter
Copy link

codecov-commenter commented Apr 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.74%. Comparing base (2f0b97b) to head (318a579).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1809   +/-   ##
=======================================
  Coverage   99.74%   99.74%           
=======================================
  Files         102      102           
  Lines        1962     1962           
  Branches      566      566           
=======================================
  Hits         1957     1957           
  Misses          5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

sonarcloud bot commented Apr 29, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@bchew bchew merged commit 4ba6061 into master Apr 29, 2024
8 checks passed
@bchew bchew deleted the renovate-commander-12.x branch April 29, 2024 02:15
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.

2 participants