glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-05-05 21:07:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

Clarify behaviour surrounding nested custom handlers

Browse source
This commit is contained in:
cpfair 2016-01-12 16:33:27 +00:00
parent 2e00cabe43
commit c83aa7a6c7
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
bash_completions.md
View file

@ -30,6 +30,13 @@ The `BashCompletionFunction` member can be used to define bash functions which g
| **Runs for Command** | `__custom_unconditional_command_func` | `__custom_command_func` | | **Runs for Command** | `__custom_unconditional_command_func` | `__custom_command_func` |
| **Runs for Command & children** | `__custom_unconditional_func` | `__custom_func` | | **Runs for Command & children** | `__custom_unconditional_func` | `__custom_func` |
If you define more than one `__custom*_func`, they will execute in the following order (latest takes precedence). If there is more than one instance of a certain function defined in a command hiearchy during completion, the most specific function will supplant less specific functions (which will *not* execute at all).
* `__custom_unconditional_func`
* `__custom_unconditional_command_func`
* `__custom_func`
* `__custom_command_func`
Some more actual code that works in kubernetes: Some more actual code that works in kubernetes:
```bash ```bash
@ -83,13 +90,6 @@ Find more information at https://github.com/GoogleCloudPlatform/kubernetes.`,
In the case of kubernetes a valid command might look something like `kubectl get pod [mypod]`. If you type `kubectl get pod [tab][tab]` the `__customc_func()` will run because the cobra.Command only understood "kubectl" and "get." `__custom_func()` will see that the cobra.Command is "kubectl_get" and will thus call another helper `__kubectl_get_resource()`. `__kubectl_get_resource` will look at the 'nouns' collected. In our example the only noun will be `pod`. So it will call `__kubectl_parse_get pod`. `__kubectl_parse_get` will actually call out to kubernetes and get any pods. It will then set `COMPREPLY` to valid pods! In the case of kubernetes a valid command might look something like `kubectl get pod [mypod]`. If you type `kubectl get pod [tab][tab]` the `__customc_func()` will run because the cobra.Command only understood "kubectl" and "get." `__custom_func()` will see that the cobra.Command is "kubectl_get" and will thus call another helper `__kubectl_get_resource()`. `__kubectl_get_resource` will look at the 'nouns' collected. In our example the only noun will be `pod`. So it will call `__kubectl_parse_get pod`. `__kubectl_parse_get` will actually call out to kubernetes and get any pods. It will then set `COMPREPLY` to valid pods!
If you define more than one `__custom*_func`, they will execute in the following order (latest takes precedence):
* `__custom_unconditional_func`
* `__custom_unconditional_command_func`
* `__custom_func`
* `__custom_command_func`
## Have the completions code complete your 'nouns' ## Have the completions code complete your 'nouns'
In the above example "pod" was assumed to already be typed. But if you want `kubectl get [tab][tab]` to show a list of valid "nouns" you have to set them. Simplified code from `kubectl get` looks like: In the above example "pod" was assumed to already be typed. But if you want `kubectl get [tab][tab]` to show a list of valid "nouns" you have to set them. Simplified code from `kubectl get` looks like: