[Console] Add completion values to input definition #44948

GromNaN · Jan 7, 2022

Q	A
Branch?	6.1
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	n/a
License	MIT
Doc PR	symfony/symfony-docs#...

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 in 098ff62

    
           public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void 
        
           { 
        
               if ($input->mustSuggestArgumentValuesFor('command_name')) { 
        
                   $descriptor = new ApplicationDescription($this->getApplication()); 
        
                   $suggestions->suggestValues(array_keys($descriptor->getCommands())); 
        
                   return; 
        
               } 
        
               if ($input->mustSuggestOptionValuesFor('format')) { 
        
                   $helper = new DescriptorHelper(); 
        
                   $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 of Command::complete that uses this values.

In the constructor of the InputOption and InputArgument classes:

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

Lines 40 to 45 in 091027a

    
           new InputArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help', function () { 
        
               return array_keys((new ApplicationDescription($this->getApplication()))->getCommands()); 
        
           }), 
        
           new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt', function () { 
        
               return (new DescriptorHelper())->getFormats(); 
        
           }),

Or using Command::addOption and Command::addArgument:

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

Line 78 in 091027a

    
           ->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 (for Add completion to commands options and arguments composer/composer#10320)

Todo:

Add tests
Add info to descriptor

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

src/Symfony/Component/Console/Input/InputArgument.php

wouterj · Jan 7, 2022

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.

From https://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 · Jan 10, 2022

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

true: calling complete.
false: disable completion
\Closure: call it
iterable: get fixed values from the iterable
null: not defined, will call complete by default. Setting null should be deprecated and become false by default in 7.0.

We must stay open to file completion once we'd have managed to get it work #43607.

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

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

src/Symfony/Component/Console/Input/InputArgument.php

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

src/Symfony/Component/Console/Input/InputArgument.php

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

src/Symfony/Component/Console/Input/InputArgument.php

src/Symfony/Component/Console/CHANGELOG.md

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

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

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

src/Symfony/Component/Console/Command/LazyCommand.php

src/Symfony/Component/Console/Input/InputArgument.php

src/Symfony/Component/Console/Input/InputOption.php

src/Symfony/Component/Console/Input/InputArgument.php

nicolas-grekas

Much better :)

src/Symfony/Component/Console/Command/LazyCommand.php

src/Symfony/Component/Console/Input/InputOption.php

GromNaN · Feb 15, 2022

Thank you for all your time for this review. We have something very clear now.

src/Symfony/Component/Console/Input/InputOption.php

GromNaN · Mar 16, 2022

@chalasr @wouterj ready for a new review. Description updated.

chalasr

Great. Just one minor question

src/Symfony/Component/Console/Command/LazyCommand.php

nicolas-grekas

Some last minute nitpicking;

src/Symfony/Component/Console/Input/InputOption.php

src/Symfony/Component/Console/Input/InputArgument.php

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

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

src/Symfony/Component/Console/Input/InputArgument.php

nicolas-grekas · Mar 17, 2022

What about this todo?

Add info to descriptor

GromNaN · Mar 17, 2022

What about this todo?

Add info to descriptor

Could be part of an other PR.

GromNaN requested a review from chalasr as a code owner January 7, 2022 22:12

carsonbot added Status: Needs Review Console Feature labels Jan 7, 2022

carsonbot added this to the 6.1 milestone Jan 7, 2022

GromNaN commented Jan 7, 2022

View reviewed changes

src/Symfony/Component/Console/Command/Command.php Outdated Show resolved Hide resolved

GromNaN force-pushed the console-completion-definition branch 2 times, most recently from 8650876 to dfb4cc6 Compare January 7, 2022 22:29

GromNaN commented Jan 7, 2022

View reviewed changes

src/Symfony/Component/Console/Input/InputArgument.php Outdated Show resolved Hide resolved

GromNaN force-pushed the console-completion-definition branch 2 times, most recently from 0f93398 to f8e03db Compare January 8, 2022 12:15

dkarlovi reviewed Jan 26, 2022

View reviewed changes

src/Symfony/Component/Console/Command/DumpCompletionCommand.php Outdated Show resolved Hide resolved

nicolas-grekas reviewed Feb 13, 2022

View reviewed changes

GromNaN force-pushed the console-completion-definition branch from f8e03db to c4d65b3 Compare February 13, 2022 22:07

nicolas-grekas reviewed Feb 14, 2022

View reviewed changes

src/Symfony/Component/Console/Input/InputArgument.php Outdated Show resolved Hide resolved

src/Symfony/Component/Console/Input/InputArgument.php Outdated Show resolved Hide resolved

src/Symfony/Component/Console/Input/InputArgument.php Outdated Show resolved Hide resolved

GromNaN force-pushed the console-completion-definition branch from c4d65b3 to ab40533 Compare February 14, 2022 08:58

nicolas-grekas reviewed Feb 14, 2022

