npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@lesjoursfr/bin-wrapper

v12.1.6

Published

Binary wrapper that makes your programs seamlessly available as local dependencies

Downloads

62

Readme

npm version QC Checks Tests

bin-wrapper

Binary wrapper that makes your programs seamlessly available as local dependencies

Install

npm install @lesjoursfr/bin-wrapper

Usage

import path from "path";
import BinWrapper from "@lesjoursfr/bin-wrapper";

const base = "https://github.com/imagemin/gifsicle-bin/raw/main/vendor";
const bin = new BinWrapper()
	.addSrc(`${base}/macos/gifsicle`, "darwin")
	.addSrc(`${base}/linux/x64/gifsicle`, "linux", "x64")
	.addSrc(`${base}/win/x64/gifsicle.exe`, "win32", "x64")
	.setDest(path.join("vendor"))
	.setUse(process.platform === "win32" ? "gifsicle.exe" : "gifsicle")
	.setVersion(">=1.71");

(async () => {
	await bin.run(["--version"]);
	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

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.

.addSrc(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.

.setDest(destination)

destination

Type: string

Accepts a path which the files will be downloaded to.

.setUse(binary)

binary

Type: string

Define which file to use as the binary.

.path

Returns the full path to your binary.

.setVersion(range)

range

Type: string

Define a semver range 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 .addSrc().

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