cli: render string pattern suggestion as a hint #3399
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
…or object I'm going to add RevsetParseError constructor for InvalidFunctionArguments, with/without a source error, and I don't want to duplicate code for all combinations. The templater change is just for consistency. I couldn't find a good naming convention for the builder-like API, so it's called .with_source(mut self, _). Another option was .source_set(source). Apparently, it's not uncommon to name consuming constructor as with_<something>().
I also renamed "UnexpectedExpression" to just "Expression" because "unexpected" doesn't apply to "immutable" revset parse/evaluation errors.
It was only needed to attach the source error object, which is now handled by the outer error type.
Inlined some of the make_error() closures instead. I'll make string pattern handler preserve the source error object.
This helps to add hint at the CLI layer.
Templater doesn't have the one yet, but I think it belongs to the same category. For clap::Error, we could use clap's own mechanism to render suggestions as "tip: ...", but I feel "Hint: ..." looks better because our error/hint message is capitalized.
martinvonz
approved these changes
Mar 30, 2024
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.
Checklist
If applicable:
CHANGELOG.md