每当目录中有一个. nvmrc 文件时,自动运行‘ nvm use’

如何配置我的 shell,使 nvm use在每次有。目录中的 nvmrc 文件,并在没有。Nvmrc 文件?

103873 次浏览

我刚刚发现了 Node.js https://github.com/wbyoung/avn的自动版本切换,你可以使用它。

npm install -g avn avn-nvm avn-n
avn setup

您也可以按照这个线程进行操作 Https://github.com/creationix/nvm/issues/110

如果使用 (z shell) :

在具有.nvmrc 文件的目录中自动调用“ nvm use”

把这个放进你的 $HOME/。当您输入包含。Nvmrc 文件,其中包含一个字符串,告诉 nvm 使用哪个节点:

# place this after nvm initialization!
autoload -U add-zsh-hook
load-nvmrc() {
local node_version="$(nvm version)"
local nvmrc_path="$(nvm_find_nvmrc)"


if [ -n "$nvmrc_path" ]; then
local nvmrc_node_version=$(nvm version "$(cat "${nvmrc_path}")")


if [ "$nvmrc_node_version" = "N/A" ]; then
nvm install
elif [ "$nvmrc_node_version" != "$node_version" ]; then
nvm use
fi
elif [ "$node_version" != "$(nvm version default)" ]; then
echo "Reverting to nvm default version"
nvm use default
fi
}
add-zsh-hook chpwd load-nvmrc
load-nvmrc

更多信息: https://github.com/creationix/nvm#zsh

如果您使用 Bash,您可以将其添加到您的 ~/.bashrc文件:

_nvmrc_hook() {
if [[ $PWD == $PREV_PWD ]]; then
return
fi
  

PREV_PWD=$PWD
[[ -f ".nvmrc" ]] && nvm use
}


if ! [[ "${PROMPT_COMMAND:-}" =~ _nvmrc_hook ]]; then
PROMPT_COMMAND="_nvmrc_hook${PROMPT_COMMAND:+;$PROMPT_COMMAND}"
fi

@ Devius的回答很棒。

我只是扩展了它,这样它就可以在将带有 .nvmrc的目录保留到另一个没有 .nvmrc的目录时恢复到默认版本。

返回文章页面

#
# Run 'nvm use' automatically every time there's
# a .nvmrc file in the directory. Also, revert to default
# version when entering a directory without .nvmrc
#
enter_directory() {
if [[ $PWD == $PREV_PWD ]]; then
return
fi


PREV_PWD=$PWD
if [[ -f ".nvmrc" ]]; then
nvm use
NVM_DIRTY=true
elif [[ $NVM_DIRTY = true ]]; then
nvm use default
NVM_DIRTY=false
fi
}


export PROMPT_COMMAND="$PROMPT_COMMAND; enter_directory"

根据 @ Doug-barbieri的建议,如果工作目录中没有 .nvmrc文件,但父目录中有一个,那么下面的脚本不会将 节点修改回默认版本。

返回文章页面

enter_directory() {
if [[ $PWD == $PREV_PWD ]]; then
return
fi


if [[ "$PWD" =~ "$PREV_PWD" && ! -f ".nvmrc" ]]; then
return
fi


PREV_PWD=$PWD
if [[ -f ".nvmrc" ]]; then
nvm use
NVM_DIRTY=true
elif [[ $NVM_DIRTY = true ]]; then
nvm use default
NVM_DIRTY=false
fi
}

诀窍就在这里:

if [[ "$PWD" =~ "$PREV_PWD" && ! -f ".nvmrc" ]]; then
return
fi

它检查 PWD 是否包含 PREV _ PWD。


这可以扩展到 Starship (即使在 Windows 的 Git Bash 而不是 WSL 上)以及使用 starship_precmd_user_func

set_win_title() {
BASEPWD=$(basename "$PWD")
echo -ne "\033]0; 📁 $BASEPWD \a" < /dev/null
if [[ $PWD == $PREV_PWD ]]; then
return
fi


if [[ "$PWD" =~ "$PREV_PWD" && ! -f ".nvmrc" ]]; then
return
fi


PREV_PWD=$PWD
if [[ -f ".nvmrc" ]]; then
nvm use
NVM_DIRTY=true
elif [[ $NVM_DIRTY = true ]]; then
nvm use default
NVM_DIRTY=false
fi
}
starship_precmd_user_func="set_win_title"
eval "$(starship init bash)"

这个答案取自 < strong > 官方 nvm 文档

