Browse Source

feat(ngrok): add completion plugin (#12826)

Jonathan Stacks 4 months ago
parent
commit
69a6359f7c
2 changed files with 34 additions and 0 deletions
  1. 20 0
      plugins/ngrok/README.md
  2. 14 0
      plugins/ngrok/ngrok.plugin.zsh

+ 20 - 0
plugins/ngrok/README.md

@@ -0,0 +1,20 @@
+# ngrok plugin
+
+This plugin adds completion for the [ngrok](https://ngrok.com) CLI.
+
+To use it, add `ngrok` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... ngrok)
+```
+
+This plugin does not add any aliases.
+
+## Cache
+
+This plugin caches the completion script and is automatically updated asynchronously when the plugin is
+loaded, which is usually when you start up a new terminal emulator.
+
+The cache is stored at:
+
+- `$ZSH_CACHE/completions/_ngrok` completions script

+ 14 - 0
plugins/ngrok/ngrok.plugin.zsh

@@ -0,0 +1,14 @@
+# Autocompletion for ngrok
+if (( ! $+commands[ngrok] )); then
+  return
+fi
+
+# If the completion file doesn't exist yet, we need to autoload it and
+# bind it to `ngrok`. Otherwise, compinit will have already done that.
+if [[ ! -f "$ZSH_CACHE_DIR/completions/_ngrok" ]]; then
+  typeset -g -A _comps
+  autoload -Uz _ngrok
+  _comps[ngrok]=_ngrok
+fi
+
+ngrok completion zsh >| "$ZSH_CACHE_DIR/completions/_ngrok" &|