This commit is contained in:
Ben Wiley 2018-10-22 20:12:27 +00:00 committed by GitHub
commit f01fd23861
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 10 deletions

View File

@ -20,8 +20,9 @@
- [Listing versions](#listing-versions)
- [.nvmrc](#nvmrc)
- [Deeper Shell Integration](#deeper-shell-integration)
- [zsh](#zsh)
- [Calling `nvm use` automatically in a directory with a `.nvmrc` file](#calling-nvm-use-automatically-in-a-directory-with-a-nvmrc-file)
- [Calling `nvm use` automatically in a directory with a `.nvmrc` file](#calling-nvm-use-automatically-in-a-directory-with-a-nvmrc-file)
- [zsh](#zsh)
- [other shells (e.g. bash)](#other-shells-eg-bash)
- [License](#license)
- [Running tests](#running-tests)
- [Bash completion](#bash-completion)
@ -377,16 +378,11 @@ You can use [`avn`](https://github.com/wbyoung/avn) to deeply integrate into you
If you prefer a lighter-weight solution, the recipes below have been contributed by `nvm` users. They are **not** supported by the `nvm` development team. We are, however, accepting pull requests for more examples.
#### zsh
#### Calling `nvm use` automatically in a directory with a `.nvmrc` file
##### Calling `nvm use` automatically in a directory with a `.nvmrc` file
This shell function will install (if needed) and `nvm use` the specified Node version when an `.nvmrc` is found, and `nvm use default` otherwise.
Put this into your `$HOME/.zshrc` to call `nvm use` automatically whenever you enter a directory that contains an
`.nvmrc` file with a string telling nvm which node to `use`:
```zsh
# place this after nvm initialization!
autoload -U add-zsh-hook
```sh
load-nvmrc() {
local node_version="$(nvm version)"
local nvmrc_path="$(nvm_find_nvmrc)"
@ -404,10 +400,29 @@ load-nvmrc() {
nvm use default
fi
}
```
In your profile (`~/.bash_profile`, `~/.zshrc`, `~/.profile`, or `~/.bashrc`), add `load-nvmrc` along with one of the following hook listeners to call `load-nvmrc` whenever you enter a new directory:
##### zsh
```zsh
autoload -U add-zsh-hook
add-zsh-hook chpwd load-nvmrc
load-nvmrc
```
##### other shells (e.g. bash)
```sh
# note: overrides the `cd` command
cd() {
builtin cd "$1"
load-nvmrc
}
load-nvmrc
```
## License
nvm is released under the MIT license.