summaryrefslogtreecommitdiff
path: root/plugins/poetry
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/poetry')
-rw-r--r--plugins/poetry/README.md9
-rw-r--r--plugins/poetry/poetry.plugin.zsh14
2 files changed, 23 insertions, 0 deletions
diff --git a/plugins/poetry/README.md b/plugins/poetry/README.md
new file mode 100644
index 000000000..51780cbed
--- /dev/null
+++ b/plugins/poetry/README.md
@@ -0,0 +1,9 @@
+# Poetry Plugin
+
+This plugin automatically installs [Poetry](https://python-poetry.org/)'s completions for you, and keeps them up to date as your Poetry version changes.
+
+To use it, add `poetry` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... poetry)
+```
diff --git a/plugins/poetry/poetry.plugin.zsh b/plugins/poetry/poetry.plugin.zsh
new file mode 100644
index 000000000..cebcb46c4
--- /dev/null
+++ b/plugins/poetry/poetry.plugin.zsh
@@ -0,0 +1,14 @@
+# Return immediately if poetry is not found
+if (( ! $+commands[poetry] )); then
+ return
+fi
+
+# If the completion file doesn't exist yet, we need to autoload it and
+# bind it to `poetry`. Otherwise, compinit will have already done that.
+if [[ ! -f "$ZSH_CACHE_DIR/completions/_poetry" ]]; then
+ typeset -g -A _comps
+ autoload -Uz _poetry
+ _comps[poetry]=_poetry
+fi
+
+poetry completions zsh >| "$ZSH_CACHE_DIR/completions/_poetry" &|