template-bun-rust-library

Project template for a Rust library with Bun FFI bindings.

Template Usage

Create a new Bun project using this as a template:

bun create @flowscripter/template-bun-rust-library

Bun Module Usage

Add the module:

bun add @flowscripter/template-bun-rust-library

Use the module:

import { world } from "@flowscripter/template-bun-rust-library";

world();

Development

Install dependencies:

bun install

Test:

cargo test

cargo build --release && bun test

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

Format:

deno fmt

Lint:

cargo fmt && deno lint index.ts src/ tests/

Generate HTML API Documentation:

deno doc --html --name=template-bun-rust-library index.ts

Documentation

Overview

Sample mermaid diagram to test rendering in markdown:

classDiagram
    Foo <|-- Bar

API

Link to auto-generated API docs:

API Documentation

License

MIT © Flowscripter