JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3521955
  • Score
    100M100P100Q211009F
  • License MIT

Airbnb's ESLint config, following our styleguide

Package Exports

  • eslint-config-airbnb
  • eslint-config-airbnb/base
  • eslint-config-airbnb/index
  • eslint-config-airbnb/legacy
  • eslint-config-airbnb/rules/best-practices
  • eslint-config-airbnb/rules/errors
  • eslint-config-airbnb/rules/es6
  • eslint-config-airbnb/rules/legacy
  • eslint-config-airbnb/rules/node
  • eslint-config-airbnb/rules/react
  • eslint-config-airbnb/rules/strict
  • eslint-config-airbnb/rules/style
  • eslint-config-airbnb/rules/variables

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-config-airbnb) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

eslint-config-airbnb

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, babel-eslint, and eslint-plugin-react.

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

eslint-config-airbnb/base

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

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

eslint-config-airbnb/legacy

Lints ES5 and below. Only requires eslint.

  1. npm install --save-dev eslint-config-airbnb 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.

Changelog

1.0.0

  • require eslint v1.0.0 or higher
  • removes babel-eslint dependency

0.1.1

  • remove id-length rule (#569)
  • enable no-mixed-spaces-and-tabs (#539)
  • enable no-const-assign (#560)
  • enable space-before-keywords (#554)

0.1.0

  • switch to modular rules files courtesy the eslint-config-default project and @taion. PR
  • export eslint-config-airbnb/legacy for ES5-only users. eslint-config-airbnb/legacy does not require the babel-eslint parser. PR

0.0.9

  • add rule no-undef
  • add rule id-length

0.0.8

  • now has a changelog
  • now is modular (see instructions above for with react and without react versions)