eslint-config-helpscout

eslint-config-helpscout

This package provides Help Scout's .eslintrc as an extensible shared config.

Usage

We export three ESLint configurations for your usage.

eslint-config-helpscout

Our default export contains all of our ESLint rules, including EcmaScript 6+ and React. It requires eslint and eslint-plugin-react.

1. npm install --save-dev eslint-config-helpscout eslint-plugin-react eslint
2. add "extends": "helpscout" to your .eslintrc

eslint-config-helpscout/base

Lints ES6+ but does not lint React. Requires eslint.

1. npm install --save-dev eslint-config-helpscout eslint
2. add "extends": "helpscout/base" to your .eslintrc

eslint-config-helpscout/legacy

Lints ES5 and below. Only requires eslint.

1. npm install --save-dev eslint-config-helpscout eslint
2. add "extends": "helpscout/legacy" to your .eslintrc

See Airbnb's Javascript styleguide and the ESlint config docs for more information.

Improving this config

Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?

You can run tests with npm test.

You can make sure this module lints with itself using npm run lint.