v10.0.1 - Security, ESM, Dependency Updates, Node 16+

.c8rc.json

@@ -0,0 +1,5 @@
+{
+	"reporter": ["lcov", "json"],
+	"reports-dir": "coverage",
+	"exclude": ["tmp", "coverage", "node_modules", ".github"]
+}

.github/workflows/test.yml

@@ -3,27 +3,31 @@ name: test
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   linux:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [16.x, 18.x, 20.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-    - run: npm install
-    - run: npm test
+    - name: Install Prerequisites
+      run: sudo apt-get -y install libpng-dev libimagequant-dev
+    - name: Npm Install
+      run: npm install
+    - name: Run Test
+      run: npm test
       env:
         CI: true
 
@@ -32,12 +36,12 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [16.x, 18.x, 20.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install
@@ -50,12 +54,12 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [16.x, 18.x, 20.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 yarn.lock
+coverage

index.d.ts

@@ -1,4 +1,4 @@
-export interface Options {
+export interface Options { // eslint-disable-line @typescript-eslint/consistent-type-definitions
 	/**
 	Speed `10` has 5% lower quality, but is about 8 times faster than the default. Speed `11` disables dithering and lowers compression level.
 
@@ -55,7 +55,7 @@
 /**
 Buffer or stream to optimize.
 */
 export type Plugin = (input: Buffer | NodeJS.ReadableStream) => Promise<Buffer>;
 
 /**
 Imagemin plugin for pngquant.

index.js

@@ -1,86 +1,86 @@
-'use strict';
-const execa = require('execa');
-const isPng = require('is-png');
-const isStream = require('is-stream');
-const pngquant = require('pngquant-bin');
-const ow = require('ow');
-
-const imageminPngquant = (options = {}) => input => {
-	const isBuffer = Buffer.isBuffer(input);
+import {execa} from 'execa';
+import isPng from 'is-png';
+import {isStream} from 'is-stream';
+import pngquant from 'pngquant-bin';
+import ow from 'ow';
+
+export function imageminPngquant(options = {}) {
+	return input => {
+		const isBuffer = Buffer.isBuffer(input);
+
+		if (!isBuffer && !isStream(input)) {
+			return Promise.reject(new TypeError(`Expected a Buffer or Stream, got ${typeof input}`));
+		}
 
-	if (!isBuffer && !isStream(input)) {
-		return Promise.reject(new TypeError(`Expected a Buffer or Stream, got ${typeof input}`));
-	}
+		if (isBuffer && !isPng(input)) {
+			return Promise.resolve(input);
+		}
 
-	if (isBuffer && !isPng(input)) {
-		return Promise.resolve(input);
-	}
+		const args = ['-'];
 
-	const args = ['-'];
+		if (options.speed !== undefined) {
+			ow(options.speed, ow.number.integer.inRange(1, 11));
+			args.push('--speed', options.speed);
+		}
 
-	if (typeof options.speed !== 'undefined') {
-		ow(options.speed, ow.number.integer.inRange(1, 11));
-		args.push('--speed', options.speed);
-	}
+		if (options.strip !== undefined) {
+			ow(options.strip, ow.boolean);
 
-	if (typeof options.strip !== 'undefined') {
-		ow(options.strip, ow.boolean);
+			if (options.strip) {
+				args.push('--strip');
+			}
+		}
 
-		if (options.strip) {
-			args.push('--strip');
+		if (options.quality !== undefined) {
+			ow(options.quality, ow.array.length(2).ofType(ow.number.inRange(0, 1)));
+			const [min, max] = options.quality;
+			args.push('--quality', `${Math.round(min * 100)}-${Math.round(max * 100)}`);
 		}
-	}
 
-	if (typeof options.quality !== 'undefined') {
-		ow(options.quality, ow.array.length(2).ofType(ow.number.inRange(0, 1)));
-		const [min, max] = options.quality;
-		args.push('--quality', `${Math.round(min * 100)}-${Math.round(max * 100)}`);
-	}
+		if (options.dithering !== undefined) {
+			ow(options.dithering, ow.any(ow.number.inRange(0, 1), ow.boolean.false));
 
-	if (typeof options.dithering !== 'undefined') {
-		ow(options.dithering, ow.any(ow.number.inRange(0, 1), ow.boolean.false));
+			if (typeof options.dithering === 'number') {
+				args.push(`--floyd=${options.dithering}`);
+			} else if (options.dithering === false) {
+				args.push('--ordered');
+			}
+		}
 
-		if (typeof options.dithering === 'number') {
-			args.push(`--floyd=${options.dithering}`);
-		} else if (options.dithering === false) {
-			args.push('--ordered');
+		if (options.posterize !== undefined) {
+			ow(options.posterize, ow.number);
+			args.push('--posterize', options.posterize);
+		}
+
+		if (options.verbose !== undefined) {
+			ow(options.verbose, ow.boolean);
+			args.push('--verbose');
 		}
-	}
-
-	if (typeof options.posterize !== 'undefined') {
-		ow(options.posterize, ow.number);
-		args.push('--posterize', options.posterize);
-	}
-
-	if (typeof options.verbose !== 'undefined') {
-		ow(options.verbose, ow.boolean);
-		args.push('--verbose');
-	}
-
-	const subprocess = execa(pngquant, args, {
-		encoding: null,
-		maxBuffer: Infinity,
-		input
-	});
-
-	const promise = subprocess
-		.then(result => result.stdout) // eslint-disable-line promise/prefer-await-to-then
-		.catch(error => {
-			// We use `error.exitCode` to check for a special condition when running the pngquant binary.
-			// See details on handling of "99" code at https://pngquant.org (search for "status code 99").
-			if (error.exitCode === 99) {
-				return input;
-			}
 
-			error.message = error.stderr || error.message;
-			throw error;
+		const subprocess = execa(pngquant, args, {
+			encoding: null,
+			maxBuffer: Number.POSITIVE_INFINITY,
+			input,
 		});
 
-	subprocess.stdout.then = promise.then.bind(promise); // eslint-disable-line promise/prefer-await-to-then
-	subprocess.stdout.catch = promise.catch.bind(promise);
+		const promise = subprocess
+			.then(result => result.stdout)
+			.catch(error => {
+				// We use `error.exitCode` to check for a special condition when running the pngquant binary.
+				// See details on handling of "99" code at https://pngquant.org (search for "status code 99").
+				if (error.exitCode === 99) {
+					return input;
+				}
+
+				error.message = error.stderr || error.message;
+				throw error;
+			});
+
+		subprocess.stdout.then = promise.then.bind(promise); // eslint-disable-line unicorn/no-thenable
+		subprocess.stdout.catch = promise.catch.bind(promise);
 
-	return subprocess.stdout;
-};
+		return subprocess.stdout;
+	};
+}
 
-module.exports = imageminPngquant;
-module.exports.default = imageminPngquant;
+export {imageminPngquant as default};

index.test-d.ts

@@ -1,14 +1,18 @@
-import * as fs from 'fs';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import * as url from 'node:url';
 import {expectType} from 'tsd';
-import imageminPngquant from '.';
+import pngquant from './index.js';
 
-const buffer = fs.readFileSync(path.join(__dirname, 'fixture.png'));
+const thisDirname = url.fileURLToPath(new URL('.', import.meta.url));
+const buffer = fs.readFileSync(path.join(thisDirname, 'fixture.png'));
 
-(async () => {
-	expectType<Buffer>(await imageminPngquant()(buffer));
-	expectType<Buffer>(await imageminPngquant({
+async function test() {
+	expectType<Buffer>(await pngquant()(buffer));
+	expectType<Buffer>(await pngquant({
 		speed: 10,
-		quality: [0.8, 1]
+		quality: [0.8, 1],
 	})(buffer));
-})();
+}
+
+await test();

package.json

@@ -4,11 +4,17 @@
 	"description": "Imagemin plugin for `pngquant`",
 	"license": "MIT",
 	"repository": "imagemin/imagemin-pngquant",
+	"type": "module",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
 	"engines": {
-		"node": ">=10"
+		"node": ">=16"
 	},
 	"scripts": {
-		"test": "xo && ava && tsd"
+		"test": "xo && npm run test:cover && tsd",
+		"test:cover": "c8 --check-coverage --statements 90 ava"
 	},
 	"files": [
 		"index.js",
@@ -24,17 +30,18 @@
 		"pngquant"
 	],
 	"dependencies": {
-		"execa": "^4.0.0",
-		"is-png": "^2.0.0",
-		"is-stream": "^2.0.0",
-		"ow": "^0.17.0",
-		"pngquant-bin": "^6.0.0"
+		"execa": "^8.0.1",
+		"is-png": "^3.0.1",
+		"is-stream": "^3.0.0",
+		"ow": "^1.1.1",
+		"pngquant-bin": "^8.0.1"
 	},
 	"devDependencies": {
-		"@types/node": "^12.0.3",
-		"ava": "^3.8.0",
-		"get-stream": "^5.1.0",
-		"tsd": "^0.11.0",
-		"xo": "^0.30.0"
+		"@types/node": "^20.8.3",
+		"c8": "^8.0.1",
+		"ava": "^5.3.1",
+		"get-stream": "^6.0.1",
+		"tsd": "^0.29.0",
+		"xo": "^0.56.0"
 	}
 }

readme.md

@@ -1,4 +1,4 @@
-# imagemin-pngquant ![GitHub Actions Status](https://github.com/imagemin/imagemin-pngquant/workflows/test/badge.svg?branch=master)
+# imagemin-pngquant 
 
 > [Imagemin](https://github.com/imagemin/imagemin) plugin for [`pngquant`](https://github.com/kornelski/pngquant)
 
@@ -8,7 +8,11 @@
 ```
 $ npm install imagemin-pngquant
 ```
-
+### Prerequisites
+> **Linux** machines must have the following packages prior to install: `libpng-dev libimagequant-dev`  
+```
+sudo apt-get -y install libpng-dev libimagequant-dev
+```
 
 ## Usage