Skip to content

theogravity/boilerplate-typescript-package

Repository files navigation

package

NPM version NPM Downloads TypeScript

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

Setup

Configure the following files:

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

In Github settings:

  • Code and Automation > Actions > 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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published