ESLint Configuration

Shared ESLint configuration for all Felloh codebases.

Usage

1. Install eslint if you haven't already done so.

   yarn add eslint --dev

2. Install this package.

   yarn add @felloh-org/eslint-config --dev

3. Extend the desired configuration in your project's ESLint config:

   # .eslintrc.yml
   extends:
     - '@felloh-org/eslint-config'

This will give you the default linting configuration, which includes rules from the flowtype, sonarjs and unicorn plugins.

Mixins

As well as our default ESLint config, various common customisations are available that you can "mix in" to your config:

• base: Base configuration that you should extend if you're not using @comicrelief/eslint-config. See TypeScript example below.
• flowtype: Adds Flow typing rules.
• jest: Uses the jest environment.
• jsdoc: Adds JSDoc rules.
• mocha: Uses the mocha environment.
• sonarjs: Adds SonarJS rules.
• unicorn: Adds Unicorn rules.