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

renovate · 2024-02-03T11:18:18Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
commander	`^7.0.0` -> `^12.0.0`

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

`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])

`v11.0.0`

Compare Source

Fixed

help command works when help option is disabled ([#1864])

Changed

leading and trailing spaces are now ignored by the .arguments() method ([#1874])
refine "types" exports for ESM to follow TypeScript guidelines ([#1886])
Breaking: Commander 11 requires Node.js v16 or higher

`v10.0.1`

Compare Source

Added

improvements to documentation ([#1858], [#1859], [#1860])

Fixed

remove unused Option.optionFlags property from TypeScript definition ([#1844])

Changed

assume boolean option intended if caller passes string instead of hash to .implies() ([#1854])

`v10.0.0`

Compare Source

Added

wrap command description in help ([#1804])

Changed

Breaking: Commander 10 requires Node.js v14 or higher

`v9.5.0`

Compare Source

Added

.getOptionValueSourceWithGlobals() ([#1832])
showGlobalOptions for .configureHelp{} and Help ([#1828])

`v9.4.1`

Compare Source

Fixed

.setOptionValue() now also clears option source ([#1795])
TypeScript: add implied to OptionValueSource for option values set by using .implies() ([#1794])
TypeScript : add undefined to return type of .getOptionValueSource() ([#1794])

Changed

additions to README

`v9.4.0`

Compare Source

Added

preSubcommand hook called before direct subcommands ([#1763])

Fixed

export InvalidOptionArgumentError in esm ([#1756])

Changed

update dependencies ([#1767])

`v9.3.0`

Compare Source

Added

.summary() for a short summary to use instead of description when listing subcommands in help ([#1726])
Option.implies() to set other option values when the option is specified ([#1724])
updated Chinese README with 9.x changes ([#1727])

Fixed

TypeScript: add string[] to .options() default value parameter type for use with variadic options ([#1721])

Deprecated

multi-character short option flag (e.g. -ws) ([#1718])

`v9.2.0`

Compare Source

Added

conditional export of 'types' for upcoming TypeScript module resolution ([#1703])
example file showing two ways to add global options to subcommands ([#1708])

Fixed

detect option conflicts in parent commands of called subcommand ([#1710])

Changed

replace deprecated String.prototype.substr ([#1706])

`v9.1.0`

Compare Source

Added

Option .conflicts() to set conflicting options which can not be specified together ([#1678])
(developer) CodeQL configuration for GitHub Actions ([#1698])

`v9.0.0`

Compare Source

Added

simpler ECMAScript import ([#1589])
Option.preset() allows specifying value/arg for option when used without option-argument (especially optional, but also boolean option) ([#1652])
.executableDir() for custom search for subcommands ([#1571])
throw with helpful message if pass Option to .option() or .requiredOption() ([#1655])
.error() for generating errors from client code just like Commander generated errors, with support for .configureOutput(), .exitOverride(), and .showHelpAfterError() ([#1675])
.optsWithGlobals() to return merged local and global options ([#1671])

Changed

Breaking: Commander 9 requires Node.js v12.20.0 or higher
update package-lock.json to lockfile@2 format ([#1659])
showSuggestionAfterError is now on by default ([#1657])
Breaking: default value specified for boolean option now always used as default value (see .preset() to match some previous behaviours) ([#1652])
default value for boolean option only shown in help if true/false ([#1652])
use command name as prefix for subcommand stand-alone executable name (with fallback to script name for backwards compatibility) ([#1571])
allow absolute path with executableFile ([#1571])
removed restriction that nested subcommands must specify executableFile ([#1571])
TypeScript: allow passing readonly string array to .choices() ([#1667])
TypeScript: allow passing readonly string array to .parse(), .parseAsync(), .aliases() ([#1669])

Fixed

option with optional argument not supplied on command line now works when option already has a value, whether from default value or from previous arguments ([#1652])

Removed

Breaking: removed internal fallback to require.main.filename when script not known from arguments passed to .parse() (can supply details using .name(), and .executableDir() or executableFile) ([#1571])

`v8.3.0`

Compare Source

Added

.getOptionValueSource() and .setOptionValueWithSource(), where expected values for source are one of 'default', 'env', 'config', 'cli' ([#1613])

Deprecated

.command('*'), use default command instead ([#1612])
on('command:*'), use .showSuggestionAfterError() instead ([#1612])

`v8.2.0`

Compare Source

Added

.showSuggestionAfterError() to show suggestions after unknown command or unknown option ([#1590])
add Option support for values from environment variables using .env() ([#1587])

Changed

show error for unknown global option before subcommand (rather than just help) ([#1590])

Removed

TypeScript declaration of unimplemented Option method argumentRejected

`v8.1.0`

Compare Source

Added

.copyInheritedSettings() ([#1557])
update Chinese translations of documentation for Commander v8 ([#1570])
Argument methods for .argRequired() and .argOptional() ([#1567])

`v8.0.0`

Compare Source

Added

.argument(name, description) for adding command-arguments ([#1490])
- supports default value for optional command-arguments ([#1508])
- supports custom processing function ([#1508])
.createArgument() factory method ([#1497])
.addArgument() ([#1490])
Argument supports .choices() ([#1525])
.showHelpAfterError() to display full help or a custom message after an error ([#1534])
.hook() with support for 'preAction' and 'postAction' callbacks ([#1514])
client typing of .opts() return type using TypeScript generics ([#1539])
the number of command-arguments is checked for programs without an action handler ([#1502])
.getOptionValue() and .setOptionValue() ([#1521])

Changed

refactor and simplify TypeScript declarations (with no default export) ([#1520])
.parseAsync() is now declared as async ([#1513])
Breaking: Help method .visibleArguments() returns array of Argument ([#1490])
Breaking: Commander 8 requires Node.js 12 or higher ([#1500])
Breaking: CommanderError code commander.invalidOptionArgument renamed commander.invalidArgument ([#1508])
Breaking: TypeScript declaration for .addTextHelp() callback no longer allows result of undefined, now just string ([#1516])
refactor index.tab into a file per class ([#1522])
remove help suggestion from "unknown command" error message (see .showHelpAfteError()) ([#1534])
Command property .arg initialised to empty array (was previously undefined) ([#1529])
update dependencies

Deprecated

second parameter of cmd.description(desc, argDescriptions) for adding argument descriptions ([#1490])
- (use new .argument(name, description) instead)
InvalidOptionArgumentError (replaced by InvalidArgumentError) ([#1508])

Removed

Breaking: TypeScript declaration for default export of global Command object ([#1520])
- (still available as named program export)

Migration Tips

If you have a simple program without an action handler, you will now get an error if
there are missing command-arguments.

program
  .option('-d, --debug')
  .arguments('<file>');
program.parse();

$ node trivial.js 
error: missing required argument 'file'

If you want to show the help in this situation, you could check the arguments before parsing:

if (process.argv.length === 2)
  program.help();
program.parse();

Or, you might choose to show the help after any user error:

program.showHelpAfterError();

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 has been generated by Mend Renovate. View repository job log here.

vercel · 2024-02-03T11:18:20Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
federation-dashboard	❌ Failed (Inspect)			Feb 3, 2024 11:18am

changeset-bot · 2024-02-03T11:18:22Z

⚠️ No Changeset found

Latest commit: 7f24f64

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

fix(deps): update dependency commander to v12

7f24f64

vercel bot had a problem deploying to Preview February 3, 2024 11:18 Failure

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

renovate bot commented Feb 3, 2024

vercel bot commented Feb 3, 2024 •

edited

changeset-bot bot commented Feb 3, 2024

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

Are you sure you want to change the base?

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

Conversation

renovate bot commented Feb 3, 2024

Release Notes

Added

Fixed

Changed

Deprecated

Removed

Migration Tips

Fixed

Added

Changed

Deprecated

Fixed

Changed

Added

Fixed

Changed

Added

Changed

Added

Fixed

Changed

Added

Fixed

Changed

Added

Fixed

Deprecated

Added

Fixed

Changed

Added

Added

Changed

Fixed

Removed

Added

Deprecated

Added

Changed

Removed

Added

Added

Changed

Deprecated

Removed

Migration Tips

Configuration

vercel bot commented Feb 3, 2024 • edited

changeset-bot bot commented Feb 3, 2024

⚠️ No Changeset found

vercel bot commented Feb 3, 2024 •

edited