@xhmikosr/bin-wrapper 5.0.0

package/index.js

@@ -0,0 +1,186 @@
+import {promises as fs} from 'node:fs';
+import path from 'node:path';
+import binCheck from 'bin-check';
+import binVersionCheck from 'bin-version-check';
+import download from '@xhmikosr/downloader';
+import osFilterObject from 'os-filter-obj';
+
+/**
+ * Initialize a new `BinWrapper`
+ *
+ * @param {Object} options
+ * @api public
+ */
+export default class BinWrapper {
+	constructor(options = {}) {
+		this.options = options;
+
+		if (this.options.strip <= 0) {
+			this.options.strip = 0;
+		} else if (!this.options.strip) {
+			this.options.strip = 1;
+		}
+	}
+
+	/**
+	 * Get or set files to download
+	 *
+	 * @param {String} src
+	 * @param {String} os
+	 * @param {String} arch
+	 * @api public
+	 */
+	src(src, os, arch) {
+		if (arguments.length === 0) {
+			return this._src;
+		}
+
+		this._src = this._src || [];
+		this._src.push({
+			url: src,
+			os,
+			arch,
+		});
+
+		return this;
+	}
+
+	/**
+	 * Get or set the destination
+	 *
+	 * @param {String} dest
+	 * @api public
+	 */
+	dest(dest) {
+		if (arguments.length === 0) {
+			return this._dest;
+		}
+
+		this._dest = dest;
+		return this;
+	}
+
+	/**
+	 * Get or set the binary
+	 *
+	 * @param {String} bin
+	 * @api public
+	 */
+	use(bin) {
+		if (arguments.length === 0) {
+			return this._use;
+		}
+
+		this._use = bin;
+		return this;
+	}
+
+	/**
+	 * Get or set a semver range to test the binary against
+	 *
+	 * @param {String} range
+	 * @api public
+	 */
+	version(range) {
+		if (arguments.length === 0) {
+			return this._version;
+		}
+
+		this._version = range;
+		return this;
+	}
+
+	/**
+	 * Get path to the binary
+	 *
+	 * @api public
+	 */
+	path() {
+		return path.join(this.dest(), this.use());
+	}
+
+	/**
+	 * Run
+	 *
+	 * @param {Array} cmd
+	 * @api public
+	 */
+	run(cmd = ['--version']) {
+		return this.findExisting().then(() => {
+			if (this.options.skipCheck) {
+				return;
+			}
+
+			return this.runCheck(cmd);
+		});
+	}
+
+	/**
+	 * Run binary check
+	 *
+	 * @param {Array} cmd
+	 * @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`);
+			}
+
+			if (this.version()) {
+				return binVersionCheck(this.path(), this.version());
+			}
+		});
+	}
+
+	/**
+	 * Find existing files
+	 *
+	 * @api private
+	 */
+	findExisting() {
+		return fs.stat(this.path()).catch(error => {
+			if (error && error.code === 'ENOENT') {
+				return this.download();
+			}
+
+			throw error;
+		});
+	}
+
+	/**
+	 * Download files
+	 *
+	 * @api private
+	 */
+	download() {
+		const files = osFilterObject(this.src() || []);
+
+		if (files.length === 0) {
+			return Promise.reject(new Error('No binary found matching your system. It\'s probably not supported.'));
+		}
+
+		const urls = [];
+		for (const file of files) {
+			urls.push(file.url);
+		}
+
+		return Promise.all(urls.map(url => download(url, this.dest(), {
+			extract: true,
+			strip: this.options.strip,
+		}))).then(result => {
+			const resultingFiles = 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);
+
+				return parsedPath.base;
+			});
+
+			return Promise.all(resultingFiles.map(fileName => fs.chmod(path.join(this.dest(), fileName), 0o755)));
+		});
+	}
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Kevin Mårtensson <kevinmartensson@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,60 @@
+{
+	"name": "@xhmikosr/bin-wrapper",
+	"version": "5.0.0",
+	"description": "Binary wrapper that makes your programs seamlessly available as local dependencies",
+	"license": "MIT",
+	"repository": "XhmikosR/bin-wrapper",
+	"publishConfig": {
+		"access": "public"
+	},
+	"author": {
+		"name": "Kevin Mårtensson",
+		"email": "kevinmartensson@gmail.com",
+		"url": "https://github.com/kevva"
+	},
+	"engines": {
+		"node": "^12.20.0 || ^14.14.0 || >=16.0.0"
+	},
+	"scripts": {
+		"ava": "ava",
+		"xo": "xo",
+		"test": "npm run xo && npm run ava",
+		"test-ci": "npm run xo && c8 ava"
+	},
+	"main": "index.js",
+	"type": "module",
+	"exports": {
+		".": "./index.js"
+	},
+	"files": [
+		"index.js"
+	],
+	"keywords": [
+		"bin",
+		"check",
+		"local",
+		"wrapper"
+	],
+	"c8": {
+		"reporter": [
+			"lcovonly",
+			"text"
+		]
+	},
+	"dependencies": {
+		"@xhmikosr/downloader": "^9.0.0",
+		"bin-check": "^4.1.0",
+		"bin-version-check": "^5.0.0",
+		"os-filter-obj": "^2.0.0"
+	},
+	"devDependencies": {
+		"ava": "^4.3.0",
+		"c8": "^7.11.3",
+		"executable": "^4.1.1",
+		"nock": "^13.2.6",
+		"path-exists": "^5.0.0",
+		"rimraf": "^3.0.2",
+		"tempy": "^2.0.0",
+		"xo": "^0.49.0"
+	}
+}

