eslint-config-airbnb-base

What is eslint-config-airbnb-base?

The eslint-config-airbnb-base package is a set of ESLint rules maintained by Airbnb. It provides a base set of rules for JavaScript projects, excluding React-specific rules. This package is designed to enforce Airbnb's coding standards and best practices, helping developers to write cleaner, more consistent code.

What are eslint-config-airbnb-base's main functionalities?

Style Guide Enforcement

By extending eslint-config-airbnb-base in your ESLint configuration file, you enforce a comprehensive set of coding standards and styles based on Airbnb's style guide. This includes rules for syntax, best practices, and avoiding common errors.

"extends": "airbnb-base"

Environment Configuration

The package allows you to configure the environment your code is expected to run in, such as browser or Node.js environments. This helps in applying specific rules that are relevant to the environment, ensuring code compatibility and preventing environment-specific errors.

{
  "env": {
    "browser": true,
    "node": true
  }
}

Customizable Rules

While eslint-config-airbnb-base provides a default set of rules, it also allows for customization. Developers can override or adjust the severity of specific rules to better fit their project's needs, offering flexibility alongside standardization.

{
  "rules": {
    "no-console": "off",
    "no-unused-vars": "warn"
  }
}

Other packages similar to eslint-config-airbnb-base

eslint-config-standard

Similar to eslint-config-airbnb-base, eslint-config-standard is an ESLint shareable config that enforces JavaScript Standard Style. It focuses on standardizing JavaScript code across projects but is less opinionated compared to Airbnb's style guide, offering a different balance between strictness and flexibility.

eslint-config-google

eslint-config-google is another set of ESLint rules based on Google's JavaScript style guide. It provides a different set of coding conventions and practices, offering an alternative to Airbnb's standards. While both aim to enforce code quality and consistency, the choice between them often comes down to personal or team preference regarding coding styles.

eslint-config-prettier

eslint-config-prettier is a config that disables rules that conflict with Prettier, an opinionated code formatter. Unlike eslint-config-airbnb-base, which focuses on linting for potential errors and stylistic issues, eslint-config-prettier is specifically designed to be used in conjunction with Prettier to avoid conflicts between formatting rules and ESLint's stylistic rules.

README

eslint-config-airbnb-base

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@^#.#.#

1. 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

1. 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.