summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/nvm
diff options
context:
space:
mode:
Diffstat (limited to 'home/.oh-my-zsh/plugins/nvm')
-rw-r--r--home/.oh-my-zsh/plugins/nvm/README.md60
-rw-r--r--home/.oh-my-zsh/plugins/nvm/nvm.plugin.zsh99
2 files changed, 159 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/nvm/README.md b/home/.oh-my-zsh/plugins/nvm/README.md
new file mode 100644
index 0000000..1245f66
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/nvm/README.md
@@ -0,0 +1,60 @@
+# nvm plugin
+
+This plugin adds autocompletions for [nvm](https://github.com/nvm-sh/nvm) — a Node.js version manager. It also
+automatically sources nvm, so you don't need to do it manually in your `.zshrc`.
+
+To use it, add `nvm` to the plugins array of your zshrc file:
+
+```zsh
+plugins=(... nvm)
+```
+
+## Settings
+
+If you installed nvm in a directory other than `$HOME/.nvm`, set and export `NVM_DIR` to be the directory
+where you installed nvm.
+
+These settings should go in your zshrc file, before Oh My Zsh is sourced:
+
+- **`NVM_HOMEBREW`**: if you installed nvm via Homebrew, in a directory other than `/usr/local/opt/nvm`, you
+ can set `NVM_HOMEBREW` to be the directory where you installed it. For example, on Apple Silicon-based Macs,
+ [Homebrew is installed in `/opt/homebrew`](https://docs.brew.sh/Installation). To get the directory where
+ nvm has been installed, regardless of chip architecture, use `NVM_HOMEBREW=$(brew --prefix nvm)`.
+
+## Customization
+
+#### Lazy startup
+
+This option will help you to defer nvm's load until you use it to speed-up your zsh startup. This will source
+nvm script only when using it, and will create a function for `node`, `npm`, `npx`, `pnpm`, `pnpx`, `yarn`,
+`corepack` and the command(s) specified by `lazy-cmd` option, so when you call either of them, nvm will be
+loaded and run with default version. To enable it, you can add this snippet to your zshrc, before Oh My Zsh is
+sourced:
+
+```zsh
+zstyle ':omz:plugins:nvm' lazy yes
+```
+
+Then, to define extra commands that will also trigger nvm load, you can use a similar syntax, adding as many
+as you want:
+
+```zsh
+zstyle ':omz:plugins:nvm' lazy-cmd eslint prettier typescript ...
+```
+
+There will be a function `_omz_nvm_load` available to load `nvm` without executing any other trigger command.
+
+#### `.nvmrc` autoload
+
+Note: _if used at the same time as `lazy`, `autoload` will start working only after nvm has been lazy-loaded_
+
+If set, the plugin will automatically load a node version when if finds a
+[`.nvmrc` file](https://github.com/nvm-sh/nvm#nvmrc) in the current working directory indicating which node
+version to load. This can be done, similar as previous options, adding:
+
+```zsh
+zstyle ':omz:plugins:nvm' autoload yes
+zstyle ':omz:plugins:nvm' silent-autoload yes # optionally remove the output generated by NVM when autoloading
+```
+
+Note: _this will not remove regular `nvm` output_
diff --git a/home/.oh-my-zsh/plugins/nvm/nvm.plugin.zsh b/home/.oh-my-zsh/plugins/nvm/nvm.plugin.zsh
new file mode 100644
index 0000000..682bddc
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/nvm/nvm.plugin.zsh
@@ -0,0 +1,99 @@
+# Don't try to load nvm if command already available
+# Note: nvm is a function so we need to use `which`
+which nvm &>/dev/null && return
+
+# See https://github.com/nvm-sh/nvm#installation-and-update
+if [[ -z "$NVM_DIR" ]]; then
+ if [[ -d "$HOME/.nvm" ]]; then
+ export NVM_DIR="$HOME/.nvm"
+ elif [[ -d "${XDG_CONFIG_HOME:-$HOME/.config}/nvm" ]]; then
+ export NVM_DIR="${XDG_CONFIG_HOME:-$HOME/.config}/nvm"
+ elif (( $+commands[brew] )); then
+ NVM_HOMEBREW="${NVM_HOMEBREW:-${HOMEBREW_PREFIX:-$(brew --prefix)}/opt/nvm}"
+ if [[ -d "$NVM_HOMEBREW" ]]; then
+ export NVM_DIR="$NVM_HOMEBREW"
+ fi
+ fi
+fi
+
+if [[ -z "$NVM_DIR" ]] || [[ ! -f "$NVM_DIR/nvm.sh" ]]; then
+ return
+fi
+
+function _omz_nvm_setup_completion {
+ local _nvm_completion
+ # Load nvm bash completion
+ for _nvm_completion in "$NVM_DIR/bash_completion" "$NVM_HOMEBREW/etc/bash_completion.d/nvm"; do
+ if [[ -f "$_nvm_completion" ]]; then
+ # Load bashcompinit
+ autoload -U +X bashcompinit && bashcompinit
+ # Bypass compinit call in nvm bash completion script. See:
+ # https://github.com/nvm-sh/nvm/blob/4436638/bash_completion#L86-L93
+ ZSH_VERSION= source "$_nvm_completion"
+ break
+ fi
+ done
+ unfunction _omz_nvm_setup_completion
+}
+
+function _omz_nvm_setup_autoload {
+ if ! zstyle -t ':omz:plugins:nvm' autoload; then
+ unfunction _omz_nvm_setup_autoload
+ return
+ fi
+
+ # Autoload nvm when finding a .nvmrc file in the current directory
+ # Adapted from: https://github.com/nvm-sh/nvm#zsh
+ function load-nvmrc {
+ local nvmrc_path="$(nvm_find_nvmrc)"
+ local nvm_silent=""
+ zstyle -t ':omz:plugins:nvm' silent-autoload && nvm_silent="--silent"
+
+ if [[ -n "$nvmrc_path" ]]; then
+ local nvmrc_node_version=$(nvm version $(command cat "$nvmrc_path" | tr -dc '[:print:]'))
+
+ if [[ "$nvmrc_node_version" = "N/A" ]]; then
+ nvm install
+ elif [[ "$nvmrc_node_version" != "$(nvm version)" ]]; then
+ nvm use $nvm_silent
+ fi
+ elif [[ -n "$(PWD=$OLDPWD nvm_find_nvmrc)" ]] && [[ "$(nvm version)" != "$(nvm version default)" ]]; then
+ [[ -z $nvm_silent ]] && echo "Reverting to nvm default version"
+
+ nvm use default $nvm_silent
+ fi
+ }
+
+ autoload -U add-zsh-hook
+ add-zsh-hook chpwd load-nvmrc
+
+ load-nvmrc
+ unfunction _omz_nvm_setup_autoload
+}
+
+if zstyle -t ':omz:plugins:nvm' lazy; then
+ # Call nvm when first using nvm, node, npm, pnpm, yarn, corepack or other commands in lazy-cmd
+ zstyle -a ':omz:plugins:nvm' lazy-cmd nvm_lazy_cmd
+ nvm_lazy_cmd=(_omz_nvm_load nvm node npm npx pnpm pnpx yarn corepack $nvm_lazy_cmd) # default values
+ eval "
+ function $nvm_lazy_cmd {
+ for func in $nvm_lazy_cmd; do
+ if (( \$+functions[\$func] )); then
+ unfunction \$func
+ fi
+ done
+ # Load nvm if it exists in \$NVM_DIR
+ [[ -f \"\$NVM_DIR/nvm.sh\" ]] && source \"\$NVM_DIR/nvm.sh\"
+ _omz_nvm_setup_completion
+ _omz_nvm_setup_autoload
+ if [[ \"\$0\" != _omz_nvm_load ]]; then
+ \"\$0\" \"\$@\"
+ fi
+ }
+ "
+ unset nvm_lazy_cmd
+else
+ source "$NVM_DIR/nvm.sh"
+ _omz_nvm_setup_completion
+ _omz_nvm_setup_autoload
+fi