/npm

Primary LanguageTypeScriptGNU Lesser General Public License v3.0LGPL-3.0

license npm latest package npm downloads Follow on Twitter

Inverter / NPM package Template

Bun + Npm + Typescript + Commit / Release Pipeline

Summary

This package contains < a template for devoloping for npm packages > for INVERTER. Learn more about INVERTER on (https://inverter.network).

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

Install dependencies

Install Bun ( bun is used for testing for primitives no bun is needed ):

# Supported on macOS, Linux, and WSL

curl -fsSL https://bun.sh/install | bash

# Upgrade Bun every once in a while

bun upgrage

Install dependencies:

bun add @inverter-network/<pkg_name>

or

npm install @inverter-network/<pkg_name>

Developing

Install Dependencies

bun install

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
  6. Make sure everything looks good (e.g. in CHANGELOG.md)
  7. Lastly run bun release:pub
  8. Done

Summary

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