Grumbler Scripts Monorepo

This is a collection of configuration scripts one can use for their projects.

Packages Available

Below is a list of available packages to install. To provide a one stop shop we will continue to support @krakenjs/grumbler-scripts which is a combination of all the packages. Feel free to use that parent package or install configs as you need.

Each package has its own installation instructions in it's respective README.

• @krakenjs/babel-config-grumbler
• @krakenjs/eslint-config-grumbler
• @krakenjs/grumbler-scripts
• @krakenjs/karma-config-grumbler
• @krakenjs/typescript-config-grumbler
• @krakenjs/webpack-config-grumbler

Contributing

Tools used

• changesets for tracking version changes
• npm workspaces for monorepo package management
• prettier for code formatting

Steps to make a change

1. Install dependencies:

   npm install
   

2. Make proposed changes

3. Run tests

   npm test
   

4. Add a changeset for versioning

   npm run changeset:add
   

5. Open a new PR

Releasing

Releasing a new latest

To release a new version please leverage Github Actions. There is a release action that can be run to create a new release.

Release a new alpha

There is no Github Action for alpha release at this time. Because this repo utilizes changesets we can follow their process locally in the meantime. This document can be seen here.