Getting Started

Installation

Click the Use this template button to create a new repository. You can also run bun create Enalmada/npm-module-template <your-new-library-name>

Github settings

• add NPM_TOKEN with access to deploy to npm to environment variables
• Actions > General > Workflow Permissions
  • Read and Write (to allow changesets to create changelog, and release)
  • Allow github actions to create and approve PR

Workflow

• install dependencies bun install
• lint files bun lint:fix
• run tests bun run test (not bun test as we are not using native tests)
• run build bun run build (not bun build as we are using build script)
• create changeset before PR changeset and choose appropriate semver and changelog

Migrate existing repository

• git remote add template https://github.com/Enalmada/npm-module-template
• git fetch template
• git merge template/main --allow-unrelated-histories
• resolve conflicts and merge