Merge pull request #62 from carlocorradini/fix

feat: darwin arm64 native binary and proxy
gunar · Feb 4, 2023 · cb6c40b · cb6c40b
2 parents 9667604 + 9ed40da
commit cb6c40b
Show file tree

Hide file tree

Showing 18 changed files with 747 additions and 890 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [v2.2.0](https://github.com/gunar/shellcheck/releases/tag/v2.2.0) - 2023-02-04
+
+### Changed
+
+- `darwin` (`arm64`) support with native binary
+
+- Proxy address environment variable name(s) reverted to old and standard behaviour
+
+- ShellCheck binaries download from <https://github.com/vscode-shellcheck/shellcheck-binaries/releases> and no more from <https://github.com/koalaman/shellcheck/releases>
+
+### Removed
+
+- Problematic and unused decompression libraries
+
 ## [v2.1.0](https://github.com/gunar/shellcheck/releases/tag/v2.1.0) - 2023-02-02
 
 ### Added

diff --git a/README.md b/README.md
@@ -21,6 +21,8 @@ npm install --save-dev shellcheck
 
 > **Note**: It's recommended to execute `shellcheck` using [`npx`](https://docs.npmjs.com/cli/commands/npx)
 
+> **Note**: Proxy support via `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables
+
 > **Note**: By default, all GitHub requests are anonymous. If you encounter error `403 | rate limit exceeded` (e.g., in CI), set the environment variable `GITHUB_TOKEN` to use your own personal access token
 
 Execute `shellcheck` directly from your npm scripts:
@@ -62,12 +64,12 @@ await download({
 
 > **Note**: [`Platform`](https://nodejs.org/api/process.html#processplatform) and [`Architecture`](https://nodejs.org/api/process.html#processarch) follow _Node.js_ naming convention
 
-| **Platform** | **Architecture** | **Notes**                                                                                                                                                                                                                                                                                                       |
-| ------------ | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `linux`      | `arm64`          |
+| **Platform** | **Architecture** |
+| ------------ | ---------------- |
 | `linux`      | `x64`            |
+| `linux`      | `arm64`          |
 | `darwin`     | `x64`            |
-| `darwin`     | `arm64`          | [Rosetta 2](https://support.apple.com/HT211861) must be installed. There is no native binary for `darwin arm64` at the moment (see [this](https://github.com/koalaman/shellcheck/issues/2109)). As a result, the downloaded binary is for `x64`, and `Rosetta 2` translates it to operate with `Apple Silicon`. |
+| `darwin`     | `arm64`          |
 | `win32`      | `x64`            |
 
 ## Contributing

diff --git a/cspell.json b/cspell.json
@@ -3,25 +3,25 @@
   "language": "en",
   "useGitignore": true,
   "import": [
+    "@cspell/dict-en_us/cspell-ext.json",
     "@cspell/dict-node/cspell-ext.json",
     "@cspell/dict-npm/cspell-ext.json",
     "@cspell/dict-typescript/cspell-ext.json"
   ],
   "ignorePaths": ["**/build/", "**/coverage/", "**/node_modules/"],
   "words": [
     "aarch64",
+    "behaviour",
     "codeql",
     "corradini",
     "cygwin",
-    "felipecrs",
-    "gunar",
     "gessner",
+    "gunar",
     "koalaman",
     "postbuild",
     "shellcheck",
     "singlequote",
     "tada",
-    "tarxz",
     "tsdoc"
   ]
 }