eslint-config-airbnb
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

eslint-config-airbnb

Airbnb's ESLint config, following our styleguide

18.0.1  •  Published 3 months ago  •  by airbnb  •  MIT License

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, eslint-plugin-react-hooks, and eslint-plugin-jsx-a11y. If you don’t need React, see eslint-config-airbnb-base.

  1. Install the correct versions of each package, which are listed by the command:
npm info "eslint-config-airbnb@latest" peerDependencies

If using npm 5+, use this shortcut

npx install-peerdeps --dev eslint-config-airbnb

If using yarn, you can also use the shortcut described above if you have npm 5+ installed on your machine, as the command will detect that you are using yarn and will act accordingly. Otherwise, run npm info "eslint-config-airbnb@latest" peerDependencies to list the peer dependencies and versions, then run yarn add --dev <dependency>@<version> for each listed peer dependency.

If using npm < 5, Linux/OSX users can run

(
  export PKG=eslint-config-airbnb;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)

Which produces and runs a command like:

npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.# eslint-plugin-react-hooks@^#.#.#

If using npm < 5, Windows users can either install all the peer dependencies manually, or use the install-peerdeps cli tool.

npm install -g install-peerdeps
install-peerdeps --dev eslint-config-airbnb

The cli will produce and run a command like:

npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.# eslint-plugin-react-hooks@^#.#.#
  1. Add "extends": "airbnb" to your .eslintrc

eslint-config/airbnb/hooks

This entry point enables the linting rules for React hooks (requires v16.8+). To use, add "extends": "airbnb/hooks" to your .eslintrc

eslint-config-airbnb/whitespace

This entry point only errors on whitespace rules and sets all other rules to warnings. View the list of whitespace rules here.

eslint-config-airbnb/base

This entry point is deprecated. See eslint-config-airbnb-base.

eslint-config-airbnb/legacy

This entry point is deprecated. See eslint-config-airbnb-base.

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.

Popularity

Weekly Downloads
1.4M
Stars
90.5K

Maintenance

Development

Last ver 3 months ago
Created 4 years ago
Last commit 9 days ago
1 day between commits

Technology

Node version: 12.8.0
70.8K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

318 contributors
Jordan Harband
Maintainer, 489 commits, 477 merges, 13 PRs
Harrison Shoff
44 commits, 45 merges, 21 PRs
Works at Airbnb
Joe Lencioni
Maintainer, 53 commits, 11 merges, 37 PRs
Works at Airbnb
Josh Perez
Maintainer, 1 commits, 48 merges, 5 PRs
Works at airbnb
Jake Teton-Landis
Maintainer, 37 merges, 10 PRs
Kevin Ivan
31 commits

Tags

eslint
eslintconfig
config
airbnb
javascript
styleguide
es2015
es2016
es2017
es2018
Ready for the next level?
Join Devstore's founding team to help us build the ultimate open-source app store, work with the latest technologies, and enjoy great culture, impact and autonomy
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things