README.md

bun-lib-starter

A starter template for node library built with bun.

What's included

• 🚀 Typescript Support
• 🧼 Linting and Formatting with Pre-commit Hooks (Powered by pre-commit and biomejs)
• 📦 Efficient Bundling with tsup (Supporting both cjs and esm)
• 🧪 Inclusive Built-in Test Runner (Powered by bun)
• 🌐 GitHub Actions for CI/CD and Semantic Release Automation

Getting Started

Prerequisites

• bun
• pre-commit

Installation

Use bun CLI to create a new project (recommended)

bun create maxam2017/bun-lib-starter <your-project-name>

or clone this repo and install manually

git clone https://github.com/maxam2017/bun-lib-starter.git

cd bun-lib-starter

pre-commit install

bun install

Development

1. Run in dev mode (watch mode)

   bun dev

2. Run tests

    bun test

License

Distributed under the MIT License. See LICENSE for more information.