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

build(deps): update dependency commander to v7 - old #8676

Merged
merged 2 commits into from
Feb 15, 2021

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 13, 2021

WhiteSource Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
commander 6.2.1 -> 7.0.0 age adoption passing confidence

Release Notes

tj/commander.js

v7.0.0

Compare Source

Added
  • .enablePositionalOptions() to let program and subcommand reuse same option ([#​1427])
  • .passThroughOptions() to pass options through to other programs without needing -- ([#​1427])
  • .allowExcessArguments(false) to show an error message if there are too many command-arguments on command line for the action handler ([#​1409])
  • .configureOutput() to modify use of stdout and stderr or customise display of errors ([#​1387])
  • use .addHelpText() to add text before or after the built-in help, for just current command or also for all subcommands ([#​1296])
  • enhance Option class ([#​1331])
    • allow hiding options from help
    • allow restricting option arguments to a list of choices
    • allow setting how default value is shown in help
  • .createOption() to support subclassing of automatically created options (like .createCommand()) ([#​1380])
  • refactor the code generating the help into a separate public Help class ([#​1365])
    • support sorting subcommands and options in help
    • support specifying wrap width (columns)
    • allow subclassing Help class
    • allow configuring Help class without subclassing
Changed
  • Breaking: options are stored safely by default, not as properties on the command ([#​1409])
    • this especially affects accessing options on program, use program.opts()
    • revert behaviour with .storeOptionsAsProperties()
  • Breaking: action handlers are passed options and command separately ([#​1409])
  • deprecated callback parameter to .help() and .outputHelp() (removed from README) ([#​1296])
  • Breaking: errors now displayed using process.stderr.write() instead of console.error()
  • deprecate .on('--help') (removed from README) ([#​1296])
  • initialise the command description to empty string (previously undefined) ([#​1365])
  • document and annotate deprecated routines ([#​1349])
Fixed
  • wrapping bugs in help ([#​1365])
    • first line of command description was wrapping two characters early
    • pad width calculation was not including help option and help command
    • pad width calculation was including hidden options and commands
  • improve backwards compatibility for custom command event listeners ([#​1403])
Deleted
  • Breaking: .passCommandToAction() ([#​1409])
    • no longer needed as action handler is passed options and command
  • Breaking: "extra arguments" parameter to action handler ([#​1409])
    • if being used to detect excess arguments, there is now an error displayed by default
Migration Tips

The biggest change is the parsed option values. Previously the options were stored by default as properties on the command object, and now the options are stored separately.

If you wish to restore the old behaviour and get running quickly you can call .storeOptionsAsProperties().
To allow you to move to the new code patterns incrementally, the action handler will be passed the command twice,
to match the new "options" and "command" parameters (see below).

program options

Use the .opts() method to access the options. This is available on any command but is used most with the program.

program.option('-d, --debug');
program.parse();
// Old code before Commander 7
if (program.debug) console.log(`Program name is ${program.name()}`);
// New code
const options = program.opts();
if (options.debug) console.log(`Program name is ${program.name()}`);

action handler

The action handler gets passed a parameter for each command-argument you declared. Previously by default the next parameter was the command object with the options as properties. Now the next two parameters are instead the options and the command. If you
only accessed the options there may be no code changes required.

program
  .command('compress <filename>')
  .option('-t, --trace')
  // Old code before Commander 7
  .action((filename, cmd)) => {
    if (cmd.trace) console.log(`Command name is ${cmd.name()}`);
  });
  // New code
  .action((filename, options, command)) => {
    if (options.trace) console.log(`Command name is ${command.name()}`);
  });

If you already set .storeOptionsAsProperties(false) you may still need to adjust your code.

program
  .command('compress <filename>')
  .storeOptionsAsProperties(false)
  .option('-t, --trace')
  // Old code before Commander 7
  .action((filename, command)) => {
    if (command.opts().trace) console.log(`Command name is ${command.name()}`);
  });
   // New code
   .action((filename, options, command)) => {
      if (command.opts().trace) console.log(`Command name is ${command.name()}`);
   });

Renovate configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Renovate will not automatically rebase this PR, because other commits have been found.

🔕 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 WhiteSource Renovate. View repository job log here.

@renovate renovate bot force-pushed the renovate/commander-7.x branch 4 times, most recently from daabc52 to c5a193b Compare February 13, 2021 11:03
@rarkins rarkins marked this pull request as draft February 13, 2021 16:42
@renovate renovate bot force-pushed the renovate/commander-7.x branch 3 times, most recently from f10abc7 to 19c7631 Compare February 14, 2021 10:47
@rarkins rarkins marked this pull request as ready for review February 15, 2021 07:56
@rarkins rarkins merged commit 0837551 into master Feb 15, 2021
@rarkins rarkins deleted the renovate/commander-7.x branch February 15, 2021 07:56
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 24.49.10 🎉

The release is available on:

Your semantic-release bot 📦🚀

rarkins added a commit that referenced this pull request Feb 16, 2021
@viceice viceice restored the renovate/commander-7.x branch February 16, 2021 15:35
@viceice viceice deleted the renovate/commander-7.x branch February 16, 2021 15:35
@viceice
Copy link
Member

viceice commented Feb 16, 2021

@rarkins What happened to revert this?

@rarkins
Copy link
Collaborator

rarkins commented Feb 16, 2021

The dispatch tool broke and kept trying to publish 0.0.0-semantic-release

@viceice
Copy link
Member

viceice commented Feb 16, 2021

ok, so renaming this pr will bring this back to pending?

@rarkins rarkins changed the title build(deps): update dependency commander to v7 build(deps): update dependency commander to v7 - old Feb 16, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants