fix: Ease clap2->3 transition for Settings #2907
Merged
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
|
We haven't decided on #2617 yet. |
epage
force-pushed
the
2to3-settings
branch
3 times, most recently
from
4003776 to
8ee7173
Compare
This brings back the old name of settings, just deprecated. Since they all map to the same bits in the bit field, this should work for `setting` and `is_set`. The only thing this lacks is being able to do equality across variants, whcih seems like a minority case. Removed settings have some extra care abouts that we'll need to look into separately. This is a part of clap-rs#2617
This partiall reverts commit efeb02c, bringing back the `AppSettins::Color*` and making them the backing store for `App::color`, to help ease the transition from clap2->3. Once we remove these deprecated settings, we might want to keep this backing store to save on memory. This is a part of clap-rs#2617
We prefer Settings to always be off by default, so when we change a default, we have to rename. This adds back in the now-default settings with deprecation messages to help the user know how things now work. Unfortunately, there is no way to notify the user that the default they relied on has changed. This also doesn't help us when the change in behavior is more than just an inverting, like `InvalidUtf8` or when a setting mapped to multiple bits.
|
I'm good with these changes. I think it will help the porting burden. We'll need to watch for any edge cases around the @pksunkara if we need to split off additional discussion in #2617 that isn't related to this PR or adding back in old, but compatible APIs with deprecation notices we can and probably should do that. I'm good with forwarding to new APIs with deprecation notices to make the porting process easier. |
|
bors r+ |
kbknapp
approved these changes
Nov 3, 2021
|
Build succeeded: |
epage
added a commit
to epage/clap
that referenced
this pull request
Nov 11, 2021
In clap-rs#2851, we moved color from an AppSetting to function (with some tweaks in clap-rs#2907). When doing this, we documented `App::color` to be equivelant of `App::global_settings(Color...)` but never actually propogated it. We are now propogating it. A test is added to ensure that no matter how we store the color choice, we continue to propogate it. This required exposing `App::get_color`.
epage
added a commit
to epage/clap
that referenced
this pull request
Nov 11, 2021
In clap-rs#2851, we moved color from an AppSetting to function (with some tweaks in clap-rs#2907). When doing this, we documented `App::color` to be equivalent of `App::global_settings(Color...)` but never actually propagated it. We are now propagating it. A test is added to ensure that no matter how we store the color choice, we continue to propagate it. This required exposing `App::get_color`.
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.
This is handling non-behavior changes in Settings as part of #2617