During implementation of bash completion to core commands, I found the code quite verbose. The completion for all options and arguments are mixed into the same method.

Example of current code

symfony/src/Symfony/Component/Console/Command/HelpCommand.php

Lines 85 to 98 in098ff62

	publicfunctioncomplete(CompletionInput$input,CompletionSuggestions$suggestions):void
	{
	if ($input->mustSuggestArgumentValuesFor('command_name')) {
	$descriptor =newApplicationDescription($this->getApplication());
	$suggestions->suggestValues(array_keys($descriptor->getCommands()));

	return;
	}

	if ($input->mustSuggestOptionValuesFor('format')) {
	$helper =newDescriptorHelper();
	$suggestions->suggestValues($helper->getFormats());
	}
	}

This PR adds the possibility to attach values to each option and argument in their definition. It provides a default implementation ofCommand::complete that uses this values.

In the constructor of theInputOption andInputArgument classes:

symfony/src/Symfony/Component/Console/Command/HelpCommand.php

Lines 40 to 45 in091027a

	newInputArgument('command_name', InputArgument::OPTIONAL,'The command name','help',function () {
	returnarray_keys((newApplicationDescription($this->getApplication()))->getCommands());
	}),
	newInputOption('format',null, InputOption::VALUE_REQUIRED,'The output format (txt, xml, json, or md)','txt',function () {
	return (newDescriptorHelper())->getFormats();
	}),

Or usingCommand::addOption andCommand::addArgument:

symfony/src/Symfony/Component/Console/Command/DumpCompletionCommand.php

Line 78 in091027a

->addArgument('shell', InputArgument::OPTIONAL,'The shell type (e.g. "bash"), the value of the "$SHELL" env var will be used if this is not given',null,fn () =>$this->getSupportedShells())

Additional benefits:

Command defined without a class can add completion.
Descriptor can show if an option/argument has completion (and values could be shown).
Easier to share suggestions when the same options are defined on several commands (forAdd completion to commands options and arguments composer/composer#10320)

Todo:

Add tests
Add info to descriptor

GromNaN requested a review fromchalasr as acode owner

January 7, 2022 22:12

carsonbot added Status: Needs Review Console Feature labels

Jan 7, 2022

carsonbot added this to the6.1 milestone

Jan 7, 2022

GromNaN commented

Jan 7, 2022

View reviewed changes

src/Symfony/Component/Console/Command/Command.php OutdatedShow resolvedHide resolved

GromNaN force-pushed theconsole-completion-definition branch 2 times, most recently from8650876 todfb4cc6Compare

January 7, 2022 22:29

GromNaN commented

Jan 7, 2022

View reviewed changes

src/Symfony/Component/Console/Input/InputArgument.php OutdatedShow resolvedHide resolved

Copy link

Member

wouterj commentedJan 7, 2022•
edited
Loading

I haven't looked at the code yet, but I really like the idea. See also these 2 comments on the original PR:#42251 Being able to predict whether an option has a value or not and maybe even dumping the static values to the completion file (e.g. for apps like Composer) are 2 other very interesting advantages of this approach.

Fromhttps://github.com/posener/complete , mentioned in the comments I referenced above, I especially like the Predict enum:

 "name":      predict.Set{"foo", "bar", "foo bar"}, "something": predict.Something, "nothing":   predict.Nothing,

Set: values are static, can be dumped (or described)
Something: We'll have to invoke the_complete command for this
Nothing: Skip completion, this option has no value (or value is not autocompletable).

We can even extend this with e.g. Files, to enable the great file completion system of shell completion.

GromNaN force-pushed theconsole-completion-definition branch 2 times, most recently from0f93398 tof8e03dbCompare

January 8, 2022 12:15

Copy link

MemberAuthor

GromNaN commentedJan 10, 2022•
edited
Loading

After you comment@wouterj, I think we can use a union type that covers each cases.

true: callingcomplete.
false: disable completion
\Closure: call it
iterable: get fixed values from the iterable
null: not defined, will callcomplete by default. Settingnull should be deprecated and becomefalse by default in7.0.