Binary wrapper that makes your programs seamlessly available as local dependencies
JavaScript
Latest commit 12a68d1 Jun 14, 2016 @sindresorhus sindresorhus OS X → macOS
Permalink
Failed to load latest commit information.
fixtures Bump AVA version May 25, 2016
.editorconfig Tweaks May 25, 2016
.gitattributes Tweaks May 25, 2016
.gitignore Various tweaks Feb 9, 2015
.travis.yml Bump AVA version May 25, 2016
index.js Fix `this.opts.strip` if statement Aug 14, 2015
license Various tweaks Feb 9, 2015
package.json Bump AVA version May 25, 2016
readme.md OS X → macOS Jun 14, 2016
test.js Bump AVA version May 25, 2016

readme.md

bin-wrapper Build Status

Binary wrapper that makes your programs seamlessly available as local dependencies

Install

$ npm install --save bin-wrapper

Usage

const BinWrapper = require('bin-wrapper');

const base = 'https://github.com/imagemin/gifsicle-bin/raw/master/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');

bin.run(['--version'], err => {
	console.log('gifsicle is working');
});

Get the path to your binary with bin.path():

console.log(bin.path()); // => path/to/vendor/gifsicle

API

new BinWrapper(options)

Creates a new BinWrapper instance.

options

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 to check the binary against.

.run([arguments], callback)

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.

callback(err)

Type: Function

Returns nothing but a possible error.

License

MIT © Kevin Mårtensson