Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Conversation

@dependabot-preview
Copy link
Contributor

Bumps commander from 2.20.0 to 3.0.0.

Release notes

Sourced from commander's releases.

v3.0.0

  • Add option to specify executable file name (#999)
    • e.g. .command('clone', 'clone description', { executableFile: 'myClone' })
  • Change docs for .command to contrast action handler vs git-style executable. (#938 #990)
  • Breaking Change TypeScript to use overloaded function for .command. (#938 #990)
  • Change to use straight quotes around strings in error messages (like 'this' instead of `this') (#915)
  • Add TypeScript "reference types" for node (#974)
  • Add support for hyphen as an option argument in subcommands (#697)
  • Add support for a short option flag and its value to be concatenated for action handler subcommands (#599)
    • e.g. -p 80 can also be supplied as -p80
  • Add executable arguments to spawn in win32, for git-style executables (#611)
    • e.g. node --harmony myCommand.js clone
  • Add parent command as prefix of subcommand in help (#980)
  • Add optional custom description to .version (#963)
    • e.g. program.version('0.0.1', '-v, --vers', 'output the current version')
  • Add .helpOption(flags, description) routine to customise help flags and description (#963)
    • e.g. .helpOption('-e, --HELP', 'read more information')
  • Fix behavior of --no-* options (#795)
    • can now define both --foo and --no-foo
    • Breaking custom event listeners: --no-foo on cli now emits option:no-foo (previously option:foo)
    • Breaking default value: defining --no-foo after defining --foo leaves the default value unchanged (previously set it to false)
    • allow boolean default value, such as from environment (#987)
  • Increment inspector port for spawned subcommands (#991)
    • e.g. node --inspect myCommand.js clone

Example Breaking Changes

The custom event for a negated option like --no-foo is option:no-foo (previously option:foo).

program
  .option('--no-foo')
  .on('option:no-foo', () => {
    console.log('removing foo');
  });

When using TypeScript, adding a command does not allow an explicit undefined for an unwanted executable description (e.g. for a command with an action handler).

program
  .command('action1', undefined, { noHelp: true }) // No longer valid
  .command('action2', { noHelp: true }) // Correct

v3.0.0-0 Prerelease

(Released as 3.0.0)

Changelog

Sourced from commander's changelog.

3.0.0 / 2019-08-08

  • Add option to specify executable file name (#999)
    • e.g. .command('clone', 'clone description', { executableFile: 'myClone' })
  • Change docs for .command to contrast action handler vs git-style executable. (#938 #990)
  • Breaking Change TypeScript to use overloaded function for .command. (#938 #990)
  • Change to use straight quotes around strings in error messages (like 'this' instead of `this') (#915)
  • Add TypeScript "reference types" for node (#974)
  • Add support for hyphen as an option argument in subcommands (#697)
  • Add support for a short option flag and its value to be concatenated for action handler subcommands (#599)
    • e.g. -p 80 can also be supplied as -p80
  • Add executable arguments to spawn in win32, for git-style executables (#611)
    • e.g. node --harmony myCommand.js clone
  • Add parent command as prefix of subcommand in help (#980)
  • Add optional custom description to .version (#963)
    • e.g. program.version('0.0.1', '-v, --vers', 'output the current version')
  • Add .helpOption(flags, description) routine to customise help flags and description (#963)
    • e.g. .helpOption('-e, --HELP', 'read more information')
  • Fix behavior of --no-* options (#795)
    • can now define both --foo and --no-foo
    • Breaking custom event listeners: --no-foo on cli now emits option:no-foo (previously option:foo)
    • Breaking default value: defining --no-foo after defining --foo leaves the default value unchanged (previously set it to false)
    • allow boolean default value, such as from environment (#987)
  • Increment inspector port for spawned subcommands (#991)
    • e.g. node --inspect myCommand.js clone

Example Breaking Changes

The custom event for a negated option like --no-foo is option:no-foo (previously option:foo).

program
  .option('--no-foo')
  .on('option:no-foo', () => {
    console.log('removing foo');
  });

When using TypeScript, adding a command does not allow an explicit undefined for an unwanted executable description (e.g
for a command with an action handler).

program
  .command('action1', undefined, { noHelp: true }) // No longer valid
  .command('action2', { noHelp: true }) // Correct

#599: #599

... (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 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)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

Bumps [commander](https://github.com/tj/commander.js) from 2.20.0 to 3.0.0.
- [Release notes](https://github.com/tj/commander.js/releases)
- [Changelog](https://github.com/tj/commander.js/blob/master/CHANGELOG.md)
- [Commits](tj/commander.js@v2.20.0...v3.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
@dependabot-preview dependabot-preview bot added the dependencies Pull requests that update a dependency file label Aug 9, 2019
@pksunkara pksunkara merged commit 8c656f5 into master Aug 19, 2019
@pksunkara pksunkara deleted the dependabot/npm_and_yarn/commander-3.0.0 branch August 19, 2019 11:54
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.

1 participant