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

Readme

Source

eslint-config-airbnb-base

This package provides Airbnb's base JS .eslintrc (without React plugins) 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.

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

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

If using npm 5+, use this shortcut

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

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

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

The cli will produce and run a command like:

npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.#

Add "extends": "airbnb-base" to your .eslintrc.

eslint-config-airbnb-base/legacy

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

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

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.

eslint-config-airbnb-base/whitespace

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

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.

Keywords

FAQs

What is eslint-config-airbnb-base?

Is eslint-config-airbnb-base popular?

Is eslint-config-airbnb-base well maintained?

Last updated on 09 Nov 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install