README.md

eslint-config-rainbow

A shareable ESLint config for Rainbow projects.

Usage

Install this package and its peer dependencies:

yarn add eslint-config-rainbow eslint jest react -D

Then extend your .eslintrc.js config:

module.exports = {
  extends: "rainbow"
}

Add a step to your package.json to lint your project:

{
  "scripts": {
    "lint": "eslint --ext '.ts,.tsx,.js,.jsx' ."
  }
}

Contributing

This repo utilizes GitHub Actions and semantic-release to automatically test and publish this package to npm. Versioning is based on the commit messages, which must follow the Conventional Commits standard i.e. feat: <msg> for minor releases, fix: <msg> for patch.

When creating a PR, ensure that your commits follow these patterns. Upon merging into main, your PR will be rolled up into a single release and published to npm. Your release and changelog notes will then appear on the releases page.