@rdbird/eslint-config

ESLint Configuration

This package provides RdBird's ESLint configuration as an extensible shared config.

• How to use it in your project
  • 1. Install dependency
  • 2. Update .eslintrc.json
  • 3. Update package.json
• Architecture

How to use it in your project

Setup requirements

npm install \
eslint babel-eslint prettier \
@rdbird/eslint-config \
--save-dev

Configure eslint

Use all plugins

.eslintrc.json

{
  "extends": [
    "@rdbird/eslint-config"
  ]
}

OR

Cherry-pick plugins

.eslintrc.json

{
  "extends": [
    "@rdbird/eslint-config/base",
    "@rdbird/eslint-config/react",
    "@rdbird/eslint-config/jsx-a11y",
    "@rdbird/eslint-config/flowtype"
  ]
}

Setup the lint task

package.json

{
  "scripts": {
    "lint": "eslint .",    
    "format": "eslint . --fix"    
  }
}

Architecture

For a better community alignment, the configuration extends StandardJS. Inspiration also comes from:

• AirBnB
• Algolia
• Supermind