feat: configuring logger level and release via environment variables,…

… deprecated node.js < 18.12.0
gunar · Jun 6, 2024 · a74f0fe · a74f0fe
1 parent 8f492ea
commit a74f0fe
Show file tree

Hide file tree

Showing 18 changed files with 5,937 additions and 10,644 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -41,7 +41,7 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest, macos-latest, windows-latest]
-        node-version: [16.x, 18.x]
+        node-version: [18.x, 20.x]
       fail-fast: true
     runs-on: ${{ matrix.platform }}
     steps:

diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-v16.17.0
+v18.12.0
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -5,6 +5,7 @@
     "EditorConfig.EditorConfig",
     "esbenp.prettier-vscode",
     "Orta.vscode-jest",
+    "GitHub.vscode-github-actions",
     "Gruntfuggly.todo-tree",
     "timonwong.shellcheck",
     "usernamehw.errorlens"

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -2,6 +2,7 @@
   "editor.formatOnSave": true,
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "typescript.tsdk": "./node_modules/typescript/lib",
+  "typescript.enablePromptUseWorkspaceTsdk": true,
   "[jsonc]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   }

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [v3.0.0](https://github.com/gunar/shellcheck/releases/tag/v3.0.0) - 2024-06-06
+
+### Added
+
+- Configure release version via environment variable `SHELLCHECKJS_RELEASE`
+
+- Configure logger level via environment variable `SHELLCHECKJS_LOGGER_LEVEL`
+
+### Deprecated
+
+- Drop support for _Node.js_ versions that do not match `>=18.12.0`
+
 ## [v2.2.0](https://github.com/gunar/shellcheck/releases/tag/v2.2.0) - 2023-02-04
 
 ### Changed

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ Downloads the most recent version of [koalaman](https://github.com/koalaman)'s [
 
 ## Installation
 
-> **Warning**: Node.js version `>= 18.4.0 || >= 16.17.0` is required
+> **Warning**: Node.js version `>= 18.12.0` is required
 
 ```sh
 npm install --save-dev shellcheck
@@ -35,6 +35,13 @@ Execute `shellcheck` directly from your npm scripts:
 }
 ```
 
+### Environment Variables
+
+| **Name**                    | **Values**                                                 | **Default** | **Description**                                                        |
+| :-------------------------- | :--------------------------------------------------------- | :---------- | :--------------------------------------------------------------------- |
+| `SHELLCHECKJS_RELEASE`      | `latest` \| `v(0\|[1-9]\d*)\.(0\|[1-9]\d*)\.(0\|[1-9]\d*)` | `latest`    | Release version. See <https://github.com/koalaman/shellcheck/releases> |
+| `SHELLCHECKJS_LOGGER_LEVEL` | `off` \| `debug` \| `info` \| `warn` \| `error`            | `info`      | Logger level                                                           |
+
 ### Programmatic
 
 > **Note**: More _functions_, _utilities_, and _constants_ are available

diff --git a/cspell.json b/cspell.json
@@ -15,11 +15,13 @@
     "codeql",
     "corradini",
     "cygwin",
+    "envalid",
     "gessner",
     "gunar",
     "koalaman",
     "postbuild",
     "shellcheck",
+    "shellcheckjs",
     "singlequote",
     "tada",
     "tsdoc"