image-guard 5.2.3 → 5.2.5

package/CHANGELOG.md

@@ -4,6 +4,20 @@ Starting with version 5.2.0, all notable changes to Image Guard are documented i
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and the project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [5.2.5] - 2026-03-17
+
+### Changed
+
+* Added recommended ESLint rules to config (and fixed resulting warnings)
+* Promoted `no-unused-vars` and `eqeqeq` from warnings to errors in ESLint config
+
+## [5.2.4] - 2026-03-04
+
+### Fixed
+
+* Changed bin entry from a Node.js script to a shell wrapper that locates node from common version managers (nvm, Volta, asdf, mise) and package managers (Homebrew) before invocation, resolving hook failures in GUI Git clients that don’t inherit the shell’s PATH
+  - **Migration:** If you set up hooks, replace `npx image-guard --staged` with `./node_modules/.bin/image-guard --staged` in your `.githooks/pre-commit` or `.husky/pre-commit`.
+
 ## [5.2.3] - 2026-02-21
 
 ### Fixed

package/NOTICE.md

@@ -0,0 +1,7 @@
+# Image Guard
+
+Copyright 2022 [Jens Oliver Meiert](https://meiert.com/)
+
+The initial developer of imagemin is [the imagemin team](https://github.com/orgs/imagemin/people).
+
+The initial developer of imagemin-merlin (aka Merlin) is [sum.cumo](https://web.archive.org/web/20191208211414/https://www.sumcumo.com/). Copyright 2019 sum.cumo GmbH.

package/README.md

@@ -64,7 +64,7 @@ Native Git hooks are simpler to set up and don’t require additional dependenci
 mkdir -p .githooks;\
 cat > .githooks/pre-commit << 'EOF'
 #!/bin/sh
-npx image-guard --staged
+./node_modules/.bin/image-guard --staged
 EOF
 chmod +x .githooks/pre-commit;\
 git config core.hooksPath .githooks;\
@@ -72,7 +72,7 @@ git add .githooks/pre-commit;\
 git commit -m "feat: add Git pre-commit hook for Image Guard";\
 npm pkg set scripts.postprepare="mkdir -p .githooks && cat > .githooks/pre-commit << 'EOF'
 #\!/bin/sh
-npx image-guard --staged
+./node_modules/.bin/image-guard --staged
 EOF
 chmod +x .githooks/pre-commit && git config core.hooksPath .githooks"
 ```
@@ -82,21 +82,21 @@ chmod +x .githooks/pre-commit && git config core.hooksPath .githooks"
 If you already use [Husky](https://typicode.github.io/husky/), run the following commands in your project root (you can copy and execute them at once):
 
 ```console
-grep -qxF "npx image-guard --staged" .husky/pre-commit || echo "\nnpx image-guard --staged" >> .husky/pre-commit;\
+grep -qxF "./node_modules/.bin/image-guard --staged" .husky/pre-commit || printf '\n./node_modules/.bin/image-guard --staged' >> .husky/pre-commit;\
 git add .husky/pre-commit;\
 git commit -m "feat: add Husky pre-commit hook for Image Guard";\
-npm pkg set scripts.postprepare="grep -qxF 'npx image-guard --staged' .husky/pre-commit || echo '\nnpx image-guard --staged' >> .husky/pre-commit"
+npm pkg set scripts.postprepare="grep -qxF './node_modules/.bin/image-guard --staged' .husky/pre-commit || printf '\\n./node_modules/.bin/image-guard --staged' >> .husky/pre-commit"
 ```
 
-If you don’t use Husky yet, run the following commands from your project root:
+If you don’t yet but want to use Husky, run the following commands from your project root:
 
 ```console
 npm i -D husky;\
 npx husky init;\
-echo "npx image-guard --staged" > .husky/pre-commit;\
+echo "./node_modules/.bin/image-guard --staged" > .husky/pre-commit;\
 git add .husky/pre-commit;\
 git commit -m "feat: add Husky pre-commit hook for Image Guard";\
-npm pkg set scripts.postprepare="grep -qxF 'npx image-guard --staged' .husky/pre-commit || echo '\nnpx image-guard --staged' >> .husky/pre-commit"
+npm pkg set scripts.postprepare="grep -qxF './node_modules/.bin/image-guard --staged' .husky/pre-commit || printf '\\n./node_modules/.bin/image-guard --staged' >> .husky/pre-commit"
 ```
 
 (The `postprepare` script ensures that the hook is added to the repository whenever someone installs the package.)
@@ -117,20 +117,6 @@ npm pkg set scripts.postprepare="grep -qxF 'npx image-guard --staged' .husky/pre
 
 * `--quiet` suppresses per‑file logs and prints only the final summary (plus errors). This reduces console noise and speeds up runs in CI and Git hooks.
 
-### Troubleshooting
-
-#### “npx: command not found”
-
-If Git hooks fail with “npx: command not found,” make sure to install (`npm i -D image-guard`) and to refer to the binary directly in the `pre-commit` hook (and, not detailed here, also in the `postprepare` script):
-
-```console
-#!/bin/sh
-export PATH="$PWD/node_modules/.bin:$PATH"
-./node_modules/.bin/image-guard --staged
-```
-
-This issue can arise in GUI Git clients (VS Code, GitHub Desktop, etc.) or with Node version managers, as these environments may not inherit your shell's `PATH`/Node environment. This affects any tool using npx in hooks.
-
 ## What Does the Output Look Like?
 
 Roughly like this:

package/bin/image-guard.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+if ! command -v node > /dev/null 2>&1; then
+  [ -s "${NVM_DIR:-$HOME/.nvm}/nvm.sh" ] && . "${NVM_DIR:-$HOME/.nvm}/nvm.sh"
+  [ -d "$HOME/.volta/bin" ] && export PATH="$HOME/.volta/bin:$PATH"
+  [ -d "$HOME/.asdf/shims" ] && export PATH="$HOME/.asdf/shims:$PATH"
+  [ -d "$HOME/.local/share/mise/shims" ] && export PATH="$HOME/.local/share/mise/shims:$PATH"
+  [ -d "/opt/homebrew/bin" ] && export PATH="/opt/homebrew/bin:$PATH"
+  [ -d "/usr/local/bin" ] && export PATH="/usr/local/bin:$PATH"
+  [ -d "/home/linuxbrew/.linuxbrew/bin" ] && export PATH="/home/linuxbrew/.linuxbrew/bin:$PATH"
+fi
+if ! command -v node > /dev/null 2>&1; then
+  echo "Image Guard: Node not found. Install Node.js via nvm, Volta, asdf, mise, or Homebrew." >&2
+  exit 1
+fi
+exec node "$(dirname "$0")/../image-guard/bin/image-guard.js" "$@"

package/bin/image-guard.test.js

@@ -305,7 +305,7 @@ describe('Image Guard', () => {
     copyFiles(testFolder, tempTestFolder)
 
     const originalCwd = process.cwd()
-    let stdout = ''
+    let stdout
     try {
       process.chdir(tempDir)
       stdout = execSync(`node "${imageGuardScript}" --quiet`, { encoding: 'utf8' })
@@ -333,7 +333,7 @@ describe('Image Guard', () => {
     })
 
     const originalCwd = process.cwd()
-    let stdout = ''
+    let stdout
     try {
       process.chdir(tempDir)
       stdout = execSync(`node "${imageGuardScript}" --dry --quiet`, { encoding: 'utf8' })
@@ -467,7 +467,7 @@ describe('Image Guard', () => {
     const filesBefore = fs.readdirSync(tempTestFolder).sort()
 
     const originalCwd = process.cwd()
-    let output = ''
+    let output
     try {
       process.chdir(tempDir)
       output = execSync(`node "${imageGuardScript}" --heic-to-avif --dry`, { encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe'] })
@@ -520,7 +520,7 @@ describe('Image Guard', () => {
     copyFiles(testFolder, tempTestFolder)
 
     const originalCwd = process.cwd()
-    let output = ''
+    let output
     try {
       process.chdir(tempDir)
       output = execSync(`node "${imageGuardScript}"`, { encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe'] })
@@ -538,7 +538,7 @@ describe('Image Guard', () => {
     copyFiles(testFolder, tempTestFolder)
 
     const originalCwd = process.cwd()
-    let output = ''
+    let output
     try {
       process.chdir(tempDir)
       output = execSync(`node "${imageGuardScript}" --keep-heic 2>&1`, { encoding: 'utf8' })

package/eslint.config.js

@@ -1,3 +1,5 @@
+import js from '@eslint/js';
+
 export default [
   {
     ignores: [
@@ -5,6 +7,7 @@ export default [
       'node_modules/**'
     ]
   },
+  js.configs.recommended,
   {
     languageOptions: {
       ecmaVersion: 'latest',
@@ -17,9 +20,8 @@ export default [
     },
     rules: {
       'no-console': 'off', // CLI tool—allow console
-      'no-undef': 'error', // Catch undefined vars
-      'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
-      eqeqeq: ['warn', 'smart'],
+      'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+      eqeqeq: ['error', 'smart'],
       curly: ['warn', 'multi-line']
     }
   }

package/package.json

@@ -1,18 +1,19 @@
 {
   "author": "Jens Oliver Meiert",
   "bin": {
-    "image-guard": "bin/image-guard.js",
-    "imagemin-guard": "bin/image-guard.js",
-    "imagemin-merlin": "bin/image-guard.js"
+    "image-guard": "bin/image-guard.sh",
+    "imagemin-guard": "bin/image-guard.sh",
+    "imagemin-merlin": "bin/image-guard.sh"
   },
   "dependencies": {
     "globby": "^16.1.0",
     "heic-decode": "^2.1.0",
     "sharp": "^0.34.5",
-    "simple-git": "^3.30.0"
+    "simple-git": "^3.31.1"
   },
   "description": "Near-lossless image compressor that’s easy to use and easy to automate",
   "devDependencies": {
+    "@eslint/js": "^10.0.0",
     "eslint": "^10.0.0"
   },
   "funding": "https://github.com/j9t/image-guard?sponsor=1",
@@ -46,5 +47,5 @@
     "test": "node --test bin/image-guard.test.js"
   },
   "type": "module",
-  "version": "5.2.3"
+  "version": "5.2.5"
 }

package/src/index.js

@@ -179,7 +179,7 @@ export async function runImageGuard() {
   }
 
   const doConversion = argv['heic-to-avif']
-  let hadFailures = false
+  let hadFailures
   let totalFiles = 0
 
   if (argv.staged) {

package/src/utils.js

@@ -283,6 +283,6 @@ const size = async (file) => {
   return stats.size
 }
 
-const sizeReadable = (size) => `${(size / 1024).toFixed(2)} KB`
+const sizeReadable = (size) => `${(size / 1024).toFixed(2)} KB` // eslint-disable-line no-irregular-whitespace
 
 export const utils = { compression, conversion, sizeReadable }

package/NOTICE

@@ -1,6 +0,0 @@
-Image Guard
-Copyright 2022 Jens Oliver Meiert (https://meiert.com/)
-
-The initial developer of imagemin is the imagemin team (https://github.com/orgs/imagemin/people).
-
-The initial developer of imagemin-merlin (aka Merlin) is sum.cumo (https://web.archive.org/web/20191208211414/https://www.sumcumo.com/). Copyright 2019 sum.cumo GmbH.