Find file History

README.md

eslint-config-airbnb-base

npm version

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

Usage

We export two ESLint configurations for your usage.

eslint-config-airbnb-base

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

  1. Install the correct versions of each package, which are listed by the command:

    npm info "eslint-config-airbnb-base@latest" peerDependencies

    Linux/OSX users can simply run

    (
      export PKG=eslint-config-airbnb-base;
      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-base eslint@^#.#.# eslint-plugin-import@^#.#.#

    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-base

    The cli will produce and run a command like:

    npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.#
  2. Add "extends": "airbnb-base" to your .eslintrc

eslint-config-airbnb-base/legacy

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

  1. Install the correct versions of each package, which are listed by the command:

    npm info "eslint-config-airbnb-base@latest" peerDependencies

    Linux/OSX users can simply run

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

    Which produces and runs a command like:

    npm install --save-dev eslint-config-airbnb-base eslint@^3.0.1 eslint-plugin-import@^1.10.3
  2. Add "extends": "airbnb-base/legacy" to your .eslintrc

See Airbnb's overarching ESLint config, 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.