Bump Rust edition, use caret requirements, upgrade to clap 4 #104
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
March 22, 2024 13:03
I ran `cargo msrv` and the minimum version of this crate was 1.64.0 so bumping the Rust edition does not raise the minimum
It seems caret requirements is the default semver compatible strategy https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#caret-requirements
Pi-Cla
changed the title
I did this because clap 2 and 3 has a dependency on atty which is unmaintained and has a potential security vulnerability https://rustsec.org/advisories/RUSTSEC-2021-0145 clap 4 migration details: - Arg::with_name() has been replaced with Arg::new() - possible_values has been replaced with value_parser - args.value_of has been replaced with args.get_one::<String> - args.gen_completions_to() has been replaced with generate() - The way we use args.is_present() means it is replaced with contains_id() - Shell completion has been moved to the clap_complete crate - app_from_crate! has been replaced with command! * Which now requires a the `cargo` feature flag to access - line wrapping is now behind a feature flag `wrap_help` * Migration guide recommends we enable this or else we would need to manually implement line wrapping - Args are now assumed to take values by default so in order to specify a flag we need to append .action(ArgAction::SetTrue) to each arg. * takes_value() has been removed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Running
cargo msrvrevealed that the minimum Rust version of this crate is already 1.64.0 so bumping the Rust edition does not effect the minimum. Also caret requirements are looser than tilde but still semver compatible so it should be good to switch (when a version is just like "2.33"cargodefaults to caret requirements)I have also decided to migrate the crate to clap 4 because clap 2 and 3 depend on an unmaintained crate with a potential security vulnerability https://rustsec.org/advisories/RUSTSEC-2021-0145
I placed the details on the migration to clap 4 in the corresponding commit message
I have ran both
cargo buildandcargo testand everything still worksHowever, the migration to the latest version of clap 4 does raise the msrv to 1.74.1
Alternatively clap and clap_complete could be pinned at version 4.2.1 to instead only have an msrv increase to 1.67.1.
Since they bumped their internal dependencies in 4.2.2
Feel free to ask any questions about this PR
Migration guide to clap 3
Migration guide to clap 4