Build tool and bindings loader for node-gyp that supports prebuilds. 

Build tool and bindings loader for node-gyp that supports prebuilds

vweevers

mafintosh

node-gyp-build

// Workaround to fix webpack's build warnings: 'the request of a dependency is an expression'

var runtimeRequire = typeof __webpack_require__ === 'function' ? __non_webpack_require__ : require // eslint-disable-line

var vars = (process.config && process.config.variables) || {}

var prebuildsOnly = !!process.env.PREBUILDS_ONLY

var abi = process.versions.modules // TODO: support old node where this is undef

var runtime = isElectron() ? 'electron' : 'node'

var libc = process.env.LIBC || (isAlpine(platform) ? 'musl' : 'glibc')

var armv = process.env.ARM_VERSION || (arch === 'arm64' ? '8' : vars.arm_version) || ''

var uv = (process.versions.uv || '').split('.')[0]

    var name = runtimeRequire(path.join(dir, 'package.json')).name.toUpperCase().replace(/-/g, '_')

    if (process.env[name + '_PREBUILD']) dir = process.env[name + '_PREBUILD']

    var release = getFirst(path.join(dir, 'build/Release'), matchBuild)

    var debug = getFirst(path.join(dir, 'build/Debug'), matchBuild)

  var nearby = resolve(path.dirname(process.execPath))

    (process.versions && process.versions.electron) ? 'electron=' + process.versions.electron : '',

    process.versions.electron ? 'electron=' + process.versions.electron : '',

    typeof __webpack_require__ === 'function' ? 'webpack=true' : '' // eslint-disable-line

  throw new Error('No native build was found for ' + target + '\n    loaded from: ' + dir + '\n')

    // Find matching "prebuilds/<platform>-<arch>" directory

    var tuples = readdirSync(path.join(dir, 'prebuilds')).map(parseTuple)

    var tuple = tuples.filter(matchTuple(platform, arch)).sort(compareTuples)[0]

    var prebuilds = path.join(dir, 'prebuilds', platform + '-' + arch)

    var prebuilds = path.join(dir, 'prebuilds', tuple.name)

    var parsed = readdirSync(prebuilds).map(parseTags)

    var candidates = parsed.filter(matchTags(runtime, abi))

    var winner = candidates.sort(compareTags(runtime))[0]

    if (winner) return path.join(prebuilds, winner.file)

  var files = readdirSync(dir).filter(filter)

  return files[0] && path.join(dir, files[0])

  if (!architectures.every(Boolean)) return

  return { name, platform, architectures }

    if (tuple.platform !== platform) return false

    return tuple.architectures.includes(arch)

  // Prefer single-arch prebuilds over multi-arch

  return a.architectures.length - b.architectures.length

  var tags = { file: file, specificity: 0 }

    if (tag === 'node' || tag === 'electron' || tag === 'node-webkit') {

    } else if (tag.slice(0, 3) === 'abi') {

    } else if (tag.slice(0, 2) === 'uv') {

    } else if (tag.slice(0, 4) === 'armv') {

    } else if (tag === 'glibc' || tag === 'musl') {

    if (tags.runtime !== runtime && !runtimeAgnostic(tags)) return false

    if (tags.abi !== abi && !tags.napi) return false

    if (tags.uv && tags.uv !== uv) return false

    if (tags.armv && tags.armv !== armv) return false

    if (tags.libc && tags.libc !== libc) return false

  return tags.runtime === 'node' && tags.napi

  // Precedence: non-agnostic runtime, abi over napi, then by specificity.

      return a.runtime === runtime ? -1 : 1

    } else if (a.specificity !== b.specificity) {

      return a.specificity > b.specificity ? -1 : 1

  if (process.versions && process.versions.electron) return true

  if (process.env.ELECTRON_RUN_AS_NODE) return true

  return typeof window !== 'undefined' && window.process && window.process.type === 'renderer'

  return platform === 'linux' && fs.existsSync('/etc/alpine-release')

  "description": "Build tool and bindings loader for node-gyp that supports prebuilds",

    "node-gyp-build-optional": "./optional.js",

    "node-gyp-build-test": "./build-test.js"

    "url": "https://github.com/prebuild/node-gyp-build.git"

    "url": "https://github.com/prebuild/node-gyp-build/issues"

  "homepage": "https://github.com/prebuild/node-gyp-build"

> Build tool and bindings loader for [`node-gyp`][node-gyp] that supports prebuilds.

[![Build Status](https://travis-ci.org/prebuild/node-gyp-build.svg?branch=master)](https://travis-ci.org/prebuild/node-gyp-build)

[![Test](https://github.com/prebuild/node-gyp-build/actions/workflows/test.yml/badge.svg)](https://github.com/prebuild/node-gyp-build/actions/workflows/test.yml)

Use together with [`prebuildify`][prebuildify] to easily support prebuilds for your native modules.

> **Note.** Prebuild names have changed in [`prebuildify@3`][prebuildify] and `node-gyp-build@4`. Please see the documentation below.

`node-gyp-build` works similar to [`node-gyp build`][node-gyp] except that it will check if a build or prebuild is present before rebuilding your project.

It's main intended use is as an npm install script and bindings loader for native modules that bundle prebuilds using [`prebuildify`][prebuildify].

First add `node-gyp-build` as an install script to your native project

Then in your `index.js`, instead of using the [`bindings`](https://www.npmjs.com/package/bindings) module use `node-gyp-build` to load your binding.

var binding = require('node-gyp-build')(__dirname)

If you do these two things and bundle prebuilds with [`prebuildify`][prebuildify] your native module will work for most platforms

without having to compile on install time AND will work in both node and electron without the need to recompile between usage.

Users can override `node-gyp-build` and force compiling by doing `npm install --build-from-source`.

Prebuilds will be attempted loaded from `MODULE_PATH/prebuilds/...` and then next `EXEC_PATH/prebuilds/...` (the latter allowing use with `zeit/pkg`)

If so desired you can bundle more specific flavors, for example `musl` builds to support Alpine, or targeting a numbered ARM architecture version.

These prebuilds can be bundled in addition to generic prebuilds; `node-gyp-build` will try to find the most specific flavor first. Prebuild filenames are composed of _tags_. The runtime tag takes precedence, as does an `abi` tag over `napi`. For more details on tags, please see [`prebuildify`][prebuildify].

Values for the `libc` and `armv` tags are auto-detected but can be overridden through the `LIBC` and `ARM_VERSION` environment variables, respectively.

[prebuildify]: https://github.com/prebuild/prebuildify

[node-gyp]: https://www.npmjs.com/package/node-gyp

		@@ -55,3 +55,3 @@ var fs = require('fs')
		'node=' + process.versions.node,
		(process.versions && process.versions.electron) ? 'electron=' + process.versions.electron : '',
		process.versions.electron ? 'electron=' + process.versions.electron : '',
		typeof __webpack_require__ === 'function' ? 'webpack=true' : '' // eslint-disable-line
		@@ -63,4 +63,9 @@ ].filter(Boolean).join(' ')
		function resolve (dir) {
		// Find matching "prebuilds/<platform>-<arch>" directory
		var tuples = readdirSync(path.join(dir, 'prebuilds')).map(parseTuple)
		var tuple = tuples.filter(matchTuple(platform, arch)).sort(compareTuples)[0]
		if (!tuple) return

		// Find most specific flavor first
		var prebuilds = path.join(dir, 'prebuilds', platform + '-' + arch)
		var prebuilds = path.join(dir, 'prebuilds', tuple.name)
		var parsed = readdirSync(prebuilds).map(parseTags)
		@@ -90,2 +95,30 @@ var candidates = parsed.filter(matchTags(runtime, abi))

		function parseTuple (name) {
		// Example: darwin-x64+arm64
		var arr = name.split('-')
		if (arr.length !== 2) return

		var platform = arr[0]
		var architectures = arr[1].split('+')

		if (!platform) return
		if (!architectures.length) return
		if (!architectures.every(Boolean)) return

		return { name, platform, architectures }
		}

		function matchTuple (platform, arch) {
		return function (tuple) {
		if (tuple == null) return false
		if (tuple.platform !== platform) return false
		return tuple.architectures.includes(arch)
		}
		}

		function compareTuples (a, b) {
		// Prefer single-arch prebuilds over multi-arch
		return a.architectures.length - b.architectures.length
		}

		function parseTags (file) {
		@@ -170,1 +203,4 @@ var arr = file.split('.')
		load.compareTags = compareTags
		load.parseTuple = parseTuple
		load.matchTuple = matchTuple
		load.compareTuples = compareTuples

		{
		"name": "node-gyp-build",
		"version": "4.2.3",
		"version": "4.3.0",
		"description": "Build tool and bindings loader for node-gyp that supports prebuilds",
		@@ -5,0 +5,0 @@ "main": "index.js",

		@@ -9,3 +9,3 @@ # node-gyp-build

		[![Build Status](https://travis-ci.org/prebuild/node-gyp-build.svg?branch=master)](https://travis-ci.org/prebuild/node-gyp-build)
		[![Test](https://github.com/prebuild/node-gyp-build/actions/workflows/test.yml/badge.svg)](https://github.com/prebuild/node-gyp-build/actions/workflows/test.yml)

		@@ -12,0 +12,0 @@ Use together with [`prebuildify`][prebuildify] to easily support prebuilds for your native modules.

Improved metrics