lib

bun/lib

A TypeScript library template using Bun.

Getting Started

npx giget gh:bentruyman/templates/bun/lib my-lib
cd my-lib
bun install

Customize

Update package.json with your project details:

• name - Your package name
• description - What your library does
• exports - The entrypoints you want to publish

Replace the example implementation in src/index.ts with your library code.

Scripts

Script	Description
bun run build	Build the library with package deps external
bun run check:dist	Verify dist/index.js size and import shape
bun run format	Format code with oxfmt
bun run format:check	Check formatting without rewriting files
bun run lint	Lint the template with oxlint
bun run typecheck	Type-check with TypeScript
bun run verify	Run format, lint, typecheck, test, and build
bun run release	Publish a new version with release-it

Development

Run tests while iterating:

bun test --watch

Distribution Modes

For normal npm-published packages, keep runtime dependencies external:

bun build src/index.ts --outdir dist --target node --packages external

Use Bun's default bundled mode only when you explicitly want a single-file distribution artifact. If a dependency stays in package.json, do not inline it into the published build by default.

Publishing

1. Update package.json name and exports fields
2. Run bun run release to build, tag, and publish to npm