[DX] Add completion to Symfony commands #43594

GromNaN · 2021-10-19T16:00:29Z

Completion of command arguments and options is coming in Symfony 5.4 (#38275). Command and option names are already autocompleted, but argument and option values needs to be implemented on each command.

As an example, #42251 added completion to secrets:remove.

This feature needs to be implemented on Symfony commands that has predictable values for their arguments and options.

Some guidelines:

Don't complete file/directory paths for now. See [DX] Add completion to Symfony commands #43594 (comment)
You don't need to filter the suggestions in PHP, compgen (used by the shell script) does this for you based on the suggestions provided by PHP
You can use the debugging utility while working on providing suggestions. See [DX] Add completion to Symfony commands #43594 (comment)

PLEASE, comment here BEFORE starting to work on something and WAIT for the confirmation to avoid duplicate work.

All commands have been claimed

Commands that does not require auto-completion:

The text was updated successfully, but these errors were encountered:

GromNaN · 2021-10-19T19:53:04Z

I'm taking help and list commands.

GromNaN · 2021-10-19T21:49:33Z

Since compgen filters the suggestion with the current input, can we agree that we don't have to filter in PHP? If filtering is necessary, it should be implemented in CompletionSuggestions.
Several commands uses the DescriptorHelper and have common options --format. Some code might be factorized.

andyexeter · 2021-10-19T22:04:37Z

I'll take cache:pool:clear and cache:pool:delete.

Should I wait for #43596 to be merged? Seems like that has a couple of useful things for testing.

GromNaN · 2021-10-19T22:27:10Z

@andyexeter they are yours.
I will wait for reviews to decide if the testing class is accepted.

StaffNowa · 2021-10-20T01:35:45Z

I can try help uuid and config 🤔

IonBazan · 2021-10-20T02:52:17Z

Can I take following?

debug:firewall
debug:form
debug:messenger
debug:router

Also, is there a way to suggest directories or files? Using Finder for that seems a bit overkill.

GromNaN · 2021-10-20T06:18:35Z

@StaffNowa ulid:generate and uuid:generate are for you.
@IonBazan you get debug:firewall, debug:form, debug:messenger, debug:router.

File and directory autocompletion seems to be a native feature of compgen: https://unix.stackexchange.com/a/26733

dkarlovi · 2021-10-20T06:49:42Z

@wouterj and I discussed files/folders being completed by falling back when nothing is suggested by Symfony. It will require a small tweak to the completion script generator.

IonBazan · 2021-10-20T06:57:43Z

@GromNaN I'm asking because compgen supports filtering files and directories: https://www.linuxjournal.com/content/more-using-bash-complete-command and some commands we use, like lint:twig should only accept *.twig files and some other accept only directories, not files.

dkarlovi · 2021-10-20T07:02:42Z

@IonBazan you should assume paths will get completed by compgen indeed. 👍

The plan is to add a feature to the completion which will allow "signaling" from the completion output to the completion script, something like suggesting (just an example)

type: file, glob: *.twig

and the completion script running native filtering. I guess it's too late to add this now (feature freeze)? /cc @wouterj

fabpot · 2021-10-20T07:04:30Z

@dkarlovi It's not too late, but we would need to add support quickly if we want to have it in 5.4.

dkarlovi · 2021-10-20T07:20:48Z

@fabpot this described feature is sure nice, but take into account that the completion script should get tweaked that it falls back to the native completion anyway if Symfony doesn't suggest anything, as noted in #43594 (comment) That is a much smaller change so doable today.

It will result in paths being completed as they usually would, so it goes:

use whatever Symfony suggested
Symfony didn't suggest anything, use the native file system suggestions

(currently missing 2)

With the signaling feature:

use whatever Symfony suggested
1.1. if a signal, use the signal to invoke compgen (maybe other things in the future?) in a specific way and use its suggestions
1.2. else a literal value, suggest those
Symfony didn't suggest anything, use the native file system suggestions

(1.1. is the new signaling feature)

The "signaling" feature is absolutely a nice one, but IMO not a blocker. If somebody did it in time, it would be awesome, but it should get some design time since the use cases will need to be get worked out. The "fallback to filesystem when nothing suggested" thing is a blocker IMO, but luckily much simpler so can be done before 5.4.

wouterj · 2021-10-20T07:41:10Z

To keep things focused: please open a poc PR or issue if we need to discuss the file completion more in detail. Personally, given the late timing of this feature, I would propose to just rely on the default file autocompletion as a fallback. Then, in 6.1 (or later, whenever someone has time) we can introduce filtered file autocompletion by using signaling.

Symfony <5.4 had zero auto completion, having a "working but not 100% feature complete" autocompletion in 5.4/6.0 is fine.

Since compgen filters the suggestion with the current input, can we agree that we don't have to filter in PHP? If filtering is necessary, it should be implemented in CompletionSuggestions.

Yes, agreed. We don't have to filter, compgen is capable of that.

dkarlovi · 2021-10-20T07:42:33Z

I just realized falling back when Symfony suggests nothing doesn't work because Symfony might be right.

For example, completing this:

bin/console compo<TAB>

to

bin/console composer. # json or lock

is incorrect since Symfony was right to suggest nothing: in this context it's completing command names and there is no command matching this pattern, it would yield bad UX.

So, seems signaling (however primitive) is the only correct way forward.

Maybe we can suggest

compgen! # using ! as a special character, any syntax can do

when we want native completion. Later more semantics can be added.

…NaN) This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [Console] Add completion to help & list commands | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #43594 | License | MIT | Doc PR | no - Add completion for commands `help` and `list` - Create a tester class to wrap completion code in tests - To autocomplete option `--format`, supported formats are exposed by `DescriptorHelper` Commits ------- dc94c72 [Console] Add completion to help & list commands

