summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/lando
diff options
context:
space:
mode:
Diffstat (limited to 'home/.oh-my-zsh/plugins/lando')
-rw-r--r--home/.oh-my-zsh/plugins/lando/LICENSE21
-rw-r--r--home/.oh-my-zsh/plugins/lando/README.md56
-rw-r--r--home/.oh-my-zsh/plugins/lando/lando.plugin.zsh52
3 files changed, 129 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/lando/LICENSE b/home/.oh-my-zsh/plugins/lando/LICENSE
new file mode 100644
index 0000000..1d49831
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/lando/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Joshua Bedford
+
+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. \ No newline at end of file
diff --git a/home/.oh-my-zsh/plugins/lando/README.md b/home/.oh-my-zsh/plugins/lando/README.md
new file mode 100644
index 0000000..2f881cf
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/lando/README.md
@@ -0,0 +1,56 @@
+# Lando ZSH (lando-zsh)
+
+This plugin adds aliases for using various languages and frameworks with [Lando](https://docs.lando.dev/basics/) for Docker. It will only run within lando-driven project directories.
+
+To use it, add `lando` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... lando)
+```
+
+## Wrapped Commands
+
+| Alias | Description |
+|:----------:|:----------------:|
+| `artisan` | `lando artisan` |
+| `composer` | `lando composer` |
+| `drush` | `lando drush` |
+| `gulp` | `lando gulp` |
+| `npm` | `lando npm` |
+| `php` | `lando php` |
+| `wp` | `lando wp` |
+| `yarn` | `lando yarn` |
+
+More or different commands can be wrapped by setting the `LANDO_ZSH_WRAPPED_COMMANDS` setting, see [Settings](#settings) below.
+
+## How It Works:
+
+This plugin removes the requirement to type `lando` before a command. It utilizes the lando version of supported commands run within directories with the following criteria:
+
+- The `.lando.yml` file is found in the current directory or any parent directory within `$LANDO_ZSH_SITES_DIRECTORY`.
+- The current directory is within `$LANDO_ZSH_SITES_DIRECTORY` but is not `$LANDO_ZSH_SITES_DIRECTORY` itself.
+- If the command is not a part of the commands available in the lando environment, it will run the command without `lando`.
+
+## Settings:
+
+> NOTE: these settings must be set *before* the plugin is loaded, and any changes require a restart of the shell to be applied.
+
+- `LANDO_ZSH_SITES_DIRECTORY`: The plugin will stop searching through parents for `CONFIG_FILE` once it hits this directory:
+ ```sh
+ LANDO_ZSH_SITES_DIRECTORY="$HOME/Code"
+ ```
+
+- `LANDO_ZSH_CONFIG_FILE`: The plugin will check to see if this provided file exists to check for presence of Lando:
+ ```sh
+ LANDO_ZSH_CONFIG_FILE=".lando.dev.yml"
+ ```
+
+- `LANDO_ZSH_WRAPPED_COMMANDS`: The list of commands to wrap, as a string of commands separated by whitespace:
+ ```sh
+ LANDO_ZSH_WRAPPED_COMMANDS="mysql php composer test artisan"
+ ```
+
+## Author:
+
+- Author: Joshua Bedford
+- URL: [https://github.com/joshuabedford/lando-zsh](https://github.com/joshuabedford/lando-zsh)
diff --git a/home/.oh-my-zsh/plugins/lando/lando.plugin.zsh b/home/.oh-my-zsh/plugins/lando/lando.plugin.zsh
new file mode 100644
index 0000000..ee796d2
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/lando/lando.plugin.zsh
@@ -0,0 +1,52 @@
+# Settings
+: ${LANDO_ZSH_SITES_DIRECTORY:="$HOME/Sites"}
+: ${LANDO_ZSH_CONFIG_FILE:=.lando.yml}
+: ${LANDO_ZSH_WRAPPED_COMMANDS:="
+ artisan
+ composer
+ drush
+ gulp
+ npm
+ php
+ wp
+ yarn
+"}
+
+# Enable multiple commands with lando.
+function ${=LANDO_ZSH_WRAPPED_COMMANDS} {
+ # If the lando task is available in `lando --help`, then it means:
+ #
+ # 1. `lando` is in a project with a `.lando.yml` file.
+ # 2. The lando task is available for lando, based on the .lando.yml config file.
+ #
+ # This has a penalty of about 250ms, so we still want to check if the lando file
+ # exists before, which is the fast path. If it exists, checking help output is
+ # still faster than running the command and failing.
+ if _lando_file_exists && lando --help 2>&1 | command grep -Eq "^ +lando $0 "; then
+ command lando "$0" "$@"
+ else
+ command "$0" "$@"
+ fi
+}
+
+# Check for the file in the current and parent directories.
+_lando_file_exists() {
+ # Only bother checking for lando within the Sites directory.
+ if [[ "$PWD/" != "$LANDO_ZSH_SITES_DIRECTORY"/* ]]; then
+ # Not within $LANDO_ZSH_SITES_DIRECTORY
+ return 1
+ fi
+
+ local curr_dir="$PWD"
+ # Checking for file: $LANDO_ZSH_CONFIG_FILE within $LANDO_ZSH_SITES_DIRECTORY...
+ while [[ "$curr_dir" != "$LANDO_ZSH_SITES_DIRECTORY" ]]; do
+ if [[ -f "$curr_dir/$LANDO_ZSH_CONFIG_FILE" ]]; then
+ return 0
+ fi
+ curr_dir="${curr_dir:h}"
+ done
+
+ # Could not find $LANDO_ZSH_CONFIG_FILE in the current directory
+ # or in any of its parents up to $LANDO_ZSH_SITES_DIRECTORY.
+ return 1
+}