https://github.com/flowscripter/template-bun-library

Project template for a Bun library.
https://github.com/flowscripter/template-bun-library

bun typescript

Last synced: 12 months ago
JSON representation

Project template for a Bun library.

• Host: GitHub
• URL: https://github.com/flowscripter/template-bun-library
• Owner: flowscripter
• License: mit
• Created: 2025-02-11T21:29:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-05-22T02:04:38.000Z (about 1 year ago)
• Last Synced: 2025-05-22T03:23:43.354Z (about 1 year ago)
• Topics: bun, typescript
• Language: TypeScript
• Homepage:
• Size: 55.7 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# template-bun-library

[![version](https://img.shields.io/github/v/release/flowscripter/template-bun-library?sort=semver)](https://github.com/flowscripter/template-bun-library/releases)

[![build](https://img.shields.io/github/actions/workflow/status/flowscripter/template-bun-library/release-bun-library.yml)](https://github.com/flowscripter/template-bun-library/actions/workflows/release-bun-library.yml)

[![coverage](https://codecov.io/gh/flowscripter/template-bun-library/graph/badge.svg?token=uWK0oWsBjr)](https://codecov.io/gh/flowscripter/template-bun-library)

[![docs](https://img.shields.io/badge/docs-API-blue)](https://flowscripter.github.io/template-bun-library/index.html)

[![license: MIT](https://img.shields.io/github/license/flowscripter/template-bun-library)](https://github.com/flowscripter/template-bun-library/blob/main/LICENSE)

> 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:

```typescript

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

world();

```

## Development

Install dependencies:

`bun install`

Test:

`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:

`deno lint index.ts src/ tests/`

Generate HTML API Documentation:

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

## Documentation

### Overview

Sample mermaid diagram to test rendering in markdown:

```mermaid

classDiagram

    Foo <|-- Bar

```

### API

Link to auto-generated API docs:

[API Documentation](https://flowscripter.github.io/template-bun-library/index.html)

## License

MIT © Flowscripter