This commit is contained in:
Chauncey McAskill 2024-06-03 04:45:49 +01:00 committed by GitHub
commit 3f8a68c1c3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 55 additions and 11 deletions

View File

@ -40,6 +40,7 @@
- [Set default node version](#set-default-node-version) - [Set default node version](#set-default-node-version)
- [Use a mirror of node binaries](#use-a-mirror-of-node-binaries) - [Use a mirror of node binaries](#use-a-mirror-of-node-binaries)
- [.nvmrc](#nvmrc) - [.nvmrc](#nvmrc)
- [.node-version](#node-version)
- [Deeper Shell Integration](#deeper-shell-integration) - [Deeper Shell Integration](#deeper-shell-integration)
- [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)
- [bash](#bash) - [bash](#bash)
@ -565,6 +566,16 @@ Now using node v5.9.1 (npm v3.7.3)
The contents of a `.nvmrc` file **must** be the `<version>` (as described by `nvm --help`) followed by a newline. No trailing spaces are allowed, and the trailing newline is required. The contents of a `.nvmrc` file **must** be the `<version>` (as described by `nvm --help`) followed by a newline. No trailing spaces are allowed, and the trailing newline is required.
### .node-version
For a little compatability with other node version managers, nvm will also sniff for `.node-version` files, defaulting to `.nvmrc` if both are found in the same folder.
```
$ echo "5.9" > .node-version
```
Unlike `.nvmrc`, `.node-version` cannot contain a "versionish" (an alias, like `node`, `iojs`, or a custom alias youve defined). `.node-version` can only have versions in the format of v1, v1.2, or v1.2.3 (the `v` is optional).
### Deeper Shell Integration ### Deeper Shell Integration
You can use [`avn`](https://github.com/wbyoung/avn) to deeply integrate into your shell and automatically invoke `nvm` when changing directories. `avn` is **not** supported by the `nvm` maintainers. Please [report issues to the `avn` team](https://github.com/wbyoung/avn/issues/new). You can use [`avn`](https://github.com/wbyoung/avn) to deeply integrate into your shell and automatically invoke `nvm` when changing directories. `avn` is **not** supported by the `nvm` maintainers. Please [report issues to the `avn` team](https://github.com/wbyoung/avn/issues/new).

29
nvm.sh
View File

@ -452,19 +452,27 @@ nvm_find_project_dir() {
# Traverse up in directory tree to find containing folder # Traverse up in directory tree to find containing folder
nvm_find_up() { nvm_find_up() {
local path_ local path_
local file
path_="${PWD}" path_="${PWD}"
while [ "${path_}" != "" ] && [ "${path_}" != '.' ] && [ ! -f "${path_}/${1-}" ]; do
# Iterate through the multiple files
while [ $# -ne 0 ]; do
# Look for files in turn in this path_
while [ "${path_}" != "" ] && [ "${path_}" != '.' ]; do
# Is the file here?
if [ -f "${path_}/${1-}" ]; then
file="${path_}/${1-}"
echo "${file}"
break 2
fi
path_=${path_%/*} path_=${path_%/*}
done done
nvm_echo "${path_}" shift
done
} }
nvm_find_nvmrc() { nvm_find_nvmrc() {
local dir nvm_echo "$(nvm_find_up '.nvmrc' '.node-version')"
dir="$(nvm_find_up '.nvmrc')"
if [ -e "${dir}/.nvmrc" ]; then
nvm_echo "${dir}/.nvmrc"
fi
} }
# Obtain nvm version from rc file # Obtain nvm version from rc file
@ -474,19 +482,20 @@ nvm_rc_version() {
NVMRC_PATH="$(nvm_find_nvmrc)" NVMRC_PATH="$(nvm_find_nvmrc)"
if [ ! -e "${NVMRC_PATH}" ]; then if [ ! -e "${NVMRC_PATH}" ]; then
if [ "${NVM_SILENT:-0}" -ne 1 ]; then if [ "${NVM_SILENT:-0}" -ne 1 ]; then
nvm_err "No .nvmrc file found" nvm_err "No .nvmrc or .node-version file found"
fi fi
return 1 return 1
fi fi
NVMRC_BASENAME="$(command basename "$NVMRC_PATH")"
NVM_RC_VERSION="$(command head -n 1 "${NVMRC_PATH}" | command tr -d '\r')" || command printf '' NVM_RC_VERSION="$(command head -n 1 "${NVMRC_PATH}" | command tr -d '\r')" || command printf ''
if [ -z "${NVM_RC_VERSION}" ]; then if [ -z "${NVM_RC_VERSION}" ]; then
if [ "${NVM_SILENT:-0}" -ne 1 ]; then if [ "${NVM_SILENT:-0}" -ne 1 ]; then
nvm_err "Warning: empty .nvmrc file found at \"${NVMRC_PATH}\"" nvm_err "Warning: empty '${NVMRC_BASENAME}' file found at \"${NVMRC_PATH}\""
fi fi
return 2 return 2
fi fi
if [ "${NVM_SILENT:-0}" -ne 1 ]; then if [ "${NVM_SILENT:-0}" -ne 1 ]; then
nvm_echo "Found '${NVMRC_PATH}' with version <${NVM_RC_VERSION}>" nvm_echo "Found '${NVMRC_BASENAME}' with version <${NVM_RC_VERSION}>"
fi fi
} }

View File

@ -8,3 +8,7 @@ nvm install --lts
if [ -f ".nvmrc" ]; then if [ -f ".nvmrc" ]; then
mv .nvmrc .nvmrc.bak mv .nvmrc .nvmrc.bak
fi fi
if [ -f ".node-version" ]; then
mv .node-version .node-version.bak
fi

View File

@ -7,7 +7,12 @@ nvm uninstall v1.0.0
nvm uninstall --lts nvm uninstall --lts
rm .nvmrc rm .nvmrc
rm .node-version
if [ -f ".nvmrc.bak" ]; then if [ -f ".nvmrc.bak" ]; then
mv .nvmrc.bak .nvmrc mv .nvmrc.bak .nvmrc
fi fi
if [ -f ".node-version.bak" ]; then
mv .node-version.bak .node-version
fi

View File

@ -12,6 +12,21 @@ echo "0.10.7" > .nvmrc
[ "$(nvm run --version | head -1)" = "Found '$PWD/.nvmrc' with version <0.10.7>" ] || die "\`nvm run\` failed to print out the \"found in .nvmrc\" message" [ "$(nvm run --version | head -1)" = "Found '$PWD/.nvmrc' with version <0.10.7>" ] || die "\`nvm run\` failed to print out the \"found in .nvmrc\" message"
echo "0.12.0" > .node-version
[ "$(nvm run --version | tail -1)" = "v0.10.7" ] || die "\`nvm run\` failed to run with the .nvmrc version"
[ "$(nvm run --version | head -1)" = "Found '$PWD/.nvmrc' with version <0.10.7>" ] || die "\`nvm run\` failed to print out the \"found in .nvmrc\" message"
rm .nvmrc
[ "$(nvm run --version | tail -1)" = "v0.12.0" ] || die "\`nvm run\` failed to run with the .node-version version"
[ "$(nvm run --version | head -1)" = "Found '$PWD/.node-version' with version <0.12.0>" ] || die "\`nvm run\` failed to print out the \"found in .node-version\" message"
rm .node-version
echo "foo" > .nvmrc echo "foo" > .nvmrc
# running nvm run with .nvmrc should not print the version information when not installed # running nvm run with .nvmrc should not print the version information when not installed