package

Boilerplate for creating a new NPM package with ESM and CJS support.

Install

• pnpm i
• npx lefthook install

Setup

Configure the following files:

• package.json
• Edit .changeset/config.json to your repository

In Github settings:

• Actions > General > Workflow permissions
  • Read and write permissions
  • Allow Github Actions to create and approve pull requests
• Secrets and variables > Actions
  • Repository Secrets > Actions > create NPM_TOKEN

Development workflow / Add a new CHANGELOG.md entry + package versioning

• Create a branch and make changes.
• Create a new changeset entry: pnpm changeset
• Commit your changes and create a pull request.
• Merge the pull request
• A new PR will be created with the changeset entry/ies.
• When the PR is merged, the package versions will be bumped and published and the changelog updated.