bare-build

Application builder for Bare that allows developers to package their JavaScript code as either native application bundles or standalone executables for both desktop and mobile.

``
npm i [-g] bare-build
`

Usage

`js
const build = require('bare-build')

for await (const resource of build('/path/to/app.js', {
base: '/path/to/',
hosts: ['darwin-arm64', 'darwin-x64'],
icon: 'icon.icns',
identifier: 'com.example.App'
})) {
console.log(resource)
}
`

`console
bare-build \
--host darwin-arm64 --host darwin-x64 \
--icon icon.icns \
--identifier com.example.App \
app.js
`

Formats

| Platform | Unpackaged | --package | --standalone |
| :------- | :------------------------- | :---------- | :------------------------------------------------------------ |
| Linux | .AppDir, Snap compatible | .AppImage | ELF executable with self-extracting .so libraries |
| Android | .apk | .aab | ELF executable with self-extracting .so libraries |
| macOS | .app | .pkg | Mach-O executable with self-extracting .framework libraries |
| iOS | .app | .pkg | Mach-O executable with self-extracting .framework libraries |
| Windows | Plain directory | .msix | PE executable with self-extracting .dll libraries |

Runtimes

bare-build ships with portable runtimes for all supported systems. Similarly to the bare CLI, the portable runtimes are designed to run only the I/O event loop of Bare and they're therefore mostly suited for standalone CLI applications. That's why we refer to them as portable; the same code will run the same way across all systems. For developing native GUI applications, however, the portable runtimes fall short as such applications require tight integration with the native event loop of the corresponding system, such as [CFRunLoop][cfrunloop] in Core Foundation or [Looper][looper] in Android. These applications must instead use a native runtime designed specifically for the system on which they're run.

[cfrunloop]: https://developer.apple.com/documentation/corefoundation/cfrunloop
[looper]: https://developer.android.com/reference/android/os/Looper

For that purpose, an alternative runtime can be specified via the runtime option or the --runtime flag. As with the portable runtimes, we maintain native runtimes for all supported systems.

| Platform | Runtime | API | CLI |
| :------- | :---------------------------------------------------------- | :-------------------------------- | :------------------------------- |
| Linux | bare-gtk | runtime: 'bare-gtk/runtime' | --runtime bare-gtk/runtime |
| Android | bare-ndk | runtime: 'bare-ndk/runtime' | --runtime bare-ndk/runtime |
| macOS | bare-app-kit | runtime: 'bare-app-kit/runtime' | --runtime bare-app-kit/runtime |
| iOS | bare-ui-kit | runtime: 'bare-ui-kit/runtime' | --runtime bare-ui-kit/runtime |
| Windows | bare-win-ui | runtime: 'bare-win-ui/runtime' | --runtime bare-win-ui/runtime |

API

#### for await (const resource of build(entry[, preflight][, options]))

Options include:

`js
options = {
name: pkg.name,
version: pkg.version,
author: pkg.author,
description: pkg.description,
icon,
identifier,
manifest,
resources,
base: '.',
hosts: [],
out: '.',
runtime,
standalone: false,
package: false,
sign: false,

// Apple signing options
identity: 'Apple Development',
applicationIdentity: identity,
installerIdentity: identity,
keychain,
entitlements,
hardenedRuntime: false,

// Windows signing options
subject,
subjectName,
thumbprint,

// Linux signing options
key,

// Android signing options
keystore,
keystoreKey,
keystorePassword
}
`

CLI

#### bare-build [flags]

Flags include:

`console
--version|-v Print the current version
--name|-n The application name
--author The name of the application author
--description The description of the application
--icon|-i The application icon
--identifier The unique application identifier
--manifest The platform specific application manifest
--resources The platform specific application resources
--base The base path of the application (default: .)
--host The host to target
--out|-o