NotificationsYou must be signed in to change notification settings
Fork9.7k
Star30.8k

Zsh shell autocompletions#43970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

adhocore wants to merge10 commits intosymfony:6.2fromadhocore:5.4

Closed

Zsh shell autocompletions#43970

adhocore wants to merge10 commits intosymfony:6.2fromadhocore:5.4

Conversation

Copy link

Contributor

adhocore commentedNov 9, 2021•
edited
Loading

Q	A
Branch?	5.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Fix#43592
License	MIT
Doc PR	-

Usage

Setup/Install

Inzsh terminal run:

bin/console completion zsh>"$fpath[1]/console"

which will add dumped zsh completion helper in first fpath (zsh's functions autoload path).
Then reload shell or just dosource "$fpath[1]/console".

Here's a simple scriptsfzsh that I'm using while adding thezsh autocompletion support as a testbed:

Toggle code

#!/bin/env php<?phpuseSymfony\Component\Console\Application;useSymfony\Component\Console\Command\Command;useSymfony\Component\Console\Completion\CompletionInput;useSymfony\Component\Console\Completion\CompletionSuggestions;useSymfony\Component\Console\Descriptor\ApplicationDescription;useSymfony\Component\Console\Helper\DescriptorHelper;useSymfony\Component\Console\Input\InputInterface;useSymfony\Component\Console\Input\InputArgument;useSymfony\Component\Console\Input\InputOption;useSymfony\Component\Console\Output\OutputInterface;putenv('SYMFONY_COMPLETION_DEBUG=1');$app =newApplication('sfzsh','0.0.1');// test1$app->add(newclass()extends Command {protectedstatic$defaultName ='test1';protectedstatic$defaultDescription ='Test one cmd';protectedfunctionconfigure():void    {$this            ->addOption('t1o1','1', InputOption::VALUE_REQUIRED,'t1o1 str val')            ->addOption('t1o2','2', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,'t1o2 array val')            ->addArgument('php', InputArgument::REQUIRED,'PHP file in current dir')        ;    }protectedfunctionexecute(InputInterface$input,OutputInterface$output):int    {return0;    }publicfunctioncomplete(CompletionInput$input,CompletionSuggestions$suggestions):void    {if ($input->mustSuggestOptionValuesFor('t1o1')) {$suggestions->suggestValues(['t1o1.v1','t1o1.v2']);return;        }if ($input->mustSuggestOptionValuesFor('t1o2')) {$suggestions->suggestValues(['t1o2.v1','t1o2.v2']);return;        }if ($input->mustSuggestArgumentValuesFor('php')) {$suggestions->suggestValues([system('ls -1 *.php')]);return;        }    }});// test2$app->add(newclass()extends Command {protectedstatic$defaultName ='test2';protectedstatic$defaultDescription ='Test two cmd';protectedfunctionconfigure():void    {$this            ->addOption('t2o1','1', InputOption::VALUE_REQUIRED,'t2o1 str val')            ->addOption('t2o2','2', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,'t2o2 array val')            ->addArgument('dir', InputArgument::REQUIRED,'subdir in current dir')        ;    }protectedfunctionexecute(InputInterface$input,OutputInterface$output):int    {return0;    }publicfunctioncomplete(CompletionInput$input,CompletionSuggestions$suggestions):void    {if ($input->mustSuggestOptionValuesFor('t2o1')) {$suggestions->suggestValues(['t2o1.v1','t2o1.v2']);return;        }if ($input->mustSuggestOptionValuesFor('t2o2')) {$suggestions->suggestValues(['t2o2.v1','t2o2.v2']);return;        }if ($input->mustSuggestArgumentValuesFor('dir')) {$suggestions->suggestValues([system('ls -1d */')]);return;        }    }});$app->run();

sfzsh completion zsh>"${fpath[1]}/sfzsh"."${fpath[1]}/sfzsh"

Autocomplete commands

sfzsh [TAB]

Shortlisting works too:sfzsh te[TAB] autocompletes fortest1 andtest2

Fuzzy match works too:sfzsh t1[TAB] autocompletestest1

Autocomplete options

 sfzsh test1 --[TAB]

Autocomplete option values

sfzsh test1 --t1o1 [TAB]

= separator works too:sfzsh test1 --t1o1=[TAB]

Autocomplete args

sfzsh test1 [TAB]

|_ (autocompletes *.php files in current dir)

sfzsh test2 [TAB]

|_ (autocompletes subdirs in current dir)

adhocore requested a review fromchalasr as acode owner

November 9, 2021 10:22

carsonbot added Status: Needs Review Feature labels

Nov 9, 2021

carsonbot added this to the5.4 milestone

Nov 9, 2021

Copy link

ContributorAuthor

adhocore commentedNov 9, 2021

maybe a false positive in fabbot ci for typo?
"help": "The <info>completion</> command dumps the shell completion script required\nto
is suggested to be
"help": "The <info>completion</> command dumps the shell completion script required\not

the\n is LF and notnot

Copy link

Member

stof commentedNov 9, 2021

Yeah, this definitely looks like a false positive

Copy link

ContributorAuthor

adhocore commentedNov 9, 2021

@stof i used auto sync upstream from github ui, so any idea how can i remove the Merge commit now?

Copy link

Member

stof commentedNov 9, 2021

@adhocore seehttps://symfony.com/doc/current/contributing/code/pull_requests.html#rebase-your-pull-request

adhocore added9 commits

November 9, 2021 17:39

Add zsh completion template resource

f846256

Add zsh completion writer (options with description)

2458f63

Add a way to make completion input aware of shell

3d38c39

Register zsh completion output writer, set shell on completion input

166851a

For zsh shell, add command description as well

fc7f870

Fix existing tests for zsh

310a7c8

Add test for zsh shell completions

0f649dc

Test completion input shell

027ce97

Fix style

f6a960b

GromNaN requested changes

Nov 10, 2021

View reviewed changes

Copy link

Member

GromNaN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I like that you added comments in the script; especially since we don't have a way to write test on it for now.

I have a suggestion to avoid shell-specific code inApplication class.

src/Symfony/Component/Console/Application.php

		$suggestions->suggestValues(array_filter(array_map(function (Command$command) {
		return$command->isHidden() ?null :$command->getName();
		$suggestions->suggestValues(array_filter(array_map(function (Command$command)use ($input){
		return$command->isHidden() ?null :$command->getName().($input->isShell('zsh') ?"\t".$command->getDescription() :'');

Copy link

Member

GromNaNNov 10, 2021•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Testing if shell is zsh seems very specific for this place.

We could use a DTO. TheZshCompletionOutput would format the value with its specificities. By implementing the__toString method, theBashCompletionOutput would not require any change.

namespaceSymfony\Component\Console\Completion;finalclass SuggestedValue {private$value;private$description;publicfunction__construct(string$value,string$description =null) {$this->value =$value;$this->description =$description;    }publicfunction__toString():string {return$this->value;    }}

Copy link

ContributorAuthor

adhocoreNov 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

or maybe some abstraction to tell/handle if the shell supports description for autocompleted suggestion

Copy link

Member

GromNaNNov 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

That would add complexity in all commands that implements completion. I'm not sure this is something we want.
Each command should set suggestions values, optionally with a description using this DTO.

src/Symfony/Component/Console/Resources/completion.zsh


		# Ensure atleast 1 input
		if ["${i}"="" ];then
		requestComp="${requestComp} -i\"\""

Copy link

Member

GromNaNNov 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

That makes theCompletionInput::getCurrentValue() equals to a space? it would be better to skip the value entirely.

Copy link

ContributorAuthor

adhocoreNov 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

i think it still requires -i option equal or 1 more than -c option that's why

Copy link

Member

GromNaNNov 10, 2021•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Then, does it work with an empty string?

Suggested change

	requestComp="${requestComp} -i\"\""
	requestComp="${requestComp} -i\"\"

Copy link

ContributorAuthor

adhocoreNov 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

no it can't be empty

src/Symfony/Component/Console/Completion/CompletionInput.php OutdatedShow resolvedHide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels

Nov 10, 2021

Remove unused return

e209577

Co-authored-by: Jérôme Tamarelle <jerome@tamarelle.net>

fabpot modified the milestones:5.4,6.1

Nov 16, 2021

fabpot modified the milestones:6.1,6.2

May 20, 2022

Copy link

Member

fabpot commentedJul 20, 2022

@adhocore @GromNaN What's the status of this PR?
I see that, at least, it needs to be rebased on current 6.2.

GromNaN mentioned this pull request

Jul 21, 2022

[Console] Zsh shell autocompletion#47018

Merged

Copy link

Member

GromNaN commentedJul 21, 2022•
edited
Loading

Hello@adhocore. I created a new PR to rebase your work and change the way descriptions are output.
Please feel free to review#47018.

GromNaN closed this

Jul 21, 2022

fabpot added a commit that referenced this pull request

Jul 22, 2022

feature#47018[Console] Zsh shell autocompletion (adhocore, GromNaN)

79ee957

This PR was merged into the 6.2 branch.Discussion----------[Console] Zsh shell autocompletion| Q             | A| ------------- | ---| Branch?       | 6.2| Bug fix?      | no| New feature?  | yes| Deprecations? | no| Tickets       |Fix#43592| License       | MIT| Doc PR        | todoContinuation of#43970* Rebased, including bug fixes.* Added description to completion values, implemented for commands and options names. (should be used for fish also)```% bin/console [TAB]about                       -- Display information about the current projectassets:install              -- Install bundle's web assets under a public directorycache:clear                 -- Clear the cachecache:pool:clear            -- Clear cache pools```Commits-------3c2e1a4 Finish Zsh completion405f207 Add zsh completion

Labels

Feature Status: Needs Work

Movatterモバイル変換

Uh oh!

Zsh shell autocompletions#43970

Zsh shell autocompletions#43970

Uh oh!

Conversation

adhocore commentedNov 9, 2021• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Usage

Setup/Install

Autocomplete commands

Autocomplete options

Autocomplete option values

Autocomplete args

Uh oh!

adhocore commentedNov 9, 2021

Uh oh!

stof commentedNov 9, 2021

Uh oh!

adhocore commentedNov 9, 2021

Uh oh!

stof commentedNov 9, 2021

Uh oh!

GromNaN left a comment

Choose a reason for hiding this comment

Uh oh!

GromNaNNov 10, 2021• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adhocoreNov 10, 2021

Choose a reason for hiding this comment

Uh oh!

GromNaNNov 10, 2021

Choose a reason for hiding this comment

Uh oh!

GromNaNNov 10, 2021

Choose a reason for hiding this comment

Uh oh!

adhocoreNov 10, 2021

Choose a reason for hiding this comment

Uh oh!

GromNaNNov 10, 2021• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adhocoreNov 11, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fabpot commentedJul 20, 2022

Uh oh!

GromNaN commentedJul 21, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

adhocore commentedNov 9, 2021•
edited
Loading

GromNaNNov 10, 2021•
edited
Loading

GromNaNNov 10, 2021•
edited
Loading

GromNaN commentedJul 21, 2022•
edited
Loading