$HOME/.bashrc的末尾加上以下内容:

find-up () {
path=$(pwd)
while [[ "$path" != "" && ! -e "$path/$1" ]]; do
path=${path%/*}
done
echo "$path"
}


cdnvm(){
cd "$@";
nvm_path=$(find-up .nvmrc | tr -d '[:space:]')


# If there are no .nvmrc file, use the default nvm version
if [[ ! $nvm_path = *[^[:space:]]* ]]; then


declare default_version;
default_version=$(nvm version default);


# If there is no default version, set it to `node`
# This will use the latest version on your machine
if [[ $default_version == "N/A" ]]; then
nvm alias default node;
default_version=$(nvm version default);
fi


# If the current version is not the default version, set it to use the default version
if [[ $(nvm current) != "$default_version" ]]; then
nvm use default;
fi


elif [[ -s $nvm_path/.nvmrc && -r $nvm_path/.nvmrc ]]; then
declare nvm_version
nvm_version=$(<"$nvm_path"/.nvmrc)


# Add the `v` suffix if it does not exists in the .nvmrc file
if [[ $nvm_version != v* ]]; then
nvm_version="v""$nvm_version"
fi


# If it is not already installed, install it
if [[ $(nvm ls "$nvm_version" | tr -d '[:space:]') == "N/A" ]]; then
nvm install "$nvm_version";
fi


if [[ $(nvm current) != "$nvm_version" ]]; then
nvm use "$nvm_version";
fi
fi
}
alias cd='cdnvm'

这是一个改进:

这个别名会从你的工作目录上搜索,以便检测到一个 .nvmrc文件。如果找到它,它将切换到该版本; 如果没有,它将使用默认版本。

扩展到 @ Adriano P的答案,我建议这个版本不太一般(只有当 .nvmrc设置在 饭桶存储库根目录上时才有效) ,但是当我们导航到项目中的其他地方而不是它的根目录时有效:

_enter_dir() {
local git_root
git_root=$(git rev-parse --show-toplevel 2>/dev/null)


if [[ "$git_root" == "$PREV_PWD" ]]; then
return
elif [[ -n "$git_root" && -f "$git_root/.nvmrc" ]]; then
nvm use
NVM_DIRTY=1
elif [[ "$NVM_DIRTY" == 1 ]]; then
nvm use default
NVM_DIRTY=0
fi
PREV_PWD="$git_root"
}


export PROMPT_COMMAND=_enter_dir
#export PROMPT_COMMAND="$PROMPT_COMMAND;_enter_dir"  # use this if PROMPT_COMMAND already defined

我使用这个名为 Oh My Zsh 的 Zsh 配置框架。这是一个非常活跃的仓库,定期更新。试试看,我相信你会喜欢的。哦,还有自动档的。Nvmrc 功能内置,所以它的简单安装包通过 npm!

Https://github.com/robbyrussell/oh-my-zsh

对于仍然面临上述问题的人来说,nvm的 README 有这一节,这将是有帮助的 Https://github.com/creationix/nvm#deeper-shell-integration

就个人而言,我更喜欢编辑 .bashrc(https://github.com/creationix/nvm#automatically-call-nvm-use)超过其他解决方案。

我尝试了很多解决方案,但没有一个是我想要的,所以我写了自己的:

ZSH 功能自动切换到正确的节点版本

据我所知,这是唯一一个符合以下所有标准:

  • 通过搜索目录树来找到最接近的 .nvmrc(就像 nvm use一样) ,确保您始终处于正确的版本;
  • 可以处理任何有效的 .nvmrc格式;
  • 如果没有安装的版本满足 .nvmrc,
  • 假设你想要的 default,如果没有 .nvmrc的任何地方向上的树;
  • 如果已经使用正确的 Node 版本,则完全静默且快速

还有一种使用 Direnv.Direnv 的解决方案,它带有 OSX 和许多发行版,因此不需要安装。

将这两行添加到. zshenv 或. bash _ profile,具体取决于使用哪个 shell:


export NVM_DIR="$HOME/.nvm" # You probably have this line already
export NODE_VERSIONS="${NVM_DIR}/versions/node"
export NODE_VERSION_PREFIX="v"

向项目根目录添加一个. envrc 文件,其中包含

set -e
use node

最后 cd 到您的目录。(不要忘记源代码。 zshenv)

Direnv 将要求您允许加载配置。 输入 direnv allow瞧!

请注意,direnv 不支持类似 lts/*的奇特构造。Nvrmc.从积极的方面来看,direnv 支持一系列运行时,比如 node、 php、 go、 pyhton、 ruby 等,允许我们使用单一工具来解决路径问题。

如果使用 zsh (zshell) :

我用不同的方式加载 nvm,这样更快,但这意味着 nvm_find_nvmrc不可用,所以@Rotareti 解决方案对我不起作用。

我找到了任何简单的修复方法: 只需调用不带参数的 nvm use,因为它已经处理了查找 .nvmrc文件本身的逻辑,如果没有找到,则使用默认版本。

# ~/.zshrc


# DEFAULT NVM CONFIG
#export NVM_DIR="$HOME/.nvm"
#[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
#[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  # This loads nvm bash_completion


# Add the following lines before all other OH MY ZSH config
# FASTER WAY TO CONFIGURE NVM ON STARTUP - OTHERWISE IT'S REALLY SLOW
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/bash_completion" ] && . "$NVM_DIR/bash_completion"
export PATH="$NVM_DIR/versions/node/v$(<$NVM_DIR/alias/default)/bin:$PATH"
alias nvm="unalias nvm; [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"; nvm $@"


# USE NVM VERSION IF .NVMRC FOUND, OTHERWISE USE DEFAULT
nvm use &>/dev/null


总之,我发现这是一个非常快速的解决方案,省去了键入 nvm use的麻烦。

我想避免 nvm use时,没有 .nvmrc文件可用,但加载时间在我的计算机上是相当低的,因为它的立场,我很少需要一个没有节点的终端-所以这对我现在的工作。

更新: 添加了关于在何处放置建议脚本的说明

Bash 版本(放入 $HOME/.bashrc) ,具有以下特性:

  • 不使用 cd别名(它允许以其他方式更改目录,例如直接在另一个目录中启动终端)
  • 在上面的目录中找到 .nvmrc(using nvm_find_nvmrc)
  • 如果不需要,不会调用 nvm use
call_nvm_use_if_needed() {
NEW_NVMRC="$(nvm_find_nvmrc)"
if [[ "$NEW_NVMRC" != "$CURRENT_NVMRC" ]]; then
if [[ -z "$NEW_NVMRC" ]]; then
nvm use default
else
nvm use
fi
CURRENT_NVMRC="$NEW_NVMRC"
fi
}


PROMPT_COMMAND="call_nvm_use_if_needed; ${PROMPT_COMMAND}"

对于 zsh 用户,您应该尝试 Zsh-nvm:

用于安装、更新和加载 nvm 的 Zsh 插件

假设你正在使用抗原,你可以像这样打开自动使用:

export NVM_AUTO_USE=true
antigen bundle lukechilds/zsh-nvm

Zsh-nvm 还支持 延迟加载,,这大大减少了 zsh 的启动时间

% time (source "$NVM_DIR/nvm.sh")
( source "$NVM_DIR/nvm.sh"; )  0.58s user 0.37s system 109% cpu 0.874 total


% time (_zsh_nvm_lazy_load)
( _zsh_nvm_lazy_load; )  0.01s user 0.01s system 168% cpu 0.012 total

对于 Windows、 zsh 和 coreybutler 的 Nvm-windows用户,这个根据上面的答案稍作修改的脚本可能会在您的。Zshrc:

autoload -U add-zsh-hook
load-nvmrc() {
if [ -f ".nvmrc" ]; then
local required_version=$(cat .nvmrc | cut -c2-)
local current_version=$(node -v)
echo "Required Node version: $required_version"
local is_available_already=$(nvm ls | grep -c "$required_version")
if [[ $required_version != $current_version && $is_available_already -lt 1 ]]; then
echo "Required version $required_version not installed, installing..."
nvm install $required_version
fi
nvm use $required_version
fi
}
add-zsh-hook chpwd load-nvmrc
load-nvmrc

对于那些使用 Apple Silicon (M1) Mac 的用户,您可能已经注意到,NVM 尝试在 nvm install上从源代码编译 Node 版本 < 16,但是失败了。下面是对 @ Rotareti’s and@Reynke’s answer的一个更新,它使用 Rosetta 为 Node < 16安装 x86 _ 64版本,同时为 Node > = 16安装本地 ARM 版本,因为 Node 16是支持 Apple Silicon 的最早版本。

一旦安装完毕,您可以从本机或 rosetta 终端使用正确的版本 nvm use,因此只有原始函数的 nvm install部分会发生变化。

用 nvm 安装路径替换 /opt/homebrew/opt/nvm/nvm.sh

~/.zshrc

# place this after nvm initialization!
autoload -U add-zsh-hook
load-nvmrc() {
local node_version="$(nvm version)"
local nvmrc_path="$(nvm_find_nvmrc)"


if [ -n "$nvmrc_path" ]; then
local nvmrc_node_version=$(nvm version "$(cat "${nvmrc_path}")")


if [ "$nvmrc_node_version" = "N/A" ]; then
# check if we're in a native (ARM) terminal
if [[ $(uname -p) == "arm" ]]; then
local nvmrc_remote_version=$(nvm version-remote "$(cat "${nvmrc_path}")")


if printf '%s\n%s\n' v16.0.0 "${nvmrc_remote_version}" | sort -VC; then
# arm and node >= v16; install native node
nvm install
else
# arm and node < v16; install x64 node using rosetta
arch -x86_64 zsh -c '. "/opt/homebrew/opt/nvm/nvm.sh"; nvm install'
nvm use
fi
else
# not arm
nvm install
fi
elif [ "$nvmrc_node_version" != "$node_version" ]; then
nvm use
fi
elif [ "$node_version" != "$(nvm version default)" ]; then
echo "Reverting to nvm default version"
nvm use default
fi
}
add-zsh-hook chpwd load-nvmrc
load-nvmrc

当您使用 fish shell 时,以下是如何在目录中有 .nvmrc时运行 nvm use:

# TODO: save this as `$HOME/.config/fish/conf.d/use_nvmrc.fish`


# HOW IT WORKS
# `nvm use` whenever .nvmrc is present in $PWD when using fish shell
# when traveling deeper, use the parent .nvmrc unless otherwise set
# also go back to default nvm when leaving the nvmrc-specified zone


function set_nvm --on-event fish_prompt
# runs whenever the fish_prompt event occurs
# if the current directory hasn't changed, do nothing
string match -q $PWD $PREV_PWD; and return 1


# if the current directory is within the previous one where we found an nvmrc
# and there is no subsequent .nvmrc here, do nothing, we are in the same repo
string match -eq $PREV_PWD $PWD; and not test -e '.nvmrc'; and return 1


# if we clear those checks, keep track of where we are
set -g PREV_PWD $PWD


if test -e '.nvmrc'


# if we find .nvmrc, run nvm use
nvm use


# and remember that we used that node
set NVM_DIRTY true


else if not string match $NVM_DIRTY true


# if we have set nvm and have stepped out of that repo
# go back to default node, if not already on it
not string match -eq (nvm current) (nvm alias default); and nvm use default


# and clear the flag
set NVM_DIRTY
end
end

这个版本将保持 cd的性能

autoload -U add-zsh-hook
use_nvmrc_version_automatically() {
if [[ -f .nvmrc ]]; then
echo ".nvmrc FOUND now INSTALLING and USING $(cat .nvmrc)"
nvm install $(cat .nvmrc) && nvm use $(cat .nvmrc)
fi
}
add-zsh-hook chpwd use_nvmrc_version_automatically
use_nvmrc_version_automatically

现在有关于如何很好地做到这一点的官方文档,请参阅 https://github.com/nvm-sh/nvm#deeper-shell-integration上更深入的 shell 集成

实际上,我已经使用 Rotareti 的解决方案一段时间了,如果没有 .nvmrc,就使用 在使用它的版本之前(这实际上是作者最初问的问题)。

所以我稍微修改了一下,所需要的只是一些替换/添加的代码行:

# Load right version of NVM
autoload -U add-zsh-hook
load-nvmrc() {
local node_version="$(nvm version)"
local nvmrc_path="$(nvm_find_nvmrc)"


if [ -n "$nvmrc_path" ]; then
local nvmrc_node_version=$(nvm version "$(cat "${nvmrc_path}")")


if [ "$nvmrc_node_version" = "N/A" ]; then
nvm install
elif [ "$nvmrc_node_version" != "$node_version" ]; then
nvm use
fi
elif [ "$node_version" != "$(nvm version-remote --lts)" ]; then
if [[ "$(nvm ls)" != *"$(nvm version-remote --lts)"* ]]; then
echo "New lts version available. Installing..."
nvm install --lts
fi
echo "Reverting to node lts version"
nvm use --lts
fi
}
add-zsh-hook chpwd load-nvmrc
load-nvmrc