How to set up Airbnb style guide with ESLint in my project?

Install eslint-config-airbnb-base for vanilla JavaScript or eslint-config-airbnb for React via npm, then extend it in your .eslintrc file. The README includes ESLint rule references for each guideline to automate enforcement.

Airbnb style guide vs StandardJS: which is better for a new project?

Airbnb's guide is more comprehensive and opinionated, ideal for teams wanting strict consistency and modern practices. StandardJS is simpler with fewer rules, better for projects favoring minimal configuration and automatic formatting.

Does Airbnb style guide support TypeScript or only JavaScript?

It's primarily for JavaScript, but community adaptations exist for TypeScript. You can use ESLint plugins to apply similar rules, though it requires extra configuration and might not cover all TypeScript-specific features.

How to override a specific rule I disagree with in Airbnb ESLint config?

In your ESLint configuration file, you can override any rule by setting it to 'off' or adjusting its options. The README lists ESLint rule names per section, making it easy to identify and customize rules like 'arrow-parens'.

Why does Airbnb prefer const over let for variable declarations?

To prevent accidental reassignments and improve code predictability, as explained in section 2.1, which highlights that const ensures references remain immutable, reducing bugs.

Is Airbnb style guide suitable for Node.js backend code?

Yes, it's framework-agnostic and works for any JavaScript environment, including Node.js. Use the base ESLint configuration without React-specific rules, and it covers modules and standard library usage relevant to backend development.

Open-Awesome

Airbnb JavaScript Style Guide

MITJavaScript

A comprehensive JavaScript style guide with ESLint rules for writing consistent and maintainable code.

GitHub

148.2k stars26.6k forks0 contributors

What is Airbnb JavaScript Style Guide?

The Airbnb JavaScript Style Guide is a set of coding standards and best practices for writing JavaScript. It provides detailed rules on syntax, formatting, and patterns to ensure code consistency and maintainability across projects. The guide is designed to help developers avoid common pitfalls and adopt modern JavaScript features effectively.

Target Audience

JavaScript developers and engineering teams looking to standardize their codebase, especially those working on large or collaborative projects where consistency is critical.

Value Proposition

Developers choose this guide because it's comprehensive, well-documented, and integrates seamlessly with ESLint for automated enforcement. Its widespread adoption and community support make it a trusted resource for improving code quality.

Overview

JavaScript Style Guide

Use Cases

Best For

Enforcing consistent coding standards across team projects
Integrating with ESLint for automated code linting
Learning modern JavaScript best practices and patterns
Onboarding new developers to a standardized codebase
Refactoring legacy JavaScript code to modern standards
Setting up a style guide for open-source JavaScript libraries

Not Ideal For

Projects not using ESLint or other linters for automated code checking, as manual enforcement is cumbersome
Solo developers or small teams working on rapid prototypes where strict rule adherence slows iteration
Legacy codebases heavily reliant on ES5 patterns without transpilation plans, due to its modern ES6+ focus
Environments where minimal style guides like StandardJS are preferred for their simplicity and fewer rules

Pros & Cons

Pros

Comprehensive Rule Coverage

Covers all JavaScript aspects from types to modules with detailed examples, as shown in the 30+ section table of contents, ensuring thorough guidance.

ESLint Integration

Includes ESLint rule references in each section, enabling automated enforcement via eslint-config-airbnb packages for consistent code quality.

Modern JavaScript Emphasis

Promotes ES6+ features like arrow functions and destructuring, keeping code contemporary and aligned with best practices, as detailed in the ES2015+ styles section.

Community and Reliability

Backed by Airbnb's engineering team and widely adopted, providing a trusted, well-maintained resource with regular updates and support.

Cons

Babel and Polyfill Dependency

Assumes Babel usage with airbnb-browser-shims or equivalent, adding setup complexity for projects not already transpiling code, as noted in the initial README warning.

Overly Opinionated Rules

Some rules, like always using parentheses in arrow functions or avoiding unary increments, can feel restrictive and may not align with all coding styles or performance needs.

Potential Breaking Changes

As a community-driven project, updates may introduce changes that require code adjustments, similar to the deprecated ES5 guide, impacting stability for some teams.

Frequently Asked Questions

Related Projects

Project Guidelines

A set of best practices for JavaScript projects

Stars29,440

Forks3,139

Last commit1 year ago

Principles of Writing Consistent, Idiomatic JavaScript

Stars25,728

Forks3,530

Last commit2 years ago

JavaScript SDK Design Guide

JavaScript SDK Design Guide extracted from work and personal experience

Stars1,430

Forks180

Last commit10 months ago

ES6 Coding Style

My coding styles.

Stars401

Forks82

Last commit10 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub