template-bun-library

Project template for a Bun library

Template Usage

Create a new Bun project using this as a template:

bun create @flowscripter/template-bun-library

Bun Module Usage

Add the module:

bun add @flowscripter/template-bun-library

Use the module:

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

world();

Development

Install dependencies:

bun install

Build (produces dist/ for Node.js and TypeScript consumers; Bun uses raw source directly):

bun run build

Test:

bun test

Format:

bunx oxfmt

Lint:

bunx oxlint index.ts src/ tests/

Generate HTML API Documentation:

bunx typedoc 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