This package provides Airbnb's .eslintrc as an extensible shared config.
We export three ESLint configurations for your usage.
Our default export contains all of our ESLint rules, including EcmaScript 6+
and React. It requires eslint
and eslint-plugin-react
.
npm install --save-dev eslint-config-airbnb eslint-plugin-react eslint
- add
"extends": "airbnb"
to your .eslintrc
Lints ES6+ but does not lint React. Requires eslint
.
npm install --save-dev eslint-config-airbnb eslint
- add
"extends": "airbnb/base"
to your .eslintrc
Lints ES5 and below. Only requires eslint
.
npm install --save-dev eslint-config-airbnb eslint
- add
"extends": "airbnb/legacy"
to your .eslintrc
See Airbnb's Javascript styleguide and the ESlint config docs for more information.
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
.