shymega / scrob

Pluggable, open-source audio scrobbler, for crustaceans.
MIT License
13 stars 1 forks source link

Bump clap from 3.2.22 to 4.0.0 #16

Closed dependabot[bot] closed 1 year ago

dependabot[bot] commented 1 year ago

Bumps clap from 3.2.22 to 4.0.0.

Release notes

Sourced from clap's releases.

v4.0.0-rc.3

Breaking Changes

  • ArgAction::Set, ArgAction::SetTrue, and Arg::Action::SetFalse now conflict by default to be like ArgAction::StoreValue and ArgAction::IncOccurrences, requiring cmd.args_override_self(true) to override instead (#4261)
  • (help) Line wrapping of help is now behind the existing wrap_help feature flag, either enable it or hard code your wraps (#4258)

Features

  • Add From<&OsStr>, From<OsString>, From<&str>, and From<String> to value_parser! (#4257)
  • Added StyledStr::ansi() to Display with ANSI escape codes
  • (error) Added Error::render which returns a StyledStr
  • (help) Command::render_usage now returns a StyledStr
  • (help) Command::render_help and Command::render_long_help which returned StyledStr
  • (help) Command::render_usage now returns a StyledStr which returned StyledStr

v4.0.0-rc.2

Documentation

  • (derive) Clarify relationship with value parser (#4244)

v4.0.0-rc.1

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

... (truncated)

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