bun-library-starter
v1.0.6
Published
A starter project for creating library with bun
Downloads
19
Readme
bun-library-starter
bun-library-starter is a starter template for creating javascript libraries with bun.
Features
- [x] Bun
- [x] Typescript
- [x] ESLint
- [x] Prettier
- [x] NPM publishing
- [x] Github Releases
Usage
Install
- Install Bun
- Clone this repository and install dependencies
$ git clone [email protected]: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.