@flowscripter/template-bun-executable v1.1.27

template-bun-executable

Project template for a cross-platform Bun executable with ffi native library and Bun library dependencies

Template Usage

Create a new Bun project using this as a template:

bun create @flowscripter/template-bun-executable

Binary Executable Usage

NOTE: The binaries are 10's of megabytes in size as the entire Bun runtime is included.

MacOS

Via Homebrew:

brew install flowscripter/tap/template-bun-executable

Linux

In a terminal:

curl -fsSL https://raw.githubusercontent.com/flowscripter/template-bun-executable/main/script/install.sh | sh

Windows

Via Winget:

winget install Flowscripter.template-bun-executable

Manual Install

You can download and extract the binary zip files from the releases page.

Functional Tests

Refer to functional_tests/README.md

Development

Install dependencies:

bun install

Test:

bun test

Run:

bun run index.ts

Compile binary:

bun build index.ts --compile --outfile /tmp/template-bun-executable

NOTE: The following tasks use Deno as it excels at these and Bun does not currently provide such functionality:

Format:

deno fmt

Lint:

deno lint index.ts src/ tests/

Documentation

Overview

Sample mermaid diagram to test rendering in markdown:

classDiagram
    Foo <|-- Bar

License

MIT © Flowscripter