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

Update clap requirement from 3.0 to 4.0 #230

Merged
merged 4 commits into from
Oct 3, 2022
Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 28, 2022

Updates the requirements on clap to permit the latest version.

Changelog

Sourced from clap's changelog.

[4.0.0] - 2022-09-28

Highlights

Arg::num_args(range)

Clap has had several ways for controlling how many values will be captured without always being clear on how they interacted, including

  • Arg::multiple_values(true)
  • Arg::number_of_values(4)
  • Arg::min_values(2)
  • Arg::max_values(20)
  • Arg::takes_value(true)

These have now all been collapsed into Arg::num_args which accepts both single values and ranges of values. num_args controls how many raw arguments on the command line will be captured as values per occurrence and independent of value delimiters.

See Issue 2688 for more background.

Polishing Help

Clap strives to give a polished CLI experience out of the box with little ceremony. With some feedback that has accumulated over time, we took this release as an opportunity to re-evaluate our --help output to make sure it is meeting that goal.

In doing this evaluation, we wanted to keep in mind:

  • Whether other CLIs had ideas that make sense to apply
  • Providing an experience that fits within the rest of applications and works across all shells

Before:

git
A fictional versioning CLI

USAGE: git <SUBCOMMAND>

OPTIONS: -h, --help Print help information

SUBCOMMANDS: add adds things clone Clones repos help Print this message or the help of the given subcommand(s) push pushes things stash

... (truncated)

Commits
  • 3a74d82 chore: Release
  • 9cd1939 Merge pull request #4269 from epage/usage
  • cb1cd67 fix(error): Include failed arg in usage in --flag=bad-value error
  • 12d76d6 fix(error): Include 'Usage:' title in --flag=bad-value error
  • 3a8d2a5 test(parser): Verify existing --flag=bad-value case
  • c7dd03e Merge pull request #4267 from jpgrayson/override-usage-help-4
  • f925ca8 docs: Clarify how to use examples
  • 7dd216b docs: Update multiline usage override rules
  • a0c8c7d docs: Clean up StyledStr entries
  • 01672f8 chore: Release
  • Additional commits viewable in compare view

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)

Updates the requirements on [clap](https://github.com/clap-rs/clap) to permit the latest version.
- [Release notes](https://github.com/clap-rs/clap/releases)
- [Changelog](https://github.com/clap-rs/clap/blob/master/CHANGELOG.md)
- [Commits](clap-rs/clap@clap_complete-v3.0.0...clap_complete-v4.0.0)

---
updated-dependencies:
- dependency-name: clap
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added k::dependencies Pull requests that update a dependency file rust Pull requests that update Rust code labels Sep 28, 2022
@tyranron tyranron added the semver::breaking Represents breaking changes label Sep 29, 2022
@ilslv
Copy link
Member

ilslv commented Sep 30, 2022

@tyranron let's postpone the clap upgrade due to clap-rs/clap#4279 (comment)

@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 30, 2022

A newer version of clap exists, but since this PR has been edited by someone other than Dependabot I haven't updated it. You'll get a PR for the updated version as normal once this PR is merged.

@ilslv
Copy link
Member

ilslv commented Oct 3, 2022

ICE on nightly is already reported: rust-lang/rust#102561

@ilslv ilslv requested a review from tyranron October 3, 2022 06:49
@tyranron tyranron added this to the 0.15.0 milestone Oct 3, 2022
Copy link
Member

@tyranron tyranron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ilslv thanks 🍻

@tyranron tyranron merged commit 730e4de into main Oct 3, 2022
@tyranron tyranron deleted the dependabot/cargo/clap-4.0 branch October 3, 2022 10:23
@tyranron tyranron added enhancement Improvement of existing features or bugfix k::api Related to API (application interface) labels Nov 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement of existing features or bugfix k::api Related to API (application interface) k::dependencies Pull requests that update a dependency file rust Pull requests that update Rust code semver::breaking Represents breaking changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants