Inverter / NPM package Template

Bun + Npm + Typescript + Standard Version + Flat Config Linting + Husky + Commit / Release Pipeline

Summary

This package contains < a template for devoloping for npm packages > for <brand_name>.

Check out the Changelog to see what changed in the last releases.

Install

bun add <pkg_name>

Install Bun ( bun is the default package manager for this project ( its optional ) ):

# Supported on macOS, Linux, and WSL
curl -fsSL https://bun.sh/install | bash
# Upgrade Bun every once in a while
bun upgrage

Developing

Install Dependencies:

bun i

Watching TS Problems:

bun watch

How to make a release

For the Maintainer: Add NPM_TOKEN to the GitHub Secrets.

1. PR with changes
2. Merge PR into main
3. Checkout main
4. git pull
5. bun release: '' | alpha | beta optionally add -- --release-as minor | major | 0.0.1
6. Make sure everything looks good (e.g. in CHANGELOG.md)
7. Lastly run bun release:pub
8. Done

License

This package is licensed - see the LICENSE file for details.