View reviewed changes

GromNaN force-pushed the console-completion-definition branch 2 times, most recently from e668ed4 to 0e31423 Compare February 14, 2022 14:20

GromNaN commented Feb 14, 2022

View reviewed changes

src/Symfony/Component/Console/CHANGELOG.md Outdated Show resolved Hide resolved

nicolas-grekas reviewed Feb 14, 2022

View reviewed changes

GromNaN force-pushed the console-completion-definition branch 4 times, most recently from d1a2af5 to 80654e5 Compare February 15, 2022 14:58

nicolas-grekas approved these changes Feb 15, 2022

View reviewed changes

src/Symfony/Component/Console/Command/LazyCommand.php Outdated Show resolved Hide resolved

src/Symfony/Component/Console/Input/InputOption.php Outdated Show resolved Hide resolved

carsonbot added Status: Reviewed and removed Status: Needs Review labels Feb 15, 2022

GromNaN force-pushed the console-completion-definition branch from 80654e5 to 5d70c9b Compare February 15, 2022 18:30

GromNaN commented Feb 15, 2022

View reviewed changes

src/Symfony/Component/Console/Input/InputOption.php Outdated Show resolved Hide resolved

nicolas-grekas requested a review from wouterj February 18, 2022 09:59

carsonbot added Status: Needs Review and removed Status: Reviewed labels Feb 18, 2022

GromNaN force-pushed the console-completion-definition branch 3 times, most recently from 091027a to 4f9c779 Compare March 16, 2022 18:43

chalasr approved these changes Mar 17, 2022

View reviewed changes

src/Symfony/Component/Console/Command/LazyCommand.php Outdated Show resolved Hide resolved

carsonbot added Status: Reviewed and removed Status: Needs Review labels Mar 17, 2022

nicolas-grekas reviewed Mar 17, 2022

View reviewed changes

GromNaN force-pushed the console-completion-definition branch 3 times, most recently from ae8e882 to a2a2e67 Compare March 17, 2022 15:56

nicolas-grekas reviewed Mar 17, 2022

View reviewed changes

src/Symfony/Component/Console/Input/InputArgument.php Outdated Show resolved Hide resolved

GromNaN force-pushed the console-completion-definition branch from a2a2e67 to 95ad05f Compare March 17, 2022 16:09

[Console] Add completion values to input definition

9951124

GromNaN force-pushed the console-completion-definition branch from 95ad05f to 9951124 Compare March 17, 2022 19:07

GromNaN merged commit 16f0668 into symfony:6.1 Mar 17, 2022

GromNaN mentioned this pull request Mar 17, 2022

[Console] Add completion values to input definition symfony/symfony-docs#16623

Closed

GromNaN deleted the console-completion-definition branch March 17, 2022 19:08

GromNaN mentioned this pull request Apr 14, 2022

Use addOption and addArgument for command input definition composer/composer#10737

Closed

fabpot mentioned this pull request Apr 15, 2022

Release v6.1.0-BETA1 #46049

Merged

GromNaN mentioned this pull request Apr 21, 2022

[Console] Document console completion symfony/symfony-docs#16723

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Add completion values to input definition #44948

[Console] Add completion values to input definition #44948

GromNaN commented Jan 7, 2022 •

edited

Loading

wouterj commented Jan 7, 2022 •

edited

Loading

GromNaN commented Jan 10, 2022 •

edited

Loading

nicolas-grekas left a comment

GromNaN commented Feb 15, 2022

GromNaN commented Mar 16, 2022

chalasr left a comment

nicolas-grekas left a comment

nicolas-grekas commented Mar 17, 2022

GromNaN commented Mar 17, 2022

	public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
	{
	if ($input->mustSuggestArgumentValuesFor('command_name')) {
	$descriptor = new ApplicationDescription($this->getApplication());
	$suggestions->suggestValues(array_keys($descriptor->getCommands()));

	return;
	}

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

	new InputArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help', function () {
	return array_keys((new ApplicationDescription($this->getApplication()))->getCommands());
	}),
	new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt', function () {
	return (new DescriptorHelper())->getFormats();
	}),

Search code, repositories, users, issues, pull requests...

[Console] Add completion values to input definition #44948

[Console] Add completion values to input definition #44948

Conversation

GromNaN commented Jan 7, 2022 • edited Loading

wouterj commented Jan 7, 2022 • edited Loading

GromNaN commented Jan 10, 2022 • edited Loading

nicolas-grekas left a comment

Choose a reason for hiding this comment

GromNaN commented Feb 15, 2022

GromNaN commented Mar 16, 2022

chalasr left a comment

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas commented Mar 17, 2022

GromNaN commented Mar 17, 2022

GromNaN commented Jan 7, 2022 •

edited

Loading

wouterj commented Jan 7, 2022 •

edited

Loading

GromNaN commented Jan 10, 2022 •

edited

Loading