Skip to content
This repository has been archived by the owner on Jul 18, 2021. It is now read-only.

Bump commander from 7.2.0 to 8.0.0 #1283

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

Conversation

dependabot-preview[bot]
Copy link
Contributor

Bumps commander from 7.2.0 to 8.0.0.

Release notes

Sourced from commander's releases.

v8.0.0

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();

... (truncated)

Changelog

Sourced from commander's changelog.

[8.0.0] (2021-06-25)

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();
</tr></table> 

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot will not automatically merge this PR because it includes an out-of-range update to a production dependency.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
  • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
  • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
  • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
  • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
  • @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

  • Update frequency (including time of day and day of week)
  • Pull request limits (per update run and/or open at any time)
  • Automerge options (never/patch/minor, and dev/runtime dependencies)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

@dependabot-preview dependabot-preview bot added the dependencies Pull requests that update a dependency file label Jun 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants