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

Upgrade to latest version of Clap #1598

Closed
chriskrycho opened this issue Dec 19, 2023 · 6 comments · Fixed by #1649
Closed

Upgrade to latest version of Clap #1598

chriskrycho opened this issue Dec 19, 2023 · 6 comments · Fixed by #1649
Labels
dependencies Pull requests that update a dependency file enhancement good first issue

Comments

@chriskrycho
Copy link
Contributor

We are currently on Clap v2; Clap has released v3 and v4 (and, just a few weeks ago, v5) over the time since we adopted it, and many of the features we use via third party integration are now nicely integrated into the library itself. Upgrading should be relatively straightforward, following the migration guides:

While v5 has some small breaking changes, they should not affect us.

Note that this will slightly affect our help output, but should not change the behavior or the program or the things we programmatically emit (e.g. volta list).

@chriskrycho chriskrycho added enhancement good first issue dependencies Pull requests that update a dependency file labels Dec 19, 2023
@gautamprikshit1
Copy link
Contributor

May I?

@chriskrycho
Copy link
Contributor Author

By all means! Feel free to ask questions here or (for more responsive feedback) in Discord, and ping @charlespierce or myself there! We're all rather in-and-out this week and next for holidays, but will be happy to help as we're able!

@chriskrycho
Copy link
Contributor Author

One other tip, on re-reading my write-up above, @gautamprikshit1 – your best move will be to tackle it by chunking it into much smaller PRs. I would suggest first creating PRs for any deprecations for v2 to v3 (and structopt), then do the v2 to v3 upgrade as a dedicated PR, and then repeat the process for the v3 to v4 upgrade.

@gautamprikshit1
Copy link
Contributor

To upgrade to clap v4, MSRV needs to be updated and upgrading to clap v3 is stuck on an error which requires the string feature of the library which was introduced in clap v4

@chriskrycho
Copy link
Contributor Author

This should be unblocked now that #1611 is merged!

@chriskrycho
Copy link
Contributor Author

@gautamprikshit1 it looks like @tottoto ended up getting this done in parallel with the efforts you started a couple weeks ago (see #1649). Thanks, though!

@chriskrycho chriskrycho linked a pull request Jan 17, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file enhancement good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants