Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

eslint-config-airbnb

npm version

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

Usage

We export three ESLint configurations for your usage.

eslint-config-airbnb

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

  1. npm install --save-dev eslint-config-airbnb eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y eslint
  2. add "extends": "airbnb" to your .eslintrc

eslint-config-airbnb/base

Lints ES6+ but does not lint React. Requires eslint and eslint-plugin-import.

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

eslint-config-airbnb/legacy

Lints ES5 and below. Requires eslint and eslint-plugin-import.

  1. npm install --save-dev eslint-config-airbnb eslint-plugin-import eslint
  2. add "extends": "airbnb/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.