Implement generic autocompletion #11
Merged
Conversation
This file contains 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
tucksaun
commented
Jun 10, 2024
…ymfony CLI's Console for Bash, ZSH, and Fish. To make it work locally one can use the instructions provided by `symfony help completion`.
This autocompletion works on commands but also on flags. The flag autocompletion is fully automatic for some basic flag types (boolean and verbosity flags) and can be customized for any flag instance by specifying the `ArgsPredictor` property:
```golang
var myCommand = &Command{
Name: "foo",
Flags: []Flag{
&StringFlag{
Name: "plan",
ArgsPredictor: func(*Context, complete.Args) []string {
return []string{"free", "basic", "business", "enterprise"}
},
},
},
}
```
One can also implement argument autocompletion for a command:
```golang
var myCommand = &Command{
Name: "foo",
ShellComplete: func(context *Context, c complete.Args) []string {
return []string{"foo", "bar", "baz"}
},
}
```
Importantly, this PR also implements autocompletion forwarding to external commands we wrap such as `console` 😎
[](https://asciinema.org/a/lxPJuBAQr4NY2tFnB1co1PDu3)
(opening as a draft for now because there are a couple of things I want to discuss and we also need to figure out the patch required on Symfony's side)
tucksaun
force-pushed
the
feat/autocomplete
branch
from
8ee5e6b to
32bbb92
Compare
|
Thank you @tucksaun! 🎊 |
javiereguiluz
added a commit
to symfony/symfony-docs
that referenced
this pull request
Jul 22, 2024
](https://asciinema.org/a/lxPJuBAQr4NY2tFnB1co1PDu3){kind=link}
This PR was submitted for the 7.1 branch but it was merged into the 5.4 branch instead. Discussion ---------- Document Symfony CLI autocompletion I recently implemented autocompletion for any tools based on [symfony-cli/console](https://github.com/symfony-cli/console) including Symfony CLI (see symfony-cli/console#11). I also added completion forwarding for `composer` and `console` (see symfony-cli/symfony-cli#493). This means that you can have the autocompletion for the 3 tools by following `symfony completion --help` instructions and that it will automatically use the right configuration (ie. PHP version, `php.ini`, etc) when running it. Note: I opened the PR against `7.1` but technically this is not related to any `Symfony version`, let me know if you want me to change the target version. Commits ------- 52f1f00 Document Symfony CLI autocompletion
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.
This PR provides generic autocompletion for every application using Symfony CLI's Console for Bash, ZSH, and Fish. To make it work locally one can use the instructions provided by
symfony help completion.Fix symfony-cli/symfony-cli#481
This autocompletion works on commands but also on flags. The flag autocompletion is fully automatic for some basic flag types (boolean and verbosity flags) and can be customized for any flag instance by specifying the
ArgsPredictorproperty:One can also implement argument autocompletion for a command:
Importantly, this PR also implements autocompletion forwarding to external commands we wrap such as
console😎(opening as a draft for now because there are a couple of things I want to discuss and we also need to figure out the patch required on Symfony's side - will open the PR tomorrow)