Merge pull request #56 from nodenv/workflows

Use shared nodenv workflows

Author: jasonkarns

.editorconfig

@@ -0,0 +1,9 @@
+# https://EditorConfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_size = 2
+indent_style = space

.github/dependabot.yml

@@ -7,12 +7,8 @@ updates:
     directory: "/"
     schedule: { interval: weekly }
     cooldown: { default-days: 15 }
-    groups:
-      dev-deps: { dependency-type: development }
 
   - package-ecosystem: github-actions
     directory: "/"
     schedule: { interval: weekly }
     cooldown: { default-days: 15 }
-    groups:
-      gh-actions: { patterns: ["*"] }

.github/workflows/release.yml

@@ -0,0 +1,10 @@
+name: Release
+on:
+  push: { tags: "v[0-9]+.[0-9]+.[0-9]+*" }
+
+permissions: {}
+jobs:
+  release:
+    permissions: { contents: write, id-token: write }
+    uses: nodenv/.github/.github/workflows/release.yml@v6
+    secrets: inherit

.github/workflows/sync-default-branch.yml

@@ -6,9 +6,8 @@ permissions: {}
 
 jobs:
   sync:
-    permissions: {contents: write}
+    permissions: { contents: write }
     uses: nodenv/.github/.github/workflows/sync-default-branch.yml@v5
-
 # One-time commands for users to switch-over:
 #
 # ```console

.github/workflows/test.yml

@@ -1,18 +1,17 @@
 name: Test
-on: [push, pull_request]
-
-permissions:
-  contents: read
+on:
+  push:
+  pull_request:
+  schedule: [{ cron: "0 0 10 * *" }] # monthly https://crontab.guru/#0_0_10_*_*
+  workflow_dispatch:
 
+permissions: {}
 jobs:
   test:
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Harden the runner (Audit all outbound calls)
-      uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911 # v2.13.0
-      with:
-        egress-policy: audit
-
-    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-    - run: npm cit
+    uses: nodenv/.github/.github/workflows/test.yml@v6
+    permissions:
+      contents: read
+      packages: read
+      id-token: write
+      security-events: write
+      statuses: write

.gitignore

@@ -1,3 +1,6 @@
 /node_modules
-/nodenv-nodenv-default-packages-*.tgz
+/package*/
+/tmp
 /test/tmp
+
+/nodenv-nodenv-default-packages-*.tgz

README.md

