[Console] Add completion to help & list commands #43596
Merged
Conversation
This file contains hidden or 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
c26a37f to
145c0f7
Compare
54 tasks
fabpot
approved these changes
Oct 20, 2021
wouterj
reviewed
Oct 20, 2021
wouterj
approved these changes
Oct 20, 2021
wouterj
reviewed
Oct 20, 2021
| throw new \LogicException(sprintf('Command "%s" must implement "%s" to support completion.', \get_class($this->command), CompletionInput::class)); | ||
| } | ||
|
|
||
| $currentIndex = \count($input); |
There was a problem hiding this comment.
Shouldn't we make this a parameter (e.g. for cases where the suggestions for argument 1 is different based on argument 2?)
There was a problem hiding this comment.
Please open a PR. The index thing is tricky and I don't know to deal with it.
|
Thank you for starting this initiative @GromNaN ! |
|
Thank you @GromNaN. |
a6e5f8f to
dc94c72
Compare
BenjaminRbt
reviewed
Oct 20, 2021
|
|
||
| public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void | ||
| { | ||
| if ($input->mustSuggestArgumentValuesFor('namespace')) { |
There was a problem hiding this comment.
Would it be an improvement to create a "Helper", in order to have common functions for complete and calling it like this:
public function shouldSuggestValues(string $type): void {
if ($input->mustSuggestArgumentValuesFor($type)) {
$descriptor = new ApplicationDescription($this->getApplication());
$suggestions->suggestValues(array_keys($descriptor->getNamespaces()));
return;
}
if ($input->mustSuggestOptionValuesFor('format')) {
$helper = new DescriptorHelper();
$suggestions->suggestValues($helper->getFormats());
}
}And calling it in the complete function for ListCommand.php and HelpCommand.php?
// ListCommand.php
public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
{
$this->commandHelper->shouldSuggestValues('namespace');
}// HelpCommand.php
public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
{
$this->commandHelper->shouldSuggestValues('command_name');
}?
There was a problem hiding this comment.
Having a helper knowing about argument names of all Symfony commands does not make sense (and would require to make argument names unique across all commands)
chalasr
reviewed
Oct 20, 2021
| * | ||
| * @author Jérôme Tamarelle <jerome@tamarelle.net> | ||
| */ | ||
| class CommandCompletionTester |
fabpot
added a commit
that referenced
this pull request
Oct 30, 2021
…, form, messenger, router (IonBazan) This PR was merged into the 5.4 branch. Discussion ---------- [Console] add suggestions for debug commands: firewall, form, messenger, router | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #43594 | License | MIT | Doc PR | - Adding Bash completion for following commands: - `debug:firewall` - `debug:form` - `debug:messenger` - `debug:router` ~Waiting for #43596 to be merged first as it adds testing utilities and `DescriptorHelper::getFormats()`.~ Commits ------- eaf9461 add suggestions for debug:firewall, debug:form, debug:messenger, debug:router
This was referenced Nov 5, 2021
Merged
Merged
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.
helpandlist--format, supported formats are exposed byDescriptorHelper