bun-library-starter v1.0.6

bun-library-starter

bun-library-starter is a starter template for creating javascript libraries with bun.

Features

• Bun
• Typescript
• ESLint
• Prettier
• NPM publishing
• Github Releases

Usage

Install

• Install Bun
• Clone this repository and install dependencies

$ git clone git@github.com:pedro199288/bun-library-starter.git
$ cd bun-library-starter
$ bun install

Set library details

To set the library name, description, author, repository and license, run the following command:

$ bun run scripts/set-library-details.ts

Development

To start developing your library, run the following command:

$ bun run dev

Build

To build your library, run the following command:

$ bun run build

Create a release

To create github and npm releases, add the `NPM_TOKEN secret to your repository secrets and run the following npm command:

$ bun release <release-type>

Where <release-type> can be major, minor or patch.

This will update the version in package.json, create a git tag and commit the changes.

License

This project is licensed under the MIT License - see the LICENSE file for details.