@@ -12,11 +12,11 @@ Forked from the excellent [`rbenv-default-gems`][rbenv-default-gems] plugin from
 <!-- toc -->
 
 - [Installation](#installation)
-  * [Installing as a nodenv plugin](#installing-as-a-nodenv-plugin)
-  * [Installing with Homebrew (for OS X users)](#installing-with-homebrew-for-os-x-users)
+  - [Installing as a nodenv plugin](#installing-as-a-nodenv-plugin)
+  - [Installing with Homebrew (for macOS users)](#installing-with-homebrew-for-macos-users)
 - [Usage](#usage)
-  * [default-packages Files](#default-packages-files)
-  * [Updating Default Packages](#updating-default-packages)
+  - [default-packages Files](#default-packages-files)
+  - [Updating Default Packages](#updating-default-packages)
 - [Credits](#credits)
 
 <!-- tocstop -->
@@ -27,36 +27,40 @@ Forked from the excellent [`rbenv-default-gems`][rbenv-default-gems] plugin from
 
 Make sure you have the latest nodenv and node-build versions, then run:
 
-    git clone https://github.com/nodenv/nodenv-default-packages.git $(nodenv root)/plugins/nodenv-default-packages
+```sh
+git clone https://github.com/nodenv/nodenv-default-packages.git $(nodenv root)/plugins/nodenv-default-packages
+```
 
-### Installing with Homebrew (for OS X users)
+### Installing with Homebrew (for macOS users)
 
-Mac OS X users can install nodenv-default-packages with the [Homebrew](http://brew.sh) package manager.
+MacOS users can install nodenv-default-packages with the [Homebrew](http://brew.sh) package manager.
 
-*This is the recommended method of installation if you installed nodenv with Homebrew.*
+_This is the recommended method of installation if you installed nodenv with Homebrew._
 
-```
-$ brew install nodenv/nodenv/nodenv-default-packages
+```sh
+brew install nodenv/nodenv/nodenv-default-packages
 ```
 
 Or, if you would like to install the latest development release:
 
-```
-$ brew install --HEAD nodenv/nodenv/nodenv-default-packages
+```sh
+brew install --HEAD nodenv/nodenv/nodenv-default-packages
 ```
 
 ## Usage
 
 nodenv-default-packages automatically installs the packages listed in the [default-packages file(s)](#default-packages-files) file every time you successfully install a new version of Node with `nodenv install`.
 
 Specify packages in `default-packages` by name, one per line.
-You may optionally specify a semver version spec after the name. For example:
+You may optionally specify a SemVer version spec after the name. For example:
 
-    grunt-cli
-    jshint ~2.6.3
-    csslint >= 0.9.0 < 0.10.0
+```txt
+grunt-cli
+jshint ~2.6.3
+csslint >= 0.9.0 < 0.10.0
+```
 
-Blank lines and lines beginning with a `#` are ignored.
+Empty lines and lines beginning with a `#` are ignored.
 
 ### default-packages Files
 
@@ -67,11 +71,16 @@ The XDG config directories searched are `$XDG_CONFIG_HOME` (`$HOME/.config` if u
 
 if you update your `$(nodenv root)/default-packages` and want to refresh some or all of your existing node installations you can use commands like this:
 
-    nodenv default-packages install 8.8.1   # Reinstall default packages on Node version 8.8.1
+```sh
+nodenv default-packages install 8.8.1   # Reinstall default packages on Node version 8.8.1
+```
 
-    nodenv default-packages install --all   # Reinstall default packages on _all_ installed Node versions
+```sh
+nodenv default-packages install --all   # Reinstall default packages on _all_ installed Node versions
+```
 
-*NOTE:* This may take some time.
+> [!NOTE]
+> This may take some time.
 
 ## Credits
 

bin/nodenv-default-packages

@@ -32,9 +32,9 @@ fi
 
 versions() {
   case "$1" in
-    "")    nodenv-version-name                   ;; # list active version
-    --all) nodenv-versions --skip-aliases --bare ;; # list all installed versions
-    *)     echo "$@"                             ;; # list specified versions
+  "") nodenv-version-name ;;                      # list active version
+  --all) nodenv-versions --skip-aliases --bare ;; # list all installed versions
+  *) echo "$@" ;;                                 # list specified versions
   esac
 }
 
@@ -50,23 +50,23 @@ for_versions() {
 # Read package names and versions from $NODENV_ROOT/default-packages
 list_default_packages() {
   default_packages_files |
-  tr '\n' '\0' | # replace newlines with nullchar so we can use xargs
-  xargs -0 sed -e 's/#.*$//g' -e '/^[[:space:]]*$/d' | # strip comments and empty lines
-  while IFS=" " read -r pkg_name pkg_version; do
-    # shellcheck disable=SC2016
-    echo "${pkg_name}${pkg_version:+@'$pkg_version'}"
-  done
+    tr '\n' '\0' |                                       # replace newlines with nullchar so we can use xargs
+    xargs -0 sed -e 's/#.*$//g' -e '/^[[:space:]]*$/d' | # strip comments and empty lines
+    while IFS=" " read -r pkg_name pkg_version; do
+      # shellcheck disable=SC2016
+      echo "${pkg_name}${pkg_version:+@'$pkg_version'}"
+    done
 }
 
 install_default_packages() {
   list_default_packages |
-  NODENV_VERSION="$1" xargs nodenv-exec npm install -g
+    NODENV_VERSION="$1" xargs nodenv-exec npm install -g
 }
 
 default_packages_files() {
   local file_found
 
-  IFS=: read -ra xdg_dirs <<< "${XDG_CONFIG_HOME:-$HOME/.config}:${XDG_CONFIG_DIRS:-/etc/xdg}"
+  IFS=: read -ra xdg_dirs <<<"${XDG_CONFIG_HOME:-$HOME/.config}:${XDG_CONFIG_DIRS:-/etc/xdg}"
 
   for dir in "$NODENV_ROOT" "${xdg_dirs[@]/%//nodenv}"; do
     if test -r "$dir/default-packages"; then
@@ -83,13 +83,16 @@ default_packages_files() {
 unset cmd
 
 case "$1" in
-  install ) for_versions install_default_packages "${@:2}" ;;
+install) for_versions install_default_packages "${@:2}" ;;
 
-  list ) list_default_packages ;;
+list) list_default_packages ;;
 
-  files ) default_packages_files ;;
+files) default_packages_files ;;
 
-  -h | --help ) nodenv-help ;;
+-h | --help) nodenv-help ;;
 
-  *) nodenv-help --usage default-packages; exit 1 ;;
+*)
+  nodenv-help --usage default-packages
+  exit 1
+  ;;
 esac