@xhmikosr/bin-wrapper 14.2.4 → 14.3.0

package/index.js

@@ -2,34 +2,42 @@ import {promises as fs} from 'node:fs';
 import path from 'node:path';
 import binCheck from '@xhmikosr/bin-check';
 import binaryVersionCheck from 'binary-version-check';
-import download from '@xhmikosr/downloader';
+import downloader from '@xhmikosr/downloader';
 import osFilterObject from '@xhmikosr/os-filter-obj';
 
 /**
- * Initialize a new `BinWrapper`
- *
- * @param {Object} options
- * @api public
+ * @typedef {Object} BinWrapperOptions
+ * @property {number} [strip=1] - Number of leading paths to strip from the archive.
+ * @property {boolean} [skipCheck=false] - Skip binary checks.
  */
+
+/**
+ * @typedef {Object} SourceFile
+ * @property {string} url - The URL of the file.
+ * @property {string} [os] - The operating system the file is for.
+ * @property {string} [arch] - The architecture the file is for.
+ */
+
 export default class BinWrapper {
+	/**
+	 * @param {BinWrapperOptions} [options]
+	 */
 	constructor(options = {}) {
-		this.options = options;
+		const {strip = 1, skipCheck = false} = options;
 
-		if (this.options.strip <= 0) {
-			this.options.strip = 0;
-		// eslint-disable-next-line logical-assignment-operators
-		} else if (!this.options.strip) {
-			this.options.strip = 1;
-		}
+		this.options = {
+			strip: Math.max(0, strip),
+			skipCheck,
+		};
 	}
 
 	/**
 	 * Get or set files to download
 	 *
-	 * @param {String} src
-	 * @param {String} os
-	 * @param {String} arch
-	 * @api public
+	 * @param {string} [src] - The source URL of the file.
+	 * @param {string} [os] - The operating system the file is for.
+	 * @param {string} [arch] - The architecture the file is for.
+	 * @returns {SourceFile[]|undefined|this} - Returns the source files if no arguments are provided, otherwise returns `this`.
 	 */
 	src(src, os, arch) {
 		if (arguments.length === 0) {
@@ -45,8 +53,8 @@ export default class BinWrapper {
 	/**
 	 * Get or set the destination
 	 *
-	 * @param {String} dest
-	 * @api public
+	 * @param {string} [dest] - The destination path.
+	 * @returns {string|undefined|this} - Returns the destination if no arguments are provided, otherwise returns `this`.
 	 */
 	dest(dest) {
 		if (arguments.length === 0) {
@@ -54,14 +62,15 @@ export default class BinWrapper {
 		}
 
 		this._dest = dest;
+
 		return this;
 	}
 
 	/**
 	 * Get or set the binary
 	 *
-	 * @param {String} bin
-	 * @api public
+	 * @param {string} [bin] - The binary name.
+	 * @returns {string|undefined|this} - Returns the binary name if no arguments are provided, otherwise returns `this`.
 	 */
 	use(bin) {
 		if (arguments.length === 0) {
@@ -69,14 +78,15 @@ export default class BinWrapper {
 		}
 
 		this._use = bin;
+
 		return this;
 	}
 
 	/**
 	 * Get or set a semver range to test the binary against
 	 *
-	 * @param {String} range
-	 * @api public
+	 * @param {string} [range] - The semver range.
+	 * @returns {string|undefined|this} - Returns the semver range if no arguments are provided, otherwise returns `this`.
 	 */
 	version(range) {
 		if (arguments.length === 0) {
@@ -84,100 +94,123 @@ export default class BinWrapper {
 		}
 
 		this._version = range;
+
 		return this;
 	}
 
 	/**
 	 * Get path to the binary
 	 *
-	 * @api public
+	 * @returns {string} - The full path to the binary.
 	 */
 	path() {
 		return path.join(this.dest(), this.use());
 	}
 
 	/**
-	 * Run
+	 * Get the source URLs matching the current OS and arch
 	 *
-	 * @param {Array} cmd
-	 * @api public
+	 * @returns {string[]}
 	 */
-	run(cmd = ['--version']) {
-		return this.findExisting().then(() => {
-			if (this.options.skipCheck) {
-				return;
-			}
+	resolvedUrls() {
+		return osFilterObject(this.src() || []).map(file => file.url);
+	}
 
-			return this.runCheck(cmd);
-		});
+	/**
+	 * Check for the binary and download it if missing, then optionally verify it works.
+	 *
+	 * @param {string[]} [cmd=['--version']] - Arguments passed to the binary when checking it.
+	 * @returns {Promise<void>}
+	 */
+	async run(cmd = ['--version']) {
+		await this.findExisting();
+
+		if (this.options.skipCheck) {
+			return;
+		}
+
+		await this.runCheck(cmd);
 	}
 
 	/**
 	 * Run binary check
 	 *
-	 * @param {Array} cmd
+	 * @param {string[]} cmd - Arguments to pass to the binary.
+	 * @returns {Promise<void>}
 	 * @api private
 	 */
-	runCheck(cmd) {
-		return binCheck(this.path(), cmd).then(works => {
-			if (!works) {
-				throw new Error(`The "${this.path()}" binary doesn't seem to work correctly`);
-			}
+	async runCheck(cmd) {
+		const works = await binCheck(this.path(), cmd);
+		if (!works) {
+			throw new Error(`The "${this.path()}" binary doesn't seem to work correctly`);
+		}
 
-			if (this.version()) {
-				return binaryVersionCheck(this.path(), this.version());
-			}
-		});
+		if (this.version()) {
+			await binaryVersionCheck(this.path(), this.version());
+		}
 	}
 
 	/**
-	 * Find existing files
+	 * Check whether the binary exists; download it if not.
 	 *
+	 * @returns {Promise<void>}
 	 * @api private
 	 */
-	findExisting() {
-		return fs.stat(this.path()).catch(error => {
+	async findExisting() {
+		try {
+			await fs.access(this.path());
+		} catch (error) {
 			if (error?.code === 'ENOENT') {
-				return this.download();
+				await this.download();
+			} else {
+				throw error;
 			}
-
-			throw error;
-		});
+		}
 	}
 
 	/**
-	 * Download files
+	 * Download files matching the current OS/arch and make them executable.
 	 *
+	 * @returns {Promise<void>}
 	 * @api private
 	 */
-	download() {
-		const files = osFilterObject(this.src() || []);
+	async download() {
+		const urls = this.resolvedUrls();
 
-		if (files.length === 0) {
-			return Promise.reject(new Error('No binary found matching your system. It\'s probably not supported.'));
+		if (urls.length === 0) {
+			throw new Error('No binary found matching your system. It\'s probably not supported.');
 		}
 
-		const urls = files.map(file => file.url);
-
-		return Promise.all(urls.map(url =>
-			download(url, this.dest(), {
+		const results = await Promise.all(urls.map(url =>
+			downloader(url, this.dest(), {
 				extract: true,
 				decompress: {
 					strip: this.options.strip,
 				},
-			}))).then(result => {
-			const resultFiles = result.flatMap((item, index) => {
-				if (Array.isArray(item)) {
-					return item.map(file => file.path);
-				}
+			})));
 
-				const parsedUrl = new URL(files[index].url);
-				const parsedPath = path.parse(parsedUrl.pathname);
+		const resultFiles = results.flatMap((item, index) => {
+			if (Array.isArray(item)) {
+				return item.map(file => file.path);
+			}
 
-				return parsedPath.base;
-			});
+			const parsedUrl = new URL(urls[index]);
 
-			return Promise.all(resultFiles.map(file => fs.chmod(path.join(this.dest(), file), 0o755)));
+			return path.parse(parsedUrl.pathname).base;
 		});
+
+		await Promise.all(resultFiles
+			.filter(Boolean)
+			.map(async file => {
+				try {
+					await fs.chmod(path.join(this.dest(), file), 0o755);
+				} catch (error) {
+					// We guess the saved name from the URL, but the downloader may
+					// have used a different one, so skip a missing file.
+					if (error?.code !== 'ENOENT') {
+						throw error;
+					}
+				}
+			}));
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@xhmikosr/bin-wrapper",
-	"version": "14.2.4",
+	"version": "14.3.0",
 	"description": "Binary wrapper that makes your programs seamlessly available as local dependencies",
 	"license": "MIT",
 	"repository": {
@@ -42,7 +42,7 @@
 	],
 	"dependencies": {
 		"@xhmikosr/bin-check": "^8.2.1",
-		"@xhmikosr/downloader": "^16.1.2",
+		"@xhmikosr/downloader": "^16.1.3",
 		"@xhmikosr/os-filter-obj": "^4.1.0",
 		"binary-version-check": "^6.1.0"
 	},
@@ -56,7 +56,6 @@
 	},
 	"xo": {
 		"rules": {
-			"promise/prefer-await-to-then": "off",
 			"unicorn/prevent-abbreviations": "off"
 		}
 	}

package/readme.md

@@ -105,6 +105,10 @@ Define which file to use as the binary.
 
 Returns the full path to your binary.
 
+### .resolvedUrls()
+
+Returns an array of the source URLs matching the current OS and arch.
+
 ### .version(range)
 
 #### range