Airbnb JavaScript Style Guide() {

A mostly reasonable approach to JavaScript

Note: this guide assumes you are using Babel, and requires that you use babel-preset-airbnb or the equivalent. It also assumes you are installing shims/polyfills in your app, with airbnb-browser-shims or the equivalent.

This guide is available in other languages too. See Translation

Other Style Guides

• ES5 (Deprecated)
• React
• CSS-in-JavaScript
• CSS & Sass
• Ruby

Table of Contents

1. Types
2. References
3. Objects
4. Arrays
5. Destructuring
6. Strings
7. Functions
8. Arrow Functions
9. Classes & Constructors
10. Modules
11. Iterators and Generators
12. Properties
13. Variables
14. Hoisting
15. Comparison Operators & Equality
16. Blocks
17. Control Statements
18. Comments
19. Whitespace
20. Commas
21. Semicolons
22. Type Casting & Coercion
23. Naming Conventions
24. Accessors
25. Events
26. jQuery
27. ECMAScript 5 Compatibility
28. ECMAScript 6+ (ES 2015+) Styles
29. Standard Library
30. Testing
31. Performance
32. Resources
33. In the Wild
34. Translation
35. The JavaScript Style Guide Guide
36. Chat With Us About JavaScript
37. Contributors
38. License
39. Amendments

Types

• 1.1 Primitives: When you access a primitive type you work directly on its value.

  • string
  • number
  • boolean
  • null
  • undefined
  • symbol
  • bigint
  
  

  ​x
  const foo = 1;
  let bar = foo;
  ​
  bar = 9;
  ​
  console.log(foo, bar); // => 1, 9
  

  • Symbols and BigInts cannot be faithfully polyfilled, so they should not be used when targeting browsers/environments that don’t support them natively.

• 1.2 Complex: When you access a complex type you work on a reference to its value.

  • object
  • array
  • function
  
  

  xxxxxxxxxx
  const foo = [1, 2];
  const bar = foo;
  ​
  bar[0] = 9;
  ​
  console.log(foo[0], bar[0]); // => 9, 9
  

⬆ back to top

References

• 2.1 Use const for all of your references; avoid using var. eslint: prefer-const, no-const-assign

  Why? This ensures that you can’t reassign your references, which can lead to bugs and difficult to comprehend code.

  xxxxxxxxxx
  // bad
  var a = 1;
  var b = 2;
  ​
  // good
  const a = 1;
  const b = 2;
  

• 2.2 If you must reassign references, use let instead of var. eslint: no-var

  Why? let is block-scoped rather than function-scoped like var.

  xxxxxxxxxx
  // bad
  var count = 1;
  if (true) {
    count += 1;
  }
  ​
  // good, use the let.
  let count = 1;
  if (true) {
    count += 1;
  }
  

• 2.3 Note that both let and const are block-scoped, whereas var is function-scoped.

  xxxxxxxxxx
  // const and let only exist in the blocks they are defined in.
  {
    let a = 1;
    const b = 1;
    var c = 1;
  }
  console.log(a); // ReferenceError
  console.log(b); // ReferenceError
  console.log(c); // Prints 1
  

  In the above code, you can see that referencing a and b will produce a ReferenceError, while c contains the number. This is because a and b are block scoped, while c is scoped to the containing function.

⬆ back to top

Objects

• 3.1 Use the literal syntax for object creation. eslint: no-new-object

  xxxxxxxxxx
  // bad
  const item = new Object();
  ​
  // good
  const item = {};
  

• 3.2 Use computed property names when creating objects with dynamic property names.

  Why? They allow you to define all the properties of an object in one place.

  xxxxxxxxxx
  ​
  function getKey(k) {
    return `a key named ${k}`;
  }
  ​
  // bad
  const obj = {
    id: 5,
    name: 'San Francisco',
  };
  obj[getKey('enabled')] = true;
  ​
  // good
  const obj = {
    id: 5,
    name: 'San Francisco',
    [getKey('enabled')]: true,
  };
  

• 3.3 Use object method shorthand. eslint: object-shorthand

  xxxxxxxxxx
  // bad
  const atom = {
    value: 1,
  ​
    addValue: function (value) {
      return atom.value + value;
    },
  };
  ​
  // good
  const atom = {
    value: 1,
  ​
    addValue(value) {
      return atom.value + value;
    },
  };
  

• 3.4 Use property value shorthand. eslint: object-shorthand

  Why? It is shorter and descriptive.

  xxxxxxxxxx
  const lukeSkywalker = 'Luke Skywalker';
  ​
  // bad
  const obj = {
    lukeSkywalker: lukeSkywalker,
  };
  ​
  // good
  const obj = {
    lukeSkywalker,
  };
  

• 3.5 Group your shorthand properties at the beginning of your object declaration.

  Why? It’s easier to tell which properties are using the shorthand.

  xxxxxxxxxx
  const anakinSkywalker = 'Anakin Skywalker';
  const lukeSkywalker = 'Luke Skywalker';
  ​
  // bad
  const obj = {
    episodeOne: 1,
    twoJediWalkIntoACantina: 2,
    lukeSkywalker,
    episodeThree: 3,
    mayTheFourth: 4,
    anakinSkywalker,
  };
  ​
  // good
  const obj = {
    lukeSkywalker,
    anakinSkywalker,
    episodeOne: 1,
    twoJediWalkIntoACantina: 2,
    episodeThree: 3,
    mayTheFourth: 4,
  };
  

• 3.6 Only quote properties that are invalid identifiers. eslint: quote-props

  Why? In general we consider it subjectively easier to read. It improves syntax highlighting, and is also more easily optimized by many JS engines.

  xxxxxxxxxx
  // bad
  const bad = {
    'foo': 3,
    'bar': 4,
    'data-blah': 5,
  };
  ​
  // good
  const good = {
    foo: 3,
    bar: 4,
    'data-blah': 5,
  };
  

• 3.7 Do not call Object.prototype methods directly, such as hasOwnProperty, propertyIsEnumerable, and isPrototypeOf. eslint: no-prototype-builtins

  Why? These methods may be shadowed by properties on the object in question - consider { hasOwnProperty: false } - or, the object may be a null object (Object.create(null)).

  xxxxxxxxxx
  // bad
  console.log(object.hasOwnProperty(key));
  ​
  // good
  console.log(Object.prototype.hasOwnProperty.call(object, key));
  ​
  // best
  const has = Object.prototype.hasOwnProperty; // cache the lookup once, in module scope.
  console.log(has.call(object, key));
  /* or */
  import has from 'has'; // https://www.npmjs.com/package/has
  console.log(has(object, key));
  /* or */
  console.log(Object.hasOwn(object, key)); // https://www.npmjs.com/package/object.hasown
  

• 3.8 Prefer the object spread syntax over Object.assign to shallow-copy objects. Use the object rest parameter syntax to get a new object with certain properties omitted. eslint: prefer-object-spread

  xxxxxxxxxx
  // very bad
  const original = { a: 1, b: 2 };
  const copy = Object.assign(original, { c: 3 }); // this mutates `original` ಠ_ಠ
  delete copy.a; // so does this
  ​
  // bad
  const original = { a: 1, b: 2 };
  const copy = Object.assign({}, original, { c: 3 }); // copy => { a: 1, b: 2, c: 3 }
  ​
  // good
  const original = { a: 1, b: 2 };
  const copy = { ...original, c: 3 }; // copy => { a: 1, b: 2, c: 3 }
  ​
  const { a, ...noA } = copy; // noA => { b: 2, c: 3 }
  

⬆ back to top

Arrays

• 4.1 Use the literal syntax for array creation. eslint: no-array-constructor

  xxxxxxxxxx
  // bad
  const items = new Array();
  ​
  // good
  const items = [];
  

• 4.2 Use Array#push instead of direct assignment to add items to an array.

  xxxxxxxxxx
  const someStack = [];
  ​
  // bad
  someStack[someStack.length] = 'abracadabra';
  ​
  // good
  someStack.push('abracadabra');
  

• 4.3 Use array spreads ... to copy arrays.

  xxxxxxxxxx
  // bad
  const len = items.length;
  const itemsCopy = [];
  let i;
  ​
  for (i = 0; i < len; i += 1) {
    itemsCopy[i] = items[i];
  }
  ​
  // good
  const itemsCopy = [...items];
  

• 4.4 To convert an iterable object to an array, use spreads ... instead of Array.from

  xxxxxxxxxx
  const foo = document.querySelectorAll('.foo');
  ​
  // good
  const nodes = Array.from(foo);
  ​
  // best
  const nodes = [...foo];
  

• 4.5 Use Array.from for converting an array-like object to an array.

  xxxxxxxxxx
  const arrLike = { 0: 'foo', 1: 'bar', 2: 'baz', length: 3 };
  ​
  // bad
  const arr = Array.prototype.slice.call(arrLike);
  ​
  // good
  const arr = Array.from(arrLike);
  

• 4.6 Use Array.from instead of spread ... for mapping over iterables, because it avoids creating an intermediate array.

  xxxxxxxxxx
  // bad
  const baz = [...foo].map(bar);
  ​
  // good
  const baz = Array.from(foo, bar);
  

• 4.7 Use return statements in array method callbacks. It’s ok to omit the return if the function body consists of a single statement returning an expression without side effects, following 8.2. eslint: array-callback-return

  xxxxxxxxxx
  // good
  [1, 2, 3].map((x) => {
    const y = x + 1;
    return x * y;
  });
  ​
  // good
  [1, 2, 3].map((x) => x + 1);
  ​
  // bad - no returned value means `acc` becomes undefined after the first iteration
  [[0, 1], [2, 3], [4, 5]].reduce((acc, item, index) => {
    const flatten = acc.concat(item);
  });
  ​
  // good
  [[0, 1], [2, 3], [4, 5]].reduce((acc, item, index) => {
    const flatten = acc.concat(item);
    return flatten;
  });
  ​
  // bad
  inbox.filter((msg) => {
    const { subject, author } = msg;
    if (subject === 'Mockingbird') {
      return author === 'Harper Lee';
    } else {
      return false;
    }
  });
  ​
  // good
  inbox.filter((msg) => {
    const { subject, author } = msg;
    if (subject === 'Mockingbird') {
      return author === 'Harper Lee';
    }
  ​
    return false;
  });
  

• 4.8 Use line breaks after opening array brackets and before closing array brackets, if an array has multiple lines

  xxxxxxxxxx
  // bad
  const arr = [
    [0, 1], [2, 3], [4, 5],
  ];
  ​
  const objectInArray = [{
    id: 1,
  }, {
    id: 2,
  }];
  ​
  const numberInArray = [
    1, 2,
  ];
  ​
  // good
  const arr = [[0, 1], [2, 3], [4, 5]];
  ​
  const objectInArray = [
    {
      id: 1,
    },
    {
      id: 2,
    },
  ];
  ​
  const numberInArray = [
    1,
    2,
  ];
  

⬆ back to top

Destructuring

• 5.1 Use object destructuring when accessing and using multiple properties of an object. eslint: prefer-destructuring

  Why? Destructuring saves you from creating temporary references for those properties, and from repetitive access of the object. Repeating object access creates more repetitive code, requires more reading, and creates more opportunities for mistakes. Destructuring objects also provides a single site of definition of the object structure that is used in the block, rather than requiring reading the entire block to determine what is used.

  xxxxxxxxxx
  // bad
  function getFullName(user) {
    const firstName = user.firstName;
    const lastName = user.lastName;
  ​
    return `${firstName} ${lastName}`;
  }
  ​
  // good
  function getFullName(user) {
    const { firstName, lastName } = user;
    return `${firstName} ${lastName}`;
  }
  ​
  // best
  function getFullName({ firstName, lastName }) {
    return `${firstName} ${lastName}`;
  }
  

• 5.2 Use array destructuring. eslint: prefer-destructuring

  xxxxxxxxxx
  const arr = [1, 2, 3, 4];
  ​
  // bad
  const first = arr[0];
  const second = arr[1];
  ​
  // good
  const [first, second] = arr;
  

• 5.3 Use object destructuring for multiple return values, not array destructuring.

  Why? You can add new properties over time or change the order of things without breaking call sites.

  xxxxxxxxxx
  // bad
  function processInput(input) {
    // then a miracle occurs
    return [left, right, top, bottom];
  }
  ​
  // the caller needs to think about the order of return data
  const [left, __, top] = processInput(input);
  ​
  // good
  function processInput(input) {
    // then a miracle occurs
    return { left, right, top, bottom };
  }
  ​
  // the caller selects only the data they need
  const { left, top } = processInput(input);
  

⬆ back to top

Strings

• 6.1 Use single quotes '' for strings. eslint: quotes

  xxxxxxxxxx
  // bad
  const name = "Capt. Janeway";
  ​
  // bad - template literals should contain interpolation or newlines
  const name = `Capt. Janeway`;
  ​
  // good
  const name = 'Capt. Janeway';
  

• 6.2 Strings that cause the line to go over 100 characters should not be written across multiple lines using string concatenation.

  Why? Broken strings are painful to work with and make code less searchable.

  xxxxxxxxxx
  // bad
  const errorMessage = 'This is a super long error that was thrown because \
  of Batman. When you stop to think about how Batman had anything to do \
  with this, you would get nowhere \
  fast.';
  ​
  // bad
  const errorMessage = 'This is a super long error that was thrown because ' +
    'of Batman. When you stop to think about how Batman had anything to do ' +
    'with this, you would get nowhere fast.';
  ​
  // good
  const errorMessage = 'This is a super long error that was thrown because of Batman. When you stop to think about how Batman had anything to do with this, you would get nowhere fast.';
  

• 6.3 When programmatically building up strings, use template strings instead of concatenation. eslint: prefer-template template-curly-spacing

  Why? Template strings give you a readable, concise syntax with proper newlines and string interpolation features.

  xxxxxxxxxx
  // bad
  function sayHi(name) {
    return 'How are you, ' + name + '?';
  }
  ​
  // bad
  function sayHi(name) {
    return ['How are you, ', name, '?'].join();
  }
  ​
  // bad
  function sayHi(name) {
    return `How are you, ${ name }?`;
  }
  ​
  // good
  function sayHi(name) {
    return `How are you, ${name}?`;
  }
  

• 6.4 Never use eval() on a string, it opens too many vulnerabilities. eslint: no-eval

• 6.5 Do not unnecessarily escape characters in strings. eslint: no-useless-escape

  Why? Backslashes harm readability, thus they should only be present when necessary.

  xxxxxxxxxx
  // bad
  const foo = '\'this\' \i\s \"quoted\"';
  ​
  // good
  const foo = '\'this\' is "quoted"';
  const foo = `my name is '${name}'`;
  

⬆ back to top

Functions

• 7.1 Use named function expressions instead of function declarations. eslint: func-style

  Why? Function declarations are hoisted, which means that it’s easy - too easy - to reference the function before it is defined in the file. This harms readability and maintainability. If you find that a function’s definition is large or complex enough that it is interfering with understanding the rest of the file, then perhaps it’s time to extract it to its own module! Don’t forget to explicitly name the expression, regardless of whether or not the name is inferred from the containing variable (which is often the case in modern browsers or when using compilers such as Babel). This eliminates any assumptions made about the Error’s call stack. (Discussion)

  xxxxxxxxxx
  // bad
  function foo() {
    // ...
  }
  ​
  // bad
  const foo = function () {
    // ...
  };
  ​
  // good
  // lexical name distinguished from the variable-referenced invocation(s)
  const short = function longUniqueMoreDescriptiveLexicalFoo() {
    // ...
  };
  

• 7.2 Wrap immediately invoked function expressions in parentheses. eslint: wrap-iife

  Why? An immediately invoked function expression is a single unit - wrapping both it, and its invocation parens, in parens, cleanly expresses this. Note that in a world with modules everywhere, you almost never need an IIFE.

  xxxxxxxxxx
  // immediately-invoked function expression (IIFE)
  (function () {
    console.log('Welcome to the Internet. Please follow me.');
  }());
  

• 7.3 Never declare a function in a non-function block (if, while, etc). Assign the function to a variable instead. Browsers will allow you to do it, but they all interpret it differently, which is bad news bears. eslint: no-loop-func

• 7.4 Note: ECMA-262 defines a block as a list of statements. A function declaration is not a statement.

  xxxxxxxxxx
  // bad
  if (currentUser) {
    function test() {
      console.log('Nope.');
    }
  }
  ​
  // good
  let test;
  if (currentUser) {
    test = () => {
      console.log('Yup.');
    };
  }
  

• 7.5 Never name a parameter arguments. This will take precedence over the arguments object that is given to every function scope.

  xxxxxxxxxx
  // bad
  function foo(name, options, arguments) {
    // ...
  }
  ​
  // good
  function foo(name, options, args) {
    // ...
  }
  

• 7.6 Never use arguments, opt to use rest syntax ... instead. eslint: prefer-rest-params

  Why? ... is explicit about which arguments you want pulled. Plus, rest arguments are a real Array, and not merely Array-like like arguments.

  xxxxxxxxxx
  // bad
  function concatenateAll() {
    const args = Array.prototype.slice.call(arguments);
    return args.join('');
  }
  ​
  // good
  function concatenateAll(...args) {
    return args.join('');
  }
  

• 7.7 Use default parameter syntax rather than mutating function arguments.

  xxxxxxxxxx
  // really bad
  function handleThings(opts) {
    // No! We shouldn’t mutate function arguments.
    // Double bad: if opts is falsy it'll be set to an object which may
    // be what you want but it can introduce subtle bugs.
    opts = opts || {};
    // ...
  }
  ​
  // still bad
  function handleThings(opts) {
    if (opts === void 0) {
      opts = {};
    }
    // ...
  }
  ​
  // good
  function handleThings(opts = {}) {
    // ...
  }
  

• 7.8 Avoid side effects with default parameters.

  Why? They are confusing to reason about.

  xxxxxxxxxx
  let b = 1;
  // bad
  function count(a = b++) {
    console.log(a);
  }
  count();  // 1
  count();  // 2
  count(3); // 3
  count();  // 3
  

• 7.9 Always put default parameters last. eslint: default-param-last

  xxxxxxxxxx
  // bad
  function handleThings(opts = {}, name) {
    // ...
  }
  ​
  // good
  function handleThings(name, opts = {}) {
    // ...
  }
  

• 7.10 Never use the Function constructor to create a new function. eslint: no-new-func

  Why? Creating a function in this way evaluates a string similarly to eval(), which opens vulnerabilities.

  xxxxxxxxxx
  // bad
  const add = new Function('a', 'b', 'return a + b');
  ​
  // still bad
  const subtract = Function('a', 'b', 'return a - b');
  

• 7.11 Spacing in a function signature. eslint: space-before-function-paren space-before-blocks

  Why? Consistency is good, and you shouldn’t have to add or remove a space when adding or removing a name.

  xxxxxxxxxx
  // bad
  const f = function(){};
  const g = function (){};
  const h = function() {};
  ​
  // good
  const x = function () {};
  const y = function a() {};
  

• 7.12 Never mutate parameters. eslint: no-param-reassign

  Why? Manipulating objects passed in as parameters can cause unwanted variable side effects in the original caller.

  xxxxxxxxxx
  // bad
  function f1(obj) {
    obj.key = 1;
  }
  ​
  // good
  function f2(obj) {
    const key = Object.prototype.hasOwnProperty.call(obj, 'key') ? obj.key : 1;
  }
  

• 7.13 Never reassign parameters. eslint: no-param-reassign

  Why? Reassigning parameters can lead to unexpected behavior, especially when accessing the arguments object. It can also cause optimization issues, especially in V8.

  xxxxxxxxxx
  // bad
  function f1(a) {
    a = 1;
    // ...
  }
  ​
  function f2(a) {
    if (!a) { a = 1; }
    // ...
  }
  ​
  // good
  function f3(a) {
    const b = a || 1;
    // ...
  }
  ​
  function f4(a = 1) {
    // ...
  }
  

• 7.14 Prefer the use of the spread syntax ... to call variadic functions. eslint: prefer-spread

  Why? It’s cleaner, you don’t need to supply a context, and you can not easily compose new with apply.

  xxxxxxxxxx
  // bad
  const x = [1, 2, 3, 4, 5];
  console.log.apply(console, x);
  ​
  // good
  const x = [1, 2, 3, 4, 5];
  console.log(...x);
  ​
  // bad
  new (Function.prototype.bind.apply(Date, [null, 2016, 8, 5]));
  ​
  // good
  new Date(...[2016, 8, 5]);
  

• 7.15 Functions with multiline signatures, or invocations, should be indented just like every other multiline list in this guide: with each item on a line by itself, with a trailing comma on the last item. eslint: function-paren-newline

  xxxxxxxxxx
  // bad
  function foo(bar,
               baz,
               quux) {
    // ...
  }
  ​
  // good
  function foo(
    bar,
    baz,
    quux,
  ) {
    // ...
  }
  ​
  // bad
  console.log(foo,
    bar,
    baz);
  ​
  // good
  console.log(
    foo,
    bar,
    baz,
  );
  

⬆ back to top

Arrow Functions

• 8.1 When you must use an anonymous function (as when passing an inline callback), use arrow function notation. eslint: prefer-arrow-callback, arrow-spacing

  Why? It creates a version of the function that executes in the context of this, which is usually what you want, and is a more concise syntax.

  Why not? If you have a fairly complicated function, you might move that logic out into its own named function expression.

  xxxxxxxxxx
  // bad
  [1, 2, 3].map(function (x) {
    const y = x + 1;
    return x * y;
  });
  ​
  // good
  [1, 2, 3].map((x) => {
    const y = x + 1;
    return x * y;
  });
  

• 8.2 If the function body consists of a single statement returning an expression without side effects, omit the braces and use the implicit return. Otherwise, keep the braces and use a return statement. eslint: arrow-parens, arrow-body-style

  Why? Syntactic sugar. It reads well when multiple functions are chained together.

  xxxxxxxxxx
  // bad
  [1, 2, 3].map((number) => {
    const nextNumber = number + 1;
    `A string containing the ${nextNumber}.`;
  });
  ​
  // good
  [1, 2, 3].map((number) => `A string containing the ${number + 1}.`);
  ​
  // good
  [1, 2, 3].map((number) => {
    const nextNumber = number + 1;
    return `A string containing the ${nextNumber}.`;
  });
  ​
  // good
  [1, 2, 3].map((number, index) => ({
    [index]: number,
  }));
  ​
  // No implicit return with side effects
  function foo(callback) {
    const val = callback();
    if (val === true) {
      // Do something if callback returns true
    }
  }
  ​
  let bool = false;
  ​
  // bad
  foo(() => bool = true);
  ​
  // good
  foo(() => {
    bool = true;
  });
  

• 8.3 In case the expression spans over multiple lines, wrap it in parentheses for better readability.

  Why? It shows clearly where the function starts and ends.

  xxxxxxxxxx
  // bad
  ['get', 'post', 'put'].map((httpMethod) => Object.prototype.hasOwnProperty.call(
      httpMagicObjectWithAVeryLongName,
      httpMethod,
    )
  );
  ​
  // good
  ['get', 'post', 'put'].map((httpMethod) => (
    Object.prototype.hasOwnProperty.call(
      httpMagicObjectWithAVeryLongName,
      httpMethod,
    )
  ));
  

• 8.4 Always include parentheses around arguments for clarity and consistency. eslint: arrow-parens

  Why? Minimizes diff churn when adding or removing arguments.

  xxxxxxxxxx
  // bad
  [1, 2, 3].map(x => x * x);
  ​
  // good
  [1, 2, 3].map((x) => x * x);
  ​
  // bad
  [1, 2, 3].map(number => (
    `A long string with the ${number}. It’s so long that we don’t want it to take up space on the .map line!`
  ));
  ​
  // good
  [1, 2, 3].map((number) => (
    `A long string with the ${number}. It’s so long that we don’t want it to take up space on the .map line!`
  ));
  ​
  // bad
  [1, 2, 3].map(x => {
    const y = x + 1;
    return x * y;
  });
  ​
  // good
  [1, 2, 3].map((x) => {
    const y = x + 1;
    return x * y;
  });
  

• 8.5 Avoid confusing arrow function syntax (=>) with comparison operators (<=, >=). eslint: no-confusing-arrow

  xxxxxxxxxx
  // bad
  const itemHeight = (item) => item.height <= 256 ? item.largeSize : item.smallSize;
  ​
  // bad
  const itemHeight = (item) => item.height >= 256 ? item.largeSize : item.smallSize;
  ​
  // good
  const itemHeight = (item) => (item.height <= 256 ? item.largeSize : item.smallSize);
  ​
  // good
  const itemHeight = (item) => {
    const { height, largeSize, smallSize } = item;
    return height <= 256 ? largeSize : smallSize;
  };
  

• 8.6 Enforce the location of arrow function bodies with implicit returns. eslint: implicit-arrow-linebreak

  xxxxxxxxxx
  // bad
  (foo) =>
    bar;
  ​
  (foo) =>
    (bar);
  ​
  // good
  (foo) => bar;
  (foo) => (bar);
  (foo) => (
     bar
  )
  

⬆ back to top

Classes & Constructors

• 9.1 Always use class. Avoid manipulating prototype directly.

  Why? class syntax is more concise and easier to reason about.

  xxxxxxxxxx
  // bad
  function Queue(contents = []) {
    this.queue = [...contents];
  }
  Queue.prototype.pop = function () {
    const value = this.queue[0];
    this.queue.splice(0, 1);
    return value;
  };
  ​
  // good
  class Queue {
    constructor(contents = []) {
      this.queue = [...contents];
    }
    pop() {
      const value = this.queue[0];
      this.queue.splice(0, 1);
      return value;
    }
  }
  

• 9.2 Use extends for inheritance.

  Why? It is a built-in way to inherit prototype functionality without breaking instanceof.

  xxxxxxxxxx
  // bad
  const inherits = require('inherits');
  function PeekableQueue(contents) {
    Queue.apply(this, contents);
  }
  inherits(PeekableQueue, Queue);
  PeekableQueue.prototype.peek = function () {
    return this.queue[0];
  };
  ​
  // good
  class PeekableQueue extends Queue {
    peek() {
      return this.queue[0];
    }
  }
  

• 9.3 Methods can return this to help with method chaining.

  xxxxxxxxxx
  // bad
  Jedi.prototype.jump = function () {
    this.jumping = true;
    return true;
  };
  ​
  Jedi.prototype.setHeight = function (height) {
    this.height = height;
  };
  ​
  const luke = new Jedi();
  luke.jump(); // => true
  luke.setHeight(20); // => undefined
  ​
  // good
  class Jedi {
    jump() {
      this.jumping = true;
      return this;
    }
  ​
    setHeight(height) {
      this.height = height;
      return this;
    }
  }
  ​
  const luke = new Jedi();
  ​
  luke.jump()
    .setHeight(20);
  

• 9.4 It’s okay to write a custom toString() method, just make sure it works successfully and causes no side effects.

  xxxxxxxxxx
  class Jedi {
    constructor(options = {}) {
      this.name = options.name || 'no name';
    }
  ​
    getName() {
      return this.name;
    }
  ​
    toString() {
      return `Jedi - ${this.getName()}`;
    }
  }
  

• 9.5 Classes have a default constructor if one is not specified. An empty constructor function or one that just delegates to a parent class is unnecessary. eslint: no-useless-constructor

  xxxxxxxxxx
  // bad
  class Jedi {
    constructor() {}
  ​
    getName() {
      return this.name;
    }
  }
  ​
  // bad
  class Rey extends Jedi {
    constructor(...args) {
      super(...args);
    }
  }
  ​
  // good
  class Rey extends Jedi {
    constructor(...args) {
      super(...args);
      this.name = 'Rey';
    }
  }
  

• 9.6 Avoid duplicate class members. eslint: no-dupe-class-members

  Why? Duplicate class member declarations will silently prefer the last one - having duplicates is almost certainly a bug.

  xxxxxxxxxx
  // bad
  class Foo {
    bar() { return 1; }
    bar() { return 2; }
  }
  ​
  // good
  class Foo {
    bar() { return 1; }
  }
  ​
  // good
  class Foo {
    bar() { return 2; }
  }
  

• 9.7 Class methods should use this or be made into a static method unless an external library or framework requires using specific non-static methods. Being an instance method should indicate that it behaves differently based on properties of the receiver. eslint: class-methods-use-this

  xxxxxxxxxx
  // bad
  class Foo {
    bar() {
      console.log('bar');
    }
  }
  ​
  // good - this is used
  class Foo {
    bar() {
      console.log(this.bar);
    }
  }
  ​
  // good - constructor is exempt
  class Foo {
    constructor() {
      // ...
    }
  }
  ​
  // good - static methods aren't expected to use this
  class Foo {
    static bar() {
      console.log('bar');
    }
  }
  

⬆ back to top

Modules

• 10.1 Always use modules (import/export) over a non-standard module system. You can always transpile to your preferred module system.

  Why? Modules are the future, let’s start using the future now.

  xxxxxxxxxx
  // bad
  const AirbnbStyleGuide = require('./AirbnbStyleGuide');
  module.exports = AirbnbStyleGuide.es6;
  ​
  // ok
  import AirbnbStyleGuide from './AirbnbStyleGuide';
  export default AirbnbStyleGuide.es6;
  ​
  // best
  import { es6 } from './AirbnbStyleGuide';
  export default es6;
  

• 10.2 Do not use wildcard imports.

  Why? This makes sure you have a single default export.

  xxxxxxxxxx
  // bad
  import * as AirbnbStyleGuide from './AirbnbStyleGuide';
  ​
  // good
  import AirbnbStyleGuide from './AirbnbStyleGuide';
  

• 10.3 And do not export directly from an import.

  Why? Although the one-liner is concise, having one clear way to import and one clear way to export makes things consistent.

  xxxxxxxxxx
  // bad
  // filename es6.js
  export { es6 as default } from './AirbnbStyleGuide';
  ​
  // good
  // filename es6.js
  import { es6 } from './AirbnbStyleGuide';
  export default es6;
  

• 10.4 Only import from a path in one place. eslint: no-duplicate-imports

  Why? Having multiple lines that import from the same path can make code harder to maintain.

  xxxxxxxxxx
  // bad
  import foo from 'foo';
  // … some other imports … //
  import { named1, named2 } from 'foo';
  ​
  // good
  import foo, { named1, named2 } from 'foo';
  ​
  // good
  import foo, {
    named1,
    named2,
  } from 'foo';
  

• 10.5 Do not export mutable bindings. eslint: import/no-mutable-exports

  Why? Mutation should be avoided in general, but in particular when exporting mutable bindings. While this technique may be needed for some special cases, in general, only constant references should be exported.

  xxxxxxxxxx
  // bad
  let foo = 3;
  export { foo };
  ​
  // good
  const foo = 3;
  export { foo };
  

• 10.6 In modules with a single export, prefer default export over named export. eslint: import/prefer-default-export

  Why? To encourage more files that only ever export one thing, which is better for readability and maintainability.

  xxxxxxxxxx
  // bad
  export function foo() {}
  ​
  // good
  export default function foo() {}
  

• 10.7 Put all imports above non-import statements. eslint: import/first

  Why? Since imports are hoisted, keeping them all at the top prevents surprising behavior.

  xxxxxxxxxx
  // bad
  import foo from 'foo';
  foo.init();
  ​
  import bar from 'bar';
  ​
  // good
  import foo from 'foo';
  import bar from 'bar';
  ​
  foo.init();
  

• 10.8 Multiline imports should be indented just like multiline array and object literals. eslint: object-curly-newline

  Why? The curly braces follow the same indentation rules as every other curly brace block in the style guide, as do the trailing commas.

  xxxxxxxxxx
  // bad
  import {longNameA, longNameB, longNameC, longNameD, longNameE} from 'path';
  ​
  // good
  import {
    longNameA,
    longNameB,
    longNameC,
    longNameD,
    longNameE,
  } from 'path';
  

• 10.9 Disallow Webpack loader syntax in module import statements. eslint: import/no-webpack-loader-syntax

  Why? Since using Webpack syntax in the imports couples the code to a module bundler. Prefer using the loader syntax in webpack.config.js.

  xxxxxxxxxx
  // bad
  import fooSass from 'css!sass!foo.scss';
  import barCss from 'style!css!bar.css';
  ​
  // good
  import fooSass from 'foo.scss';
  import barCss from 'bar.css';
  

• 10.10 Do not include JavaScript filename extensions eslint: import/extensions

  Why? Including extensions inhibits refactoring, and inappropriately hardcodes implementation details of the module you're importing in every consumer.

  xxxxxxxxxx
  // bad
  import foo from './foo.js';
  import bar from './bar.jsx';
  import baz from './baz/index.jsx';
  ​
  // good
  import foo from './foo';
  import bar from './bar';
  import baz from './baz';
  

⬆ back to top

Iterators and Generators

• 11.1 Don’t use iterators. Prefer JavaScript’s higher-order functions instead of loops like for-in or for-of. eslint: no-iterator no-restricted-syntax

  Why? This enforces our immutable rule. Dealing with pure functions that return values is easier to reason about than side effects.

  Use map() / every() / filter() / find() / findIndex() / reduce() / some() / ... to iterate over arrays, and Object.keys() / Object.values() / Object.entries() to produce arrays so you can iterate over objects.

  xxxxxxxxxx
  const numbers = [1, 2, 3, 4, 5];
  ​
  // bad
  let sum = 0;
  for (let num of numbers) {
    sum += num;
  }
  sum === 15;
  ​
  // good
  let sum = 0;
  numbers.forEach((num) => {
    sum += num;
  });
  sum === 15;
  ​
  // best (use the functional force)
  const sum = numbers.reduce((total, num) => total + num, 0);
  sum === 15;
  ​
  // bad
  const increasedByOne = [];
  for (let i = 0; i < numbers.length; i++) {
    increasedByOne.push(numbers[i] + 1);
  }
  ​
  // good
  const increasedByOne = [];
  numbers.forEach((num) => {
    increasedByOne.push(num + 1);
  });
  ​
  // best (keeping it functional)
  const increasedByOne = numbers.map((num) => num + 1);
  

• 11.2 Don’t use generators for now.

  Why? They don’t transpile well to ES5.

• 11.3 If you must use generators, or if you disregard our advice, make sure their function signature is spaced properly. eslint: generator-star-spacing

  Why? function and * are part of the same conceptual keyword - * is not a modifier for function, function* is a unique construct, different from function.

  xxxxxxxxxx
  // bad
  function * foo() {
    // ...
  }
  ​
  // bad
  const bar = function * () {
    // ...
  };
  ​
  // bad
  const baz = function *() {
    // ...
  };
  ​
  // bad
  const quux = function*() {
    // ...
  };
  ​
  // bad
  function*foo() {
    // ...
  }
  ​
  // bad
  function *foo() {
    // ...
  }
  ​
  // very bad
  function
  *
  foo() {
    // ...
  }
  ​
  // very bad
  const wat = function
  *
  () {
    // ...
  };
  ​
  // good
  function* foo() {
    // ...
  }
  ​
  // good
  const foo = function* () {
    // ...
  };
  

⬆ back to top

Properties

• 12.1 Use dot notation when accessing properties. eslint: dot-notation

  xxxxxxxxxx
  const luke = {
    jedi: true,
    age: 28,
  };
  ​
  // bad
  const isJedi = luke['jedi'];
  ​
  // good
  const isJedi = luke.jedi;
  

• 12.2 Use bracket notation [] when accessing properties with a variable.

  xxxxxxxxxx
  const luke = {
    jedi: true,
    age: 28,
  };
  ​
  function getProp(prop) {
    return luke[prop];
  }
  ​
  const isJedi = getProp('jedi');
  

• 12.3 Use exponentiation operator ** when calculating exponentiations. eslint: prefer-exponentiation-operator.

  xxxxxxxxxx
  // bad
  const binary = Math.pow(2, 10);
  ​
  // good
  const binary = 2 ** 10;
  

⬆ back to top

Variables

• 13.1 Always use const or let to declare variables. Not doing so will result in global variables. We want to avoid polluting the global namespace. Captain Planet warned us of that. eslint: no-undef prefer-const

  xxxxxxxxxx
  // bad
  superPower = new SuperPower();
  ​
  // good
  const superPower = new SuperPower();
  

• 13.2 Use one const or let declaration per variable or assignment. eslint: one-var

  Why? It’s easier to add new variable declarations this way, and you never have to worry about swapping out a ; for a , or introducing punctuation-only diffs. You can also step through each declaration with the debugger, instead of jumping through all of them at once.

  xxxxxxxxxx
  // bad
  const items = getItems(),
      goSportsTeam = true,
      dragonball = 'z';
  ​
  // bad
  // (compare to above, and try to spot the mistake)
  const items = getItems(),
      goSportsTeam = true;
      dragonball = 'z';
  ​
  // good
  const items = getItems();
  const goSportsTeam = true;
  const dragonball = 'z';
  

• 13.3 Group all your consts and then group all your lets.

  Why? This is helpful when later on you might need to assign a variable depending on one of the previously assigned variables.

  xxxxxxxxxx
  // bad
  let i, len, dragonball,
      items = getItems(),
      goSportsTeam = true;
  ​
  // bad
  let i;
  const items = getItems();
  let dragonball;
  const goSportsTeam = true;
  let len;
  ​
  // good
  const goSportsTeam = true;
  const items = getItems();
  let dragonball;
  let i;
  let length;
  

• 13.4 Assign variables where you need them, but place them in a reasonable place.

  Why? let and const are block scoped and not function scoped.

  xxxxxxxxxx
  // bad - unnecessary function call
  function checkName(hasName) {
    const name = getName();
  ​
    if (hasName === 'test') {
      return false;
    }
  ​
    if (name === 'test') {
      this.setName('');
      return false;
    }
  ​
    return name;
  }
  ​
  // good
  function checkName(hasName) {
    if (hasName === 'test') {
      return false;
    }
  ​
    const name = getName();
  ​
    if (name === 'test') {
      this.setName('');
      return false;
    }
  ​
    return name;
  }
  

• 13.5 Don’t chain variable assignments. eslint: no-multi-assign

  Why? Chaining variable assignments creates implicit global variables.

  xxxxxxxxxx
  // bad
  (function example() {
    // JavaScript interprets this as
    // let a = ( b = ( c = 1 ) );
    // The let keyword only applies to variable a; variables b and c become
    // global variables.
    let a = b = c = 1;
  }());
  ​
  console.log(a); // throws ReferenceError
  console.log(b); // 1
  console.log(c); // 1
  ​
  // good
  (function example() {
    let a = 1;
    let b = a;
    let c = a;
  }());
  ​
  console.log(a); // throws ReferenceError
  console.log(b); // throws ReferenceError
  console.log(c); // throws ReferenceError
  ​
  // the same applies for `const`
  

• 13.6 Avoid using unary increments and decrements (++, --). eslint no-plusplus

  Why? Per the eslint documentation, unary increment and decrement statements are subject to automatic semicolon insertion and can cause silent errors with incrementing or decrementing values within an application. It is also more expressive to mutate your values with statements like num += 1 instead of num++ or num ++. Disallowing unary increment and decrement statements also prevents you from pre-incrementing/pre-decrementing values unintentionally which can also cause unexpected behavior in your programs.

  xxxxxxxxxx
  // bad
  ​
  const array = [1, 2, 3];
  let num = 1;
  num++;
  --num;
  ​
  let sum = 0;
  let truthyCount = 0;
  for (let i = 0; i < array.length; i++) {
    let value = array[i];
    sum += value;
    if (value) {
      truthyCount++;
    }
  }
  ​
  // good
  ​
  const array = [1, 2, 3];
  let num = 1;
  num += 1;
  num -= 1;
  ​
  const sum = array.reduce((a, b) => a + b, 0);
  const truthyCount = array.filter(Boolean).length;
  

• 13.7 Avoid linebreaks before or after = in an assignment. If your assignment violates max-len, surround the value in parens. eslint operator-linebreak.

  Why? Linebreaks surrounding = can obfuscate the value of an assignment.

  xxxxxxxxxx
  // bad
  const foo =
    superLongLongLongLongLongLongLongLongFunctionName();
  ​
  // bad
  const foo
    = 'superLongLongLongLongLongLongLongLongString';
  ​
  // good
  const foo = (
    superLongLongLongLongLongLongLongLongFunctionName()
  );
  ​
  // good
  const foo = 'superLongLongLongLongLongLongLongLongString';