wouterj · 2021-10-20T08:06:08Z

Taking inspiration from https://github.com/posener/complete/tree/master , the only thing we might need to introduce in 5.4 is a complete.nothing "signal".

Values suggested? -> complete suggested values
"nothing" returned? -> don't do anything
No values suggested (e.g. no complete support yet)? -> fallback to default bash behavior (i.e. complete files/dirs)

dkarlovi · 2021-10-20T09:09:15Z

@GromNaN completion command actually has an argument which you can suggest, shell.

welcoMattic · 2021-10-20T10:09:04Z

@GromNaN Great initiative! I can help to make auto-complete for translation:pull and translation:push commands

GromNaN · 2021-10-20T10:21:27Z

@welcoMattic you are the one for translation:pull and translation:push.

wouterj · 2021-10-20T10:27:14Z

Just a recap of the debugging info (as it's not yet documented):

You can enable debug mode by running export SYMFONY_COMPLETION_DEBUG=1 once in your shell
Then open another terminal window and run bin/console completion --debug.
Enjoy live debugging information when trying to use the bash completion in the shell of (1):

This PR was squashed before being merged into the 5.4 branch. Discussion ---------- Add completion for debug:twig | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #43594 | License | MIT | Doc PR | - Add completion for debug:twig Commits ------- 68c5e3c Add completion for debug:twig

GromNaN · 2021-11-02T18:59:25Z

Hello @makraz, can I take messenger:consume?

Edit: done #43891

StaffNowa · 2021-11-02T19:35:47Z

Hey @makraz, do you have time or we can help you with server:log too?

StaffNowa · 2021-11-02T19:39:12Z

@GromNaN now I see server:log. Do we need to autocomplete hostname and format? According me it is not predictable
--host localhost or any IP (can put some localhost IP addreses).
--format - not sure what we can predict :)

GromNaN · 2021-11-02T20:23:34Z

@GromNaN now I see server:log. Do we need to autocomplete hostname and format? According me it is not predictable --host localhost or any IP (can put some localhost IP addreses). --format - not sure what we can predict :)

What do you think of suggesting the default value for both? It would be useful as a starting point, instead of reading the doc.

StaffNowa · 2021-11-02T20:31:41Z

@GromNaN now I see server:log. Do we need to autocomplete hostname and format? According me it is not predictable --host localhost or any IP (can put some localhost IP addreses). --format - not sure what we can predict :)

What do you think of suggesting the default value for both? It would be useful as a starting point, instead of reading the doc.

Yes good point👌

StaffNowa · 2021-11-02T21:06:36Z

@GromNaN added default hosts and ports from real life :)

