diff --git a/.editorconfig b/.editorconfig index 70c43d3..bec8105 100644 --- a/.editorconfig +++ b/.editorconfig @@ -26,3 +26,10 @@ insert_final_newline = off [Makefile] indent_style = tab + +[test/fixtures/nvmrc/**] +indent_style = off +insert_final_newline = off + +[test/fixtures/actual/alias/empty] +insert_final_newline = off diff --git a/.github/workflows/latest-npm.yml b/.github/workflows/latest-npm.yml index 8f3bc18..b368080 100644 --- a/.github/workflows/latest-npm.yml +++ b/.github/workflows/latest-npm.yml @@ -2,6 +2,9 @@ name: 'Tests: `nvm install-latest-npm`' on: [pull_request, push] +permissions: + contents: read + jobs: matrix: runs-on: ubuntu-latest diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index b0a61f6..3e915ba 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -2,10 +2,11 @@ name: 'Tests: linting' on: [pull_request, push] +permissions: + contents: read + jobs: eclint: - permissions: - contents: read runs-on: ubuntu-latest steps: - uses: step-security/harden-runner@v2 @@ -23,8 +24,6 @@ jobs: - run: npm run eclint dockerfile_lint: - permissions: - contents: read runs-on: ubuntu-latest steps: - uses: step-security/harden-runner@v2 @@ -44,8 +43,6 @@ jobs: - run: npm run dockerfile_lint doctoc: - permissions: - contents: read runs-on: ubuntu-latest steps: - uses: step-security/harden-runner@v2 @@ -63,8 +60,6 @@ jobs: - run: npm run doctoc:check test_naming: - permissions: - contents: read runs-on: ubuntu-latest steps: - uses: step-security/harden-runner@v2 diff --git a/.github/workflows/rebase.yml b/.github/workflows/rebase.yml index e7724ae..5cfc9c4 100644 --- a/.github/workflows/rebase.yml +++ b/.github/workflows/rebase.yml @@ -2,6 +2,9 @@ name: Automatic Rebase on: [pull_request_target] +permissions: + contents: read + jobs: _: permissions: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 346a184..84fe2d8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -2,10 +2,11 @@ name: 'Tests: release process' on: [pull_request, push] +permissions: + contents: read + jobs: release: - permissions: - contents: read runs-on: ubuntu-latest steps: - name: Harden Runner diff --git a/.github/workflows/require-allow-edits.yml b/.github/workflows/require-allow-edits.yml index efb6c49..13cafee 100644 --- a/.github/workflows/require-allow-edits.yml +++ b/.github/workflows/require-allow-edits.yml @@ -2,6 +2,9 @@ name: Require “Allow Edits” on: [pull_request_target] +permissions: + contents: read + jobs: _: permissions: diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml index ed0f614..3534809 100644 --- a/.github/workflows/shellcheck.yml +++ b/.github/workflows/shellcheck.yml @@ -2,10 +2,11 @@ name: 'Tests: shellcheck' on: [pull_request, push] +permissions: + contents: read + jobs: shellcheck_matrix: - permissions: - contents: read runs-on: ubuntu-latest strategy: fail-fast: false @@ -52,8 +53,4 @@ jobs: needs: [shellcheck_matrix] runs-on: ubuntu-latest steps: - - name: Harden Runner - uses: step-security/harden-runner@v2 - with: - egress-policy: block - run: true diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 7480c33..60f7c05 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -2,6 +2,9 @@ name: urchin tests on: [push] +permissions: + contents: read + jobs: tests: permissions: @@ -49,6 +52,8 @@ jobs: - run: make TERM=xterm-256color TEST_SUITE="${{ matrix.suite }}" SHELL="${{ matrix.shell }}" URCHIN="$(npx which urchin)" test-${{ matrix.shell }} nvm: + permissions: + contents: none name: 'all test suites, all shells' needs: [tests] runs-on: ubuntu-latest diff --git a/.github/workflows/toc.yml b/.github/workflows/toc.yml index 94c8f0d..8772bcc 100644 --- a/.github/workflows/toc.yml +++ b/.github/workflows/toc.yml @@ -2,6 +2,9 @@ name: update readme TOC on: [push] +permissions: + contents: read + jobs: _: permissions: diff --git a/.github/workflows/windows-npm.yml b/.github/workflows/windows-npm.yml index 51234ae..6119f79 100644 --- a/.github/workflows/windows-npm.yml +++ b/.github/workflows/windows-npm.yml @@ -2,6 +2,9 @@ name: 'Tests on Windows: `nvm install`' on: [pull_request, push] +permissions: + contents: read + env: NVM_INSTALL_GITHUB_REPO: ${{ github.repository }} NVM_INSTALL_VERSION: ${{ github.sha }} diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..8503510 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "test/fixtures/nvmrc"] + path = test/fixtures/nvmrc + url = git@github.com:nvm-sh/nvmrc.git diff --git a/.travis.yml b/.travis.yml index a4a774f..d07ba1f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,6 +8,10 @@ addons: # - gcc-4.8 # - g++-4.8 +# https://gist.github.com/iedemam/9830045 +git: + submodules: false + cache: ccache: true directories: @@ -16,6 +20,11 @@ cache: before_install: - sudo sed -i 's/mozilla\/DST_Root_CA_X3.crt/!mozilla\/DST_Root_CA_X3.crt/g' /etc/ca-certificates.conf - sudo update-ca-certificates -f + + # https://gist.github.com/iedemam/9830045 + - sed -i 's/git@github.com:/https:\/\/github.com\//' .gitmodules + - git submodule update --init --recursive + - $SHELL --version 2> /dev/null || dpkg -s $SHELL 2> /dev/null || which $SHELL - curl --version - wget --version diff --git a/README.md b/README.md index 9e47e01..cc021e6 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ -# Node Version Manager [![Build Status](https://app.travis-ci.com/nvm-sh/nvm.svg?branch=master)][3] [![nvm version](https://img.shields.io/badge/version-v0.39.7-yellow.svg)][4] [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/684/badge)](https://bestpractices.coreinfrastructure.org/projects/684) +# Node Version Manager [![Build Status](https://app.travis-ci.com/nvm-sh/nvm.svg?branch=master)][3] [![nvm version](https://img.shields.io/badge/version-v0.39.7-yellow.svg)][4] [![CII Best Practices](https://bestpractices.dev/projects/684/badge)](https://bestpractices.dev/projects/684) @@ -298,6 +298,13 @@ To install a specific version of node: nvm install 14.7.0 # or 16.3.0, 12.22.1, etc ``` +To set an alias: + +```sh +nvm alias my_alias v14.4.0 +``` +Make sure that your alias does not contain any spaces or slashes. + The first version installed becomes the default. New shells will start with the default version of node (e.g., `nvm alias default`). You can list available versions using `ls-remote`: @@ -563,7 +570,11 @@ Now using node v5.9.1 (npm v3.7.3) `nvm use` et. al. will traverse directory structure upwards from the current directory looking for the `.nvmrc` file. In other words, running `nvm use` et. al. in any subdirectory of a directory with an `.nvmrc` will result in that `.nvmrc` being utilized. -The contents of a `.nvmrc` file **must** be the `` (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** contain precisely one `` (as described by `nvm --help`) followed by a newline. `.nvmrc` files may also have comments. The comment delimiter is `#`, and it and any text after it, as well as blank lines, and leading and trailing white space, will be ignored when parsing. + +Key/value pairs using `=` are also allowed and ignored, but are reserved for future use, and may cause validation errors in the future. + +Run [`npx nvmrc`](https://npmjs.com/nvmrc) to validate an `.nvmrc` file. If that tool’s results do not agree with nvm, one or the other has a bug - please file an issue. ### Deeper Shell Integration diff --git a/nvm.sh b/nvm.sh index 30433f0..71c151c 100644 --- a/nvm.sh +++ b/nvm.sh @@ -468,7 +468,89 @@ nvm_find_nvmrc() { fi } -# Obtain nvm version from rc file +nvm_nvmrc_invalid_msg() { + local error_text + error_text="invalid .nvmrc! +all non-commented content (anything after # is a comment) must be either: + - a single bare nvm-recognized version-ish + - or, multiple distinct key-value pairs, each key/value separated by a single equals sign (=) + +additionally, a single bare nvm-recognized version-ish must be present (after stripping comments)." + + local warn_text + warn_text="non-commented content parsed: +${1}" + + nvm_err "$(nvm_wrap_with_color_code r "${error_text}") + +$(nvm_wrap_with_color_code y "${warn_text}")" +} + +nvm_process_nvmrc() { + local NVMRC_PATH="$1" + local lines + local unpaired_line + + lines=$(command sed 's/#.*//' "$NVMRC_PATH" | command sed 's/^[[:space:]]*//;s/[[:space:]]*$//' | nvm_grep -v '^$') + + if [ -z "$lines" ]; then + nvm_nvmrc_invalid_msg "${lines}" + return 1 + fi + + # Initialize key-value storage + local keys='' + local values='' + + while IFS= read -r line; do + if [ -z "${line}" ]; then + continue + elif [ -z "${line%%=*}" ]; then + if [ -n "${unpaired_line}" ]; then + nvm_nvmrc_invalid_msg "${lines}" + return 1 + fi + unpaired_line="${line}" + elif case "$line" in *'='*) true;; *) false;; esac; then + key="${line%%=*}" + value="${line#*=}" + + # Trim whitespace around key and value + key=$(nvm_echo "${key}" | command sed 's/^[[:space:]]*//;s/[[:space:]]*$//') + value=$(nvm_echo "${value}" | command sed 's/^[[:space:]]*//;s/[[:space:]]*$//') + + # Check for invalid key "node" + if [ "${key}" = 'node' ]; then + nvm_nvmrc_invalid_msg "${lines}" + return 1 + fi + + # Check for duplicate keys + if nvm_echo "${keys}" | nvm_grep -q -E "(^| )${key}( |$)"; then + nvm_nvmrc_invalid_msg "${lines}" + return 1 + fi + keys="${keys} ${key}" + values="${values} ${value}" + else + if [ -n "${unpaired_line}" ]; then + nvm_nvmrc_invalid_msg "${lines}" + return 1 + fi + unpaired_line="${line}" + fi + done </dev/null 2>&1 unset NVM_RC_VERSION NVM_NODEJS_ORG_MIRROR NVM_IOJS_ORG_MIRROR NVM_DIR \ NVM_CD_FLAGS NVM_BIN NVM_INC NVM_MAKE_JOBS \ diff --git a/test/common.sh b/test/common.sh index beadafa..f5bf6ff 100644 --- a/test/common.sh +++ b/test/common.sh @@ -101,3 +101,147 @@ watch() { kill %2; return $EXIT_CODE } + + +# JSON parsing from https://gist.github.com/assaf/ee377a186371e2e269a7 +nvm_json_throw() { + nvm_err "$*" + exit 1 +} + +nvm_json_awk_egrep() { + local pattern_string + pattern_string="${1}" + + awk '{ + while ($0) { + start=match($0, pattern); + token=substr($0, start, RLENGTH); + print token; + $0=substr($0, start+RLENGTH); + } + }' "pattern=${pattern_string}" +} + +nvm_json_tokenize() { + local GREP + GREP='grep -Eao' + + local ESCAPE + local CHAR + + # if echo "test string" | grep -Eo "test" > /dev/null 2>&1; then + # ESCAPE='(\\[^u[:cntrl:]]|\\u[0-9a-fA-F]{4})' + # CHAR='[^[:cntrl:]"\\]' + # else + GREP=nvm_json_awk_egrep + ESCAPE='(\\\\[^u[:cntrl:]]|\\u[0-9a-fA-F]{4})' + CHAR='[^[:cntrl:]"\\\\]' + # fi + + local STRING + STRING="\"${CHAR}*(${ESCAPE}${CHAR}*)*\"" + local NUMBER + NUMBER='-?(0|[1-9][0-9]*)([.][0-9]*)?([eE][+-]?[0-9]*)?' + local KEYWORD + KEYWORD='null|false|true' + local SPACE + SPACE='[[:space:]]+' + + $GREP "${STRING}|${NUMBER}|${KEYWORD}|${SPACE}|." | TERM=dumb grep -Ev "^${SPACE}$" +} + +_json_parse_array() { + local index=0 + local ary='' + read -r token + case "$token" in + ']') ;; + *) + while :; do + _json_parse_value "${1}" "${index}" + index=$((index+1)) + ary="${ary}${value}" + read -r token + case "${token}" in + ']') break ;; + ',') ary="${ary}," ;; + *) nvm_json_throw "EXPECTED , or ] GOT ${token:-EOF}" ;; + esac + read -r token + done + ;; + esac + : +} + +_json_parse_object() { + local key + local obj='' + read -r token + case "$token" in + '}') ;; + *) + while :; do + case "${token}" in + '"'*'"') key="${token}" ;; + *) nvm_json_throw "EXPECTED string GOT ${token:-EOF}" ;; + esac + read -r token + case "${token}" in + ':') ;; + *) nvm_json_throw "EXPECTED : GOT ${token:-EOF}" ;; + esac + read -r token + _json_parse_value "${1}" "${key}" + obj="${obj}${key}:${value}" + read -r token + case "${token}" in + '}') break ;; + ',') obj="${obj}," ;; + *) nvm_json_throw "EXPECTED , or } GOT ${token:-EOF}" ;; + esac + read -r token + done + ;; + esac + : +} + +_json_parse_value() { + local jpath="${1:+$1,}$2" + local isleaf=0 + local isempty=0 + local print=0 + + case "$token" in + '{') _json_parse_object "${jpath}" ;; + '[') _json_parse_array "${jpath}" ;; + # At this point, the only valid single-character tokens are digits. + ''|[!0-9]) nvm_json_throw "EXPECTED value GOT >${token:-EOF}<" ;; + *) + value=$token + isleaf=1 + [ "${value}" = '""' ] && isempty=1 + ;; + esac + + [ "${value}" = '' ] && return + [ "${isleaf}" -eq 1 ] && [ $isempty -eq 0 ] && print=1 + [ "${print}" -eq 1 ] && printf "[%s]\t%s\n" "${jpath}" "${value}" + : +} + +_json_parse() { + read -r token + _json_parse_value + read -r token + case "${token}" in + '') ;; + *) nvm_json_throw "EXPECTED EOF GOT >${token}<" ;; + esac +} + +nvm_json_extract() { + nvm_json_tokenize | _json_parse | grep -e "${1}" | awk '{print $2 $3}' +} diff --git a/test/fast/Aliases/'nvm alias' should not accept aliases with a hash b/test/fast/Aliases/'nvm alias' should not accept aliases with a hash new file mode 100755 index 0000000..3922ea7 --- /dev/null +++ b/test/fast/Aliases/'nvm alias' should not accept aliases with a hash @@ -0,0 +1,26 @@ +#!/bin/sh + +\. ../../../nvm.sh + +die () { echo "$@" ; exit 1; } + +OUTPUT="$(nvm alias foo#bar baz 2>&1)" +EXPECTED_OUTPUT="Aliases with a comment delimiter (#) are not supported." +[ "$OUTPUT" = "$EXPECTED_OUTPUT" ] || die "trying to create an alias with a hash should fail with '$EXPECTED_OUTPUT', got '$OUTPUT'" + +EXIT_CODE="$(nvm alias foo#bar baz >/dev/null 2>&1 ; echo $?)" +[ "$EXIT_CODE" = "1" ] || die "trying to create an alias with a hash should fail with code 1, got '$EXIT_CODE'" + +OUTPUT="$(nvm alias foo# baz 2>&1)" +EXPECTED_OUTPUT="Aliases with a comment delimiter (#) are not supported." +[ "$OUTPUT" = "$EXPECTED_OUTPUT" ] || die "trying to create an alias ending with a hash should fail with '$EXPECTED_OUTPUT', got '$OUTPUT'" + +EXIT_CODE="$(nvm alias foo# baz >/dev/null 2>&1 ; echo $?)" +[ "$EXIT_CODE" = "1" ] || die "trying to create an alias ending with a hash should fail with code 1, got '$EXIT_CODE'" + +OUTPUT="$(nvm alias \#bar baz 2>&1)" +EXPECTED_OUTPUT="Aliases with a comment delimiter (#) are not supported." +[ "$OUTPUT" = "$EXPECTED_OUTPUT" ] || die "trying to create an alias starting with a hash should fail with '$EXPECTED_OUTPUT', got '$OUTPUT'" + +EXIT_CODE="$(nvm alias \#bar baz >/dev/null 2>&1 ; echo $?)" +[ "$EXIT_CODE" = "1" ] || die "trying to create an alias starting with a hash should fail with code 1, got '$EXIT_CODE'" diff --git a/test/fast/Unit tests/nvm_process_nvmrc b/test/fast/Unit tests/nvm_process_nvmrc new file mode 100755 index 0000000..5102c57 --- /dev/null +++ b/test/fast/Unit tests/nvm_process_nvmrc @@ -0,0 +1,34 @@ +#!/bin/sh + +die () { echo "$@" ; cleanup ; exit 1; } + +cleanup() { + echo 'cleaned up' +} + +\. ../../../nvm.sh + +\. ../../common.sh + +for f in ../../../test/fixtures/nvmrc/test/fixtures/valid/*; do + STDOUT="$(nvm_process_nvmrc $f/.nvmrc 2>/dev/null)" + EXIT_CODE="$(nvm_process_nvmrc $f/.nvmrc >/dev/null 2>/dev/null; echo $?)" + + EXPECTED="$(nvm_json_extract node < "${f}/expected.json" | tr -d '"')" + + [ "${EXIT_CODE}" = "0" ] || die "$(basename "${f}"): expected exit code of 0 but got ${EXIT_CODE}" + + [ "${STDOUT}" = "${EXPECTED}" ] || die "$(basename "${f}"): expected STDOUT of \`${EXPECTED}\` but got \`${STDOUT}\`" +done + +for f in ../../../test/fixtures/nvmrc/test/fixtures/invalid/*; do + STDOUT="$(nvm_process_nvmrc $f/.nvmrc 2>/dev/null)" + STDERR="$(nvm_process_nvmrc $f/.nvmrc 2>&1 >/dev/null | awk '{if(NR > 8) print $0}' | strip_colors)" + EXIT_CODE="$(nvm_process_nvmrc $f/.nvmrc >/dev/null 2>/dev/null; echo $?)" + + EXPECTED="$(nvm_json_extract < "${f}/expected.json" | tr -d '"')" + + [ "${EXIT_CODE}" != "0" ] || die "$(basename "${f}"): expected exit code of 'not 0' but got ${EXIT_CODE}" + + [ "${STDERR}" = "${EXPECTED}" ] || die "$(basename "${f}"): expected STDERR of \`${EXPECTED}\` but got \`${STDERR}\`" +done diff --git a/test/fixtures/nvmrc b/test/fixtures/nvmrc new file mode 160000 index 0000000..0d325aa --- /dev/null +++ b/test/fixtures/nvmrc @@ -0,0 +1 @@ +Subproject commit 0d325aa903893072cb07daf43ae04b491e104d6c