summaryrefslogtreecommitdiff
path: root/plugins/nvm/README.md
diff options
context:
space:
mode:
authorGuo, Quan <1118270+guoquan@users.noreply.github.com>2021-06-14 01:32:47 +0800
committerGitHub <noreply@github.com>2021-06-13 10:32:47 -0700
commit70a0577712bc8f78e14173c8032df3701ea2887f (patch)
tree81318c231673ea79a0d75dab35295b6bd06c3f88 /plugins/nvm/README.md
parent36cc94f3dcd8d6214b5a4bedf180bc723eb49a3f (diff)
downloadzsh-70a0577712bc8f78e14173c8032df3701ea2887f.tar.gz
zsh-70a0577712bc8f78e14173c8032df3701ea2887f.tar.bz2
zsh-70a0577712bc8f78e14173c8032df3701ea2887f.zip
feat(nvm): introduce customizable list of command that triggers lazy loading (#9946)
* Add customizable list of command that triggers lazy loading * Add $NVM_LAZY_CMD * Add instruction to `NVM_LAZY_CMD` in README.md
Diffstat (limited to 'plugins/nvm/README.md')
-rw-r--r--plugins/nvm/README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/plugins/nvm/README.md b/plugins/nvm/README.md
index 700613085..0c2bbf9f0 100644
--- a/plugins/nvm/README.md
+++ b/plugins/nvm/README.md
@@ -21,7 +21,11 @@ These settings should go in your zshrc file, before Oh My Zsh is sourced:
- **`NVM_LAZY`**: if you want the plugin to defer the load of nvm to speed-up the start of your zsh session,
set `NVM_LAZY` to `1`. This will use the `--no-use` parameter when loading nvm, and will create a function
- for `node`, `npm` and `yarn`, so when you call either of these three, nvm will load with `nvm use default`.
+ for `node`, `npm`, `yarn`, and the command(s) specified by `NVM_LAZY_CMD`, so when you call either of them,
+ nvm will load with `nvm use default`.
+
+- **`NVM_LAZY_CMD`**: if you want additional command(s) to trigger lazy loading of nvm, set `NVM_LAZY_CMD` to
+ the command or an array of the commands.
- **`NVM_AUTOLOAD`**: if `NVM_AUTOLOAD` is set to `1`, 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