…affNowa) This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [FrameworkBundle] Add completion for workflow:dump | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #43594 | License | MIT | Doc PR | - Add completion for workflow:dump We do not have tests here at all Commits ------- 5d3b60a [FrameworkBundle] Add completion for workflow:dump

…e (GromNaN) This PR was merged into the 5.4 branch. Discussion ---------- [Messenger] Add completion to command messenger:consume | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #43594 | License | MIT | Doc PR | - Command `messenger:consume` takes a list of `receivers` that should be unique. The values for option `--bus` where easy to inject into the command. I skipped the option `--queue` whose values are defined deep in the transport options. Commits ------- f99f586 [Messenger] Add completion to command messenger:consume

This PR was merged into the 5.4 branch. Discussion ---------- [Framework] Add completion to debug:container | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #43594 | License | MIT | Doc PR | - The command `debug:container` has several options which cannot be used all together. This PR adds completion for service names, tag names, parameter names and output format. Commits ------- 01fe89e [Framework] Add completion to debug:container

… (scyzoryck) This PR was merged into the 5.4 branch. Discussion ---------- [Messenger] Add command completion for failed messages | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #43594 | License | MIT | Doc PR | no Add command completion for failed messages. Commits ------- a01a895 [Messenger] Add completion for failed messages commands.

…nt (eclairia, Adrien Jourdier) This PR was squashed before being merged into the 5.4 branch. Discussion ---------- feat: add completion for DebugAutowiring search argument | Q | A | ------------- | --- | Branch? | 5.4 Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #43594 | License | MIT | Doc PR | - Adding Bash completion debug:autowiring command. Commits ------- ef8c518 feat: add completion for DebugAutowiring search argument

wouterj · 2021-11-04T18:16:46Z

Hi @stephenkhoo

do I need to include that test?

Yes, you can add a test for the completion support.

There is no direct need to add all missing tests (but if you want to do that as well, a PR is welcome to e.g. 4.4 or 5.3).

makraz · 2021-11-08T10:14:56Z

Hey @makraz, do you have time or we can help you with server:log too?

Hi @StaffNowa sorry just back to online work

StaffNowa · 2021-11-08T10:21:35Z

@makraz Hey, it is not needed anymore for the server:log command. People decided do not nothing for this command :)

…stephenkhoo) This PR was merged into the 5.4 branch. Discussion ---------- [Framework] Add completion to `debug:event-dispatcher` | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #43859 #43594 | License | MIT | Doc PR | - Rework PR from `@stephenkhoo` Commits ------- 97160dd Complete event name & dispatcher in EventDispatcherDebugCommand

…ll and push commands (welcoMattic) This PR was merged into the 5.4 branch. Discussion ---------- [Translation] Add completion feature on translation pull and push commands | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no  | Tickets | Fix (partially) symfony/symfony#43594  | License | MIT | Doc PR | This PR adds completion for arguments and options on `translation:pull` and `translation:push` commands. Commits ------- 036b03278f Add completion feature on translation pull and push commands

carsonbot added the DX DX = Developer eXperience (anything that improves the experience of using Symfony) label Oct 19, 2021

GromNaN mentioned this issue Oct 19, 2021

[Console][UX][DX] shell completion support directly in the Console component #38275

Closed

wouterj added Console Help wanted Issues and PRs which are looking for volunteers to complete them. and removed Console labels Oct 19, 2021

wouterj pinned this issue Oct 19, 2021

GromNaN mentioned this issue Oct 19, 2021

[Console] Add completion to help & list commands #43596

Merged

IonBazan mentioned this issue Oct 20, 2021

[Console] add suggestions for debug commands: firewall, form, messenger, router #43598

Merged

dkarlovi mentioned this issue Oct 20, 2021

[Console][Completion] fallback to native (filesystem) completion when Symfony completion not implemented #43607

Closed

dkarlovi mentioned this issue Oct 20, 2021

[Console][Completion] allow "signaling" from the completion command to the completion script #43608

Open

stephenkhoo mentioned this issue Oct 31, 2021

[Console] Add auto-completion to debug:event-dispatcher #43859

Closed

6 tasks

StaffNowa mentioned this issue Nov 1, 2021

