eslint-config-eventbrite-react
Eventbrite's ESLint config that lints React & JSX, adhering to the Eventbrite JavaScript Coding Style Guide.
Usage
This ESLint configuration requires eslint
, eslint-plugin-import
, eslint-plugin-react
, eslint-plugin-jsx-a11y
and babel-eslint
.
Install peer dependencies if they are not installed already
npm install --save-dev eslint@^3.0.0 eslint-plugin-import@^2.0.0 eslint-plugin-react@^6.0.0 eslint-plugin-jsx-a11y@^6.0.0 babel-eslint@^7.0.0
yarn add -D eslint@^3.0.0 eslint-plugin-import@^2.0.0 eslint-plugin-react@^6.0.0 eslint-plugin-jsx-a11y@^6.0.0 babel-eslint@^7.0.0
Install eslint-config-eventbrite-react
npm install --save-dev eslint-config-eventbrite-react
yarn add -D eslint-config-eventbrite-react
Extend eslint-config-eventbrite-react
in your .eslintrc.json
:
{
"extends": "eventbrite-react"
}
NOTE: This configuration extends eslint-config-eventbrite
and plugin:react/recommended'
.
Contributing
Thank you for your willingness to contribute! 😀
Although eslint-config-eventbrite-react
is a public package, its primary purpose is for linting Eventbrite's React JavaScript code. Therefore, it is unlikely that we'll accept changes to rules as they may adversely affect the linting of our own code. However, we do welcome fixes for errors or additions for omissions.
If you are uncertain as to whether your suggestion qualifies, go ahead and submit a Pull Request and we'll let you know. Thanks again!
License
MIT. Copyright (c) 2016 Eventbrite.
Thanks
Many thanks to Airbnb and their example eslint-config-airbnb
.