eslint-config-eventbrite
v5.0.0
Published
Eventbrites's base ESLint config that lints ES6+/ES2015+ and adheres to the Eventbrite JavaScript Coding Style Guide
Downloads
4,449
Readme
eslint-config-eventbrite
Eventbrite's base ESLint config that lints ES6+/ES2015+ and adheres to the Eventbrite JavaScript Coding Style Guide.
Usage
This ESLint configuration requires eslint
, babel-eslint
, eslint-plugin-babel
, eslint-plugin-import
, and eslint-plugin-jest
.
Install using npm:
npm install --save-dev eslint@^4.19.1 babel-eslint@^8.2.3 eslint-plugin-babel@^5.1.0 eslint-plugin-import@^2.11.0 eslint-plugin-jest@^21.15.1 eslint-config-eventbrite
...or using yarn:
yarn add --dev eslint@^4.19.1 babel-eslint@^8.2.3 eslint-plugin-babel@^5.1.0 eslint-plugin-import@^2.11.0 eslint-plugin-jest@^21.15.1 eslint-config-eventbrite
Extend eslint-config-eventbrite
in your .eslintrc.json
:
{
"extends": "eventbrite"
}
NOTE: This configuration extends eslint-config-eventbrite-legacy
and plugin:import/errors
.
Contributing
Thank you for your willingness to contribute! 😀
Although eslint-config-eventbrite
is a public package, its primary purpose is for linting Eventbrite's 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
The library is available as open source under the terms of the MIT License.
Thanks
Many thanks to Airbnb and their example eslint-config-airbnb
.