Refactor things and support compose.yml files

Author: mdeboer

.circleci/config.yml

@@ -6,3 +6,6 @@ insert_final_newline = true
 charset = utf-8
 indent_size = 4
 indent_style = space
+
+[*.{yml,yaml}]
+indent_size = 2

.editorconfig

@@ -0,0 +1,26 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+
+  workflow_dispatch: ~
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install ZUnit
+        run: |
+          curl -L https://github.com/zunit-zsh/zunit/releases/download/v0.8.2/zunit > /usr/local/bin/zunit
+          curl -L https://raw.githubusercontent.com/molovo/revolver/master/revolver > /usr/local/bin/revolver
+          curl -L https://raw.githubusercontent.com/molovo/color/master/color.zsh > /usr/local/bin/color
+          chmod +x /usr/local/bin/{color,revolver,zunit}
+          chmod +x tests/_support/bin/*
+
+      - name: Run tests
+        run: zunit

.github/workflows/zunit.yml

@@ -0,0 +1,3 @@
+/.vscode
+/.idea
+/tests/_output

.gitignore

@@ -3,6 +3,6 @@ directories:
   tests: tests
   output: tests/_output
   support: tests/_support
-time_limit: 30
+time_limit: 5
 fail_fast: false
 allow_risky: false

.zunit.yml

@@ -1,7 +1,7 @@
-Copyright 2019-2020 Maarten de Boer, Cloudstek
+Copyright 2019-2025 Maarten de Boer <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE

@@ -8,13 +8,6 @@ This plugins adds `start`, `restart`, `stop`, `up` and `down` commands when it d
 in the current directory (e.g. your application). Just run `up` and get coding! This saves you typing `docker-compose`
 or `vagrant` every time or aliasing them. Also gives you one set of commands that work for both environments.
 
-### Docker
-
-Aside from simply running `up`, you can also extend your configuration by running `up <name>`, which will
-run `docker-compose` with both `docker-compose.yml` and extend it with `docker-compose.<name>.yml`. For more on
-extending please see the [official docker documentation](https://docs.docker.com/compose/extends). Additional arguments
-will be directly supplied to the docker-compose.
-
 ### Vagrant
 
 Vagrant doesn't have a `down`, `restart`, `start` or `stop` commands natively but don't worry, that's been taken care of
@@ -30,44 +23,66 @@ supplied to vagrant.
 | start   | [up](https://www.vagrantup.com/docs/cli/up.html)           | [start](https://docs.docker.com/compose/reference/start/)     |
 | restart | [reload](https://www.vagrantup.com/docs/cli/reload.html)   | [restart](https://docs.docker.com/compose/reference/restart/) |
 | stop    | [halt](https://www.vagrantup.com/docs/cli/halt.html)       | [stop](https://docs.docker.com/compose/reference/stop/)       |
-| enter   |                                                            | [exec](https://docs.docker.com/compose/reference/exec/) /bin/bash -l (or custom command/shell, e.g. with `enter /bin/sh`)      |
+
+#### Enter command
+
+There is one extra command that doesn't map to either Vagrant or Docker natively. Currently it is only implemented for
+Docker and allows you to quickly open a shell in a container.
+
+```shell
+enter my-container          # Spawns /bin/bash -l in my-container
+enter my-container /bin/sh  # Spawns /bin/sh in my-container (useful for Alpine based images) 
+```
 
 ## Installation
 
 ### oh-my-zsh
 
-1. Clone this repository in `$ZSH_CUSTOM/plugins/appup`:
+1. Clone this repository to `$ZSH_CUSTOM/plugins/appup`.
+2. Edit your `.zshrc` and add `appup` to the list of plugins.
 
-   ```bash
-   git clone https://github.com/Cloudstek/zsh-plugin-appup.git "$ZSH_CUSTOM/plugins/appup"
-   ```
-2. Edit `~/.zshrc` and add `appup` to the list of plugins
+### Antidote
 
-### Plain ZSH
+```shell
+antidote install mdeboer/zsh-plugin-appup
+```
 
-1. Clone this repository somewhere
+### Antigen
+
+```shell
+antigen bundle mdeboer/zsh-plugin-appup
+```
 
-2. Edit your `~/.zshrc` and add this line near the bottom of the file:
+### ZI
 
-   ```bash
-   source path/to/the/repository/appup.plugin.zsh
-   ```
+```shell
+zi load mdeboer/zsh-plugin-appup
+```
 
-## Updating
+### Plain ZSH
 
-1. Go to the directory where you cloned the plugin repository
-2. Run `git pull origin master`
+1. Clone this repository somewhere
+2. Edit your `.zshrc` and `source` the `appup.plugin.zsh` somewhere:
 
 ## Configuration options
 
-AppUp has a few configuration options to customise its behaviour. Please make sure you define these in `~/.zshrc`
-*before* you load any plugins.
+This plugin has a few configuration options to customise its behaviour. Please make sure you define these in your
+`.zshrc` file *before* you load any plugins.
+
+For more information about `zstyle`, see the man page `zshmodules(1)`.
+
+| Option                                       | Values | Default | Description                                                                                                                                   |
+|----------------------------------------------|--------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| `':omz:plugins:appup:docker' check-started`  | yes/no | no      | Enable/disable checking if docker is running.                                                                                                 |
+| `':omz:plugins:appup:docker' docker-machine` | yes/no | no      | If both docker (e.g. Docker Desktop) and docker-machine are installed, check if docker-machine (when `yes`) or docker (when `no`) is running. |
+| `':omz:plugins:appup:docker' env-files`      | array  |         | Additional env files to load (if they exist) when running `up` (adds `--env-file=...` arguments to the docker compose command).               | 
 
-Currently these options only affect docker.
+### Example
 
-| Name                 | Values     | Default | Description                                                                                                                                       |
-|----------------------|------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------|
-| APPUP_CHECK_STARTED  | true/false | true    | Enable/disable checking if docker is running completely.                                                                                          |
-| APPUP_DOCKER_MACHINE | true/false | true    | If both docker (e.g. Docker Desktop) and docker-machine are installed, check if docker-machine (when `true`) or docker (when `false`) is running. |
-| APPUP_LOAD_ENVS      | true/false | true    | When true, load .env, .env.local, .env.docker and .env.docker.local if they exist with `docker compose --env-file`.                               | 
+```shell
+zstyle ':omz:plugins:appup:docker' check-started yes
+zstyle ':omz:plugins:appup:docker' docker-machine no
+zstyle ':omz:plugins:appup:docker' env-files .env.foo .env.bar # Will also load .env.foo and/or .env.bar if they exist.
 
+# Load the plugin here...
+```

README.md

@@ -0,0 +1,26 @@
+# Upgrading
+
+## 1.4.x - 2.0.x
+
+### Repository URL
+
+The repository moved from https://github.com/Cloudstek/zsh-plugin-appup to https://github.com/mdeboer/zsh-plugin-appup.
+The owner has not changed, still me.
+
+### Projects (Docker)
+
+There is no longer any support for "projects" where for example `up foo` would look to see if `docker-compose.foo.yml`
+exists and would call `docker compose -f docker-compose.yml -f docker-compose.foo.yml up ...`.
+
+The implementation was fragile and a pain to maintain. Composer itself now has plenty of (better) options to manage
+scenarios like this and it is often better to supply the arguments themselves if needed.
+
+### Configuration options
+
+The configuration options have changed from environment variables to using `zstyle` (see the `zshmodules` man page).
+
+| Old                  | New                                          | Notes                                                   |
+|----------------------|----------------------------------------------|---------------------------------------------------------|
+| APPUP_CHECK_STARTED  | `':omz:plugins:appup:docker' check-started`  |                                                         |
+| APPUP_DOCKER_MACHINE | `':omz:plugins:appup:docker' docker-machine` |                                                         |
+| APPUP_LOAD_ENVS      | `':omz:plugins:appup:docker' env-files`      | Please see the [README](README.md), minor changes here. |

UPGRADING.md

@@ -0,0 +1,78 @@
+COMPOSER_FILES=('compose.yaml' 'compose.yml' 'docker-compose.yaml' 'docker-compose.yml')
+
+_appup_docker () {
+    if hash docker >/dev/null 2>&1 -neq 0; then
+        echo >&2 "Docker compose file found but docker compose is not installed."
+        return 1
+    fi
+
+    # Check if docker has been started
+    if zstyle -t ':omz:plugins:appup:docker' check-started; then
+        if hash docker-machine >/dev/null 2>&1 && zstyle -t ':omz:plugins:appup:docker' docker-machine; then
+            if docker-machine status | grep -qi "Stopped"; then
+                read -r -k 1 "REPLY?Docker Machine is not running, would you like to start it? [y/N] "
+                echo ""
+
+                if [[ "${REPLY:l}" != "y" ]]; then
+                    return 0
+                fi
+
+                docker-machine start default && eval $(docker-machine env default)
+                echo ""
+            fi
+        elif docker ps 2>&1 | grep -qi "Is the docker daemon running?"; then
+            if [[ "${OSTYPE:l}" != "darwin"* ]]; then
+                echo "Docker is not running."
+                return 1
+            fi
+
+            read -r -k 1 "REPLY?Docker for Mac is not running, would you like to start it? [y/N] "
+            echo ""
+
+            if [[ "${REPLY:l}" != "y" ]]; then
+                return 0
+            fi
+
+            open -a Docker
+
+            echo ""
+            echo "Waiting for docker to start.."
+            echo ""
+
+            # Wait for it to start
+            while true; do
+                if docker ps 2>&1 | grep -qi "Is the docker daemon running?" || docker ps 2>&1 | grep -qi "connection refused"; then
+                    sleep 5
+                else
+                    break
+                fi
+            done
+        fi
+    fi
+
+    # Env files
+    env_files=()
+
+    if [[ "$1" == "up" ]]; then
+        zstyle -a ':omz:plugins:appup:docker' env-files opt_env_files
+
+        for f in $opt_env_files; do
+            if [ -e "$f" ]; then
+                env_files+=( "$f" )
+            fi
+        done
+    fi
+
+    # Run docker compose.
+    docker compose --env-file=$^env_files $1 "${@:2}"
+}
+
+_appup_docker_file_found() {
+    for f in "${COMPOSER_FILES[@]}"; do
+        if [ -e "$f" ]; then
+            return 0
+        fi
+    done
+
+    return 1
+}

_docker.zsh

@@ -0,0 +1,7 @@
+_appup_vagrant () {
+    if hash vagrant >/dev/null 2>&1; then
+        vagrant $1 "${@:2}"
+    else
+        echo >&2 "Vagrant file found but vagrant is not installed."
+    fi
+}