Add support for distributing prebuilds as platform-specific packages

README.md

@@ -71,7 +71,14 @@ module.exports = binding
 An added benefit of this approach is that your native modules will work across multiple node and electron versions without having the user
 need to reinstall or recompile them - as long as you produce prebuilds for all versions. With Node-API you only have to produce prebuilds for every runtime.
 
-When publishing your module to npm remember to include the `./prebuilds` folder.
+
+## Platform-specific Packages
+As an alternate to including all prebuilds directly in your published package, you can use  `--optional-packages` to setup the prebuilds for publishing as separate platform-specific packages. Using this option, each prebuild directory will also include a package.json that specifies the target platform and architectures along with some basic package files. Each of these prebuild directories can then be published as separate packages in NPM. In addition,
+the main package should specify all the platform packages as `optionalDependencies`. When installed, NPM (or Yarn, etc.) will then only install the optional dependency with the platform/architecture matching the target machine.
+
+This provides both the efficiency of only needing to download/install the binary (or binaries) needed for the current platform, but also the key benefit of the prebuildify system in that binaries are downloaded and available as part of the normal NPM install process (no install scripts for extra downloads are necessary). When using this method, you should omit the prebuilds folder when publishing your package (since they will be separately downloaded).
+
+If you do not use this option, when publishing your module to npm, remember to include the `./prebuilds` folder.
 
 That's it! Happy native hacking.
 
@@ -94,6 +101,7 @@ Options can be provided via (in order of precedence) the programmatic API, the C
 | `--tag-uv`           | -                    | `false`                        | Tag prebuild with `uv`\*\*\*
 | `--tag-armv`         | -                    | `false`                        | Tag prebuild with `armv`\*\*\*
 | `--tag-libc`         | -                    | `false`                        | Tag prebuild with `libc`\*\*\*
+| `--optional-dependencies`| -                    | `false`                        | Add package.json and basic files for package publishing
 | `--preinstall`       | -                    | -                              | Command to run before build
 | `--postinstall`      | -                    | -                              | Command to run after build
 | `--shell`            | `PREBUILD_SHELL`     | `'sh'` on Android              | Shell to spawn commands in

bin.js

@@ -15,9 +15,10 @@ var argv = minimist(process.argv.slice(2), {
     tagArmv: 'tag-armv',
     tagLibc: 'tag-libc',
     electronCompat: 'electron-compat',
+    optionalPackages: 'optional-packages',
     cache: 'c'
   },
-  boolean: ['quiet', 'strip', 'napi', 'debug', 'all', 'electron-compat']
+  boolean: ['quiet', 'optional-packages', 'strip', 'napi', 'debug', 'all', 'electron-compat']
 })
 
 argv.targets = [].concat(argv.target || [])

index.js

@@ -62,6 +62,13 @@ function prebuildify (opts, cb) {
   if (opts.arch === 'ia32' && opts.platform === 'linux' && opts.arch !== os.arch()) {
     opts.env.CFLAGS = '-m32'
   }
+  var packageData
+  if (opts.optionalPackages) {
+    if (opts.arch.indexOf('+') > -1) {
+      throw new Error('Optional packages do not support multi-arch values')
+    }
+    packageData = JSON.parse(fs.readFileSync(path.join(opts.cwd, 'package.json')))
+  }
 
   // Since [email protected] npm adds its bundled node-gyp to PATH, taking precedence
   // over the local .bin folder. Counter that by (again) adding .bin to PATH.
@@ -71,7 +78,26 @@ function prebuildify (opts, cb) {
     if (err) return cb(err)
     loop(opts, function (err) {
       if (err) return cb(err)
-
+      if (opts.optionalPackages) {
+        var packageName = packageData.name
+        var description = 'Platform specific binary for ' + packageName + ' on ' + opts.platform + ' OS with ' + opts.arch + ' architecture'
+        fs.writeFileSync(path.join(opts.builds, 'package.json'), JSON.stringify({
+          // append platform, and prefix with scoped name matching package name if unscoped
+          name: (packageName[0] === '@' ? '' : '@' + packageName + '/') + packageName + '-' + opts.platform + '-' + opts.arch,
+          version: packageData.version,
+          os: [opts.platform],
+          cpu: [opts.arch],
+          // copy some of the useful package metadata, if any of these are missing, should just be skipped when stringified
+          license: packageData.license,
+          author: packageData.author,
+          repository: packageData.repository,
+          bugs: packageData.bugs,
+          homepage: packageData.homepage,
+          description
+        }, null, 2))
+        fs.writeFileSync(path.join(opts.builds, 'index.js'), '') // needed to resolve package
+        fs.writeFileSync(path.join(opts.builds, 'README.md'), description)
+      }
       if (opts.artifacts) return copyRecursive(opts.artifacts, opts.builds, cb)
       return cb()
     })