package/readme.md

@@ -0,0 +1,133 @@
+# bin-wrapper [![CI](https://github.com/XhmikosR/bin-wrapper/actions/workflows/ci.yml/badge.svg)](https://github.com/XhmikosR/bin-wrapper/actions/workflows/ci.yml)
+
+> Binary wrapper that makes your programs seamlessly available as local dependencies
+
+
+## Install
+
+```sh
+npm install bin-wrapper
+```
+
+
+## Usage
+
+```js
+import path from 'node:path';
+import BinWrapper from 'bin-wrapper';
+
+const base = 'https://github.com/imagemin/gifsicle-bin/raw/main/vendor';
+const bin = new BinWrapper()
+	.src(`${base}/macos/gifsicle`, 'darwin')
+	.src(`${base}/linux/x64/gifsicle`, 'linux', 'x64')
+	.src(`${base}/win/x64/gifsicle.exe`, 'win32', 'x64')
+	.dest(path.join('vendor'))
+	.use(process.platform === 'win32' ? 'gifsicle.exe' : 'gifsicle')
+	.version('>=1.71');
+
+(async () => {
+	await bin.run(['--version']);
+	console.log('gifsicle is working');
+})();
+```
+
+Get the path to your binary with `bin.path()`:
+
+```js
+console.log(bin.path());
+//=> 'path/to/vendor/gifsicle'
+```
+
+
+## API
+
+### `new BinWrapper(options)`
+
+Creates a new `BinWrapper` instance.
+
+#### options
+
+Type: `Object`
+
+##### skipCheck
+
+* Type: `boolean`
+* Default: `false`
+
+Whether to skip the binary check or not.
+
+##### strip
+
+* Type: `number`
+* Default: `1`
+
+Strip a number of leading paths from file names on extraction.
+
+### .src(url, [os], [arch])
+
+Adds a source to download.
+
+#### url
+
+Type: `string`
+
+Accepts a URL pointing to a file to download.
+
+#### os
+
+Type: `string`
+
+Tie the source to a specific OS.
+
+#### arch
+
+Type: `string`
+
+Tie the source to a specific arch.
+
+### .dest(destination)
+
+#### destination
+
+Type: `string`
+
+Accepts a path which the files will be downloaded to.
+
+### .use(binary)
+
+#### binary
+
+Type: `string`
+
+Define which file to use as the binary.
+
+### .path()
+
+Returns the full path to your binary.
+
+### .version(range)
+
+#### range
+
+Type: `string`
+
+Define a [semver range](https://github.com/npm/node-semver#ranges) to check
+the binary against.
+
+### .run([arguments])
+
+Runs the search for the binary. If no binary is found it will download the file
+using the URL provided in `.src()`.
+
+#### arguments
+
+* Type: `Array`
+* Default: `['--version']`
+
+Command to run the binary with. If it exits with code `0` it means that the
+binary is working.
+
+
+## License
+
+MIT © [Kevin Mårtensson](http://kevinmartensson.com)