Add command suggestions feature #1022
Open
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
krepysh
force-pushed
the
1021_add_commands_suggestions
branch
2 times, most recently
from
ce0d78f to
ae33263
Compare
krepysh
commented
Feb 10, 2025
krepysh
force-pushed
the
1021_add_commands_suggestions
branch
from
ae33263 to
6b6d9af
Compare
krepysh
force-pushed
the
1021_add_commands_suggestions
branch
from
6b6d9af to
ed400b8
Compare
krepysh
commented
Mar 7, 2025
| Argument( | ||
| names=("suggestions", "s"), | ||
| kind=bool, | ||
| default=True, |
There was a problem hiding this comment.
Is it possible to default here to True?
If someone wanted to disable new feature, it is possible with --no-suggestions flag I guess.
This change prevent program from crashing, when ParseError is raised due to processing core args
krepysh
force-pushed
the
1021_add_commands_suggestions
branch
from
ed400b8 to
9455d8a
Compare
krepysh
force-pushed
the
1021_add_commands_suggestions
branch
5 times, most recently
from
09ddae8 to
44ef6ce
Compare
krepysh
force-pushed
the
1021_add_commands_suggestions
branch
from
44ef6ce to
1ca1904
Compare
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.
🚀 Description
💁 Why is this change needed?
This update enhances Invoke’s error handling by providing command suggestions when a command is mistyped, similar to how Git and Django’s
manage.pyhandle such errors.This feature is especially useful for projects with complex command structures, particularly those involving multiple namespaces and deep nesting. In such cases, offering quick suggestions from the CLI tool significantly improves the user experience and efficiency.
🧑💻 Technical details
I implemented pattern matching using the
difflibmodule, which is part of Python’s standard library, so no additional dependencies are required.Additionally, a new argument,
--[no-]suggestions(or-S), was introduced which defaults toTrue.📷 Demonstration
invoke_public_demo.mov
♻️ Related to
This PR addresses issue #1021 and also related to PR #1010