npm-module-template

A starter template for npm modules. Currently setup with the following tech:

• bun build - with types the best I could (see build notes below)
• lint-staged check git staged files
• vitest test framework
• eslint with prettier formatting
• fixpack to normalize package.json changes along with npm pkg fix
• husky pre commit hooks
• changesets change and release workflow
• renovate dependency management
• Github Actions
• Starlight Documentation

Installation

Click the Use this template button to create a new repository (or run bun create Enalmada/npm-module-template <your-new-library-name>)

Documentation

Read the documentation website

TODO

• tests framework to bun (when bun supports mocking modules)

inspiration

• bun-lib-starter

Notes

Build

• Using latest module and target settings for current LTS
• using tsc for types until bun support comes around

Contribute

Using changesets so please remember to run "changeset" with any PR that might be interesting to people on an older template. Although this isn't being deployed as a module, I would like to call out things worth keeping in sync.