feat: Adds argument suggestion support for unknown arguments #204
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.
When an undefined prefixed argument is provided, the current default behavior is to ignore this unknown argument.
Some command-line tools (Composer is an example) suggest alternative arguments based on a similarity between the unknown argument and those defined in the script.
This modification adds this functionality to CLImate without breaking compatibility with previous versions and without this functionality being mandatory.
The
League\CLImate\Argument\Manager::getUnknowPrefixedArgumentsAndSuggestions()
method returns an array with the unknown arguments as keys and the best argument suggestion as values, based on the PHP function similar_text.With this result, the developer can easily implement a message to the user informing about the unknown argument and offering alternatives, as in this example: