package-kit

A monorepository template built for easing the development and maintainence of npm packages

Getting started

• Run pnpm install to install all dependencies

Test and Deploy

• Run pnpm test to run all test suites in all packages

• Run pnpm build to build all packages

• Run pnpm --filter <package> test to run test suites for a particular package

• Deployment is handled automatically by GitHub Actions when a commit is pushed to the master branch
  

Git commit messages

• We follow conventional commits during our development workflow as it helps us automate our release process. More information can be found at their official documentation

• Supported commit message prefixes for version bumping are as follows:

  - Feat! - bump major version

  - Feat  - bump minor version

  - Fix   - bump patch version

• Refer the commitlint.config.js file for a full list of supported commit message prefixes

Disable version bumping for specific commit

• Add the following to a commit message as follows: "--no-bump"
  

  git commit -m "Feat: some feature --no-bump"

Linting and Formatting

• Run pnpm lint to lint all packages
• Run pnpm format to format all packages

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

pnpm dlx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

pnpm dlx turbo link