Fix zsh autocomplete #3221
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,52 +19,49 @@ | |
| # * @felixr docker zsh completion script : https://github.com/felixr/docker-zsh-completion | ||
| # ------------------------------------------------------------------------- | ||
|
|
||
| __docker-compose_q() { | ||
| docker-compose 2>/dev/null $compose_options "$@" | ||
| } | ||
|
|
||
| # All services defined in docker-compose.yml | ||
| __docker-compose_all_services_in_compose_file() { | ||
| local already_selected | ||
| local -a services | ||
| already_selected=$(echo $words | tr " " "|") | ||
| __docker-compose_q config --services \ | ||
| | grep -Ev "^(${already_selected})$" | ||
| } | ||
|
|
||
| # All services, even those without an existing container | ||
| __docker-compose_services_all() { | ||
| [[ $PREFIX = -* ]] && return 1 | ||
| integer ret=1 | ||
| services=$(__docker-compose_all_services_in_compose_file) | ||
| _alternative "args:services:($services)" && ret=0 | ||
|
|
||
| return ret | ||
| } | ||
|
|
||
| # All services that have an entry with the given key in their docker-compose.yml section | ||
| __docker-compose_services_with_key() { | ||
| local already_selected | ||
| local -a buildable | ||
| already_selected=$(echo $words | tr " " "|") | ||
| # flatten sections to one line, then filter lines containing the key and return section name. | ||
| __docker-compose_q config \ | ||
| | sed -n -e '/^services:/,/^[^ ]/p' \ | ||
| | sed -n 's/^ //p' \ | ||
| | awk '/^[a-zA-Z0-9]/{printf "\n"};{printf $0;next;}' \ | ||
| | grep " \+$1:" \ | ||
|
There was a problem hiding this comment. Please do not drop the first
Author
There was a problem hiding this comment. @albers I'm dropping the first For instance, this service will be matched (assuming my-app:
build: ./my-dir
ports:
- 80…but this one won't: my-app:
ports:
- 80
build: ./my-dirThere was a problem hiding this comment. @aeriksson yes, you're right. Thanks for spotting this. |
||
| | cut -d: -f1 \ | ||
| | grep -Ev "^(${already_selected})$" | ||
| } | ||
|
|
||
| # All services that are defined by a Dockerfile reference | ||
| __docker-compose_services_from_build() { | ||
| [[ $PREFIX = -* ]] && return 1 | ||
| integer ret=1 | ||
| buildable=$(__docker-compose_services_with_key build) | ||
| _alternative "args:buildable services:($buildable)" && ret=0 | ||
|
|
||
| return ret | ||
|
|
@@ -74,7 +71,7 @@ __docker-compose_services_from_build() { | |
| __docker-compose_services_from_image() { | ||
| [[ $PREFIX = -* ]] && return 1 | ||
| integer ret=1 | ||
| pullable=$(__docker-compose_services_with_key image) | ||
| _alternative "args:pullable services:($pullable)" && ret=0 | ||
|
|
||
| return ret | ||
|
|
@@ -96,7 +93,7 @@ __docker-compose_get_services() { | |
| shift | ||
| [[ $kind =~ (stopped|all) ]] && args=($args -a) | ||
|
|
||
| lines=(${(f)"$(_call_program commands docker $docker_options ps $args)"}) | ||
| services=(${(f)"$(_call_program commands docker-compose 2>/dev/null $compose_options ps -q)"}) | ||
|
|
||
| # Parse header line to find columns | ||
|
|
@@ -185,15 +182,25 @@ __docker-compose_commands() { | |
| } | ||
|
|
||
| __docker-compose_subcommand() { | ||
| local opts_help opts_force_recreate opts_no_recreate opts_no_build opts_remove_orphans opts_timeout opts_no_color opts_no_deps | ||
|
|
||
| opts_help='(: -)--help[Print usage]' | ||
| opts_force_recreate="(--no-recreate)--force-recreate[Recreate containers even if their configuration and image haven't changed. Incompatible with --no-recreate.]" | ||
| opts_no_recreate="(--force-recreate)--no-recreate[If containers already exist, don't recreate them. Incompatible with --force-recreate.]" | ||
| opts_no_build="(--build)--no-build[Don't build an image, even if it's missing.]" | ||
| opts_remove_orphans="--remove-orphans[Remove containers for services not defined in the Compose file]" | ||
| opts_timeout=('(-t --timeout)'{-t,--timeout}"[Specify a shutdown timeout in seconds. (default: 10)]:seconds: ") | ||
| opts_no_color='--no-color[Produce monochrome output.]' | ||
| opts_no_deps="--no-deps[Don't start linked services.]" | ||
|
|
||
| integer ret=1 | ||
|
|
||
| case "$words[1]" in | ||
| (build) | ||
| _arguments \ | ||
| $opts_help \ | ||
| '--force-rm[Always remove intermediate containers.]' \ | ||
| '--no-cache[Do not use cache when building the image.]' \ | ||
| '--pull[Always attempt to pull a newer version of the image.]' \ | ||
| '*:services:__docker-compose_services_from_build' && ret=0 | ||
| ;; | ||
|
|
@@ -206,21 +213,23 @@ __docker-compose_subcommand() { | |
| (create) | ||
| _arguments \ | ||
| $opts_help \ | ||
| $opts_force_recreate \ | ||
| $opts_no_recreate \ | ||
| $opts_no_build \ | ||
| "(--no-build)--build[Build images before creating containers.]" \ | ||
| '*:services:__docker-compose_services_all' && ret=0 | ||
| ;; | ||
| (down) | ||
| _arguments \ | ||
| $opts_help \ | ||
| "--rmi[Remove images. Type must be one of: 'all': Remove all images used by any service. 'local': Remove only images that don't have a custom tag set by the \`image\` field.]:type:(all local)" \ | ||
| '(-v --volumes)'{-v,--volumes}"[Remove named volumes declared in the \`volumes\` section of the Compose file and anonymous volumes attached to containers.]" \ | ||
| $opts_remove_orphans && ret=0 | ||
| ;; | ||
| (events) | ||
| _arguments \ | ||
| $opts_help \ | ||
| '--json[Output events as a stream of json objects]' \ | ||
| '*:services:__docker-compose_services_all' && ret=0 | ||
| ;; | ||
| (exec) | ||
|
|
@@ -230,7 +239,7 @@ __docker-compose_subcommand() { | |
| '--privileged[Give extended privileges to the process.]' \ | ||
| '--user=[Run the command as this user.]:username:_users' \ | ||
| '-T[Disable pseudo-tty allocation. By default `docker-compose exec` allocates a TTY.]' \ | ||
| '--index=[Index of the container if there are multiple instances of a service \[default: 1\]]:index: ' \ | ||
| '(-):running services:__docker-compose_runningservices' \ | ||
| '(-):command: _command_names -e' \ | ||
| '*::arguments: _normal' && ret=0 | ||
|
|
@@ -248,7 +257,7 @@ __docker-compose_subcommand() { | |
| _arguments \ | ||
| $opts_help \ | ||
| '(-f --follow)'{-f,--follow}'[Follow log output]' \ | ||
| $opts_no_color \ | ||
| '--tail=[Number of lines to show from the end of the logs for each container.]:number of lines: ' \ | ||
| '(-t --timestamps)'{-t,--timestamps}'[Show timestamps]' \ | ||
| '*:services:__docker-compose_services_all' && ret=0 | ||
|
|
@@ -261,8 +270,8 @@ __docker-compose_subcommand() { | |
| (port) | ||
| _arguments \ | ||
| $opts_help \ | ||
| '--protocol=[tcp or udp \[default: tcp\]]:protocol:(tcp udp)' \ | ||
| '--index=[index of the container if there are multiple instances of a service \[default: 1\]]:index: ' \ | ||
| '1:running services:__docker-compose_runningservices' \ | ||
| '2:port:_ports' && ret=0 | ||
| ;; | ||
|
|
@@ -282,7 +291,7 @@ __docker-compose_subcommand() { | |
| _arguments \ | ||
| $opts_help \ | ||
| '(-f --force)'{-f,--force}"[Don't ask to confirm removal]" \ | ||
| '-v[Remove any anonymous volumes attached to containers]' \ | ||
| '*:stopped services:__docker-compose_stoppedservices' && ret=0 | ||
| ;; | ||
| (run) | ||
|
|
@@ -291,22 +300,22 @@ __docker-compose_subcommand() { | |
| '-d[Detached mode: Run container in the background, print new container name.]' \ | ||
| '*-e[KEY=VAL Set an environment variable (can be used multiple times)]:environment variable KEY=VAL: ' \ | ||
| '--entrypoint[Overwrite the entrypoint of the image.]:entry point: ' \ | ||
| '--name=[Assign a name to the container]:name: ' \ | ||
| $opts_no_deps \ | ||
| '(-p --publish)'{-p,--publish=}"[Publish a container's port(s) to the host]" \ | ||
| '--rm[Remove container after run. Ignored in detached mode.]' \ | ||
| "--service-ports[Run command with the service's ports enabled and mapped to the host.]" \ | ||
| '-T[Disable pseudo-tty allocation. By default `docker-compose run` allocates a TTY.]' \ | ||
| '(-u --user)'{-u,--user=}'[Run as specified username or uid]:username or uid:_users' \ | ||
| '(-w --workdir)'{-w,--workdir=}'[Working directory inside the container]:workdir: ' \ | ||
| '(-):services:__docker-compose_services' \ | ||
| '(-):command: _command_names -e' \ | ||
| '*::arguments: _normal' && ret=0 | ||
| ;; | ||
| (scale) | ||
| _arguments \ | ||
| $opts_help \ | ||
| $opts_timeout \ | ||
| '*:running services:__docker-compose_runningservices' && ret=0 | ||
| ;; | ||
| (start) | ||
|
|
@@ -317,7 +326,7 @@ __docker-compose_subcommand() { | |
| (stop|restart) | ||
| _arguments \ | ||
| $opts_help \ | ||
| $opts_timeout \ | ||
| '*:running services:__docker-compose_runningservices' && ret=0 | ||
| ;; | ||
| (unpause) | ||
|
|
@@ -328,15 +337,16 @@ __docker-compose_subcommand() { | |
| (up) | ||
| _arguments \ | ||
| $opts_help \ | ||
| '(--abort-on-container-exit)-d[Detached mode: Run containers in the background, print new container names. Incompatible with --abort-on-container-exit.]' \ | ||
| $opts_no_color \ | ||
| $opts_no_deps \ | ||
| $opts_force_recreate \ | ||
| $opts_no_recreate \ | ||
| $opts_no_build \ | ||
| "(--no-build)--build[Build images before starting containers.]" \ | ||
| "(-d)--abort-on-container-exit[Stops all containers if any container was stopped. Incompatible with -d.]" \ | ||
| '(-t --timeout)'{-t,--timeout}"[Use this timeout in seconds for container shutdown when attached or when containers are already running. (default: 10)]:seconds: " \ | ||
| $opts_remove_orphans \ | ||
| '*:services:__docker-compose_services_all' && ret=0 | ||
| ;; | ||
| (version) | ||
|
|
@@ -366,16 +376,57 @@ _docker-compose() { | |
|
|
||
| _arguments -C \ | ||
| '(- :)'{-h,--help}'[Get help]' \ | ||
| '(-f --file)'{-f,--file}'[Specify an alternate docker-compose file (default: docker-compose.yml)]:file:_files -g "*.yml"' \ | ||
| '(-p --project-name)'{-p,--project-name}'[Specify an alternate project name (default: directory name)]:project name:' \ | ||
| '--verbose[Show more output]' \ | ||
| '(- :)'{-v,--version}'[Print version and exit]' \ | ||
| '(-H --host)'{-H,--host}'[Daemon socket to connect to]:host:' \ | ||
|
There was a problem hiding this comment. Since you are alphabetically re-ordering
Author
There was a problem hiding this comment. Yeah, I'll break the commit up. Regarding the sorting, I reordered the flags to match the order given by Do you want me to do alphabetical ordering instead? There was a problem hiding this comment.
Oh my bad, it's fine like that. |
||
| '--tls[Use TLS; implied by --tlsverify]' \ | ||
| '--tlscacert=[Trust certs signed only by this CA]:ca path:' \ | ||
| '--tlscert=[Path to TLS certificate file]:client cert path:' \ | ||
| '--tlskey=[Path to TLS key file]:tls key path:' \ | ||
| '--tlsverify[Use TLS and verify the remote]' \ | ||
| "--skip-hostname-check[Don't check the daemon's hostname against the name specified in the client certificate (for example if your docker host is an IP address)]" \ | ||
| '(-): :->command' \ | ||
| '(-)*:: :->option-or-argument' && ret=0 | ||
|
|
||
| local -a relevant_compose_flags relevant_docker_flags compose_options docker_options | ||
|
|
||
| relevant_compose_flags=( | ||
| "--file" "-f" | ||
| "--host" "-H" | ||
| "--project-name" "-p" | ||
| "--tls" | ||
| "--tlscacert" | ||
| "--tlscert" | ||
| "--tlskey" | ||
| "--tlsverify" | ||
| "--skip-hostname-check" | ||
| ) | ||
|
|
||
| relevant_docker_flags=( | ||
| "--host" "-H" | ||
| "--tls" | ||
| "--tlscacert" | ||
| "--tlscert" | ||
| "--tlskey" | ||
| "--tlsverify" | ||
| ) | ||
|
|
||
| for k in "${(@k)opt_args}"; do | ||
| if [[ -n "${relevant_docker_flags[(r)$k]}" ]]; then | ||
| docker_options+=$k | ||
| if [[ -n "$opt_args[$k]" ]]; then | ||
| docker_options+=$opt_args[$k] | ||
| fi | ||
| fi | ||
| if [[ -n "${relevant_compose_flags[(r)$k]}" ]]; then | ||
| compose_options+=$k | ||
| if [[ -n "$opt_args[$k]" ]]; then | ||
| compose_options+=$opt_args[$k] | ||
| fi | ||
| fi | ||
| done | ||
|
|
||
| case $state in | ||
| (command) | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is normally a meaning about triple underscore prefix which is sub-functions used by complete function. Ex:
__docker-compose_services_from_buildusing___docker-compose_services_with_key. But I'm okay about using only double underscore prefix.