CivicSource ESLint Configuration

Shareable ESLint configuration to be used in CivicSource client applications

Read more in general about how eslint shareable configurations work.

Install

yarn add eslint-config-civicsource --dev

or

npm install eslint-config-civicsource --save-dev

Usage

Add to your .eslintrc.yml:

extends:
  - civicsource

This includes all civicsource rules (except the testing rules). You could also choose to include them individually:

extends:
  - civicsource/style
  - civicsource/react
  - civicsource/imports

The testing rules are not included by default and can be included via:

extends:
  - civicsource/mocha

or

extends:
  - civicsource/jest

Contributing

When adding rules or plugins, put them into the correct js file based on category (e.g. add react rules to react.js). Make sure to add a small comment explaining what the rule does (feel free to be as snarky as possible) along with a link to the rule documentation.

Versioning

When making changes, be sure to follow semantic versioning.

• Any new error rules you add should be a major version bump.
• Any more restrictive changes to existing error rules should be a major version bump.
• Any easing of restrictions to existing error rules can be a minor version bump.
• Any new fixable error rules can be a minor version bump.
• Any addition or changes to warning rules should be a minor version bump.
• Any bug fixes should be a patch version bump.
• Anytime you realize you broke one of these rules, fixing it should be a patch version bump.