bare-runtime 1.22.0 → 1.22.1-0

package/README.md

@@ -3,9 +3,47 @@
 Prebuilt Bare binaries for macOS, iOS, Linux, Android, and Windows.
 
 ```
-npm i bare-runtime
+npm i [-g] bare-runtime
 ```
 
+## API
+
+> [!WARNING]
+> These functions are currently subject to change between releases and are not by covered Semantic Versioning. The version of the prebuilds strictly match the corresponding Bare version. If your code depends on the APIs make sure to specify a fixed version (`1.2.3`) when declaring the module dependency.
+
+#### `const prebuild = runtime([referrer][, options])`
+
+Get the path to the Bare binary prebuild for the current platform. Will throw an error if no matching binary prebuild is found.
+
+Options include:
+
+```js
+options = {
+  platform: process.platform,
+  arch: process.arch
+}
+```
+
+### Spawning
+
+The `bare-runtime/spawn` module provides a convenient way to spawn the Bare binary prebuilds as child processes, adding appropriate executable permissions as required.
+
+#### `const process = spawn([referrer][, options])`
+
+Options include:
+
+```js
+options = {
+  platform: process.platform,
+  arch: process.arch,
+  args: process.argv.slice(2)
+}
+```
+
+## CLI
+
+The module exposes a CLI that as a convenience will spawn the Bare binary that matches your platform. See <https://github.com/holepunchto/bare#usage> for details on the `bare` CLI.
+
 ## License
 
 Apache-2.0

package/lib/spawn.js

@@ -1,13 +1,13 @@
-/* global Bare */
+const fs = require('fs')
 const childProcess = require('child_process')
 const runtime = require('..')
 
 module.exports = function spawn(referrer, opts) {
   if (typeof referrer === 'object' && referrer !== null) {
     opts = referrer
-    referrer = 'ninja'
+    referrer = 'bare'
   } else if (typeof referrer !== 'string') {
-    referrer = 'ninja'
+    referrer = 'bare'
   }
 
   if (!opts) opts = {}
@@ -18,5 +18,13 @@ module.exports = function spawn(referrer, opts) {
       : process.argv.slice(2)
   } = opts
 
-  return childProcess.spawn(runtime(referrer, opts), args, opts)
+  const bin = runtime(referrer, opts)
+
+  try {
+    fs.accessSync(bin, fs.constants.X_OK)
+  } catch {
+    fs.chmodSync(bin, 0o755)
+  }
+
+  return childProcess.spawn(bin, args, opts)
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-runtime",
-  "version": "1.22.0",
+  "version": "1.22.1-0",
   "description": "Prebuilt Bare binaries for macOS, iOS, Linux, Android, and Windows",
   "exports": {
     ".": "./index.js",