README.md

insighty-eslint-config

Standard Insighty ESLint configuration.

How do I use this?

Getting Started

1. Pick one of the included configs
2. Copy to the root of your project, right next to your package.json
3. Install dependencies as described below

Included configs

Basic ES6

Dependencies: yarn add --dev eslint babel-eslint eslint-config-airbnb-base eslint-plugin-import

React

Dependencies: yarn add --dev eslint babel-eslint eslint-config-airbnb eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react

Common Usage Patterns

Scripts

For the sake of simplicity, it is recommended to extend the package.json "scripts" section with the following:

    "lint": "eslint .",
    "lint-fix": "eslint . --fix",

What is --fix?

Running on the CI server

Then, linting can be plugged into the CI build or git's pre-commit hook via yarn lint or npm run lint

Have an RFC? Having Troubles?

Please open a GitHub issue or submit a pull request.