Test command completion requires symfony/console 5.4+ #43864

Closed

GromNaN mentioned this issue Nov 2, 2021

[Messenger] Add completion to command messenger:consume #43891

Merged

StaffNowa mentioned this issue Nov 2, 2021

[MonologBridge] Add completion for server:log #43892

Closed

fabpot closed this as completed in d77697c Nov 4, 2021

fabpot closed this as completed in #43850 Nov 4, 2021

wouterj reopened this Nov 4, 2021

fabpot closed this as completed Nov 8, 2021

wouterj unpinned this issue Nov 18, 2021

dkarlovi mentioned this issue Nov 19, 2021

[2.3] Add support for completion when on Symfony 5.4 composer/composer#10292

Closed

GromNaN mentioned this issue Nov 29, 2021

[Framework] Add completion to debug:event-dispatcher #44321

Merged

GromNaN mentioned this issue Dec 1, 2021

Add completion to commands options and arguments composer/composer#10320

Merged

GromNaN mentioned this issue Jan 5, 2022

[Console] Bash completion integration symfony/symfony-docs#15947

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DX] Add completion to Symfony commands #43594

[DX] Add completion to Symfony commands #43594

GromNaN commented Oct 19, 2021 •

edited

Loading

GromNaN commented Oct 19, 2021

GromNaN commented Oct 19, 2021

andyexeter commented Oct 19, 2021

GromNaN commented Oct 19, 2021

StaffNowa commented Oct 20, 2021

IonBazan commented Oct 20, 2021 •

edited

Loading

GromNaN commented Oct 20, 2021

dkarlovi commented Oct 20, 2021

IonBazan commented Oct 20, 2021

dkarlovi commented Oct 20, 2021

fabpot commented Oct 20, 2021

dkarlovi commented Oct 20, 2021

wouterj commented Oct 20, 2021

dkarlovi commented Oct 20, 2021 •

edited

Loading

wouterj commented Oct 20, 2021

dkarlovi commented Oct 20, 2021

welcoMattic commented Oct 20, 2021

GromNaN commented Oct 20, 2021

wouterj commented Oct 20, 2021

GromNaN commented Nov 2, 2021 •

edited

Loading

StaffNowa commented Nov 2, 2021

StaffNowa commented Nov 2, 2021

GromNaN commented Nov 2, 2021

StaffNowa commented Nov 2, 2021

StaffNowa commented Nov 2, 2021

wouterj commented Nov 4, 2021

makraz commented Nov 8, 2021

StaffNowa commented Nov 8, 2021

[DX] Add completion to Symfony commands #43594

[DX] Add completion to Symfony commands #43594

Comments

GromNaN commented Oct 19, 2021 • edited Loading

GromNaN commented Oct 19, 2021

GromNaN commented Oct 19, 2021

andyexeter commented Oct 19, 2021

GromNaN commented Oct 19, 2021

StaffNowa commented Oct 20, 2021

IonBazan commented Oct 20, 2021 • edited Loading

GromNaN commented Oct 20, 2021

dkarlovi commented Oct 20, 2021

IonBazan commented Oct 20, 2021

dkarlovi commented Oct 20, 2021

fabpot commented Oct 20, 2021

dkarlovi commented Oct 20, 2021

wouterj commented Oct 20, 2021

dkarlovi commented Oct 20, 2021 • edited Loading

wouterj commented Oct 20, 2021

dkarlovi commented Oct 20, 2021

welcoMattic commented Oct 20, 2021

GromNaN commented Oct 20, 2021

wouterj commented Oct 20, 2021

GromNaN commented Nov 2, 2021 • edited Loading

StaffNowa commented Nov 2, 2021

StaffNowa commented Nov 2, 2021

GromNaN commented Nov 2, 2021

StaffNowa commented Nov 2, 2021

StaffNowa commented Nov 2, 2021

wouterj commented Nov 4, 2021

makraz commented Nov 8, 2021

StaffNowa commented Nov 8, 2021

GromNaN commented Oct 19, 2021 •

edited

Loading

IonBazan commented Oct 20, 2021 •

edited

Loading

dkarlovi commented Oct 20, 2021 •

edited

Loading

GromNaN commented Nov 2, 2021 •

edited

Loading