feat: add decompress option support (#18)

Author: XhmikosR

fixtures/gifsicle-linux.tar.xz

@@ -9,6 +9,7 @@ import osFilterObject from '@xhmikosr/os-filter-obj';
  * @typedef {Object} BinWrapperOptions
  * @property {number} [strip=1] - Number of leading paths to strip from the archive.
  * @property {boolean} [skipCheck=false] - Skip binary checks.
+ * @property {object} [decompress={}] - Extra options forwarded to @xhmikosr/decompress (e.g. `{ plugins: [...] }`). The `strip` key here is ignored; use the top-level `strip` option.
  */
 
 /**
@@ -23,11 +24,12 @@ export default class BinWrapper {
 	 * @param {BinWrapperOptions} [options]
 	 */
 	constructor(options = {}) {
-		const {strip = 1, skipCheck = false} = options;
+		const {strip = 1, skipCheck = false, decompress = {}} = options;
 
 		this.options = {
 			strip: Math.max(0, strip),
 			skipCheck,
+			decompress: {...decompress},
 		};
 	}
 
@@ -185,6 +187,7 @@ export default class BinWrapper {
 			downloader(url, this.dest(), {
 				extract: true,
 				decompress: {
+					...this.options.decompress,
 					strip: this.options.strip,
 				},
 			})));

index.js

@@ -47,6 +47,7 @@
 		"binary-version-check": "^6.1.0"
 	},
 	"devDependencies": {
+		"@felipecrs/decompress-tarxz": "^5.0.6",
 		"ava": "^7.0.0",
 		"c8": "^11.0.0",
 		"isexe": "^4.0.0",

package-lock.json

@@ -63,6 +63,14 @@ Whether to skip the binary check or not.
 
 Strip a number of leading paths from file names on extraction.
 
+##### decompress
+
+* Type: `Object`
+* Default: `{}`
+
+Extra options forwarded to [`@xhmikosr/decompress`](https://github.com/XhmikosR/decompress) e.g. `plugins`.
+The `strip` key is ignored here; use the top-level `strip` option instead.
+
 ### .src(url, [os], [arch])
 
 Adds a source to download.

package.json

@@ -6,6 +6,7 @@ import {isexe} from 'isexe';
 import nock from 'nock';
 import {temporaryDirectory} from 'tempy';
 import test from 'ava';
+import decompressTarxz from '@felipecrs/decompress-tarxz';
 import BinWrapper from './index.js';
 
 const __filename = fileURLToPath(import.meta.url);
@@ -35,7 +36,9 @@ test.beforeEach(() => {
 		.get('/gifsicle-win32.tar.gz')
 		.replyWithFile(200, fixture('gifsicle-win32.tar.gz'))
 		.get('/test.js')
-		.replyWithFile(200, __filename);
+		.replyWithFile(200, __filename)
+		.get('/gifsicle-linux.tar.xz')
+		.replyWithFile(200, fixture('gifsicle-linux.tar.xz'));
 });
 
 test('expose a constructor', t => {
@@ -202,6 +205,30 @@ test('downloaded files are set to be executable', async t => {
 	}
 });
 
+test('use custom decompress plugins', async t => {
+	const temporaryDir = temporaryDirectory();
+	const bin = new BinWrapper({skipCheck: true, decompress: {plugins: [decompressTarxz()]}})
+		.src('http://foo.com/gifsicle-linux.tar.xz')
+		.dest(temporaryDir)
+		.use('gifsicle');
+
+	await bin.run();
+	t.true(await pathExists(bin.path()));
+	await removeDir(temporaryDir);
+});
+
+test('forward decompress options to the downloader', async t => {
+	const temporaryDir = temporaryDirectory();
+	const bin = new BinWrapper({skipCheck: true, decompress: {filter: () => false}})
+		.src('http://foo.com/gifsicle.tar.gz')
+		.dest(temporaryDir)
+		.use(binary);
+
+	await bin.run();
+	t.false(await pathExists(bin.path()));
+	await removeDir(temporaryDir);
+});
+
 test('tolerate a non-archive file saved under a different name than the URL', async t => {
 	const temporaryDir = temporaryDirectory();