bin-wrapper

What is bin-wrapper?

The bin-wrapper npm package is a utility that helps you download and manage binaries for your Node.js projects. It allows you to specify a binary, download it if necessary, and make it available for use in your project. This is particularly useful for ensuring that the correct version of a binary is used, regardless of the environment in which your code is running.

What are bin-wrapper's main functionalities?

Download and manage binaries

This feature allows you to specify different sources for binaries based on the operating system and architecture. The code sample demonstrates how to set up a BinWrapper instance to download the gifsicle binary for different platforms and run it to check its version.

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

const base = 'https://raw.githubusercontent.com/imagemin/gifsicle-bin/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(__dirname, 'vendor'))
  .use(process.platform === 'win32' ? 'gifsicle.exe' : 'gifsicle');

bin.run(['--version']).then(() => {
  console.log('Binary is working');
}).catch(err => {
  console.error('Binary failed to run', err);
});

Other packages similar to bin-wrapper

node-pre-gyp

node-pre-gyp is a tool that makes it easy to publish and install Node.js C++ addons from binaries. It provides a way to package and distribute precompiled binaries, which can be downloaded and used without requiring users to compile the code themselves. Compared to bin-wrapper, node-pre-gyp is more focused on C++ addons and their distribution, whereas bin-wrapper is more general-purpose for managing any kind of binary.

nexe

nexe is a command-line utility that compiles your Node.js application into a single executable file. It includes the Node.js runtime and your application code, making it easy to distribute and run your application on different systems. While bin-wrapper focuses on downloading and managing external binaries, nexe is about packaging your Node.js application into a standalone binary.

pkg

pkg is a tool that packages Node.js projects into executable files for different platforms. It allows you to create a single executable that includes your application code and the Node.js runtime. Similar to nexe, pkg is focused on creating standalone executables, whereas bin-wrapper is about managing external binaries that your project depends on.

README

bin-wrapper

Binary wrapper for Node.js that makes your programs seamlessly available as local dependencies

Getting started

Install with npm: npm install bin-wrapper

Examples

var BinWrapper = require('bin-wrapper');
var bin = new BinWrapper({ bin: 'gifsicle', dest: 'vendor' });

bin
    .addUrl('https://raw.github.com/yeoman/node-gifsicle/0.1.4/vendor/osx/gifsicle', 'darwin')
    .addUrl('https://raw.github.com/yeoman/node-gifsicle/0.1.4/vendor/linux/x64/gifsicle', 'linux', 'x64')
    .addFile('https://raw.github.com/yeoman/node-jpegtran-bin/master/vendor/win/x64/libjpeg-62.dll', 'windows', 'x64')
    .addSource('http://www.lcdf.org/gifsicle/gifsicle-1.71.tar.gz')
    .check()
    .on('error', function (err) {
        console.log(err);
    });
    .on('fail', function () {
        this.build('./configure && make && make install')
    })
    .on('success', function () {
        console.log('gifsicle is working');
    })
    .on('finish', function () {
        console.log('gifsicle rebuilt successfully!')
    })

Get the path to your binary with bin.path.

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

API

new BinWrapper(opts)

Creates a new BinWrapper. Available options are bin which is the name of the binary and dest which is where to download/build the binary to.

.check(cmd)

Check if a binary is present and working. If it isn't, download and test it by running the binary with cmd and see if it exits correctly.

Emits success if the binary is working and fail if the binary failed to exit with status code 0.

.build(cmd)

Download the source archive defined in the src property and build it using the build script defined in the cmd argument.

Emits finish when build is finished successfully.

.addPath(src)

Add a path where to check for the binary. By default dest is added to paths.

.addUrl(url, platform, arch)

Add a URL to download the binary from. Use platform and arch to target a specific system.

.addFile(url, platform, arch)

Add a file to download alongside with the binary. Use platform and arch to target a specific system.

.addSource(url)

Add a URL where to download the source code from.

Options

bin

Type: String
Default: undefined

Set the name of the binary.

dest

Type: String
Default: process.cwd()

Destination to download/build binary.

License

MIT License (c) Kevin Mårtensson