diff --git a/README.md b/README.md
index 9a325a355b..5d076d7f40 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Airbnb JavaScript Style Guide() {
+# Airbnb JavaScript Style Guide
-*A mostly reasonable approach to JavaScript*
+_A mostly reasonable approach to JavaScript_
> **Note**: this guide assumes you are using [Babel](https://babeljs.io), and requires that you use [babel-preset-airbnb](https://npmjs.com/babel-preset-airbnb) or the equivalent. It also assumes you are installing shims/polyfills in your app, with [airbnb-browser-shims](https://npmjs.com/airbnb-browser-shims) or the equivalent.
@@ -12,3749 +12,3797 @@ This guide is available in other languages too. See [Translation](#translation)
Other Style Guides
- - [ES5 (Deprecated)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5)
- - [React](react/)
- - [CSS-in-JavaScript](css-in-javascript/)
- - [CSS & Sass](https://github.com/airbnb/css)
- - [Ruby](https://github.com/airbnb/ruby)
+- [ES5 (Deprecated)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5)
+- [React](react/)
+- [CSS-in-JavaScript](css-in-javascript/)
+- [CSS & Sass](https://github.com/airbnb/css)
+- [Ruby](https://github.com/airbnb/ruby)
## Table of Contents
- 1. [Types](#types)
- 1. [References](#references)
- 1. [Objects](#objects)
- 1. [Arrays](#arrays)
- 1. [Destructuring](#destructuring)
- 1. [Strings](#strings)
- 1. [Functions](#functions)
- 1. [Arrow Functions](#arrow-functions)
- 1. [Classes & Constructors](#classes--constructors)
- 1. [Modules](#modules)
- 1. [Iterators and Generators](#iterators-and-generators)
- 1. [Properties](#properties)
- 1. [Variables](#variables)
- 1. [Hoisting](#hoisting)
- 1. [Comparison Operators & Equality](#comparison-operators--equality)
- 1. [Blocks](#blocks)
- 1. [Control Statements](#control-statements)
- 1. [Comments](#comments)
- 1. [Whitespace](#whitespace)
- 1. [Commas](#commas)
- 1. [Semicolons](#semicolons)
- 1. [Type Casting & Coercion](#type-casting--coercion)
- 1. [Naming Conventions](#naming-conventions)
- 1. [Accessors](#accessors)
- 1. [Events](#events)
- 1. [jQuery](#jquery)
- 1. [ECMAScript 5 Compatibility](#ecmascript-5-compatibility)
- 1. [ECMAScript 6+ (ES 2015+) Styles](#ecmascript-6-es-2015-styles)
- 1. [Standard Library](#standard-library)
- 1. [Testing](#testing)
- 1. [Performance](#performance)
- 1. [Resources](#resources)
- 1. [In the Wild](#in-the-wild)
- 1. [Translation](#translation)
- 1. [The JavaScript Style Guide Guide](#the-javascript-style-guide-guide)
- 1. [Chat With Us About JavaScript](#chat-with-us-about-javascript)
- 1. [Contributors](#contributors)
- 1. [License](#license)
- 1. [Amendments](#amendments)
+1. [Types](#types)
+1. [References](#references)
+1. [Objects](#objects)
+1. [Arrays](#arrays)
+1. [Destructuring](#destructuring)
+1. [Strings](#strings)
+1. [Functions](#functions)
+1. [Arrow Functions](#arrow-functions)
+1. [Classes & Constructors](#classes--constructors)
+1. [Modules](#modules)
+1. [Iterators and Generators](#iterators-and-generators)
+1. [Properties](#properties)
+1. [Variables](#variables)
+1. [Hoisting](#hoisting)
+1. [Comparison Operators & Equality](#comparison-operators--equality)
+1. [Blocks](#blocks)
+1. [Control Statements](#control-statements)
+1. [Comments](#comments)
+1. [Whitespace](#whitespace)
+1. [Commas](#commas)
+1. [Semicolons](#semicolons)
+1. [Type Casting & Coercion](#type-casting--coercion)
+1. [Naming Conventions](#naming-conventions)
+1. [Accessors](#accessors)
+1. [Events](#events)
+1. [jQuery](#jquery)
+1. [ECMAScript 5 Compatibility](#ecmascript-5-compatibility)
+1. [ECMAScript 6+ (ES 2015+) Styles](#ecmascript-6-es-2015-styles)
+1. [Standard Library](#standard-library)
+1. [Testing](#testing)
+1. [Performance](#performance)
+1. [Resources](#resources)
+1. [In the Wild](#in-the-wild)
+1. [Translation](#translation)
+1. [The JavaScript Style Guide Guide](#the-javascript-style-guide-guide)
+1. [Chat With Us About JavaScript](#chat-with-us-about-javascript)
+1. [Contributors](#contributors)
+1. [License](#license)
+1. [Amendments](#amendments)
## Types
-
- - [1.1](#types--primitives) **Primitives**: When you access a primitive type you work directly on its value.
+
- - `string`
- - `number`
- - `boolean`
- - `null`
- - `undefined`
- - `symbol`
- - `bigint`
+- [1.1](#types--primitives) **Primitives**: When you access a primitive type you work directly on its value.
-
+ - `string`
+ - `number`
+ - `boolean`
+ - `null`
+ - `undefined`
+ - `symbol`
+ - `bigint`
- ```javascript
- const foo = 1;
- let bar = foo;
+
- bar = 9;
+ ```javascript
+ const foo = 1;
+ let bar = foo;
- console.log(foo, bar); // => 1, 9
- ```
+ bar = 9;
- - Symbols and BigInts cannot be faithfully polyfilled, so they should not be used when targeting browsers/environments that don’t support them natively.
+ console.log(foo, bar); // => 1, 9
+ ```
-
- - [1.2](#types--complex) **Complex**: When you access a complex type you work on a reference to its value.
+ - Symbols and BigInts cannot be faithfully polyfilled, so they should not be used when targeting browsers/environments that don’t support them natively.
- - `object`
- - `array`
- - `function`
+
-
+- [1.2](#types--complex) **Complex**: When you access a complex type you work on a reference to its value.
- ```javascript
- const foo = [1, 2];
- const bar = foo;
+ - `object`
+ - `array`
+ - `function`
- bar[0] = 9;
+
- console.log(foo[0], bar[0]); // => 9, 9
- ```
+ ```javascript
+ const foo = [1, 2];
+ const bar = foo;
+
+ bar[0] = 9;
+
+ console.log(foo[0], bar[0]); // => 9, 9
+ ```
**[⬆ back to top](#table-of-contents)**
## References
-
- - [2.1](#references--prefer-const) Use `const` for all of your references; avoid using `var`. eslint: [`prefer-const`](https://eslint.org/docs/rules/prefer-const), [`no-const-assign`](https://eslint.org/docs/rules/no-const-assign)
+
- > Why? This ensures that you can’t reassign your references, which can lead to bugs and difficult to comprehend code.
+- [2.1](#references--prefer-const) Use `const` for all of your references; avoid using `var`. eslint: [`prefer-const`](https://eslint.org/docs/rules/prefer-const), [`no-const-assign`](https://eslint.org/docs/rules/no-const-assign)
- ```javascript
- // bad
- var a = 1;
- var b = 2;
+ > Why? This ensures that you can’t reassign your references, which can lead to bugs and difficult to comprehend code.
- // good
- const a = 1;
- const b = 2;
- ```
+ ```javascript
+ // bad
+ var a = 1;
+ var b = 2;
-
- - [2.2](#references--disallow-var) If you must reassign references, use `let` instead of `var`. eslint: [`no-var`](https://eslint.org/docs/rules/no-var)
+ // good
+ const a = 1;
+ const b = 2;
+ ```
- > Why? `let` is block-scoped rather than function-scoped like `var`.
+
- ```javascript
- // bad
- var count = 1;
- if (true) {
- count += 1;
- }
+- [2.2](#references--disallow-var) If you must reassign references, use `let` instead of `var`. eslint: [`no-var`](https://eslint.org/docs/rules/no-var)
- // good, use the let.
- let count = 1;
- if (true) {
- count += 1;
- }
- ```
+ > Why? `let` is block-scoped rather than function-scoped like `var`.
-
- - [2.3](#references--block-scope) Note that both `let` and `const` are block-scoped, whereas `var` is function-scoped.
+ ```javascript
+ // bad
+ var count = 1;
+ if (true) {
+ count += 1;
+ }
- ```javascript
- // 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
- ```
+ // good, use the let.
+ let count = 1;
+ if (true) {
+ count += 1;
+ }
+ ```
+
+
+
+- [2.3](#references--block-scope) Note that both `let` and `const` are block-scoped, whereas `var` is function-scoped.
+
+ ```javascript
+ // 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.
+ 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](#table-of-contents)**
## Objects
-
- - [3.1](#objects--no-new) Use the literal syntax for object creation. eslint: [`no-new-object`](https://eslint.org/docs/rules/no-new-object)
+
- ```javascript
- // bad
- const item = new Object();
+- [3.1](#objects--no-new) Use the literal syntax for object creation. eslint: [`no-new-object`](https://eslint.org/docs/rules/no-new-object)
- // good
- const item = {};
- ```
+ ```javascript
+ // bad
+ const item = new Object();
-
- - [3.2](#es6-computed-properties) Use computed property names when creating objects with dynamic property names.
+ // good
+ const item = {};
+ ```
- > Why? They allow you to define all the properties of an object in one place.
+
- ```javascript
+- [3.2](#es6-computed-properties) Use computed property names when creating objects with dynamic property names.
- function getKey(k) {
- return `a key named ${k}`;
- }
+ > Why? They allow you to define all the properties of an object in one place.
- // bad
- const obj = {
- id: 5,
- name: 'San Francisco',
- };
- obj[getKey('enabled')] = true;
+ ```javascript
+ function getKey(k) {
+ return `a key named ${k}`;
+ }
- // good
- const obj = {
- id: 5,
- name: 'San Francisco',
- [getKey('enabled')]: true,
- };
- ```
+ // bad
+ const obj = {
+ id: 5,
+ name: "San Francisco",
+ };
+ obj[getKey("enabled")] = true;
-
- - [3.3](#es6-object-shorthand) Use object method shorthand. eslint: [`object-shorthand`](https://eslint.org/docs/rules/object-shorthand)
+ // good
+ const obj = {
+ id: 5,
+ name: "San Francisco",
+ [getKey("enabled")]: true,
+ };
+ ```
- ```javascript
- // bad
- const atom = {
- value: 1,
+
- addValue: function (value) {
- return atom.value + value;
- },
- };
+- [3.3](#es6-object-shorthand) Use object method shorthand. eslint: [`object-shorthand`](https://eslint.org/docs/rules/object-shorthand)
- // good
- const atom = {
- value: 1,
+ ```javascript
+ // bad
+ const atom = {
+ value: 1,
- addValue(value) {
- return atom.value + value;
- },
- };
- ```
+ addValue: function (value) {
+ return atom.value + value;
+ },
+ };
-
- - [3.4](#es6-object-concise) Use property value shorthand. eslint: [`object-shorthand`](https://eslint.org/docs/rules/object-shorthand)
+ // good
+ const atom = {
+ value: 1,
- > Why? It is shorter and descriptive.
+ addValue(value) {
+ return atom.value + value;
+ },
+ };
+ ```
- ```javascript
- const lukeSkywalker = 'Luke Skywalker';
+
- // bad
- const obj = {
- lukeSkywalker: lukeSkywalker,
- };
+- [3.4](#es6-object-concise) Use property value shorthand. eslint: [`object-shorthand`](https://eslint.org/docs/rules/object-shorthand)
- // good
- const obj = {
- lukeSkywalker,
- };
- ```
+ > Why? It is shorter and descriptive.
-
- - [3.5](#objects--grouped-shorthand) Group your shorthand properties at the beginning of your object declaration.
+ ```javascript
+ const lukeSkywalker = "Luke Skywalker";
- > Why? It’s easier to tell which properties are using the shorthand.
+ // bad
+ const obj = {
+ lukeSkywalker: lukeSkywalker,
+ };
- ```javascript
- const anakinSkywalker = 'Anakin Skywalker';
- const lukeSkywalker = 'Luke Skywalker';
+ // good
+ const obj = {
+ lukeSkywalker,
+ };
+ ```
- // 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.5](#objects--grouped-shorthand) Group your shorthand properties at the beginning of your object declaration.
-
- - [3.6](#objects--quoted-props) Only quote properties that are invalid identifiers. eslint: [`quote-props`](https://eslint.org/docs/rules/quote-props)
+ > Why? It’s easier to tell which properties are using the shorthand.
- > Why? In general we consider it subjectively easier to read. It improves syntax highlighting, and is also more easily optimized by many JS engines.
+ ```javascript
+ const anakinSkywalker = "Anakin Skywalker";
+ const lukeSkywalker = "Luke Skywalker";
- ```javascript
- // bad
- const bad = {
- 'foo': 3,
- 'bar': 4,
- 'data-blah': 5,
- };
+ // bad
+ const obj = {
+ episodeOne: 1,
+ twoJediWalkIntoACantina: 2,
+ lukeSkywalker,
+ episodeThree: 3,
+ mayTheFourth: 4,
+ anakinSkywalker,
+ };
- // good
- const good = {
- foo: 3,
- bar: 4,
- 'data-blah': 5,
- };
- ```
+ // good
+ const obj = {
+ lukeSkywalker,
+ anakinSkywalker,
+ episodeOne: 1,
+ twoJediWalkIntoACantina: 2,
+ episodeThree: 3,
+ mayTheFourth: 4,
+ };
+ ```
+
+
+
+- [3.6](#objects--quoted-props) Only quote properties that are invalid identifiers. eslint: [`quote-props`](https://eslint.org/docs/rules/quote-props)
-
- - [3.7](#objects--prototype-builtins) Do not call `Object.prototype` methods directly, such as `hasOwnProperty`, `propertyIsEnumerable`, and `isPrototypeOf`. eslint: [`no-prototype-builtins`](https://eslint.org/docs/rules/no-prototype-builtins)
+ > Why? In general we consider it subjectively easier to read. It improves syntax highlighting, and is also more easily optimized by many JS engines.
+
+ ```javascript
+ // bad
+ const bad = {
+ foo: 3,
+ bar: 4,
+ "data-blah": 5,
+ };
- > 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)`). In modern browsers that support ES2022, or with a polyfill such as , `Object.hasOwn` can also be used as an alternative to `Object.prototype.hasOwnProperty.call`.
+ // good
+ const good = {
+ foo: 3,
+ bar: 4,
+ "data-blah": 5,
+ };
+ ```
- ```javascript
- // bad
- console.log(object.hasOwnProperty(key));
+
- // good
- console.log(Object.prototype.hasOwnProperty.call(object, key));
+- [3.7](#objects--prototype-builtins) Do not call `Object.prototype` methods directly, such as `hasOwnProperty`, `propertyIsEnumerable`, and `isPrototypeOf`. eslint: [`no-prototype-builtins`](https://eslint.org/docs/rules/no-prototype-builtins)
- // better
- const has = Object.prototype.hasOwnProperty; // cache the lookup once, in module scope.
- console.log(has.call(object, key));
+ > 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)`). In modern browsers that support ES2022, or with a polyfill such as , `Object.hasOwn` can also be used as an alternative to `Object.prototype.hasOwnProperty.call`.
- // best
- console.log(Object.hasOwn(object, key)); // only supported in browsers that support ES2022
+ ```javascript
+ // bad
+ console.log(object.hasOwnProperty(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
- ```
+ // good
+ console.log(Object.prototype.hasOwnProperty.call(object, key));
-
- - [3.8](#objects--rest-spread) Prefer the object spread syntax over [`Object.assign`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/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`](https://eslint.org/docs/rules/prefer-object-spread)
+ // better
+ const has = Object.prototype.hasOwnProperty; // cache the lookup once, in module scope.
+ console.log(has.call(object, key));
- ```javascript
- // very bad
- const original = { a: 1, b: 2 };
- const copy = Object.assign(original, { c: 3 }); // this mutates `original` ಠ_ಠ
- delete copy.a; // so does this
+ // best
+ console.log(Object.hasOwn(object, key)); // only supported in browsers that support ES2022
- // bad
- const original = { a: 1, b: 2 };
- const copy = Object.assign({}, original, { c: 3 }); // copy => { a: 1, b: 2, c: 3 }
+ /* 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
+ ```
- // 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 }
- ```
+- [3.8](#objects--rest-spread) Prefer the object spread syntax over [`Object.assign`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/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`](https://eslint.org/docs/rules/prefer-object-spread)
+
+ ```javascript
+ // 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](#table-of-contents)**
## Arrays
-
- - [4.1](#arrays--literals) Use the literal syntax for array creation. eslint: [`no-array-constructor`](https://eslint.org/docs/rules/no-array-constructor)
+
- ```javascript
- // bad
- const items = new Array();
+- [4.1](#arrays--literals) Use the literal syntax for array creation. eslint: [`no-array-constructor`](https://eslint.org/docs/rules/no-array-constructor)
- // good
- const items = [];
- ```
+ ```javascript
+ // bad
+ const items = new Array();
-
- - [4.2](#arrays--push) Use [Array#push](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/push) instead of direct assignment to add items to an array.
+ // good
+ const items = [];
+ ```
- ```javascript
- const someStack = [];
+
- // bad
- someStack[someStack.length] = 'abracadabra';
+- [4.2](#arrays--push) Use [Array#push](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/push) instead of direct assignment to add items to an array.
- // good
- someStack.push('abracadabra');
- ```
+ ```javascript
+ const someStack = [];
-
- - [4.3](#es6-array-spreads) Use array spreads `...` to copy arrays.
+ // bad
+ someStack[someStack.length] = "abracadabra";
- ```javascript
- // bad
- const len = items.length;
- const itemsCopy = [];
- let i;
+ // good
+ someStack.push("abracadabra");
+ ```
- for (i = 0; i < len; i += 1) {
- itemsCopy[i] = items[i];
- }
+
- // good
- const itemsCopy = [...items];
- ```
+- [4.3](#es6-array-spreads) Use array spreads `...` to copy arrays.
-
-
- - [4.4](#arrays--from-iterable) To convert an iterable object to an array, use spreads `...` instead of [`Array.from`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from)
+ ```javascript
+ // bad
+ const len = items.length;
+ const itemsCopy = [];
+ let i;
- ```javascript
- const foo = document.querySelectorAll('.foo');
+ for (i = 0; i < len; i += 1) {
+ itemsCopy[i] = items[i];
+ }
- // good
- const nodes = Array.from(foo);
+ // good
+ const itemsCopy = [...items];
+ ```
- // best
- const nodes = [...foo];
- ```
+
+
-
- - [4.5](#arrays--from-array-like) Use [`Array.from`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from) for converting an array-like object to an array.
+- [4.4](#arrays--from-iterable) To convert an iterable object to an array, use spreads `...` instead of [`Array.from`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from)
- ```javascript
- const arrLike = { 0: 'foo', 1: 'bar', 2: 'baz', length: 3 };
+ ```javascript
+ const foo = document.querySelectorAll(".foo");
- // bad
- const arr = Array.prototype.slice.call(arrLike);
+ // good
+ const nodes = Array.from(foo);
- // good
- const arr = Array.from(arrLike);
- ```
+ // best
+ const nodes = [...foo];
+ ```
-
- - [4.6](#arrays--mapping) Use [`Array.from`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from) instead of spread `...` for mapping over iterables, because it avoids creating an intermediate array.
+
- ```javascript
- // bad
- const baz = [...foo].map(bar);
+- [4.5](#arrays--from-array-like) Use [`Array.from`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from) for converting an array-like object to an array.
- // good
- const baz = Array.from(foo, bar);
- ```
+ ```javascript
+ const arrLike = { 0: "foo", 1: "bar", 2: "baz", length: 3 };
-
- - [4.7](#arrays--callback-return) 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](#arrows--implicit-return). eslint: [`array-callback-return`](https://eslint.org/docs/rules/array-callback-return)
+ // bad
+ const arr = Array.prototype.slice.call(arrLike);
- ```javascript
- // good
- [1, 2, 3].map((x) => {
- const y = x + 1;
- return x * y;
- });
+ // good
+ const arr = Array.from(arrLike);
+ ```
- // 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);
- });
+- [4.6](#arrays--mapping) Use [`Array.from`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from) instead of spread `...` for mapping over iterables, because it avoids creating an intermediate array.
- // good
- [[0, 1], [2, 3], [4, 5]].reduce((acc, item, index) => {
- const flatten = acc.concat(item);
- return flatten;
- });
+ ```javascript
+ // bad
+ const baz = [...foo].map(bar);
- // bad
- inbox.filter((msg) => {
- const { subject, author } = msg;
- if (subject === 'Mockingbird') {
- return author === 'Harper Lee';
- } else {
- return false;
- }
- });
+ // good
+ const baz = Array.from(foo, bar);
+ ```
- // good
- inbox.filter((msg) => {
- const { subject, author } = msg;
- if (subject === 'Mockingbird') {
- return author === 'Harper Lee';
- }
+
+
+- [4.7](#arrays--callback-return) 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](#arrows--implicit-return). eslint: [`array-callback-return`](https://eslint.org/docs/rules/array-callback-return)
+
+ ```javascript
+ // 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](#arrays--bracket-newline) Use line breaks after opening array brackets and before closing array brackets, if an array has multiple lines
+
+ ```javascript
+ // bad
+ const arr = [
+ [0, 1],
+ [2, 3],
+ [4, 5],
+ ];
+
+ const objectInArray = [
+ {
+ id: 1,
+ },
+ {
+ id: 2,
+ },
+ ];
-
- - [4.8](#arrays--bracket-newline) Use line breaks after opening array brackets and before closing array brackets, if an array has multiple lines
+ const numberInArray = [1, 2];
- ```javascript
- // bad
- const arr = [
- [0, 1], [2, 3], [4, 5],
- ];
+ // good
+ const arr = [
+ [0, 1],
+ [2, 3],
+ [4, 5],
+ ];
- const objectInArray = [{
+ 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,
- ];
- ```
+ },
+ ];
+
+ const numberInArray = [1, 2];
+ ```
**[⬆ back to top](#table-of-contents)**
## Destructuring
-
- - [5.1](#destructuring--object) Use object destructuring when accessing and using multiple properties of an object. eslint: [`prefer-destructuring`](https://eslint.org/docs/rules/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.
+- [5.1](#destructuring--object) Use object destructuring when accessing and using multiple properties of an object. eslint: [`prefer-destructuring`](https://eslint.org/docs/rules/prefer-destructuring)
- ```javascript
- // bad
- function getFullName(user) {
- const firstName = user.firstName;
- const lastName = user.lastName;
+ > 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.
- return `${firstName} ${lastName}`;
- }
+ ```javascript
+ // bad
+ function getFullName(user) {
+ const firstName = user.firstName;
+ const lastName = user.lastName;
- // good
- function getFullName(user) {
- const { firstName, lastName } = user;
- return `${firstName} ${lastName}`;
- }
+ return `${firstName} ${lastName}`;
+ }
- // best
- function getFullName({ firstName, lastName }) {
- return `${firstName} ${lastName}`;
- }
- ```
+ // good
+ function getFullName(user) {
+ const { firstName, lastName } = user;
+ return `${firstName} ${lastName}`;
+ }
-
- - [5.2](#destructuring--array) Use array destructuring. eslint: [`prefer-destructuring`](https://eslint.org/docs/rules/prefer-destructuring)
+ // best
+ function getFullName({ firstName, lastName }) {
+ return `${firstName} ${lastName}`;
+ }
+ ```
- ```javascript
- const arr = [1, 2, 3, 4];
+
- // bad
- const first = arr[0];
- const second = arr[1];
+- [5.2](#destructuring--array) Use array destructuring. eslint: [`prefer-destructuring`](https://eslint.org/docs/rules/prefer-destructuring)
- // good
- const [first, second] = arr;
- ```
+ ```javascript
+ const arr = [1, 2, 3, 4];
-
- - [5.3](#destructuring--object-over-array) Use object destructuring for multiple return values, not array destructuring.
+ // bad
+ const first = arr[0];
+ const second = arr[1];
- > Why? You can add new properties over time or change the order of things without breaking call sites.
+ // good
+ const [first, second] = arr;
+ ```
- ```javascript
- // 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);
+- [5.3](#destructuring--object-over-array) Use object destructuring for multiple return values, not array destructuring.
- // good
- function processInput(input) {
- // then a miracle occurs
- return { left, right, top, bottom };
- }
+ > Why? You can add new properties over time or change the order of things without breaking call sites.
+
+ ```javascript
+ // bad
+ 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);
- ```
+ // 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](#table-of-contents)**
## Strings
-
- - [6.1](#strings--quotes) Use single quotes `''` for strings. eslint: [`quotes`](https://eslint.org/docs/rules/quotes)
+
- ```javascript
- // bad
- const name = "Capt. Janeway";
+- [6.1](#strings--quotes) Use single quotes `''` for strings. eslint: [`quotes`](https://eslint.org/docs/rules/quotes)
- // bad - template literals should contain interpolation or newlines
- const name = `Capt. Janeway`;
+ ```javascript
+ // bad
+ const name = "Capt. Janeway";
- // good
- const name = 'Capt. Janeway';
- ```
+ // bad - template literals should contain interpolation or newlines
+ const name = `Capt. Janeway`;
-
- - [6.2](#strings--line-length) Strings that cause the line to go over 100 characters should not be written across multiple lines using string concatenation.
+ // good
+ const name = "Capt. Janeway";
+ ```
- > Why? Broken strings are painful to work with and make code less searchable.
+
- ```javascript
- // 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.';
+- [6.2](#strings--line-length) Strings that cause the line to go over 100 characters should not be written across multiple lines using string concatenation.
- // 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.';
+ > Why? Broken strings are painful to work with and make code less searchable.
- // 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.';
- ```
+ ```javascript
+ // 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.";
-
- - [6.3](#es6-template-literals) When programmatically building up strings, use template strings instead of concatenation. eslint: [`prefer-template`](https://eslint.org/docs/rules/prefer-template) [`template-curly-spacing`](https://eslint.org/docs/rules/template-curly-spacing)
+ // 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.";
- > Why? Template strings give you a readable, concise syntax with proper newlines and string interpolation features.
+ // 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.";
+ ```
- ```javascript
- // bad
- function sayHi(name) {
- return 'How are you, ' + name + '?';
- }
+
- // bad
- function sayHi(name) {
- return ['How are you, ', name, '?'].join();
- }
+- [6.3](#es6-template-literals) When programmatically building up strings, use template strings instead of concatenation. eslint: [`prefer-template`](https://eslint.org/docs/rules/prefer-template) [`template-curly-spacing`](https://eslint.org/docs/rules/template-curly-spacing)
- // bad
- function sayHi(name) {
- return `How are you, ${ name }?`;
- }
+ > Why? Template strings give you a readable, concise syntax with proper newlines and string interpolation features.
- // good
- function sayHi(name) {
- return `How are you, ${name}?`;
- }
- ```
+ ```javascript
+ // bad
+ function sayHi(name) {
+ return "How are you, " + name + "?";
+ }
+
+ // bad
+ function sayHi(name) {
+ return ["How are you, ", name, "?"].join();
+ }
-
- - [6.4](#strings--eval) Never use `eval()` on a string; it opens too many vulnerabilities. eslint: [`no-eval`](https://eslint.org/docs/rules/no-eval)
+ // bad
+ function sayHi(name) {
+ return `How are you, ${name}?`;
+ }
-
- - [6.5](#strings--escaping) Do not unnecessarily escape characters in strings. eslint: [`no-useless-escape`](https://eslint.org/docs/rules/no-useless-escape)
+ // good
+ function sayHi(name) {
+ return `How are you, ${name}?`;
+ }
+ ```
- > Why? Backslashes harm readability, thus they should only be present when necessary.
+
- ```javascript
- // bad
- const foo = '\'this\' \i\s \"quoted\"';
+- [6.4](#strings--eval) Never use `eval()` on a string; it opens too many vulnerabilities. eslint: [`no-eval`](https://eslint.org/docs/rules/no-eval)
- // good
- const foo = '\'this\' is "quoted"';
- const foo = `my name is '${name}'`;
- ```
+
+
+- [6.5](#strings--escaping) Do not unnecessarily escape characters in strings. eslint: [`no-useless-escape`](https://eslint.org/docs/rules/no-useless-escape)
+
+ > Why? Backslashes harm readability, thus they should only be present when necessary.
+
+ ```javascript
+ // bad
+ const foo = "'this' is \"quoted\"";
+
+ // good
+ const foo = "'this' is \"quoted\"";
+ const foo = `my name is '${name}'`;
+ ```
**[⬆ back to top](#table-of-contents)**
## Functions
-
- - [7.1](#functions--declarations) Use named function expressions instead of function declarations. eslint: [`func-style`](https://eslint.org/docs/rules/func-style), [`func-names`](https://eslint.org/docs/latest/rules/func-names)
+
- > 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](https://github.com/airbnb/javascript/issues/794))
+- [7.1](#functions--declarations) Use named function expressions instead of function declarations. eslint: [`func-style`](https://eslint.org/docs/rules/func-style), [`func-names`](https://eslint.org/docs/latest/rules/func-names)
- ```javascript
- // bad
- function foo() {
- // ...
+ > 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](https://github.com/airbnb/javascript/issues/794))
+
+ ```javascript
+ // bad
+ function foo() {
+ // ...
+ }
+
+ // bad
+ const foo = function () {
+ // ...
+ };
+
+ // good
+ // lexical name distinguished from the variable-referenced invocation(s)
+ const short = function longUniqueMoreDescriptiveLexicalFoo() {
+ // ...
+ };
+ ```
+
+
+
+- [7.2](#functions--iife) Wrap immediately invoked function expressions in parentheses. eslint: [`wrap-iife`](https://eslint.org/docs/rules/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.
+
+ ```javascript
+ // immediately-invoked function expression (IIFE)
+ (function () {
+ console.log("Welcome to the Internet. Please follow me.");
+ })();
+ ```
+
+
+
+- [7.3](#functions--in-blocks) 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`](https://eslint.org/docs/rules/no-loop-func)
+
+
+
+- [7.4](#functions--note-on-blocks) **Note:** ECMA-262 defines a `block` as a list of statements. A function declaration is not a statement.
+
+ ```javascript
+ // bad
+ if (currentUser) {
+ function test() {
+ console.log("Nope.");
}
+ }
- // bad
- const foo = function () {
- // ...
+ // good
+ let test;
+ if (currentUser) {
+ test = () => {
+ console.log("Yup.");
};
+ }
+ ```
- // good
- // lexical name distinguished from the variable-referenced invocation(s)
- const short = function longUniqueMoreDescriptiveLexicalFoo() {
- // ...
- };
- ```
+
-
- - [7.2](#functions--iife) Wrap immediately invoked function expressions in parentheses. eslint: [`wrap-iife`](https://eslint.org/docs/rules/wrap-iife)
+- [7.5](#functions--arguments-shadow) Never name a parameter `arguments`. This will take precedence over the `arguments` object that is given to every function scope.
- > 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.
+ ```javascript
+ // bad
+ function foo(name, options, arguments) {
+ // ...
+ }
- ```javascript
- // immediately-invoked function expression (IIFE)
- (function () {
- console.log('Welcome to the Internet. Please follow me.');
- }());
- ```
+ // good
+ function foo(name, options, args) {
+ // ...
+ }
+ ```
-
- - [7.3](#functions--in-blocks) 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`](https://eslint.org/docs/rules/no-loop-func)
+
-
- - [7.4](#functions--note-on-blocks) **Note:** ECMA-262 defines a `block` as a list of statements. A function declaration is not a statement.
+- [7.6](#es6-rest) Never use `arguments`, opt to use rest syntax `...` instead. eslint: [`prefer-rest-params`](https://eslint.org/docs/rules/prefer-rest-params)
- ```javascript
- // bad
- if (currentUser) {
- function test() {
- console.log('Nope.');
- }
- }
+ > Why? `...` is explicit about which arguments you want pulled. Plus, rest arguments are a real Array, and not merely Array-like like `arguments`.
- // good
- let test;
- if (currentUser) {
- test = () => {
- console.log('Yup.');
- };
- }
- ```
+ ```javascript
+ // bad
+ function concatenateAll() {
+ const args = Array.prototype.slice.call(arguments);
+ return args.join("");
+ }
-
- - [7.5](#functions--arguments-shadow) Never name a parameter `arguments`. This will take precedence over the `arguments` object that is given to every function scope.
+ // good
+ function concatenateAll(...args) {
+ return args.join("");
+ }
+ ```
- ```javascript
- // bad
- function foo(name, options, arguments) {
- // ...
- }
+
- // good
- function foo(name, options, args) {
- // ...
+- [7.7](#es6-default-parameters) Use default parameter syntax rather than mutating function arguments.
+
+ ```javascript
+ // 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 = {};
}
- ```
+ // ...
+ }
-
- - [7.6](#es6-rest) Never use `arguments`, opt to use rest syntax `...` instead. eslint: [`prefer-rest-params`](https://eslint.org/docs/rules/prefer-rest-params)
+ // good
+ function handleThings(opts = {}) {
+ // ...
+ }
+ ```
- > Why? `...` is explicit about which arguments you want pulled. Plus, rest arguments are a real Array, and not merely Array-like like `arguments`.
+
- ```javascript
- // bad
- function concatenateAll() {
- const args = Array.prototype.slice.call(arguments);
- return args.join('');
- }
+- [7.8](#functions--default-side-effects) Avoid side effects with default parameters.
- // good
- function concatenateAll(...args) {
- return args.join('');
- }
- ```
-
-
- - [7.7](#es6-default-parameters) Use default parameter syntax rather than mutating function arguments.
-
- ```javascript
- // 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 || {};
- // ...
- }
+ > Why? They are confusing to reason about.
- // still bad
- function handleThings(opts) {
- if (opts === void 0) {
- opts = {};
- }
- // ...
- }
+ ```javascript
+ let b = 1;
+ // bad
+ function count(a = b++) {
+ console.log(a);
+ }
+ count(); // 1
+ count(); // 2
+ count(3); // 3
+ count(); // 3
+ ```
- // good
- function handleThings(opts = {}) {
- // ...
- }
- ```
+
-
- - [7.8](#functions--default-side-effects) Avoid side effects with default parameters.
+- [7.9](#functions--defaults-last) Always put default parameters last. eslint: [`default-param-last`](https://eslint.org/docs/rules/default-param-last)
- > Why? They are confusing to reason about.
+ ```javascript
+ // bad
+ function handleThings(opts = {}, name) {
+ // ...
+ }
- ```javascript
- let b = 1;
- // bad
- function count(a = b++) {
- console.log(a);
- }
- count(); // 1
- count(); // 2
- count(3); // 3
- count(); // 3
- ```
-
-
- - [7.9](#functions--defaults-last) Always put default parameters last. eslint: [`default-param-last`](https://eslint.org/docs/rules/default-param-last)
-
- ```javascript
- // bad
- function handleThings(opts = {}, name) {
- // ...
- }
+ // good
+ function handleThings(name, opts = {}) {
+ // ...
+ }
+ ```
- // good
- function handleThings(name, opts = {}) {
- // ...
- }
- ```
+
-
- - [7.10](#functions--constructor) Never use the Function constructor to create a new function. eslint: [`no-new-func`](https://eslint.org/docs/rules/no-new-func)
+- [7.10](#functions--constructor) Never use the Function constructor to create a new function. eslint: [`no-new-func`](https://eslint.org/docs/rules/no-new-func)
- > Why? Creating a function in this way evaluates a string similarly to `eval()`, which opens vulnerabilities.
+ > Why? Creating a function in this way evaluates a string similarly to `eval()`, which opens vulnerabilities.
- ```javascript
- // bad
- const add = new Function('a', 'b', 'return a + b');
+ ```javascript
+ // bad
+ const add = new Function("a", "b", "return a + b");
- // still bad
- const subtract = Function('a', 'b', 'return a - b');
- ```
+ // still bad
+ const subtract = Function("a", "b", "return a - b");
+ ```
-
- - [7.11](#functions--signature-spacing) Spacing in a function signature. eslint: [`space-before-function-paren`](https://eslint.org/docs/rules/space-before-function-paren) [`space-before-blocks`](https://eslint.org/docs/rules/space-before-blocks)
+
- > Why? Consistency is good, and you shouldn’t have to add or remove a space when adding or removing a name.
+- [7.11](#functions--signature-spacing) Spacing in a function signature. eslint: [`space-before-function-paren`](https://eslint.org/docs/rules/space-before-function-paren) [`space-before-blocks`](https://eslint.org/docs/rules/space-before-blocks)
- ```javascript
- // bad
- const f = function(){};
- const g = function (){};
- const h = function() {};
+ > Why? Consistency is good, and you shouldn’t have to add or remove a space when adding or removing a name.
- // good
- const x = function () {};
- const y = function a() {};
- ```
+ ```javascript
+ // bad
+ const f = function () {};
+ const g = function () {};
+ const h = function () {};
-
- - [7.12](#functions--mutate-params) Never mutate parameters. eslint: [`no-param-reassign`](https://eslint.org/docs/rules/no-param-reassign)
+ // good
+ const x = function () {};
+ const y = function a() {};
+ ```
- > Why? Manipulating objects passed in as parameters can cause unwanted variable side effects in the original caller.
+
- ```javascript
- // bad
- function f1(obj) {
- obj.key = 1;
- }
+- [7.12](#functions--mutate-params) Never mutate parameters. eslint: [`no-param-reassign`](https://eslint.org/docs/rules/no-param-reassign)
- // good
- function f2(obj) {
- const key = Object.prototype.hasOwnProperty.call(obj, 'key') ? obj.key : 1;
- }
- ```
+ > Why? Manipulating objects passed in as parameters can cause unwanted variable side effects in the original caller.
+
+ ```javascript
+ // bad
+ function f1(obj) {
+ obj.key = 1;
+ }
+
+ // good
+ function f2(obj) {
+ const key = Object.prototype.hasOwnProperty.call(obj, "key") ? obj.key : 1;
+ }
+ ```
-
- - [7.13](#functions--reassign-params) Never reassign parameters. eslint: [`no-param-reassign`](https://eslint.org/docs/rules/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.
+- [7.13](#functions--reassign-params) Never reassign parameters. eslint: [`no-param-reassign`](https://eslint.org/docs/rules/no-param-reassign)
- ```javascript
- // bad
- function f1(a) {
+ > Why? Reassigning parameters can lead to unexpected behavior, especially when accessing the `arguments` object. It can also cause optimization issues, especially in V8.
+
+ ```javascript
+ // bad
+ function f1(a) {
+ a = 1;
+ // ...
+ }
+
+ function f2(a) {
+ if (!a) {
a = 1;
- // ...
}
+ // ...
+ }
- function f2(a) {
- if (!a) { a = 1; }
- // ...
- }
+ // good
+ function f3(a) {
+ const b = a || 1;
+ // ...
+ }
- // good
- function f3(a) {
- const b = a || 1;
- // ...
- }
+ function f4(a = 1) {
+ // ...
+ }
+ ```
- function f4(a = 1) {
- // ...
- }
- ```
+
-
- - [7.14](#functions--spread-vs-apply) Prefer the use of the spread syntax `...` to call variadic functions. eslint: [`prefer-spread`](https://eslint.org/docs/rules/prefer-spread)
+- [7.14](#functions--spread-vs-apply) Prefer the use of the spread syntax `...` to call variadic functions. eslint: [`prefer-spread`](https://eslint.org/docs/rules/prefer-spread)
- > Why? It’s cleaner, you don’t need to supply a context, and you can not easily compose `new` with `apply`.
+ > Why? It’s cleaner, you don’t need to supply a context, and you can not easily compose `new` with `apply`.
- ```javascript
- // bad
- const x = [1, 2, 3, 4, 5];
- console.log.apply(console, x);
+ ```javascript
+ // bad
+ const x = [1, 2, 3, 4, 5];
+ console.log.apply(console, x);
- // good
- const x = [1, 2, 3, 4, 5];
- console.log(...x);
+ // good
+ const x = [1, 2, 3, 4, 5];
+ console.log(...x);
- // bad
- new (Function.prototype.bind.apply(Date, [null, 2016, 8, 5]));
+ // bad
+ new (Function.prototype.bind.apply(Date, [null, 2016, 8, 5]))();
- // good
- new Date(...[2016, 8, 5]);
- ```
+ // good
+ new Date(...[2016, 8, 5]);
+ ```
-
- - [7.15](#functions--signature-invocation-indentation) 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`](https://eslint.org/docs/rules/function-paren-newline)
+
- ```javascript
- // bad
- function foo(bar,
- baz,
- quux) {
- // ...
- }
+- [7.15](#functions--signature-invocation-indentation) 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`](https://eslint.org/docs/rules/function-paren-newline)
- // good
- function foo(
- bar,
- baz,
- quux,
- ) {
- // ...
- }
+ ```javascript
+ // bad
+ function foo(bar, baz, quux) {
+ // ...
+ }
+
+ // good
+ function foo(bar, baz, quux) {
+ // ...
+ }
- // bad
- console.log(foo,
- bar,
- baz);
+ // bad
+ console.log(foo, bar, baz);
- // good
- console.log(
- foo,
- bar,
- baz,
- );
- ```
+ // good
+ console.log(foo, bar, baz);
+ ```
**[⬆ back to top](#table-of-contents)**
## Arrow Functions
-
- - [8.1](#arrows--use-them) When you must use an anonymous function (as when passing an inline callback), use arrow function notation. eslint: [`prefer-arrow-callback`](https://eslint.org/docs/rules/prefer-arrow-callback), [`arrow-spacing`](https://eslint.org/docs/rules/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.
+- [8.1](#arrows--use-them) When you must use an anonymous function (as when passing an inline callback), use arrow function notation. eslint: [`prefer-arrow-callback`](https://eslint.org/docs/rules/prefer-arrow-callback), [`arrow-spacing`](https://eslint.org/docs/rules/arrow-spacing)
- > Why not? If you have a fairly complicated function, you might move that logic out into its own named function expression.
+ > 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.
- ```javascript
- // bad
- [1, 2, 3].map(function (x) {
- const y = x + 1;
- return x * y;
- });
+ > Why not? If you have a fairly complicated function, you might move that logic out into its own named function expression.
- // good
- [1, 2, 3].map((x) => {
- const y = x + 1;
- return x * y;
- });
- ```
+ ```javascript
+ // bad
+ [1, 2, 3].map(function (x) {
+ const y = x + 1;
+ return x * y;
+ });
-
- - [8.2](#arrows--implicit-return) If the function body consists of a single statement returning an [expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators#Expressions) without side effects, omit the braces and use the implicit return. Otherwise, keep the braces and use a `return` statement. eslint: [`arrow-parens`](https://eslint.org/docs/rules/arrow-parens), [`arrow-body-style`](https://eslint.org/docs/rules/arrow-body-style)
+ // good
+ [1, 2, 3].map((x) => {
+ const y = x + 1;
+ return x * y;
+ });
+ ```
- > Why? Syntactic sugar. It reads well when multiple functions are chained together.
+
- ```javascript
- // bad
- [1, 2, 3].map((number) => {
- const nextNumber = number + 1;
- `A string containing the ${nextNumber}.`;
- });
+- [8.2](#arrows--implicit-return) If the function body consists of a single statement returning an [expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators#Expressions) without side effects, omit the braces and use the implicit return. Otherwise, keep the braces and use a `return` statement. eslint: [`arrow-parens`](https://eslint.org/docs/rules/arrow-parens), [`arrow-body-style`](https://eslint.org/docs/rules/arrow-body-style)
- // good
- [1, 2, 3].map((number) => `A string containing the ${number + 1}.`);
+ > Why? Syntactic sugar. It reads well when multiple functions are chained together.
- // good
- [1, 2, 3].map((number) => {
- const nextNumber = number + 1;
- return `A string containing the ${nextNumber}.`;
- });
+ ```javascript
+ // bad
+ [1, 2, 3].map((number) => {
+ const nextNumber = number + 1;
+ `A string containing the ${nextNumber}.`;
+ });
- // good
- [1, 2, 3].map((number, index) => ({
- [index]: number,
- }));
+ // good
+ [1, 2, 3].map((number) => `A string containing the ${number + 1}.`);
- // No implicit return with side effects
- function foo(callback) {
- const val = callback();
- if (val === true) {
- // Do something if callback returns true
- }
+ // 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;
+ let bool = false;
- // bad
- foo(() => bool = true);
+ // bad
+ foo(() => (bool = true));
- // good
- foo(() => {
- bool = true;
- });
- ```
-
-
- - [8.3](#arrows--paren-wrap) 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.
-
- ```javascript
- // 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](#arrows--one-arg-parens) Always include parentheses around arguments for clarity and consistency. eslint: [`arrow-parens`](https://eslint.org/docs/rules/arrow-parens)
-
- > Why? Minimizes diff churn when adding or removing arguments.
-
- ```javascript
- // 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
+ foo(() => {
+ bool = true;
+ });
+ ```
- // good
- [1, 2, 3].map((x) => {
- const y = x + 1;
- return x * y;
- });
- ```
+
-
- - [8.5](#arrows--confusing) Avoid confusing arrow function syntax (`=>`) with comparison operators (`<=`, `>=`). eslint: [`no-confusing-arrow`](https://eslint.org/docs/rules/no-confusing-arrow)
+- [8.3](#arrows--paren-wrap) In case the expression spans over multiple lines, wrap it in parentheses for better readability.
- ```javascript
- // bad
- const itemHeight = (item) => item.height <= 256 ? item.largeSize : item.smallSize;
+ > Why? It shows clearly where the function starts and ends.
- // bad
- const itemHeight = (item) => item.height >= 256 ? item.largeSize : item.smallSize;
+ ```javascript
+ // bad
+ ["get", "post", "put"].map((httpMethod) => Object.prototype.hasOwnProperty.call(httpMagicObjectWithAVeryLongName, httpMethod));
- // good
- const itemHeight = (item) => (item.height <= 256 ? item.largeSize : item.smallSize);
+ // good
+ ["get", "post", "put"].map((httpMethod) => Object.prototype.hasOwnProperty.call(httpMagicObjectWithAVeryLongName, httpMethod));
+ ```
- // good
- const itemHeight = (item) => {
- const { height, largeSize, smallSize } = item;
- return height <= 256 ? largeSize : smallSize;
- };
- ```
+
+
+- [8.4](#arrows--one-arg-parens) Always include parentheses around arguments for clarity and consistency. eslint: [`arrow-parens`](https://eslint.org/docs/rules/arrow-parens)
+
+ > Why? Minimizes diff churn when adding or removing arguments.
+
+ ```javascript
+ // 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;
+ });
-
- - [8.6](#whitespace--implicit-arrow-linebreak) Enforce the location of arrow function bodies with implicit returns. eslint: [`implicit-arrow-linebreak`](https://eslint.org/docs/rules/implicit-arrow-linebreak)
+ // good
+ [1, 2, 3].map((x) => {
+ const y = x + 1;
+ return x * y;
+ });
+ ```
- ```javascript
- // bad
- (foo) =>
- bar;
+
- (foo) =>
- (bar);
+- [8.5](#arrows--confusing) Avoid confusing arrow function syntax (`=>`) with comparison operators (`<=`, `>=`). eslint: [`no-confusing-arrow`](https://eslint.org/docs/rules/no-confusing-arrow)
- // good
- (foo) => bar;
- (foo) => (bar);
- (foo) => (
- bar
- )
- ```
+ ```javascript
+ // 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](#whitespace--implicit-arrow-linebreak) Enforce the location of arrow function bodies with implicit returns. eslint: [`implicit-arrow-linebreak`](https://eslint.org/docs/rules/implicit-arrow-linebreak)
+
+ ```javascript
+ // bad
+ (foo) => bar;
+
+ (foo) => bar;
+
+ // good
+ (foo) => bar;
+ (foo) => bar;
+ (foo) => bar;
+ ```
**[⬆ back to top](#table-of-contents)**
## Classes & Constructors
-
- - [9.1](#constructors--use-class) Always use `class`. Avoid manipulating `prototype` directly.
+
+
+- [9.1](#constructors--use-class) Always use `class`. Avoid manipulating `prototype` directly.
+
+ > Why? `class` syntax is more concise and easier to reason about.
- > Why? `class` syntax is more concise and easier to reason about.
+ ```javascript
+ // bad
+ function Queue(contents = []) {
+ this.queue = [...contents];
+ }
+ Queue.prototype.pop = function () {
+ const value = this.queue[0];
+ this.queue.splice(0, 1);
+ return value;
+ };
- ```javascript
- // bad
- function Queue(contents = []) {
+ // good
+ class Queue {
+ constructor(contents = []) {
this.queue = [...contents];
}
- Queue.prototype.pop = function () {
+ pop() {
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](#constructors--extends) Use `extends` for inheritance.
+
- > Why? It is a built-in way to inherit prototype functionality without breaking `instanceof`.
+- [9.2](#constructors--extends) Use `extends` for inheritance.
- ```javascript
- // bad
- const inherits = require('inherits');
- function PeekableQueue(contents) {
- Queue.apply(this, contents);
- }
- inherits(PeekableQueue, Queue);
- PeekableQueue.prototype.peek = function () {
- return this.queue[0];
- };
+ > Why? It is a built-in way to inherit prototype functionality without breaking `instanceof`.
- // good
- class PeekableQueue extends Queue {
- peek() {
- return this.queue[0];
- }
+ ```javascript
+ // 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](#constructors--chaining) Methods can return `this` to help with method chaining.
+
- ```javascript
- // bad
- Jedi.prototype.jump = function () {
- this.jumping = true;
- return true;
- };
+- [9.3](#constructors--chaining) Methods can return `this` to help with method chaining.
- Jedi.prototype.setHeight = function (height) {
- this.height = height;
- };
+ ```javascript
+ // bad
+ Jedi.prototype.jump = function () {
+ this.jumping = true;
+ return true;
+ };
- const luke = new Jedi();
- luke.jump(); // => true
- luke.setHeight(20); // => undefined
+ Jedi.prototype.setHeight = function (height) {
+ this.height = height;
+ };
- // good
- class Jedi {
- jump() {
- this.jumping = true;
- return this;
- }
+ const luke = new Jedi();
+ luke.jump(); // => true
+ luke.setHeight(20); // => undefined
- setHeight(height) {
- this.height = height;
- return this;
- }
+ // good
+ class Jedi {
+ jump() {
+ this.jumping = true;
+ return this;
}
- const luke = new Jedi();
+ setHeight(height) {
+ this.height = height;
+ return this;
+ }
+ }
- luke.jump()
- .setHeight(20);
- ```
+ const luke = new Jedi();
-
- - [9.4](#constructors--tostring) It’s okay to write a custom `toString()` method, just make sure it works successfully and causes no side effects.
+ luke.jump().setHeight(20);
+ ```
- ```javascript
- class Jedi {
- constructor(options = {}) {
- this.name = options.name || 'no name';
- }
+
- getName() {
- return this.name;
- }
+- [9.4](#constructors--tostring) It’s okay to write a custom `toString()` method, just make sure it works successfully and causes no side effects.
- toString() {
- return `Jedi - ${this.getName()}`;
- }
+ ```javascript
+ class Jedi {
+ constructor(options = {}) {
+ this.name = options.name || "no name";
}
- ```
-
- - [9.5](#constructors--no-useless) 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`](https://eslint.org/docs/rules/no-useless-constructor)
+ getName() {
+ return this.name;
+ }
- ```javascript
- // bad
- class Jedi {
- constructor() {}
+ toString() {
+ return `Jedi - ${this.getName()}`;
+ }
+ }
+ ```
- getName() {
- return this.name;
- }
+
+
+- [9.5](#constructors--no-useless) 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`](https://eslint.org/docs/rules/no-useless-constructor)
+
+ ```javascript
+ // bad
+ class Jedi {
+ constructor() {}
+
+ getName() {
+ return this.name;
}
+ }
- // bad
- class Rey extends Jedi {
- constructor(...args) {
- super(...args);
- }
+ // bad
+ class Rey extends Jedi {
+ constructor(...args) {
+ super(...args);
}
+ }
- // good
- class Rey extends Jedi {
- constructor(...args) {
- super(...args);
- this.name = 'Rey';
- }
+ // good
+ class Rey extends Jedi {
+ constructor(...args) {
+ super(...args);
+ this.name = "Rey";
}
- ```
+ }
+ ```
-
- - [9.6](#classes--no-duplicate-members) Avoid duplicate class members. eslint: [`no-dupe-class-members`](https://eslint.org/docs/rules/no-dupe-class-members)
+
- > Why? Duplicate class member declarations will silently prefer the last one - having duplicates is almost certainly a bug.
+- [9.6](#classes--no-duplicate-members) Avoid duplicate class members. eslint: [`no-dupe-class-members`](https://eslint.org/docs/rules/no-dupe-class-members)
- ```javascript
- // bad
- class Foo {
- bar() { return 1; }
- bar() { return 2; }
+ > Why? Duplicate class member declarations will silently prefer the last one - having duplicates is almost certainly a bug.
+
+ ```javascript
+ // bad
+ class Foo {
+ bar() {
+ return 1;
+ }
+ bar() {
+ return 2;
}
+ }
- // good
- class Foo {
- bar() { return 1; }
+ // good
+ class Foo {
+ bar() {
+ return 1;
}
+ }
- // good
- class Foo {
- bar() { return 2; }
+ // good
+ class Foo {
+ bar() {
+ return 2;
}
- ```
+ }
+ ```
-
- - [9.7](#classes--methods-use-this) 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`](https://eslint.org/docs/rules/class-methods-use-this)
+
- ```javascript
- // bad
- class Foo {
- bar() {
- console.log('bar');
- }
+- [9.7](#classes--methods-use-this) 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`](https://eslint.org/docs/rules/class-methods-use-this)
+
+ ```javascript
+ // bad
+ class Foo {
+ bar() {
+ console.log("bar");
}
+ }
- // good - this is used
- class Foo {
- bar() {
- console.log(this.bar);
- }
+ // good - this is used
+ class Foo {
+ bar() {
+ console.log(this.bar);
}
+ }
- // good - constructor is exempt
- class Foo {
- constructor() {
- // ...
- }
+ // good - constructor is exempt
+ class Foo {
+ constructor() {
+ // ...
}
+ }
- // good - static methods aren't expected to use this
- class Foo {
- static bar() {
- console.log('bar');
- }
+ // good - static methods aren't expected to use this
+ class Foo {
+ static bar() {
+ console.log("bar");
}
- ```
+ }
+ ```
**[⬆ back to top](#table-of-contents)**
## Modules
-
- - [10.1](#modules--use-them) 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.
-
- ```javascript
- // bad
- const AirbnbStyleGuide = require('./AirbnbStyleGuide');
- module.exports = AirbnbStyleGuide.es6;
+
+
+- [10.1](#modules--use-them) 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.
+
+ ```javascript
+ // 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](#modules--no-wildcard) Do not use wildcard imports.
+
+ > Why? This makes sure you have a single default export.
+
+ ```javascript
+ // bad
+ import * as AirbnbStyleGuide from "./AirbnbStyleGuide";
+
+ // good
+ import AirbnbStyleGuide from "./AirbnbStyleGuide";
+ ```
+
+
+
+- [10.3](#modules--no-export-from-import) 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.
+
+ ```javascript
+ // bad
+ // filename es6.js
+ export { es6 as default } from './AirbnbStyleGuide';
+
+ // good
+ // filename es6.js
+ import { es6 } from './AirbnbStyleGuide';
+ export default es6;
+ ```
+
+
+
+- [10.4](#modules--no-duplicate-imports) Only import from a path in one place.
+ eslint: [`no-duplicate-imports`](https://eslint.org/docs/rules/no-duplicate-imports)
+
+ > Why? Having multiple lines that import from the same path can make code harder to maintain.
+
+ ```javascript
+ // 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](#modules--no-mutable-exports) Do not export mutable bindings.
+ eslint: [`import/no-mutable-exports`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-mutable-exports.md)
+
+ > 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.
+
+ ```javascript
+ // bad
+ let foo = 3;
+ export { foo };
+
+ // good
+ const foo = 3;
+ export { foo };
+ ```
+
+
+
+- [10.6](#modules--prefer-default-export) In modules with a single export, prefer default export over named export.
+ eslint: [`import/prefer-default-export`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md)
+
+ > Why? To encourage more files that only ever export one thing, which is better for readability and maintainability.
+
+ ```javascript
+ // bad
+ export function foo() {}
+
+ // good
+ export default function foo() {}
+ ```
+
+
+
+- [10.7](#modules--imports-first) Put all `import`s above non-import statements.
+ eslint: [`import/first`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/first.md)
+
+ > Why? Since `import`s are hoisted, keeping them all at the top prevents surprising behavior.
+
+ ```javascript
+ // bad
+ import foo from "foo";
+ foo.init();
+
+ import bar from "bar";
+
+ // good
+ import foo from "foo";
+ import bar from "bar";
+
+ foo.init();
+ ```
+
+
+
+- [10.8](#modules--multiline-imports-over-newlines) Multiline imports should be indented just like multiline array and object literals.
+ eslint: [`object-curly-newline`](https://eslint.org/docs/rules/object-curly-newline)
- // ok
- import AirbnbStyleGuide from './AirbnbStyleGuide';
- export default AirbnbStyleGuide.es6;
+ > Why? The curly braces follow the same indentation rules as every other curly brace block in the style guide, as do the trailing commas.
- // best
- import { es6 } from './AirbnbStyleGuide';
- export default es6;
- ```
-
-
- - [10.2](#modules--no-wildcard) Do not use wildcard imports.
+ ```javascript
+ // bad
+ import { longNameA, longNameB, longNameC, longNameD, longNameE } from "path";
- > Why? This makes sure you have a single default export.
+ // good
+ import { longNameA, longNameB, longNameC, longNameD, longNameE } from "path";
+ ```
- ```javascript
- // bad
- import * as AirbnbStyleGuide from './AirbnbStyleGuide';
+
- // good
- import AirbnbStyleGuide from './AirbnbStyleGuide';
- ```
-
-
- - [10.3](#modules--no-export-from-import) 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.
-
- ```javascript
- // bad
- // filename es6.js
- export { es6 as default } from './AirbnbStyleGuide';
-
- // good
- // filename es6.js
- import { es6 } from './AirbnbStyleGuide';
- export default es6;
- ```
-
-
- - [10.4](#modules--no-duplicate-imports) Only import from a path in one place.
- eslint: [`no-duplicate-imports`](https://eslint.org/docs/rules/no-duplicate-imports)
- > Why? Having multiple lines that import from the same path can make code harder to maintain.
-
- ```javascript
- // 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](#modules--no-mutable-exports) Do not export mutable bindings.
- eslint: [`import/no-mutable-exports`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-mutable-exports.md)
- > 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.
-
- ```javascript
- // bad
- let foo = 3;
- export { foo };
-
- // good
- const foo = 3;
- export { foo };
- ```
-
-
- - [10.6](#modules--prefer-default-export) In modules with a single export, prefer default export over named export.
- eslint: [`import/prefer-default-export`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md)
- > Why? To encourage more files that only ever export one thing, which is better for readability and maintainability.
-
- ```javascript
- // bad
- export function foo() {}
-
- // good
- export default function foo() {}
- ```
-
-
- - [10.7](#modules--imports-first) Put all `import`s above non-import statements.
- eslint: [`import/first`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/first.md)
- > Why? Since `import`s are hoisted, keeping them all at the top prevents surprising behavior.
-
- ```javascript
- // bad
- import foo from 'foo';
- foo.init();
-
- import bar from 'bar';
-
- // good
- import foo from 'foo';
- import bar from 'bar';
-
- foo.init();
- ```
-
-
- - [10.8](#modules--multiline-imports-over-newlines) Multiline imports should be indented just like multiline array and object literals.
- eslint: [`object-curly-newline`](https://eslint.org/docs/rules/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.
-
- ```javascript
- // bad
- import {longNameA, longNameB, longNameC, longNameD, longNameE} from 'path';
-
- // good
- import {
- longNameA,
- longNameB,
- longNameC,
- longNameD,
- longNameE,
- } from 'path';
- ```
-
-
- - [10.9](#modules--no-webpack-loader-syntax) Disallow Webpack loader syntax in module import statements.
- eslint: [`import/no-webpack-loader-syntax`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-webpack-loader-syntax.md)
- > Why? Since using Webpack syntax in the imports couples the code to a module bundler. Prefer using the loader syntax in `webpack.config.js`.
-
- ```javascript
- // 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](#modules--import-extensions) Do not include JavaScript filename extensions
- eslint: [`import/extensions`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/extensions.md)
- > Why? Including extensions inhibits refactoring, and inappropriately hardcodes implementation details of the module you're importing in every consumer.
-
- ```javascript
- // 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';
- ```
+- [10.9](#modules--no-webpack-loader-syntax) Disallow Webpack loader syntax in module import statements.
+ eslint: [`import/no-webpack-loader-syntax`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-webpack-loader-syntax.md)
+
+ > Why? Since using Webpack syntax in the imports couples the code to a module bundler. Prefer using the loader syntax in `webpack.config.js`.
+
+ ```javascript
+ // 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](#modules--import-extensions) Do not include JavaScript filename extensions
+ eslint: [`import/extensions`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/extensions.md)
+
+ > Why? Including extensions inhibits refactoring, and inappropriately hardcodes implementation details of the module you're importing in every consumer.
+
+ ```javascript
+ // 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](#table-of-contents)**
## Iterators and Generators
-
- - [11.1](#iterators--nope) Don’t use iterators. Prefer JavaScript’s higher-order functions instead of loops like `for-in` or `for-of`. eslint: [`no-iterator`](https://eslint.org/docs/rules/no-iterator) [`no-restricted-syntax`](https://eslint.org/docs/rules/no-restricted-syntax)
+
- > Why? This enforces our immutable rule. Dealing with pure functions that return values is easier to reason about than side effects.
+- [11.1](#iterators--nope) Don’t use iterators. Prefer JavaScript’s higher-order functions instead of loops like `for-in` or `for-of`. eslint: [`no-iterator`](https://eslint.org/docs/rules/no-iterator) [`no-restricted-syntax`](https://eslint.org/docs/rules/no-restricted-syntax)
- > 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.
+ > Why? This enforces our immutable rule. Dealing with pure functions that return values is easier to reason about than side effects.
- ```javascript
- const numbers = [1, 2, 3, 4, 5];
+ > 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.
- // bad
- let sum = 0;
- for (let num of numbers) {
- sum += num;
- }
- sum === 15;
+ ```javascript
+ const numbers = [1, 2, 3, 4, 5];
- // good
- let sum = 0;
- numbers.forEach((num) => {
- sum += num;
- });
- sum === 15;
+ // bad
+ let sum = 0;
+ for (let num of numbers) {
+ sum += num;
+ }
+ sum === 15;
- // best (use the functional force)
- const sum = numbers.reduce((total, num) => total + num, 0);
- sum === 15;
+ // good
+ let sum = 0;
+ numbers.forEach((num) => {
+ sum += num;
+ });
+ sum === 15;
- // bad
- const increasedByOne = [];
- for (let i = 0; i < numbers.length; i++) {
- increasedByOne.push(numbers[i] + 1);
- }
+ // best (use the functional force)
+ const sum = numbers.reduce((total, num) => total + num, 0);
+ sum === 15;
- // good
- const increasedByOne = [];
- numbers.forEach((num) => {
- increasedByOne.push(num + 1);
- });
+ // bad
+ const increasedByOne = [];
+ for (let i = 0; i < numbers.length; i++) {
+ increasedByOne.push(numbers[i] + 1);
+ }
- // best (keeping it functional)
- const increasedByOne = numbers.map((num) => num + 1);
- ```
+ // good
+ const increasedByOne = [];
+ numbers.forEach((num) => {
+ increasedByOne.push(num + 1);
+ });
-
- - [11.2](#generators--nope) Don’t use generators for now.
+ // best (keeping it functional)
+ const increasedByOne = numbers.map((num) => num + 1);
+ ```
- > Why? They don’t transpile well to ES5.
+
-
- - [11.3](#generators--spacing) If you must use generators, or if you disregard [our advice](#generators--nope), make sure their function signature is spaced properly. eslint: [`generator-star-spacing`](https://eslint.org/docs/rules/generator-star-spacing)
+- [11.2](#generators--nope) Don’t use generators for now.
- > Why? `function` and `*` are part of the same conceptual keyword - `*` is not a modifier for `function`, `function*` is a unique construct, different from `function`.
+ > Why? They don’t transpile well to ES5.
- ```javascript
- // bad
- function * foo() {
- // ...
- }
+
- // bad
- const bar = function * () {
- // ...
- };
+- [11.3](#generators--spacing) If you must use generators, or if you disregard [our advice](#generators--nope), make sure their function signature is spaced properly. eslint: [`generator-star-spacing`](https://eslint.org/docs/rules/generator-star-spacing)
- // bad
- const baz = function *() {
- // ...
- };
+ > Why? `function` and `*` are part of the same conceptual keyword - `*` is not a modifier for `function`, `function*` is a unique construct, different from `function`.
- // bad
- const quux = function*() {
- // ...
- };
+ ```javascript
+ // bad
+ function* foo() {
+ // ...
+ }
- // bad
- function*foo() {
- // ...
- }
+ // bad
+ const bar = function* () {
+ // ...
+ };
- // bad
- function *foo() {
- // ...
- }
+ // bad
+ const baz = function* () {
+ // ...
+ };
- // very bad
- function
- *
- foo() {
- // ...
- }
+ // bad
+ const quux = function* () {
+ // ...
+ };
- // very bad
- const wat = function
- *
- () {
- // ...
- };
+ // bad
+ function* foo() {
+ // ...
+ }
- // good
- function* foo() {
- // ...
- }
+ // bad
+ function* foo() {
+ // ...
+ }
- // good
- const foo = function* () {
- // ...
- };
- ```
+ // very bad
+ function* foo() {
+ // ...
+ }
+
+ // very bad
+ const wat = function* () {
+ // ...
+ };
+
+ // good
+ function* foo() {
+ // ...
+ }
+
+ // good
+ const foo = function* () {
+ // ...
+ };
+ ```
**[⬆ back to top](#table-of-contents)**
## Properties
-
- - [12.1](#properties--dot) Use dot notation when accessing properties. eslint: [`dot-notation`](https://eslint.org/docs/rules/dot-notation)
+
- ```javascript
- const luke = {
- jedi: true,
- age: 28,
- };
+- [12.1](#properties--dot) Use dot notation when accessing properties. eslint: [`dot-notation`](https://eslint.org/docs/rules/dot-notation)
- // bad
- const isJedi = luke['jedi'];
+ ```javascript
+ const luke = {
+ jedi: true,
+ age: 28,
+ };
- // good
- const isJedi = luke.jedi;
- ```
+ // bad
+ const isJedi = luke["jedi"];
-
- - [12.2](#properties--bracket) Use bracket notation `[]` when accessing properties with a variable.
+ // good
+ const isJedi = luke.jedi;
+ ```
- ```javascript
- const luke = {
- jedi: true,
- age: 28,
- };
+
- function getProp(prop) {
- return luke[prop];
- }
+- [12.2](#properties--bracket) Use bracket notation `[]` when accessing properties with a variable.
+
+ ```javascript
+ const luke = {
+ jedi: true,
+ age: 28,
+ };
+
+ function getProp(prop) {
+ return luke[prop];
+ }
+
+ const isJedi = getProp("jedi");
+ ```
- const isJedi = getProp('jedi');
- ```
+
-
- - [12.3](#es2016-properties--exponentiation-operator) Use exponentiation operator `**` when calculating exponentiations. eslint: [`prefer-exponentiation-operator`](https://eslint.org/docs/rules/prefer-exponentiation-operator).
+- [12.3](#es2016-properties--exponentiation-operator) Use exponentiation operator `**` when calculating exponentiations. eslint: [`prefer-exponentiation-operator`](https://eslint.org/docs/rules/prefer-exponentiation-operator).
- ```javascript
- // bad
- const binary = Math.pow(2, 10);
+ ```javascript
+ // bad
+ const binary = Math.pow(2, 10);
- // good
- const binary = 2 ** 10;
- ```
+ // good
+ const binary = 2 ** 10;
+ ```
**[⬆ back to top](#table-of-contents)**
## Variables
-
- - [13.1](#variables--const) 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`](https://eslint.org/docs/rules/no-undef) [`prefer-const`](https://eslint.org/docs/rules/prefer-const)
-
- ```javascript
- // bad
- superPower = new SuperPower();
-
- // good
- const superPower = new SuperPower();
- ```
-
-
- - [13.2](#variables--one-const) Use one `const` or `let` declaration per variable or assignment. eslint: [`one-var`](https://eslint.org/docs/rules/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.
-
- ```javascript
- // 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](#variables--const-let-group) Group all your `const`s and then group all your `let`s.
-
- > Why? This is helpful when later on you might need to assign a variable depending on one of the previously assigned variables.
-
- ```javascript
- // 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](#variables--define-where-used) Assign variables where you need them, but place them in a reasonable place.
-
- > Why? `let` and `const` are block scoped and not function scoped.
-
- ```javascript
- // bad - unnecessary function call
- function checkName(hasName) {
- const name = getName();
-
- if (hasName === 'test') {
- return false;
- }
+
- if (name === 'test') {
- this.setName('');
- return false;
- }
+- [13.1](#variables--const) 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`](https://eslint.org/docs/rules/no-undef) [`prefer-const`](https://eslint.org/docs/rules/prefer-const)
+
+ ```javascript
+ // bad
+ superPower = new SuperPower();
+
+ // good
+ const superPower = new SuperPower();
+ ```
+
+
+
+- [13.2](#variables--one-const) Use one `const` or `let` declaration per variable or assignment. eslint: [`one-var`](https://eslint.org/docs/rules/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.
+
+ ```javascript
+ // 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](#variables--const-let-group) Group all your `const`s and then group all your `let`s.
+
+ > Why? This is helpful when later on you might need to assign a variable depending on one of the previously assigned variables.
- return name;
+ ```javascript
+ // 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](#variables--define-where-used) Assign variables where you need them, but place them in a reasonable place.
+
+ > Why? `let` and `const` are block scoped and not function scoped.
+
+ ```javascript
+ // bad - unnecessary function call
+ function checkName(hasName) {
+ const name = getName();
+
+ if (hasName === "test") {
+ return false;
}
- // good
- function checkName(hasName) {
- if (hasName === 'test') {
- return false;
- }
+ if (name === "test") {
+ this.setName("");
+ return false;
+ }
- const name = getName();
+ return name;
+ }
- if (name === 'test') {
- this.setName('');
- return false;
- }
+ // good
+ function checkName(hasName) {
+ if (hasName === "test") {
+ return false;
+ }
+
+ const name = getName();
- return name;
+ if (name === "test") {
+ this.setName("");
+ return false;
}
- ```
-
-
- - [13.5](#variables--no-chain-assignment) Don’t chain variable assignments. eslint: [`no-multi-assign`](https://eslint.org/docs/rules/no-multi-assign)
-
- > Why? Chaining variable assignments creates implicit global variables.
-
- ```javascript
- // 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](#variables--unary-increment-decrement) Avoid using unary increments and decrements (`++`, `--`). eslint [`no-plusplus`](https://eslint.org/docs/rules/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.
-
- ```javascript
- // 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++;
- }
+
+ return name;
+ }
+ ```
+
+
+
+- [13.5](#variables--no-chain-assignment) Don’t chain variable assignments. eslint: [`no-multi-assign`](https://eslint.org/docs/rules/no-multi-assign)
+
+ > Why? Chaining variable assignments creates implicit global variables.
+
+ ```javascript
+ // 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](#variables--unary-increment-decrement) Avoid using unary increments and decrements (`++`, `--`). eslint [`no-plusplus`](https://eslint.org/docs/rules/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.
+
+ ```javascript
+ // 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
+ // good
- const array = [1, 2, 3];
- let num = 1;
- num += 1;
- num -= 1;
+ 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;
- ```
+ const sum = array.reduce((a, b) => a + b, 0);
+ const truthyCount = array.filter(Boolean).length;
+ ```
- - [13.7](#variables--linebreak) Avoid linebreaks before or after `=` in an assignment. If your assignment violates [`max-len`](https://eslint.org/docs/rules/max-len), surround the value in parens. eslint [`operator-linebreak`](https://eslint.org/docs/rules/operator-linebreak).
- > Why? Linebreaks surrounding `=` can obfuscate the value of an assignment.
+- [13.7](#variables--linebreak) Avoid linebreaks before or after `=` in an assignment. If your assignment violates [`max-len`](https://eslint.org/docs/rules/max-len), surround the value in parens. eslint [`operator-linebreak`](https://eslint.org/docs/rules/operator-linebreak).
- ```javascript
- // bad
- const foo =
- superLongLongLongLongLongLongLongLongFunctionName();
+ > Why? Linebreaks surrounding `=` can obfuscate the value of an assignment.
- // bad
- const foo
- = 'superLongLongLongLongLongLongLongLongString';
+ ```javascript
+ // bad
+ const foo = superLongLongLongLongLongLongLongLongFunctionName();
- // good
- const foo = (
- superLongLongLongLongLongLongLongLongFunctionName()
- );
+ // bad
+ const foo = "superLongLongLongLongLongLongLongLongString";
- // good
- const foo = 'superLongLongLongLongLongLongLongLongString';
- ```
+ // good
+ const foo = superLongLongLongLongLongLongLongLongFunctionName();
+
+ // good
+ const foo = "superLongLongLongLongLongLongLongLongString";
+ ```
- - [13.8](#variables--no-unused-vars) Disallow unused variables. eslint: [`no-unused-vars`](https://eslint.org/docs/rules/no-unused-vars)
- > Why? Variables that are declared and not used anywhere in the code are most likely an error due to incomplete refactoring. Such variables take up space in the code and can lead to confusion by readers.
+- [13.8](#variables--no-unused-vars) Disallow unused variables. eslint: [`no-unused-vars`](https://eslint.org/docs/rules/no-unused-vars)
- ```javascript
- // bad
+ > Why? Variables that are declared and not used anywhere in the code are most likely an error due to incomplete refactoring. Such variables take up space in the code and can lead to confusion by readers.
- const some_unused_var = 42;
+ ```javascript
+ // bad
- // Write-only variables are not considered as used.
- let y = 10;
- y = 5;
+ const some_unused_var = 42;
- // A read for a modification of itself is not considered as used.
- let z = 0;
- z = z + 1;
+ // Write-only variables are not considered as used.
+ let y = 10;
+ y = 5;
- // Unused function arguments.
- function getX(x, y) {
- return x;
- }
+ // A read for a modification of itself is not considered as used.
+ let z = 0;
+ z = z + 1;
- // good
+ // Unused function arguments.
+ function getX(x, y) {
+ return x;
+ }
- function getXPlusY(x, y) {
- return x + y;
- }
+ // good
- const x = 1;
- const y = a + 2;
+ function getXPlusY(x, y) {
+ return x + y;
+ }
- alert(getXPlusY(x, y));
+ const x = 1;
+ const y = a + 2;
- // 'type' is ignored even if unused because it has a rest property sibling.
- // This is a form of extracting an object that omits the specified keys.
- const { type, ...coords } = data;
- // 'coords' is now the 'data' object without its 'type' property.
- ```
+ alert(getXPlusY(x, y));
+
+ // 'type' is ignored even if unused because it has a rest property sibling.
+ // This is a form of extracting an object that omits the specified keys.
+ const { type, ...coords } = data;
+ // 'coords' is now the 'data' object without its 'type' property.
+ ```
**[⬆ back to top](#table-of-contents)**
## Hoisting
-
- - [14.1](#hoisting--about) `var` declarations get hoisted to the top of their closest enclosing function scope, their assignment does not. `const` and `let` declarations are blessed with a new concept called [Temporal Dead Zones (TDZ)](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/let#temporal_dead_zone_tdz). It’s important to know why [typeof is no longer safe](https://web.archive.org/web/20200121061528/http://es-discourse.com/t/why-typeof-is-no-longer-safe/15).
+
+
+- [14.1](#hoisting--about) `var` declarations get hoisted to the top of their closest enclosing function scope, their assignment does not. `const` and `let` declarations are blessed with a new concept called [Temporal Dead Zones (TDZ)](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/let#temporal_dead_zone_tdz). It’s important to know why [typeof is no longer safe](https://web.archive.org/web/20200121061528/http://es-discourse.com/t/why-typeof-is-no-longer-safe/15).
+
+ ```javascript
+ // we know this wouldn’t work (assuming there
+ // is no notDefined global variable)
+ function example() {
+ console.log(notDefined); // => throws a ReferenceError
+ }
+
+ // creating a variable declaration after you
+ // reference the variable will work due to
+ // variable hoisting. Note: the assignment
+ // value of `true` is not hoisted.
+ function example() {
+ console.log(declaredButNotAssigned); // => undefined
+ var declaredButNotAssigned = true;
+ }
+
+ // the interpreter is hoisting the variable
+ // declaration to the top of the scope,
+ // which means our example could be rewritten as:
+ function example() {
+ let declaredButNotAssigned;
+ console.log(declaredButNotAssigned); // => undefined
+ declaredButNotAssigned = true;
+ }
+
+ // using const and let
+ function example() {
+ console.log(declaredButNotAssigned); // => throws a ReferenceError
+ console.log(typeof declaredButNotAssigned); // => throws a ReferenceError
+ const declaredButNotAssigned = true;
+ }
+ ```
+
+
+
+- [14.2](#hoisting--anon-expressions) Anonymous function expressions hoist their variable name, but not the function assignment.
+
+ ```javascript
+ function example() {
+ console.log(anonymous); // => undefined
+
+ anonymous(); // => TypeError anonymous is not a function
+
+ var anonymous = function () {
+ console.log("anonymous function expression");
+ };
+ }
+ ```
- ```javascript
- // we know this wouldn’t work (assuming there
- // is no notDefined global variable)
- function example() {
- console.log(notDefined); // => throws a ReferenceError
- }
+
- // creating a variable declaration after you
- // reference the variable will work due to
- // variable hoisting. Note: the assignment
- // value of `true` is not hoisted.
- function example() {
- console.log(declaredButNotAssigned); // => undefined
- var declaredButNotAssigned = true;
- }
+- [14.3](#hoisting--named-expressions) Named function expressions hoist the variable name, not the function name or the function body.
- // the interpreter is hoisting the variable
- // declaration to the top of the scope,
- // which means our example could be rewritten as:
- function example() {
- let declaredButNotAssigned;
- console.log(declaredButNotAssigned); // => undefined
- declaredButNotAssigned = true;
- }
+ ```javascript
+ function example() {
+ console.log(named); // => undefined
- // using const and let
- function example() {
- console.log(declaredButNotAssigned); // => throws a ReferenceError
- console.log(typeof declaredButNotAssigned); // => throws a ReferenceError
- const declaredButNotAssigned = true;
- }
- ```
+ named(); // => TypeError named is not a function
-
- - [14.2](#hoisting--anon-expressions) Anonymous function expressions hoist their variable name, but not the function assignment.
+ superPower(); // => ReferenceError superPower is not defined
- ```javascript
- function example() {
- console.log(anonymous); // => undefined
+ var named = function superPower() {
+ console.log("Flying");
+ };
+ }
- anonymous(); // => TypeError anonymous is not a function
+ // the same is true when the function name
+ // is the same as the variable name.
+ function example() {
+ console.log(named); // => undefined
- var anonymous = function () {
- console.log('anonymous function expression');
- };
- }
- ```
+ named(); // => TypeError named is not a function
-
- - [14.3](#hoisting--named-expressions) Named function expressions hoist the variable name, not the function name or the function body.
+ var named = function named() {
+ console.log("named");
+ };
+ }
+ ```
- ```javascript
- function example() {
- console.log(named); // => undefined
+
- named(); // => TypeError named is not a function
+- [14.4](#hoisting--declarations) Function declarations hoist their name and the function body.
- superPower(); // => ReferenceError superPower is not defined
+ ```javascript
+ function example() {
+ superPower(); // => Flying
- var named = function superPower() {
- console.log('Flying');
- };
+ function superPower() {
+ console.log("Flying");
}
+ }
+ ```
- // the same is true when the function name
- // is the same as the variable name.
- function example() {
- console.log(named); // => undefined
+
- named(); // => TypeError named is not a function
+- [14.5](#no-use-before-define) Variables, classes, and functions should be defined before they can be used. eslint: [`no-use-before-define`](https://eslint.org/docs/latest/rules/no-use-before-define)
- var named = function named() {
- console.log('named');
- };
- }
- ```
+ > Why? When variables, classes, or functions are declared after being used, it can harm readability since a reader won't know what a thing that's referenced is. It's much clearer for a reader to first encounter the source of a thing (whether imported from another module, or defined in the file) before encountering a use of the thing.
-
- - [14.4](#hoisting--declarations) Function declarations hoist their name and the function body.
+ ```javascript
+ // bad
- ```javascript
- function example() {
- superPower(); // => Flying
+ // Variable a is being used before it is being defined.
+ console.log(a); // this will be undefined, since while the declaration is hoisted, the initialization is not
+ var a = 10;
- function superPower() {
- console.log('Flying');
- }
- }
- ```
+ // Function fun is being called before being defined.
+ fun();
+ function fun() {}
-
- - [14.5](#no-use-before-define) Variables, classes, and functions should be defined before they can be used. eslint: [`no-use-before-define`](https://eslint.org/docs/latest/rules/no-use-before-define)
+ // Class A is being used before being defined.
+ new A(); // ReferenceError: Cannot access 'A' before initialization
+ class A {}
- > Why? When variables, classes, or functions are declared after being used, it can harm readability since a reader won't know what a thing that's referenced is. It's much clearer for a reader to first encounter the source of a thing (whether imported from another module, or defined in the file) before encountering a use of the thing.
+ // `let` and `const` are hoisted, but they don't have a default initialization.
+ // The variables 'a' and 'b' are in a Temporal Dead Zone where JavaScript
+ // knows they exist (declaration is hoisted) but they are not accessible
+ // (as they are not yet initialized).
- ```javascript
- // bad
+ console.log(a); // ReferenceError: Cannot access 'a' before initialization
+ console.log(b); // ReferenceError: Cannot access 'b' before initialization
+ let a = 10;
+ const b = 5;
- // Variable a is being used before it is being defined.
- console.log(a); // this will be undefined, since while the declaration is hoisted, the initialization is not
- var a = 10;
+ // good
- // Function fun is being called before being defined.
- fun();
- function fun() {}
+ var a = 10;
+ console.log(a); // 10
- // Class A is being used before being defined.
- new A(); // ReferenceError: Cannot access 'A' before initialization
- class A {
- }
+ function fun() {}
+ fun();
- // `let` and `const` are hoisted, but they don't have a default initialization.
- // The variables 'a' and 'b' are in a Temporal Dead Zone where JavaScript
- // knows they exist (declaration is hoisted) but they are not accessible
- // (as they are not yet initialized).
+ class A {}
+ new A();
- console.log(a); // ReferenceError: Cannot access 'a' before initialization
- console.log(b); // ReferenceError: Cannot access 'b' before initialization
- let a = 10;
- const b = 5;
+ let a = 10;
+ const b = 5;
+ console.log(a); // 10
+ console.log(b); // 5
+ ```
+- For more information refer to [JavaScript Scoping & Hoisting](https://www.adequatelygood.com/2010/2/JavaScript-Scoping-and-Hoisting/) by [Ben Cherry](https://www.adequatelygood.com/).
- // good
+**[⬆ back to top](#table-of-contents)**
- var a = 10;
- console.log(a); // 10
+## Comparison Operators & Equality
- function fun() {}
- fun();
+
- class A {
- }
- new A();
+- [15.1](#comparison--eqeqeq) Use `===` and `!==` over `==` and `!=`. eslint: [`eqeqeq`](https://eslint.org/docs/rules/eqeqeq)
- let a = 10;
- const b = 5;
- console.log(a); // 10
- console.log(b); // 5
- ```
+
- - For more information refer to [JavaScript Scoping & Hoisting](https://www.adequatelygood.com/2010/2/JavaScript-Scoping-and-Hoisting/) by [Ben Cherry](https://www.adequatelygood.com/).
+- [15.2](#comparison--if) Conditional statements such as the `if` statement evaluate their expression using coercion with the `ToBoolean` abstract method and always follow these simple rules:
-**[⬆ back to top](#table-of-contents)**
+ - **Objects** evaluate to **true**
+ - **Undefined** evaluates to **false**
+ - **Null** evaluates to **false**
+ - **Booleans** evaluate to **the value of the boolean**
+ - **Numbers** evaluate to **false** if **+0, -0, or NaN**, otherwise **true**
+ - **Strings** evaluate to **false** if an empty string `''`, otherwise **true**
-## Comparison Operators & Equality
+ ```javascript
+ if ([0] && []) {
+ // true
+ // an array (even an empty one) is an object, objects will evaluate to true
+ }
+ ```
-
- - [15.1](#comparison--eqeqeq) Use `===` and `!==` over `==` and `!=`. eslint: [`eqeqeq`](https://eslint.org/docs/rules/eqeqeq)
+
-
- - [15.2](#comparison--if) Conditional statements such as the `if` statement evaluate their expression using coercion with the `ToBoolean` abstract method and always follow these simple rules:
+- [15.3](#comparison--shortcuts) Use shortcuts for booleans, but explicit comparisons for strings and numbers.
- - **Objects** evaluate to **true**
- - **Undefined** evaluates to **false**
- - **Null** evaluates to **false**
- - **Booleans** evaluate to **the value of the boolean**
- - **Numbers** evaluate to **false** if **+0, -0, or NaN**, otherwise **true**
- - **Strings** evaluate to **false** if an empty string `''`, otherwise **true**
+ ```javascript
+ // bad
+ if (isValid === true) {
+ // ...
+ }
- ```javascript
- if ([0] && []) {
- // true
- // an array (even an empty one) is an object, objects will evaluate to true
- }
- ```
+ // good
+ if (isValid) {
+ // ...
+ }
-
- - [15.3](#comparison--shortcuts) Use shortcuts for booleans, but explicit comparisons for strings and numbers.
+ // bad
+ if (name) {
+ // ...
+ }
- ```javascript
- // bad
- if (isValid === true) {
- // ...
- }
+ // good
+ if (name !== "") {
+ // ...
+ }
- // good
- if (isValid) {
- // ...
- }
+ // bad
+ if (collection.length) {
+ // ...
+ }
- // bad
- if (name) {
- // ...
- }
+ // good
+ if (collection.length > 0) {
+ // ...
+ }
+ ```
- // good
- if (name !== '') {
- // ...
- }
+
- // bad
- if (collection.length) {
- // ...
- }
+- [15.4](#comparison--moreinfo) For more information see [Truth, Equality, and JavaScript](https://javascriptweblog.wordpress.com/2011/02/07/truth-equality-and-javascript/#more-2108) by Angus Croll.
- // good
- if (collection.length > 0) {
- // ...
- }
- ```
-
-
- - [15.4](#comparison--moreinfo) For more information see [Truth, Equality, and JavaScript](https://javascriptweblog.wordpress.com/2011/02/07/truth-equality-and-javascript/#more-2108) by Angus Croll.
-
-
- - [15.5](#comparison--switch-blocks) Use braces to create blocks in `case` and `default` clauses that contain lexical declarations (e.g. `let`, `const`, `function`, and `class`). eslint: [`no-case-declarations`](https://eslint.org/docs/rules/no-case-declarations)
-
- > Why? Lexical declarations are visible in the entire `switch` block but only get initialized when assigned, which only happens when its `case` is reached. This causes problems when multiple `case` clauses attempt to define the same thing.
-
- ```javascript
- // bad
- switch (foo) {
- case 1:
- let x = 1;
- break;
- case 2:
- const y = 2;
- break;
- case 3:
- function f() {
- // ...
- }
- break;
- default:
- class C {}
- }
+
- // good
- switch (foo) {
- case 1: {
- let x = 1;
- break;
- }
- case 2: {
- const y = 2;
- break;
- }
- case 3: {
- function f() {
- // ...
- }
- break;
+- [15.5](#comparison--switch-blocks) Use braces to create blocks in `case` and `default` clauses that contain lexical declarations (e.g. `let`, `const`, `function`, and `class`). eslint: [`no-case-declarations`](https://eslint.org/docs/rules/no-case-declarations)
+
+ > Why? Lexical declarations are visible in the entire `switch` block but only get initialized when assigned, which only happens when its `case` is reached. This causes problems when multiple `case` clauses attempt to define the same thing.
+
+ ```javascript
+ // bad
+ switch (foo) {
+ case 1:
+ let x = 1;
+ break;
+ case 2:
+ const y = 2;
+ break;
+ case 3:
+ function f() {
+ // ...
}
- case 4:
- bar();
- break;
- default: {
- class C {}
+ break;
+ default:
+ class C {}
+ }
+
+ // good
+ switch (foo) {
+ case 1: {
+ let x = 1;
+ break;
+ }
+ case 2: {
+ const y = 2;
+ break;
+ }
+ case 3: {
+ function f() {
+ // ...
}
+ break;
+ }
+ case 4:
+ bar();
+ break;
+ default: {
+ class C {}
}
- ```
-
-
- - [15.6](#comparison--nested-ternaries) Ternaries should not be nested and generally be single line expressions. eslint: [`no-nested-ternary`](https://eslint.org/docs/rules/no-nested-ternary)
-
- ```javascript
- // bad
- const foo = maybe1 > maybe2
- ? "bar"
- : value1 > value2 ? "baz" : null;
-
- // split into 2 separated ternary expressions
- const maybeNull = value1 > value2 ? 'baz' : null;
-
- // better
- const foo = maybe1 > maybe2
- ? 'bar'
- : maybeNull;
-
- // best
- const foo = maybe1 > maybe2 ? 'bar' : maybeNull;
- ```
-
-
- - [15.7](#comparison--unneeded-ternary) Avoid unneeded ternary statements. eslint: [`no-unneeded-ternary`](https://eslint.org/docs/rules/no-unneeded-ternary)
-
- ```javascript
- // bad
- const foo = a ? a : b;
- const bar = c ? true : false;
- const baz = c ? false : true;
- const quux = a != null ? a : b;
-
- // good
- const foo = a || b;
- const bar = !!c;
- const baz = !c;
- const quux = a ?? b;
- ```
-
-
- - [15.8](#comparison--no-mixed-operators) When mixing operators, enclose them in parentheses. The only exception is the standard arithmetic operators: `+`, `-`, and `**` since their precedence is broadly understood. We recommend enclosing `/` and `*` in parentheses because their precedence can be ambiguous when they are mixed.
+ }
+ ```
+
+
+
+- [15.6](#comparison--nested-ternaries) Ternaries should not be nested and generally be single line expressions. eslint: [`no-nested-ternary`](https://eslint.org/docs/rules/no-nested-ternary)
+
+ ```javascript
+ // bad
+ const foo = maybe1 > maybe2 ? "bar" : value1 > value2 ? "baz" : null;
+
+ // split into 2 separated ternary expressions
+ const maybeNull = value1 > value2 ? "baz" : null;
+
+ // better
+ const foo = maybe1 > maybe2 ? "bar" : maybeNull;
+
+ // best
+ const foo = maybe1 > maybe2 ? "bar" : maybeNull;
+ ```
+
+
+
+- [15.7](#comparison--unneeded-ternary) Avoid unneeded ternary statements. eslint: [`no-unneeded-ternary`](https://eslint.org/docs/rules/no-unneeded-ternary)
+
+ ```javascript
+ // bad
+ const foo = a ? a : b;
+ const bar = c ? true : false;
+ const baz = c ? false : true;
+ const quux = a != null ? a : b;
+
+ // good
+ const foo = a || b;
+ const bar = !!c;
+ const baz = !c;
+ const quux = a ?? b;
+ ```
+
+
+
+- [15.8](#comparison--no-mixed-operators) When mixing operators, enclose them in parentheses. The only exception is the standard arithmetic operators: `+`, `-`, and `**` since their precedence is broadly understood. We recommend enclosing `/` and `*` in parentheses because their precedence can be ambiguous when they are mixed.
eslint: [`no-mixed-operators`](https://eslint.org/docs/rules/no-mixed-operators)
- > Why? This improves readability and clarifies the developer’s intention.
+ > Why? This improves readability and clarifies the developer’s intention.
- ```javascript
- // bad
- const foo = a && b < 0 || c > 0 || d + 1 === 0;
+ ```javascript
+ // bad
+ const foo = (a && b < 0) || c > 0 || d + 1 === 0;
- // bad
- const bar = a ** b - 5 % d;
+ // bad
+ const bar = a ** b - (5 % d);
- // bad
- // one may be confused into thinking (a || b) && c
- if (a || b && c) {
- return d;
- }
+ // bad
+ // one may be confused into thinking (a || b) && c
+ if (a || (b && c)) {
+ return d;
+ }
- // bad
- const bar = a + b / c * d;
+ // bad
+ const bar = a + (b / c) * d;
- // good
- const foo = (a && b < 0) || c > 0 || (d + 1 === 0);
+ // good
+ const foo = (a && b < 0) || c > 0 || d + 1 === 0;
- // good
- const bar = a ** b - (5 % d);
+ // good
+ const bar = a ** b - (5 % d);
- // good
- if (a || (b && c)) {
- return d;
- }
+ // good
+ if (a || (b && c)) {
+ return d;
+ }
- // good
- const bar = a + (b / c) * d;
- ```
+ // good
+ const bar = a + (b / c) * d;
+ ```
-
- - [15.9](#nullish-coalescing-operator) The nullish coalescing operator (`??`) is a logical operator that returns its right-hand side operand when its left-hand side operand is `null` or `undefined`. Otherwise, it returns the left-hand side operand.
+
- > Why? It provides precision by distinguishing null/undefined from other falsy values, enhancing code clarity and predictability.
+- [15.9](#nullish-coalescing-operator) The nullish coalescing operator (`??`) is a logical operator that returns its right-hand side operand when its left-hand side operand is `null` or `undefined`. Otherwise, it returns the left-hand side operand.
- ```javascript
- // bad
- const value = 0 ?? 'default';
- // returns 0, not 'default'
+ > Why? It provides precision by distinguishing null/undefined from other falsy values, enhancing code clarity and predictability.
- // bad
- const value = '' ?? 'default';
- // returns '', not 'default'
+ ```javascript
+ // bad
+ const value = 0 ?? "default";
+ // returns 0, not 'default'
- // good
- const value = null ?? 'default';
- // returns 'default'
+ // bad
+ const value = "" ?? "default";
+ // returns '', not 'default'
- // good
- const user = {
- name: 'John',
- age: null
- };
- const age = user.age ?? 18;
- // returns 18
- ```
+ // good
+ const value = null ?? "default";
+ // returns 'default'
+
+ // good
+ const user = {
+ name: "John",
+ age: null,
+ };
+ const age = user.age ?? 18;
+ // returns 18
+ ```
**[⬆ back to top](#table-of-contents)**
## Blocks
-
- - [16.1](#blocks--braces) Use braces with all multiline blocks. eslint: [`nonblock-statement-body-position`](https://eslint.org/docs/rules/nonblock-statement-body-position)
+
- ```javascript
- // bad
- if (test)
- return false;
+- [16.1](#blocks--braces) Use braces with all multiline blocks. eslint: [`nonblock-statement-body-position`](https://eslint.org/docs/rules/nonblock-statement-body-position)
- // good
- if (test) return false;
+ ```javascript
+ // bad
+ if (test) return false;
- // good
- if (test) {
- return false;
- }
+ // good
+ if (test) return false;
- // bad
- function foo() { return false; }
+ // good
+ if (test) {
+ return false;
+ }
- // good
- function bar() {
- return false;
- }
- ```
+ // bad
+ function foo() {
+ return false;
+ }
-
- - [16.2](#blocks--cuddled-elses) If you’re using multiline blocks with `if` and `else`, put `else` on the same line as your `if` block’s closing brace. eslint: [`brace-style`](https://eslint.org/docs/rules/brace-style)
+ // good
+ function bar() {
+ return false;
+ }
+ ```
- ```javascript
- // bad
- if (test) {
- thing1();
- thing2();
- }
- else {
- thing3();
- }
+
+
+- [16.2](#blocks--cuddled-elses) If you’re using multiline blocks with `if` and `else`, put `else` on the same line as your `if` block’s closing brace. eslint: [`brace-style`](https://eslint.org/docs/rules/brace-style)
+
+ ```javascript
+ // bad
+ if (test) {
+ thing1();
+ thing2();
+ } else {
+ thing3();
+ }
- // good
- if (test) {
- thing1();
- thing2();
+ // good
+ if (test) {
+ thing1();
+ thing2();
+ } else {
+ thing3();
+ }
+ ```
+
+
+
+- [16.3](#blocks--no-else-return) If an `if` block always executes a `return` statement, the subsequent `else` block is unnecessary. A `return` in an `else if` block following an `if` block that contains a `return` can be separated into multiple `if` blocks. eslint: [`no-else-return`](https://eslint.org/docs/rules/no-else-return)
+
+ ```javascript
+ // bad
+ function foo() {
+ if (x) {
+ return x;
} else {
- thing3();
+ return y;
}
- ```
+ }
-
- - [16.3](#blocks--no-else-return) If an `if` block always executes a `return` statement, the subsequent `else` block is unnecessary. A `return` in an `else if` block following an `if` block that contains a `return` can be separated into multiple `if` blocks. eslint: [`no-else-return`](https://eslint.org/docs/rules/no-else-return)
-
- ```javascript
- // bad
- function foo() {
- if (x) {
- return x;
- } else {
- return y;
- }
+ // bad
+ function cats() {
+ if (x) {
+ return x;
+ } else if (y) {
+ return y;
}
+ }
- // bad
- function cats() {
- if (x) {
- return x;
- } else if (y) {
+ // bad
+ function dogs() {
+ if (x) {
+ return x;
+ } else {
+ if (y) {
return y;
}
}
+ }
- // bad
- function dogs() {
- if (x) {
- return x;
- } else {
- if (y) {
- return y;
- }
- }
+ // good
+ function foo() {
+ if (x) {
+ return x;
}
- // good
- function foo() {
- if (x) {
- return x;
- }
+ return y;
+ }
- return y;
+ // good
+ function cats() {
+ if (x) {
+ return x;
}
- // good
- function cats() {
- if (x) {
- return x;
- }
-
- if (y) {
- return y;
- }
+ if (y) {
+ return y;
}
+ }
- // good
- function dogs(x) {
- if (x) {
- if (z) {
- return y;
- }
- } else {
- return z;
+ // good
+ function dogs(x) {
+ if (x) {
+ if (z) {
+ return y;
}
+ } else {
+ return z;
}
- ```
+ }
+ ```
**[⬆ back to top](#table-of-contents)**
## Control Statements
-
- - [17.1](#control-statements) In case your control statement (`if`, `while` etc.) gets too long or exceeds the maximum line length, each (grouped) condition could be put into a new line. The logical operator should begin the line.
+
- > Why? Requiring operators at the beginning of the line keeps the operators aligned and follows a pattern similar to method chaining. This also improves readability by making it easier to visually follow complex logic.
+- [17.1](#control-statements) In case your control statement (`if`, `while` etc.) gets too long or exceeds the maximum line length, each (grouped) condition could be put into a new line. The logical operator should begin the line.
- ```javascript
- // bad
- if ((foo === 123 || bar === 'abc') && doesItLookGoodWhenItBecomesThatLong() && isThisReallyHappening()) {
- thing1();
- }
+ > Why? Requiring operators at the beginning of the line keeps the operators aligned and follows a pattern similar to method chaining. This also improves readability by making it easier to visually follow complex logic.
- // bad
- if (foo === 123 &&
- bar === 'abc') {
- thing1();
- }
+ ```javascript
+ // bad
+ if ((foo === 123 || bar === "abc") && doesItLookGoodWhenItBecomesThatLong() && isThisReallyHappening()) {
+ thing1();
+ }
- // bad
- if (foo === 123
- && bar === 'abc') {
- thing1();
- }
+ // bad
+ if (foo === 123 && bar === "abc") {
+ thing1();
+ }
- // bad
- if (
- foo === 123 &&
- bar === 'abc'
- ) {
- thing1();
- }
+ // bad
+ if (foo === 123 && bar === "abc") {
+ thing1();
+ }
- // good
- if (
- foo === 123
- && bar === 'abc'
- ) {
- thing1();
- }
+ // bad
+ if (foo === 123 && bar === "abc") {
+ thing1();
+ }
- // good
- if (
- (foo === 123 || bar === 'abc')
- && doesItLookGoodWhenItBecomesThatLong()
- && isThisReallyHappening()
- ) {
- thing1();
- }
+ // good
+ if (foo === 123 && bar === "abc") {
+ thing1();
+ }
- // good
- if (foo === 123 && bar === 'abc') {
- thing1();
- }
- ```
+ // good
+ if ((foo === 123 || bar === "abc") && doesItLookGoodWhenItBecomesThatLong() && isThisReallyHappening()) {
+ thing1();
+ }
-
- - [17.2](#control-statements--value-selection) Don't use selection operators in place of control statements.
+ // good
+ if (foo === 123 && bar === "abc") {
+ thing1();
+ }
+ ```
- ```javascript
- // bad
- !isRunning && startRunning();
+
- // good
- if (!isRunning) {
- startRunning();
- }
- ```
+- [17.2](#control-statements--value-selection) Don't use selection operators in place of control statements.
+
+ ```javascript
+ // bad
+ !isRunning && startRunning();
+
+ // good
+ if (!isRunning) {
+ startRunning();
+ }
+ ```
**[⬆ back to top](#table-of-contents)**
## Comments
-
- - [18.1](#comments--multiline) Use `/** ... */` for multiline comments.
+
- ```javascript
- // bad
- // make() returns a new element
- // based on the passed in tag name
- //
- // @param {String} tag
- // @return {Element} element
- function make(tag) {
+- [18.1](#comments--multiline) Use `/** ... */` for multiline comments.
- // ...
+ ```javascript
+ // bad
+ // make() returns a new element
+ // based on the passed in tag name
+ //
+ // @param {String} tag
+ // @return {Element} element
+ function make(tag) {
+ // ...
- return element;
- }
+ return element;
+ }
- // good
- /**
- * make() returns a new element
- * based on the passed-in tag name
- */
- function make(tag) {
+ // good
+ /**
+ * make() returns a new element
+ * based on the passed-in tag name
+ */
+ function make(tag) {
+ // ...
- // ...
+ return element;
+ }
+ ```
- return element;
- }
- ```
+
-
- - [18.2](#comments--singleline) Use `//` for single line comments. Place single line comments on a newline above the subject of the comment. Put an empty line before the comment unless it’s on the first line of a block.
+- [18.2](#comments--singleline) Use `//` for single line comments. Place single line comments on a newline above the subject of the comment. Put an empty line before the comment unless it’s on the first line of a block.
- ```javascript
- // bad
- const active = true; // is current tab
+ ```javascript
+ // bad
+ const active = true; // is current tab
- // good
- // is current tab
- const active = true;
+ // good
+ // is current tab
+ const active = true;
- // bad
- function getType() {
- console.log('fetching type...');
- // set the default type to 'no type'
- const type = this.type || 'no type';
+ // bad
+ function getType() {
+ console.log("fetching type...");
+ // set the default type to 'no type'
+ const type = this.type || "no type";
- return type;
- }
+ return type;
+ }
- // good
- function getType() {
- console.log('fetching type...');
+ // good
+ function getType() {
+ console.log("fetching type...");
- // set the default type to 'no type'
- const type = this.type || 'no type';
+ // set the default type to 'no type'
+ const type = this.type || "no type";
- return type;
- }
+ return type;
+ }
- // also good
- function getType() {
- // set the default type to 'no type'
- const type = this.type || 'no type';
+ // also good
+ function getType() {
+ // set the default type to 'no type'
+ const type = this.type || "no type";
- return type;
- }
- ```
+ return type;
+ }
+ ```
-
- - [18.3](#comments--spaces) Start all comments with a space to make it easier to read. eslint: [`spaced-comment`](https://eslint.org/docs/rules/spaced-comment)
+
- ```javascript
- // bad
- //is current tab
- const active = true;
+- [18.3](#comments--spaces) Start all comments with a space to make it easier to read. eslint: [`spaced-comment`](https://eslint.org/docs/rules/spaced-comment)
- // good
- // is current tab
- const active = true;
+ ```javascript
+ // bad
+ //is current tab
+ const active = true;
- // bad
- /**
- *make() returns a new element
- *based on the passed-in tag name
- */
- function make(tag) {
+ // good
+ // is current tab
+ const active = true;
- // ...
+ // bad
+ /**
+ *make() returns a new element
+ *based on the passed-in tag name
+ */
+ function make(tag) {
+ // ...
- return element;
- }
+ return element;
+ }
+
+ // good
+ /**
+ * make() returns a new element
+ * based on the passed-in tag name
+ */
+ function make(tag) {
+ // ...
- // good
- /**
- * make() returns a new element
- * based on the passed-in tag name
- */
- function make(tag) {
+ return element;
+ }
+ ```
- // ...
+
- return element;
- }
- ```
+- [18.4](#comments--actionitems) Prefixing your comments with `FIXME` or `TODO` helps other developers quickly understand if you’re pointing out a problem that needs to be revisited, or if you’re suggesting a solution to the problem that needs to be implemented. These are different than regular comments because they are actionable. The actions are `FIXME: -- need to figure this out` or `TODO: -- need to implement`.
-
- - [18.4](#comments--actionitems) Prefixing your comments with `FIXME` or `TODO` helps other developers quickly understand if you’re pointing out a problem that needs to be revisited, or if you’re suggesting a solution to the problem that needs to be implemented. These are different than regular comments because they are actionable. The actions are `FIXME: -- need to figure this out` or `TODO: -- need to implement`.
+
-
- - [18.5](#comments--fixme) Use `// FIXME:` to annotate problems.
+- [18.5](#comments--fixme) Use `// FIXME:` to annotate problems.
- ```javascript
- class Calculator extends Abacus {
- constructor() {
- super();
+ ```javascript
+ class Calculator extends Abacus {
+ constructor() {
+ super();
- // FIXME: shouldn’t use a global here
- total = 0;
- }
+ // FIXME: shouldn’t use a global here
+ total = 0;
}
- ```
+ }
+ ```
-
- - [18.6](#comments--todo) Use `// TODO:` to annotate solutions to problems.
+
- ```javascript
- class Calculator extends Abacus {
- constructor() {
- super();
+- [18.6](#comments--todo) Use `// TODO:` to annotate solutions to problems.
- // TODO: total should be configurable by an options param
- this.total = 0;
- }
+ ```javascript
+ class Calculator extends Abacus {
+ constructor() {
+ super();
+
+ // TODO: total should be configurable by an options param
+ this.total = 0;
}
- ```
+ }
+ ```
**[⬆ back to top](#table-of-contents)**
## Whitespace
-
- - [19.1](#whitespace--spaces) Use soft tabs (space character) set to 2 spaces. eslint: [`indent`](https://eslint.org/docs/rules/indent)
+
- ```javascript
- // bad
- function foo() {
- ∙∙∙∙let name;
- }
+- [19.1](#whitespace--spaces) Use soft tabs (space character) set to 2 spaces. eslint: [`indent`](https://eslint.org/docs/rules/indent)
- // bad
- function bar() {
- ∙let name;
- }
+ ```javascript
+ // bad
+ function foo() {
+ ∙∙∙∙let name;
+ }
- // good
- function baz() {
- ∙∙let name;
- }
- ```
+ // bad
+ function bar() {
+ ∙let name;
+ }
-
- - [19.2](#whitespace--before-blocks) Place 1 space before the leading brace. eslint: [`space-before-blocks`](https://eslint.org/docs/rules/space-before-blocks)
+ // good
+ function baz() {
+ ∙∙let name;
+ }
+ ```
- ```javascript
- // bad
- function test(){
- console.log('test');
- }
+
- // good
- function test() {
- console.log('test');
- }
+- [19.2](#whitespace--before-blocks) Place 1 space before the leading brace. eslint: [`space-before-blocks`](https://eslint.org/docs/rules/space-before-blocks)
- // bad
- dog.set('attr',{
- age: '1 year',
- breed: 'Bernese Mountain Dog',
- });
+ ```javascript
+ // bad
+ function test() {
+ console.log("test");
+ }
- // good
- dog.set('attr', {
- age: '1 year',
- breed: 'Bernese Mountain Dog',
- });
- ```
+ // good
+ function test() {
+ console.log("test");
+ }
-
- - [19.3](#whitespace--around-keywords) Place 1 space before the opening parenthesis in control statements (`if`, `while` etc.). Place no space between the argument list and the function name in function calls and declarations. eslint: [`keyword-spacing`](https://eslint.org/docs/rules/keyword-spacing)
+ // bad
+ dog.set("attr", {
+ age: "1 year",
+ breed: "Bernese Mountain Dog",
+ });
- ```javascript
- // bad
- if(isJedi) {
- fight ();
- }
+ // good
+ dog.set("attr", {
+ age: "1 year",
+ breed: "Bernese Mountain Dog",
+ });
+ ```
- // good
- if (isJedi) {
- fight();
- }
+
- // bad
- function fight () {
- console.log ('Swooosh!');
- }
+- [19.3](#whitespace--around-keywords) Place 1 space before the opening parenthesis in control statements (`if`, `while` etc.). Place no space between the argument list and the function name in function calls and declarations. eslint: [`keyword-spacing`](https://eslint.org/docs/rules/keyword-spacing)
- // good
- function fight() {
- console.log('Swooosh!');
- }
- ```
+ ```javascript
+ // bad
+ if (isJedi) {
+ fight();
+ }
-
- - [19.4](#whitespace--infix-ops) Set off operators with spaces. eslint: [`space-infix-ops`](https://eslint.org/docs/rules/space-infix-ops)
+ // good
+ if (isJedi) {
+ fight();
+ }
- ```javascript
- // bad
- const x=y+5;
+ // bad
+ function fight() {
+ console.log("Swooosh!");
+ }
- // good
- const x = y + 5;
- ```
+ // good
+ function fight() {
+ console.log("Swooosh!");
+ }
+ ```
-
- - [19.5](#whitespace--newline-at-end) End files with a single newline character. eslint: [`eol-last`](https://eslint.org/docs/rules/eol-last)
+
- ```javascript
- // bad
- import { es6 } from './AirbnbStyleGuide';
- // ...
- export default es6;
- ```
+- [19.4](#whitespace--infix-ops) Set off operators with spaces. eslint: [`space-infix-ops`](https://eslint.org/docs/rules/space-infix-ops)
- ```javascript
- // bad
- import { es6 } from './AirbnbStyleGuide';
- // ...
- export default es6;↵
- ↵
- ```
+ ```javascript
+ // bad
+ const x = y + 5;
- ```javascript
- // good
- import { es6 } from './AirbnbStyleGuide';
- // ...
- export default es6;↵
- ```
-
-
- - [19.6](#whitespace--chains) Use indentation when making long method chains (more than 2 method chains). Use a leading dot, which
- emphasizes that the line is a method call, not a new statement. eslint: [`newline-per-chained-call`](https://eslint.org/docs/rules/newline-per-chained-call) [`no-whitespace-before-property`](https://eslint.org/docs/rules/no-whitespace-before-property)
-
- ```javascript
- // bad
- $('#items').find('.selected').highlight().end().find('.open').updateCount();
-
- // bad
- $('#items').
- find('.selected').
- highlight().
- end().
- find('.open').
- updateCount();
-
- // good
- $('#items')
- .find('.selected')
- .highlight()
- .end()
- .find('.open')
- .updateCount();
-
- // bad
- const leds = stage.selectAll('.led').data(data).enter().append('svg:svg').classed('led', true)
- .attr('width', (radius + margin) * 2).append('svg:g')
- .attr('transform', `translate(${radius + margin}, ${radius + margin})`)
- .call(tron.led);
-
- // good
- const leds = stage.selectAll('.led')
- .data(data)
- .enter().append('svg:svg')
- .classed('led', true)
- .attr('width', (radius + margin) * 2)
- .append('svg:g')
- .attr('transform', `translate(${radius + margin}, ${radius + margin})`)
- .call(tron.led);
-
- // good
- const leds = stage.selectAll('.led').data(data);
- const svg = leds.enter().append('svg:svg');
- svg.classed('led', true).attr('width', (radius + margin) * 2);
- const g = svg.append('svg:g');
- g.attr('transform', `translate(${radius + margin}, ${radius + margin})`).call(tron.led);
- ```
-
-
- - [19.7](#whitespace--after-blocks) Leave a blank line after blocks and before the next statement.
-
- ```javascript
- // bad
- if (foo) {
- return bar;
- }
- return baz;
+ // good
+ const x = y + 5;
+ ```
- // good
- if (foo) {
- return bar;
- }
+
- return baz;
+- [19.5](#whitespace--newline-at-end) End files with a single newline character. eslint: [`eol-last`](https://eslint.org/docs/rules/eol-last)
- // bad
- const obj = {
- foo() {
- },
- bar() {
- },
- };
- return obj;
+ ```javascript
+ // bad
+ import { es6 } from "./AirbnbStyleGuide";
+ // ...
+ export default es6;
+ ```
- // good
- const obj = {
- foo() {
- },
+ ```javascript
+ // bad
+ import { es6 } from './AirbnbStyleGuide';
+ // ...
+ export default es6;↵
+ ↵
+ ```
- bar() {
- },
- };
+ ```javascript
+ // good
+ import { es6 } from './AirbnbStyleGuide';
+ // ...
+ export default es6;↵
+ ```
+
+
+
+- [19.6](#whitespace--chains) Use indentation when making long method chains (more than 2 method chains). Use a leading dot, which
+ emphasizes that the line is a method call, not a new statement. eslint: [`newline-per-chained-call`](https://eslint.org/docs/rules/newline-per-chained-call) [`no-whitespace-before-property`](https://eslint.org/docs/rules/no-whitespace-before-property)
+
+ ```javascript
+ // bad
+ $("#items").find(".selected").highlight().end().find(".open").updateCount();
+
+ // bad
+ $("#items").find(".selected").highlight().end().find(".open").updateCount();
+
+ // good
+ $("#items").find(".selected").highlight().end().find(".open").updateCount();
+
+ // bad
+ const leds = stage
+ .selectAll(".led")
+ .data(data)
+ .enter()
+ .append("svg:svg")
+ .classed("led", true)
+ .attr("width", (radius + margin) * 2)
+ .append("svg:g")
+ .attr("transform", `translate(${radius + margin}, ${radius + margin})`)
+ .call(tron.led);
+
+ // good
+ const leds = stage
+ .selectAll(".led")
+ .data(data)
+ .enter()
+ .append("svg:svg")
+ .classed("led", true)
+ .attr("width", (radius + margin) * 2)
+ .append("svg:g")
+ .attr("transform", `translate(${radius + margin}, ${radius + margin})`)
+ .call(tron.led);
+
+ // good
+ const leds = stage.selectAll(".led").data(data);
+ const svg = leds.enter().append("svg:svg");
+ svg.classed("led", true).attr("width", (radius + margin) * 2);
+ const g = svg.append("svg:g");
+ g.attr("transform", `translate(${radius + margin}, ${radius + margin})`).call(tron.led);
+ ```
+
+
+
+- [19.7](#whitespace--after-blocks) Leave a blank line after blocks and before the next statement.
- return obj;
+ ```javascript
+ // bad
+ if (foo) {
+ return bar;
+ }
+ return baz;
- // bad
- const arr = [
- function foo() {
- },
- function bar() {
- },
- ];
- return arr;
+ // good
+ if (foo) {
+ return bar;
+ }
- // good
- const arr = [
- function foo() {
- },
+ return baz;
- function bar() {
- },
- ];
+ // bad
+ const obj = {
+ foo() {},
+ bar() {},
+ };
+ return obj;
- return arr;
- ```
+ // good
+ const obj = {
+ foo() {},
-
- - [19.8](#whitespace--padded-blocks) Do not pad your blocks with blank lines. eslint: [`padded-blocks`](https://eslint.org/docs/rules/padded-blocks)
+ bar() {},
+ };
- ```javascript
- // bad
- function bar() {
+ return obj;
- console.log(foo);
+ // bad
+ const arr = [function foo() {}, function bar() {}];
+ return arr;
- }
+ // good
+ const arr = [function foo() {}, function bar() {}];
- // bad
- if (baz) {
+ return arr;
+ ```
- console.log(quux);
- } else {
- console.log(foo);
+
- }
+- [19.8](#whitespace--padded-blocks) Do not pad your blocks with blank lines. eslint: [`padded-blocks`](https://eslint.org/docs/rules/padded-blocks)
- // bad
- class Foo {
+ ```javascript
+ // bad
+ function bar() {
+ console.log(foo);
+ }
- constructor(bar) {
- this.bar = bar;
- }
- }
+ // bad
+ if (baz) {
+ console.log(quux);
+ } else {
+ console.log(foo);
+ }
- // good
- function bar() {
- console.log(foo);
+ // bad
+ class Foo {
+ constructor(bar) {
+ this.bar = bar;
}
+ }
- // good
- if (baz) {
- console.log(quux);
- } else {
- console.log(foo);
- }
- ```
+ // good
+ function bar() {
+ console.log(foo);
+ }
-
- - [19.9](#whitespace--no-multiple-blanks) Do not use multiple blank lines to pad your code. eslint: [`no-multiple-empty-lines`](https://eslint.org/docs/rules/no-multiple-empty-lines)
+ // good
+ if (baz) {
+ console.log(quux);
+ } else {
+ console.log(foo);
+ }
+ ```
-
- ```javascript
- // bad
- class Person {
- constructor(fullName, email, birthday) {
- this.fullName = fullName;
+
+- [19.9](#whitespace--no-multiple-blanks) Do not use multiple blank lines to pad your code. eslint: [`no-multiple-empty-lines`](https://eslint.org/docs/rules/no-multiple-empty-lines)
- this.email = email;
+
+ ```javascript
+ // bad
+ class Person {
+ constructor(fullName, email, birthday) {
+ this.fullName = fullName;
- this.setAge(birthday);
- }
+ this.email = email;
+ this.setAge(birthday);
+ }
- setAge(birthday) {
- const today = new Date();
+ setAge(birthday) {
+ const today = new Date();
+ const age = this.getAge(today, birthday);
- const age = this.getAge(today, birthday);
+ this.age = age;
+ }
+ getAge(today, birthday) {
+ // ..
+ }
+ }
- this.age = age;
- }
+ // good
+ class Person {
+ constructor(fullName, email, birthday) {
+ this.fullName = fullName;
+ this.email = email;
+ this.setAge(birthday);
+ }
+ setAge(birthday) {
+ const today = new Date();
+ const age = getAge(today, birthday);
+ this.age = age;
+ }
- getAge(today, birthday) {
- // ..
- }
+ getAge(today, birthday) {
+ // ..
}
+ }
+ ```
- // good
- class Person {
- constructor(fullName, email, birthday) {
- this.fullName = fullName;
- this.email = email;
- this.setAge(birthday);
- }
+
- setAge(birthday) {
- const today = new Date();
- const age = getAge(today, birthday);
- this.age = age;
- }
+- [19.10](#whitespace--in-parens) Do not add spaces inside parentheses. eslint: [`space-in-parens`](https://eslint.org/docs/rules/space-in-parens)
- getAge(today, birthday) {
- // ..
- }
- }
- ```
+ ```javascript
+ // bad
+ function bar(foo) {
+ return foo;
+ }
-
- - [19.10](#whitespace--in-parens) Do not add spaces inside parentheses. eslint: [`space-in-parens`](https://eslint.org/docs/rules/space-in-parens)
+ // good
+ function bar(foo) {
+ return foo;
+ }
- ```javascript
- // bad
- function bar( foo ) {
- return foo;
- }
+ // bad
+ if (foo) {
+ console.log(foo);
+ }
- // good
- function bar(foo) {
- return foo;
- }
+ // good
+ if (foo) {
+ console.log(foo);
+ }
+ ```
- // bad
- if ( foo ) {
- console.log(foo);
- }
+
- // good
- if (foo) {
- console.log(foo);
- }
- ```
-
-
- - [19.11](#whitespace--in-brackets) Do not add spaces inside brackets. eslint: [`array-bracket-spacing`](https://eslint.org/docs/rules/array-bracket-spacing)
-
- ```javascript
- // bad
- const foo = [ 1, 2, 3 ];
- console.log(foo[ 0 ]);
-
- // good
- const foo = [1, 2, 3];
- console.log(foo[0]);
- ```
-
-
- - [19.12](#whitespace--in-braces) Add spaces inside curly braces. eslint: [`object-curly-spacing`](https://eslint.org/docs/rules/object-curly-spacing)
-
- ```javascript
- // bad
- const foo = {clark: 'kent'};
-
- // good
- const foo = { clark: 'kent' };
- ```
-
-
- - [19.13](#whitespace--max-len) Avoid having lines of code that are longer than 100 characters (including whitespace). Note: per [above](#strings--line-length), long strings are exempt from this rule, and should not be broken up. eslint: [`max-len`](https://eslint.org/docs/rules/max-len)
-
- > Why? This ensures readability and maintainability.
-
- ```javascript
- // bad
- const foo = jsonData && jsonData.foo && jsonData.foo.bar && jsonData.foo.bar.baz && jsonData.foo.bar.baz.quux && jsonData.foo.bar.baz.quux.xyzzy;
-
- // bad
- $.ajax({ method: 'POST', url: 'https://airbnb.com/', data: { name: 'John' } }).done(() => console.log('Congratulations!')).fail(() => console.log('You have failed this city.'));
-
- // good
- const foo = jsonData
- && jsonData.foo
- && jsonData.foo.bar
- && jsonData.foo.bar.baz
- && jsonData.foo.bar.baz.quux
- && jsonData.foo.bar.baz.quux.xyzzy;
-
- // better
- const foo = jsonData
- ?.foo
- ?.bar
- ?.baz
- ?.quux
- ?.xyzzy;
+- [19.11](#whitespace--in-brackets) Do not add spaces inside brackets. eslint: [`array-bracket-spacing`](https://eslint.org/docs/rules/array-bracket-spacing)
- // good
- $.ajax({
- method: 'POST',
- url: 'https://airbnb.com/',
- data: { name: 'John' },
- })
- .done(() => console.log('Congratulations!'))
- .fail(() => console.log('You have failed this city.'));
- ```
+ ```javascript
+ // bad
+ const foo = [1, 2, 3];
+ console.log(foo[0]);
-
- - [19.14](#whitespace--block-spacing) Require consistent spacing inside an open block token and the next token on the same line. This rule also enforces consistent spacing inside a close block token and previous token on the same line. eslint: [`block-spacing`](https://eslint.org/docs/rules/block-spacing)
+ // good
+ const foo = [1, 2, 3];
+ console.log(foo[0]);
+ ```
- ```javascript
- // bad
- function foo() {return true;}
- if (foo) { bar = 0;}
+
- // good
- function foo() { return true; }
- if (foo) { bar = 0; }
- ```
+- [19.12](#whitespace--in-braces) Add spaces inside curly braces. eslint: [`object-curly-spacing`](https://eslint.org/docs/rules/object-curly-spacing)
-
- - [19.15](#whitespace--comma-spacing) Avoid spaces before commas and require a space after commas. eslint: [`comma-spacing`](https://eslint.org/docs/rules/comma-spacing)
+ ```javascript
+ // bad
+ const foo = { clark: "kent" };
- ```javascript
- // bad
- const foo = 1,bar = 2;
- const arr = [1 , 2];
+ // good
+ const foo = { clark: "kent" };
+ ```
- // good
- const foo = 1, bar = 2;
- const arr = [1, 2];
- ```
+
-
- - [19.16](#whitespace--computed-property-spacing) Enforce spacing inside of computed property brackets. eslint: [`computed-property-spacing`](https://eslint.org/docs/rules/computed-property-spacing)
+- [19.13](#whitespace--max-len) Avoid having lines of code that are longer than 100 characters (including whitespace). Note: per [above](#strings--line-length), long strings are exempt from this rule, and should not be broken up. eslint: [`max-len`](https://eslint.org/docs/rules/max-len)
- ```javascript
- // bad
- obj[foo ]
- obj[ 'foo']
- const x = {[ b ]: a}
- obj[foo[ bar ]]
+ > Why? This ensures readability and maintainability.
- // good
- obj[foo]
- obj['foo']
- const x = { [b]: a }
- obj[foo[bar]]
- ```
+ ```javascript
+ // bad
+ const foo = jsonData && jsonData.foo && jsonData.foo.bar && jsonData.foo.bar.baz && jsonData.foo.bar.baz.quux && jsonData.foo.bar.baz.quux.xyzzy;
-
- - [19.17](#whitespace--func-call-spacing) Avoid spaces between functions and their invocations. eslint: [`func-call-spacing`](https://eslint.org/docs/rules/func-call-spacing)
+ // bad
+ $.ajax({ method: "POST", url: "https://airbnb.com/", data: { name: "John" } })
+ .done(() => console.log("Congratulations!"))
+ .fail(() => console.log("You have failed this city."));
- ```javascript
- // bad
- func ();
+ // good
+ const foo = jsonData && jsonData.foo && jsonData.foo.bar && jsonData.foo.bar.baz && jsonData.foo.bar.baz.quux && jsonData.foo.bar.baz.quux.xyzzy;
- func
- ();
+ // better
+ const foo = jsonData?.foo?.bar?.baz?.quux?.xyzzy;
- // good
- func();
- ```
+ // good
+ $.ajax({
+ method: "POST",
+ url: "https://airbnb.com/",
+ data: { name: "John" },
+ })
+ .done(() => console.log("Congratulations!"))
+ .fail(() => console.log("You have failed this city."));
+ ```
-
- - [19.18](#whitespace--key-spacing) Enforce spacing between keys and values in object literal properties. eslint: [`key-spacing`](https://eslint.org/docs/rules/key-spacing)
+
- ```javascript
- // bad
- const obj = { foo : 42 };
- const obj2 = { foo:42 };
+- [19.14](#whitespace--block-spacing) Require consistent spacing inside an open block token and the next token on the same line. This rule also enforces consistent spacing inside a close block token and previous token on the same line. eslint: [`block-spacing`](https://eslint.org/docs/rules/block-spacing)
- // good
- const obj = { foo: 42 };
- ```
-
-
- - [19.19](#whitespace--no-trailing-spaces) Avoid trailing spaces at the end of lines. eslint: [`no-trailing-spaces`](https://eslint.org/docs/rules/no-trailing-spaces)
-
-
- - [19.20](#whitespace--no-multiple-empty-lines) Avoid multiple empty lines, only allow one newline at the end of files, and avoid a newline at the beginning of files. eslint: [`no-multiple-empty-lines`](https://eslint.org/docs/rules/no-multiple-empty-lines)
-
-
- ```javascript
- // bad - multiple empty lines
- const x = 1;
+ ```javascript
+ // bad
+ function foo() {
+ return true;
+ }
+ if (foo) {
+ bar = 0;
+ }
+ // good
+ function foo() {
+ return true;
+ }
+ if (foo) {
+ bar = 0;
+ }
+ ```
- const y = 2;
+
- // bad - 2+ newlines at end of file
- const x = 1;
- const y = 2;
+- [19.15](#whitespace--comma-spacing) Avoid spaces before commas and require a space after commas. eslint: [`comma-spacing`](https://eslint.org/docs/rules/comma-spacing)
+ ```javascript
+ // bad
+ const foo = 1,
+ bar = 2;
+ const arr = [1, 2];
- // bad - 1+ newline(s) at beginning of file
+ // good
+ const foo = 1,
+ bar = 2;
+ const arr = [1, 2];
+ ```
- const x = 1;
- const y = 2;
+
- // good
- const x = 1;
- const y = 2;
+- [19.16](#whitespace--computed-property-spacing) Enforce spacing inside of computed property brackets. eslint: [`computed-property-spacing`](https://eslint.org/docs/rules/computed-property-spacing)
- ```
-
+ ```javascript
+ // bad
+ obj[foo];
+ obj["foo"];
+ const x = { [b]: a };
+ obj[foo[bar]];
-**[⬆ back to top](#table-of-contents)**
+ // good
+ obj[foo];
+ obj["foo"];
+ const x = { [b]: a };
+ obj[foo[bar]];
+ ```
-## Commas
+
-
- - [20.1](#commas--leading-trailing) Leading commas: **Nope.** eslint: [`comma-style`](https://eslint.org/docs/rules/comma-style)
-
- ```javascript
- // bad
- const story = [
- once
- , upon
- , aTime
- ];
-
- // good
- const story = [
- once,
- upon,
- aTime,
- ];
-
- // bad
- const hero = {
- firstName: 'Ada'
- , lastName: 'Lovelace'
- , birthYear: 1815
- , superPower: 'computers'
- };
+- [19.17](#whitespace--func-call-spacing) Avoid spaces between functions and their invocations. eslint: [`func-call-spacing`](https://eslint.org/docs/rules/func-call-spacing)
- // good
- const hero = {
- firstName: 'Ada',
- lastName: 'Lovelace',
- birthYear: 1815,
- superPower: 'computers',
- };
- ```
+ ```javascript
+ // bad
+ func();
-
- - [20.2](#commas--dangling) Additional trailing comma: **Yup.** eslint: [`comma-dangle`](https://eslint.org/docs/rules/comma-dangle)
+ func();
- > Why? This leads to cleaner git diffs. Also, transpilers like Babel will remove the additional trailing comma in the transpiled code which means you don’t have to worry about the [trailing comma problem](https://github.com/airbnb/javascript/blob/es5-deprecated/es5/README.md#commas) in legacy browsers.
+ // good
+ func();
+ ```
- ```diff
- // bad - git diff without trailing comma
- const hero = {
- firstName: 'Florence',
- - lastName: 'Nightingale'
- + lastName: 'Nightingale',
- + inventorOf: ['coxcomb chart', 'modern nursing']
- };
+
- // good - git diff with trailing comma
- const hero = {
- firstName: 'Florence',
- lastName: 'Nightingale',
- + inventorOf: ['coxcomb chart', 'modern nursing'],
- };
- ```
+- [19.18](#whitespace--key-spacing) Enforce spacing between keys and values in object literal properties. eslint: [`key-spacing`](https://eslint.org/docs/rules/key-spacing)
- ```javascript
- // bad
- const hero = {
- firstName: 'Dana',
- lastName: 'Scully'
- };
+ ```javascript
+ // bad
+ const obj = { foo: 42 };
+ const obj2 = { foo: 42 };
- const heroes = [
- 'Batman',
- 'Superman'
- ];
+ // good
+ const obj = { foo: 42 };
+ ```
- // good
- const hero = {
- firstName: 'Dana',
- lastName: 'Scully',
- };
+
- const heroes = [
- 'Batman',
- 'Superman',
- ];
-
- // bad
- function createHero(
- firstName,
- lastName,
- inventorOf
- ) {
- // does nothing
- }
+- [19.19](#whitespace--no-trailing-spaces) Avoid trailing spaces at the end of lines. eslint: [`no-trailing-spaces`](https://eslint.org/docs/rules/no-trailing-spaces)
- // good
- function createHero(
- firstName,
- lastName,
- inventorOf,
- ) {
- // does nothing
- }
+
- // good (note that a comma must not appear after a "rest" element)
- function createHero(
- firstName,
- lastName,
- inventorOf,
- ...heroArgs
- ) {
- // does nothing
- }
+- [19.20](#whitespace--no-multiple-empty-lines) Avoid multiple empty lines, only allow one newline at the end of files, and avoid a newline at the beginning of files. eslint: [`no-multiple-empty-lines`](https://eslint.org/docs/rules/no-multiple-empty-lines)
+
+
+
+ ```javascript
+ // bad - multiple empty lines
+ const x = 1;
+
+ const y = 2;
+
+ // bad - 2+ newlines at end of file
+ const x = 1;
+ const y = 2;
+
+ // bad - 1+ newline(s) at beginning of file
+
+ const x = 1;
+ const y = 2;
+
+ // good
+ const x = 1;
+ const y = 2;
+ ```
- // bad
- createHero(
- firstName,
- lastName,
- inventorOf
- );
-
- // good
- createHero(
- firstName,
- lastName,
- inventorOf,
- );
-
- // good (note that a comma must not appear after a "rest" element)
- createHero(
- firstName,
- lastName,
- inventorOf,
- ...heroArgs
- );
- ```
+
**[⬆ back to top](#table-of-contents)**
-## Semicolons
+## Commas
-
- - [21.1](#semicolons--required) **Yup.** eslint: [`semi`](https://eslint.org/docs/rules/semi)
+
+
+- [20.1](#commas--leading-trailing) Leading commas: **Nope.** eslint: [`comma-style`](https://eslint.org/docs/rules/comma-style)
+
+ ```javascript
+ // bad
+ const story = [once, upon, aTime];
+
+ // good
+ const story = [once, upon, aTime];
+
+ // bad
+ const hero = {
+ firstName: "Ada",
+ lastName: "Lovelace",
+ birthYear: 1815,
+ superPower: "computers",
+ };
+
+ // good
+ const hero = {
+ firstName: "Ada",
+ lastName: "Lovelace",
+ birthYear: 1815,
+ superPower: "computers",
+ };
+ ```
+
+
+
+- [20.2](#commas--dangling) Additional trailing comma: **Yup.** eslint: [`comma-dangle`](https://eslint.org/docs/rules/comma-dangle)
+
+ > Why? This leads to cleaner git diffs. Also, transpilers like Babel will remove the additional trailing comma in the transpiled code which means you don’t have to worry about the [trailing comma problem](https://github.com/airbnb/javascript/blob/es5-deprecated/es5/README.md#commas) in legacy browsers.
+
+ ```diff
+ // bad - git diff without trailing comma
+ const hero = {
+ firstName: 'Florence',
+ - lastName: 'Nightingale'
+ + lastName: 'Nightingale',
+ + inventorOf: ['coxcomb chart', 'modern nursing']
+ };
+
+ // good - git diff with trailing comma
+ const hero = {
+ firstName: 'Florence',
+ lastName: 'Nightingale',
+ + inventorOf: ['coxcomb chart', 'modern nursing'],
+ };
+ ```
+
+ ```javascript
+ // bad
+ const hero = {
+ firstName: "Dana",
+ lastName: "Scully",
+ };
+
+ const heroes = ["Batman", "Superman"];
+
+ // good
+ const hero = {
+ firstName: "Dana",
+ lastName: "Scully",
+ };
+
+ const heroes = ["Batman", "Superman"];
+
+ // bad
+ function createHero(firstName, lastName, inventorOf) {
+ // does nothing
+ }
+
+ // good
+ function createHero(firstName, lastName, inventorOf) {
+ // does nothing
+ }
+
+ // good (note that a comma must not appear after a "rest" element)
+ function createHero(firstName, lastName, inventorOf, ...heroArgs) {
+ // does nothing
+ }
+
+ // bad
+ createHero(firstName, lastName, inventorOf);
+
+ // good
+ createHero(firstName, lastName, inventorOf);
+
+ // good (note that a comma must not appear after a "rest" element)
+ createHero(firstName, lastName, inventorOf, ...heroArgs);
+ ```
- > Why? When JavaScript encounters a line break without a semicolon, it uses a set of rules called [Automatic Semicolon Insertion](https://tc39.github.io/ecma262/#sec-automatic-semicolon-insertion) to determine whether it should regard that line break as the end of a statement, and (as the name implies) place a semicolon into your code before the line break if it thinks so. ASI contains a few eccentric behaviors, though, and your code will break if JavaScript misinterprets your line break. These rules will become more complicated as new features become a part of JavaScript. Explicitly terminating your statements and configuring your linter to catch missing semicolons will help prevent you from encountering issues.
+**[⬆ back to top](#table-of-contents)**
- ```javascript
- // bad - raises exception
- const luke = {}
- const leia = {}
- [luke, leia].forEach((jedi) => jedi.father = 'vader')
+## Semicolons
- // bad - raises exception
- const reaction = "No! That’s impossible!"
- (async function meanwhileOnTheFalcon() {
- // handle `leia`, `lando`, `chewie`, `r2`, `c3p0`
- // ...
- }())
+
- // bad - returns `undefined` instead of the value on the next line - always happens when `return` is on a line by itself because of ASI!
- function foo() {
- return
- 'search your feelings, you know it to be foo'
- }
+- [21.1](#semicolons--required) **Yup.** eslint: [`semi`](https://eslint.org/docs/rules/semi)
- // good
- const luke = {};
- const leia = {};
- [luke, leia].forEach((jedi) => {
- jedi.father = 'vader';
- });
+ > Why? When JavaScript encounters a line break without a semicolon, it uses a set of rules called [Automatic Semicolon Insertion](https://tc39.github.io/ecma262/#sec-automatic-semicolon-insertion) to determine whether it should regard that line break as the end of a statement, and (as the name implies) place a semicolon into your code before the line break if it thinks so. ASI contains a few eccentric behaviors, though, and your code will break if JavaScript misinterprets your line break. These rules will become more complicated as new features become a part of JavaScript. Explicitly terminating your statements and configuring your linter to catch missing semicolons will help prevent you from encountering issues.
+
+ ```javascript
+ // bad - raises exception
+ const luke = {};
+ const leia = {}[(luke, leia)].forEach((jedi) => (jedi.father = "vader"));
- // good
- const reaction = 'No! That’s impossible!';
+ // bad - raises exception
+ const reaction = "No! That’s impossible!"(
(async function meanwhileOnTheFalcon() {
// handle `leia`, `lando`, `chewie`, `r2`, `c3p0`
// ...
- }());
+ })()
+ );
+
+ // bad - returns `undefined` instead of the value on the next line - always happens when `return` is on a line by itself because of ASI!
+ function foo() {
+ return;
+ ("search your feelings, you know it to be foo");
+ }
+
+ // good
+ const luke = {};
+ const leia = {};
+ [luke, leia].forEach((jedi) => {
+ jedi.father = "vader";
+ });
+
+ // good
+ const reaction = "No! That’s impossible!";
+ (async function meanwhileOnTheFalcon() {
+ // handle `leia`, `lando`, `chewie`, `r2`, `c3p0`
+ // ...
+ })();
- // good
- function foo() {
- return 'search your feelings, you know it to be foo';
- }
- ```
+ // good
+ function foo() {
+ return "search your feelings, you know it to be foo";
+ }
+ ```
- [Read more](https://stackoverflow.com/questions/7365172/semicolon-before-self-invoking-function/7365214#7365214).
+ [Read more](https://stackoverflow.com/questions/7365172/semicolon-before-self-invoking-function/7365214#7365214).
**[⬆ back to top](#table-of-contents)**
## Type Casting & Coercion
-
- - [22.1](#coercion--explicit) Perform type coercion at the beginning of the statement.
+
+
+- [22.1](#coercion--explicit) Perform type coercion at the beginning of the statement.
+
+
+
+- [22.2](#coercion--strings) Strings: eslint: [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers)
+
+ ```javascript
+ // => this.reviewScore = 9;
-
- - [22.2](#coercion--strings) Strings: eslint: [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers)
+ // bad
+ const totalScore = new String(this.reviewScore); // typeof totalScore is "object" not "string"
- ```javascript
- // => this.reviewScore = 9;
+ // bad
+ const totalScore = this.reviewScore + ""; // invokes this.reviewScore.valueOf()
- // bad
- const totalScore = new String(this.reviewScore); // typeof totalScore is "object" not "string"
+ // bad
+ const totalScore = this.reviewScore.toString(); // isn’t guaranteed to return a string
- // bad
- const totalScore = this.reviewScore + ''; // invokes this.reviewScore.valueOf()
+ // good
+ const totalScore = String(this.reviewScore);
+ ```
- // bad
- const totalScore = this.reviewScore.toString(); // isn’t guaranteed to return a string
+
- // good
- const totalScore = String(this.reviewScore);
- ```
+- [22.3](#coercion--numbers) Numbers: Use `Number` for type casting and `parseInt` always with a radix for parsing strings. eslint: [`radix`](https://eslint.org/docs/rules/radix) [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers)
-
- - [22.3](#coercion--numbers) Numbers: Use `Number` for type casting and `parseInt` always with a radix for parsing strings. eslint: [`radix`](https://eslint.org/docs/rules/radix) [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers)
+ > Why? The `parseInt` function produces an integer value dictated by interpretation of the contents of the string argument according to the specified radix. Leading whitespace in string is ignored. If radix is `undefined` or `0`, it is assumed to be `10` except when the number begins with the character pairs `0x` or `0X`, in which case a radix of 16 is assumed. This differs from ECMAScript 3, which merely discouraged (but allowed) octal interpretation. Many implementations have not adopted this behavior as of 2013. And, because older browsers must be supported, always specify a radix.
- > Why? The `parseInt` function produces an integer value dictated by interpretation of the contents of the string argument according to the specified radix. Leading whitespace in string is ignored. If radix is `undefined` or `0`, it is assumed to be `10` except when the number begins with the character pairs `0x` or `0X`, in which case a radix of 16 is assumed. This differs from ECMAScript 3, which merely discouraged (but allowed) octal interpretation. Many implementations have not adopted this behavior as of 2013. And, because older browsers must be supported, always specify a radix.
+ ```javascript
+ const inputValue = "4";
- ```javascript
- const inputValue = '4';
+ // bad
+ const val = new Number(inputValue);
- // bad
- const val = new Number(inputValue);
+ // bad
+ const val = +inputValue;
- // bad
- const val = +inputValue;
+ // bad
+ const val = inputValue >> 0;
- // bad
- const val = inputValue >> 0;
+ // bad
+ const val = parseInt(inputValue);
- // bad
- const val = parseInt(inputValue);
+ // good
+ const val = Number(inputValue);
- // good
- const val = Number(inputValue);
+ // good
+ const val = parseInt(inputValue, 10);
+ ```
- // good
- const val = parseInt(inputValue, 10);
- ```
+
-
- - [22.4](#coercion--comment-deviations) If for whatever reason you are doing something wild and `parseInt` is your bottleneck and need to use Bitshift for [performance reasons](https://web.archive.org/web/20200414205431/https://jsperf.com/coercion-vs-casting/3), leave a comment explaining why and what you’re doing.
+- [22.4](#coercion--comment-deviations) If for whatever reason you are doing something wild and `parseInt` is your bottleneck and need to use Bitshift for [performance reasons](https://web.archive.org/web/20200414205431/https://jsperf.com/coercion-vs-casting/3), leave a comment explaining why and what you’re doing.
- ```javascript
- // good
- /**
- * parseInt was the reason my code was slow.
- * Bitshifting the String to coerce it to a
- * Number made it a lot faster.
- */
- const val = inputValue >> 0;
- ```
+ ```javascript
+ // good
+ /**
+ * parseInt was the reason my code was slow.
+ * Bitshifting the String to coerce it to a
+ * Number made it a lot faster.
+ */
+ const val = inputValue >> 0;
+ ```
-
- - [22.5](#coercion--bitwise) **Note:** Be careful when using bitshift operations. Numbers are represented as [64-bit values](https://es5.github.io/#x4.3.19), but bitshift operations always return a 32-bit integer ([source](https://es5.github.io/#x11.7)). Bitshift can lead to unexpected behavior for integer values larger than 32 bits. [Discussion](https://github.com/airbnb/javascript/issues/109). Largest signed 32-bit Int is 2,147,483,647:
+
- ```javascript
- 2147483647 >> 0; // => 2147483647
- 2147483648 >> 0; // => -2147483648
- 2147483649 >> 0; // => -2147483647
- ```
+- [22.5](#coercion--bitwise) **Note:** Be careful when using bitshift operations. Numbers are represented as [64-bit values](https://es5.github.io/#x4.3.19), but bitshift operations always return a 32-bit integer ([source](https://es5.github.io/#x11.7)). Bitshift can lead to unexpected behavior for integer values larger than 32 bits. [Discussion](https://github.com/airbnb/javascript/issues/109). Largest signed 32-bit Int is 2,147,483,647:
-
- - [22.6](#coercion--booleans) Booleans: eslint: [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers)
+ ```javascript
+ 2147483647 >> 0; // => 2147483647
+ 2147483648 >> 0; // => -2147483648
+ 2147483649 >> 0; // => -2147483647
+ ```
- ```javascript
- const age = 0;
+
- // bad
- const hasAge = new Boolean(age);
+- [22.6](#coercion--booleans) Booleans: eslint: [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers)
- // good
- const hasAge = Boolean(age);
+ ```javascript
+ const age = 0;
- // best
- const hasAge = !!age;
- ```
+ // bad
+ const hasAge = new Boolean(age);
+
+ // good
+ const hasAge = Boolean(age);
+
+ // best
+ const hasAge = !!age;
+ ```
**[⬆ back to top](#table-of-contents)**
## Naming Conventions
-
- - [23.1](#naming--descriptive) Avoid single letter names. Be descriptive with your naming. eslint: [`id-length`](https://eslint.org/docs/rules/id-length)
+
- ```javascript
- // bad
- function q() {
- // ...
- }
+- [23.1](#naming--descriptive) Avoid single letter names. Be descriptive with your naming. eslint: [`id-length`](https://eslint.org/docs/rules/id-length)
- // good
- function query() {
- // ...
- }
- ```
+ ```javascript
+ // bad
+ function q() {
+ // ...
+ }
+
+ // good
+ function query() {
+ // ...
+ }
+ ```
+
+
+
+- [23.2](#naming--camelCase) Use camelCase when naming objects, functions, and instances. eslint: [`camelcase`](https://eslint.org/docs/rules/camelcase)
+
+ ```javascript
+ // bad
+ const OBJEcttsssss = {};
+ const this_is_my_object = {};
+ function c() {}
-
- - [23.2](#naming--camelCase) Use camelCase when naming objects, functions, and instances. eslint: [`camelcase`](https://eslint.org/docs/rules/camelcase)
+ // good
+ const thisIsMyObject = {};
+ function thisIsMyFunction() {}
+ ```
- ```javascript
- // bad
- const OBJEcttsssss = {};
- const this_is_my_object = {};
- function c() {}
+
- // good
- const thisIsMyObject = {};
- function thisIsMyFunction() {}
- ```
+- [23.3](#naming--PascalCase) Use PascalCase only when naming constructors or classes. eslint: [`new-cap`](https://eslint.org/docs/rules/new-cap)
-
- - [23.3](#naming--PascalCase) Use PascalCase only when naming constructors or classes. eslint: [`new-cap`](https://eslint.org/docs/rules/new-cap)
+ ```javascript
+ // bad
+ function user(options) {
+ this.name = options.name;
+ }
- ```javascript
- // bad
- function user(options) {
+ const bad = new user({
+ name: "nope",
+ });
+
+ // good
+ class User {
+ constructor(options) {
this.name = options.name;
}
+ }
- const bad = new user({
- name: 'nope',
- });
+ const good = new User({
+ name: "yup",
+ });
+ ```
- // good
- class User {
- constructor(options) {
- this.name = options.name;
- }
- }
+
- const good = new User({
- name: 'yup',
- });
- ```
-
-
- - [23.4](#naming--leading-underscore) Do not use trailing or leading underscores. eslint: [`no-underscore-dangle`](https://eslint.org/docs/rules/no-underscore-dangle)
-
- > Why? JavaScript does not have the concept of privacy in terms of properties or methods. Although a leading underscore is a common convention to mean “private”, in fact, these properties are fully public, and as such, are part of your public API contract. This convention might lead developers to wrongly think that a change won’t count as breaking, or that tests aren’t needed. tl;dr: if you want something to be “private”, it must not be observably present.
-
- ```javascript
- // bad
- this.__firstName__ = 'Panda';
- this.firstName_ = 'Panda';
- this._firstName = 'Panda';
-
- // good
- this.firstName = 'Panda';
-
- // good, in environments where WeakMaps are available
- // see https://compat-table.github.io/compat-table/es6/#test-WeakMap
- const firstNames = new WeakMap();
- firstNames.set(this, 'Panda');
- ```
-
-
- - [23.5](#naming--self-this) Don’t save references to `this`. Use arrow functions or [Function#bind](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind).
-
- ```javascript
- // bad
- function foo() {
- const self = this;
- return function () {
- console.log(self);
- };
- }
+- [23.4](#naming--leading-underscore) Do not use trailing or leading underscores. eslint: [`no-underscore-dangle`](https://eslint.org/docs/rules/no-underscore-dangle)
- // bad
- function foo() {
- const that = this;
- return function () {
- console.log(that);
- };
- }
+ > Why? JavaScript does not have the concept of privacy in terms of properties or methods. Although a leading underscore is a common convention to mean “private”, in fact, these properties are fully public, and as such, are part of your public API contract. This convention might lead developers to wrongly think that a change won’t count as breaking, or that tests aren’t needed. tl;dr: if you want something to be “private”, it must not be observably present.
- // good
- function foo() {
- return () => {
- console.log(this);
- };
- }
- ```
+ ```javascript
+ // bad
+ this.__firstName__ = "Panda";
+ this.firstName_ = "Panda";
+ this._firstName = "Panda";
-
- - [23.6](#naming--filename-matches-export) A base filename should exactly match the name of its default export.
+ // good
+ this.firstName = "Panda";
- ```javascript
- // file 1 contents
- class CheckBox {
- // ...
- }
- export default CheckBox;
-
- // file 2 contents
- export default function fortyTwo() { return 42; }
-
- // file 3 contents
- export default function insideDirectory() {}
-
- // in some other file
- // bad
- import CheckBox from './checkBox'; // PascalCase import/export, camelCase filename
- import FortyTwo from './FortyTwo'; // PascalCase import/filename, camelCase export
- import InsideDirectory from './InsideDirectory'; // PascalCase import/filename, camelCase export
-
- // bad
- import CheckBox from './check_box'; // PascalCase import/export, snake_case filename
- import forty_two from './forty_two'; // snake_case import/filename, camelCase export
- import inside_directory from './inside_directory'; // snake_case import, camelCase export
- import index from './inside_directory/index'; // requiring the index file explicitly
- import insideDirectory from './insideDirectory/index'; // requiring the index file explicitly
-
- // good
- import CheckBox from './CheckBox'; // PascalCase export/import/filename
- import fortyTwo from './fortyTwo'; // camelCase export/import/filename
- import insideDirectory from './insideDirectory'; // camelCase export/import/directory name/implicit "index"
- // ^ supports both insideDirectory.js and insideDirectory/index.js
- ```
-
-
- - [23.7](#naming--camelCase-default-export) Use camelCase when you export-default a function. Your filename should be identical to your function’s name.
-
- ```javascript
- function makeStyleGuide() {
- // ...
- }
+ // good, in environments where WeakMaps are available
+ // see https://compat-table.github.io/compat-table/es6/#test-WeakMap
+ const firstNames = new WeakMap();
+ firstNames.set(this, "Panda");
+ ```
- export default makeStyleGuide;
- ```
+
-
- - [23.8](#naming--PascalCase-singleton) Use PascalCase when you export a constructor / class / singleton / function library / bare object.
+- [23.5](#naming--self-this) Don’t save references to `this`. Use arrow functions or [Function#bind](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind).
- ```javascript
- const AirbnbStyleGuide = {
- es6: {
- },
+ ```javascript
+ // bad
+ function foo() {
+ const self = this;
+ return function () {
+ console.log(self);
};
+ }
- export default AirbnbStyleGuide;
- ```
+ // bad
+ function foo() {
+ const that = this;
+ return function () {
+ console.log(that);
+ };
+ }
-
- - [23.9](#naming--Acronyms-and-Initialisms) Acronyms and initialisms should always be all uppercased, or all lowercased.
+ // good
+ function foo() {
+ return () => {
+ console.log(this);
+ };
+ }
+ ```
- > Why? Names are for readability, not to appease a computer algorithm.
+
- ```javascript
- // bad
- import SmsContainer from './containers/SmsContainer';
+- [23.6](#naming--filename-matches-export) A base filename should exactly match the name of its default export.
- // bad
- const HttpRequests = [
- // ...
- ];
+ ```javascript
+ // file 1 contents
+ class CheckBox {
+ // ...
+ }
+ export default CheckBox;
- // good
- import SMSContainer from './containers/SMSContainer';
+ // file 2 contents
+ export default function fortyTwo() { return 42; }
- // good
- const HTTPRequests = [
- // ...
- ];
+ // file 3 contents
+ export default function insideDirectory() {}
- // also good
- const httpRequests = [
- // ...
- ];
+ // in some other file
+ // bad
+ import CheckBox from './checkBox'; // PascalCase import/export, camelCase filename
+ import FortyTwo from './FortyTwo'; // PascalCase import/filename, camelCase export
+ import InsideDirectory from './InsideDirectory'; // PascalCase import/filename, camelCase export
- // best
- import TextMessageContainer from './containers/TextMessageContainer';
+ // bad
+ import CheckBox from './check_box'; // PascalCase import/export, snake_case filename
+ import forty_two from './forty_two'; // snake_case import/filename, camelCase export
+ import inside_directory from './inside_directory'; // snake_case import, camelCase export
+ import index from './inside_directory/index'; // requiring the index file explicitly
+ import insideDirectory from './insideDirectory/index'; // requiring the index file explicitly
- // best
- const requests = [
- // ...
- ];
- ```
+ // good
+ import CheckBox from './CheckBox'; // PascalCase export/import/filename
+ import fortyTwo from './fortyTwo'; // camelCase export/import/filename
+ import insideDirectory from './insideDirectory'; // camelCase export/import/directory name/implicit "index"
+ // ^ supports both insideDirectory.js and insideDirectory/index.js
+ ```
+
+
-
- - [23.10](#naming--uppercase) You may optionally uppercase a constant only if it (1) is exported, (2) is a `const` (it can not be reassigned), and (3) the programmer can trust it (and its nested properties) to never change.
+- [23.7](#naming--camelCase-default-export) Use camelCase when you export-default a function. Your filename should be identical to your function’s name.
- > Why? This is an additional tool to assist in situations where the programmer would be unsure if a variable might ever change. UPPERCASE_VARIABLES are letting the programmer know that they can trust the variable (and its properties) not to change.
- - What about all `const` variables? - This is unnecessary, so uppercasing should not be used for constants within a file. It should be used for exported constants however.
- - What about exported objects? - Uppercase at the top level of export (e.g. `EXPORTED_OBJECT.key`) and maintain that all nested properties do not change.
+ ```javascript
+ function makeStyleGuide() {
+ // ...
+ }
- ```javascript
- // bad
- const PRIVATE_VARIABLE = 'should not be unnecessarily uppercased within a file';
+ export default makeStyleGuide;
+ ```
- // bad
- export const THING_TO_BE_CHANGED = 'should obviously not be uppercased';
+
- // bad
- export let REASSIGNABLE_VARIABLE = 'do not use let with uppercase variables';
+- [23.8](#naming--PascalCase-singleton) Use PascalCase when you export a constructor / class / singleton / function library / bare object.
- // ---
+ ```javascript
+ const AirbnbStyleGuide = {
+ es6: {},
+ };
- // allowed but does not supply semantic value
- export const apiKey = 'SOMEKEY';
+ export default AirbnbStyleGuide;
+ ```
- // better in most cases
- export const API_KEY = 'SOMEKEY';
+
- // ---
+- [23.9](#naming--Acronyms-and-Initialisms) Acronyms and initialisms should always be all uppercased, or all lowercased.
- // bad - unnecessarily uppercases key while adding no semantic value
- export const MAPPING = {
- KEY: 'value'
- };
+ > Why? Names are for readability, not to appease a computer algorithm.
- // good
- export const MAPPING = {
- key: 'value',
- };
- ```
+ ```javascript
+ // bad
+ import SmsContainer from "./containers/SmsContainer";
+
+ // bad
+ const HttpRequests = [
+ // ...
+ ];
+
+ // good
+ import SMSContainer from "./containers/SMSContainer";
+
+ // good
+ const HTTPRequests = [
+ // ...
+ ];
+
+ // also good
+ const httpRequests = [
+ // ...
+ ];
+
+ // best
+ import TextMessageContainer from "./containers/TextMessageContainer";
+
+ // best
+ const requests = [
+ // ...
+ ];
+ ```
+
+
+
+- [23.10](#naming--uppercase) You may optionally uppercase a constant only if it (1) is exported, (2) is a `const` (it can not be reassigned), and (3) the programmer can trust it (and its nested properties) to never change.
+
+ > Why? This is an additional tool to assist in situations where the programmer would be unsure if a variable might ever change. UPPERCASE_VARIABLES are letting the programmer know that they can trust the variable (and its properties) not to change.
+
+ - What about all `const` variables? - This is unnecessary, so uppercasing should not be used for constants within a file. It should be used for exported constants however.
+ - What about exported objects? - Uppercase at the top level of export (e.g. `EXPORTED_OBJECT.key`) and maintain that all nested properties do not change.
+
+ ```javascript
+ // bad
+ const PRIVATE_VARIABLE = "should not be unnecessarily uppercased within a file";
+
+ // bad
+ export const THING_TO_BE_CHANGED = "should obviously not be uppercased";
+
+ // bad
+ export let REASSIGNABLE_VARIABLE = "do not use let with uppercase variables";
+
+ // ---
+
+ // allowed but does not supply semantic value
+ export const apiKey = "SOMEKEY";
+
+ // better in most cases
+ export const API_KEY = "SOMEKEY";
+
+ // ---
+
+ // bad - unnecessarily uppercases key while adding no semantic value
+ export const MAPPING = {
+ KEY: "value",
+ };
+
+ // good
+ export const MAPPING = {
+ key: "value",
+ };
+ ```
**[⬆ back to top](#table-of-contents)**
## Accessors
-
- - [24.1](#accessors--not-required) Accessor functions for properties are not required.
+
-
- - [24.2](#accessors--no-getters-setters) Do not use JavaScript getters/setters as they cause unexpected side effects and are harder to test, maintain, and reason about. Instead, if you do make accessor functions, use `getVal()` and `setVal('hello')`.
-
- ```javascript
- // bad
- class Dragon {
- get age() {
- // ...
- }
+- [24.1](#accessors--not-required) Accessor functions for properties are not required.
- set age(value) {
- // ...
- }
- }
+
- // good
- class Dragon {
- getAge() {
- // ...
- }
+- [24.2](#accessors--no-getters-setters) Do not use JavaScript getters/setters as they cause unexpected side effects and are harder to test, maintain, and reason about. Instead, if you do make accessor functions, use `getVal()` and `setVal('hello')`.
- setAge(value) {
- // ...
- }
+ ```javascript
+ // bad
+ class Dragon {
+ get age() {
+ // ...
}
- ```
-
- - [24.3](#accessors--boolean-prefix) If the property/method is a `boolean`, use `isVal()` or `hasVal()`.
+ set age(value) {
+ // ...
+ }
+ }
- ```javascript
- // bad
- if (!dragon.age()) {
- return false;
+ // good
+ class Dragon {
+ getAge() {
+ // ...
}
- // good
- if (!dragon.hasAge()) {
- return false;
+ setAge(value) {
+ // ...
}
- ```
+ }
+ ```
-
- - [24.4](#accessors--consistent) It’s okay to create `get()` and `set()` functions, but be consistent.
+
- ```javascript
- class Jedi {
- constructor(options = {}) {
- const lightsaber = options.lightsaber || 'blue';
- this.set('lightsaber', lightsaber);
- }
+- [24.3](#accessors--boolean-prefix) If the property/method is a `boolean`, use `isVal()` or `hasVal()`.
- set(key, val) {
- this[key] = val;
- }
+ ```javascript
+ // bad
+ if (!dragon.age()) {
+ return false;
+ }
- get(key) {
- return this[key];
- }
+ // good
+ if (!dragon.hasAge()) {
+ return false;
+ }
+ ```
+
+
+
+- [24.4](#accessors--consistent) It’s okay to create `get()` and `set()` functions, but be consistent.
+
+ ```javascript
+ class Jedi {
+ constructor(options = {}) {
+ const lightsaber = options.lightsaber || "blue";
+ this.set("lightsaber", lightsaber);
+ }
+
+ set(key, val) {
+ this[key] = val;
+ }
+
+ get(key) {
+ return this[key];
}
- ```
+ }
+ ```
**[⬆ back to top](#table-of-contents)**
## Events
-
- - [25.1](#events--hash) When attaching data payloads to events (whether DOM events or something more proprietary like Backbone events), pass an object literal (also known as a "hash") instead of a raw value. This allows a subsequent contributor to add more data to the event payload without finding and updating every handler for the event. For example, instead of:
+
- ```javascript
- // bad
- $(this).trigger('listingUpdated', listing.id);
+- [25.1](#events--hash) When attaching data payloads to events (whether DOM events or something more proprietary like Backbone events), pass an object literal (also known as a "hash") instead of a raw value. This allows a subsequent contributor to add more data to the event payload without finding and updating every handler for the event. For example, instead of:
- // ...
+ ```javascript
+ // bad
+ $(this).trigger("listingUpdated", listing.id);
- $(this).on('listingUpdated', (e, listingID) => {
- // do something with listingID
- });
- ```
+ // ...
- prefer:
+ $(this).on("listingUpdated", (e, listingID) => {
+ // do something with listingID
+ });
+ ```
- ```javascript
- // good
- $(this).trigger('listingUpdated', { listingID: listing.id });
+ prefer:
- // ...
+ ```javascript
+ // good
+ $(this).trigger("listingUpdated", { listingID: listing.id });
- $(this).on('listingUpdated', (e, data) => {
- // do something with data.listingID
- });
- ```
+ // ...
+
+ $(this).on("listingUpdated", (e, data) => {
+ // do something with data.listingID
+ });
+ ```
- **[⬆ back to top](#table-of-contents)**
+**[⬆ back to top](#table-of-contents)**
## jQuery
-
- - [26.1](#jquery--dollar-prefix) Prefix jQuery object variables with a `$`.
+
- ```javascript
- // bad
- const sidebar = $('.sidebar');
+- [26.1](#jquery--dollar-prefix) Prefix jQuery object variables with a `$`.
- // good
- const $sidebar = $('.sidebar');
+ ```javascript
+ // bad
+ const sidebar = $(".sidebar");
- // good
- const $sidebarBtn = $('.sidebar-btn');
- ```
+ // good
+ const $sidebar = $(".sidebar");
-
- - [26.2](#jquery--cache) Cache jQuery lookups.
+ // good
+ const $sidebarBtn = $(".sidebar-btn");
+ ```
- ```javascript
- // bad
- function setSidebar() {
- $('.sidebar').hide();
+
- // ...
+- [26.2](#jquery--cache) Cache jQuery lookups.
- $('.sidebar').css({
- 'background-color': 'pink',
- });
- }
+ ```javascript
+ // bad
+ function setSidebar() {
+ $(".sidebar").hide();
- // good
- function setSidebar() {
- const $sidebar = $('.sidebar');
- $sidebar.hide();
+ // ...
- // ...
+ $(".sidebar").css({
+ "background-color": "pink",
+ });
+ }
- $sidebar.css({
- 'background-color': 'pink',
- });
- }
- ```
+ // good
+ function setSidebar() {
+ const $sidebar = $(".sidebar");
+ $sidebar.hide();
+
+ // ...
+
+ $sidebar.css({
+ "background-color": "pink",
+ });
+ }
+ ```
+
+
-
- - [26.3](#jquery--queries) For DOM queries use Cascading `$('.sidebar ul')` or parent > child `$('.sidebar > ul')`. [jsPerf](https://web.archive.org/web/20200414183810/https://jsperf.com/jquery-find-vs-context-sel/16)
+- [26.3](#jquery--queries) For DOM queries use Cascading `$('.sidebar ul')` or parent > child `$('.sidebar > ul')`. [jsPerf](https://web.archive.org/web/20200414183810/https://jsperf.com/jquery-find-vs-context-sel/16)
-
- - [26.4](#jquery--find) Use `find` with scoped jQuery object queries.
+
- ```javascript
- // bad
- $('ul', '.sidebar').hide();
+- [26.4](#jquery--find) Use `find` with scoped jQuery object queries.
- // bad
- $('.sidebar').find('ul').hide();
+ ```javascript
+ // bad
+ $("ul", ".sidebar").hide();
- // good
- $('.sidebar ul').hide();
+ // bad
+ $(".sidebar").find("ul").hide();
- // good
- $('.sidebar > ul').hide();
+ // good
+ $(".sidebar ul").hide();
- // good
- $sidebar.find('ul').hide();
- ```
+ // good
+ $(".sidebar > ul").hide();
+
+ // good
+ $sidebar.find("ul").hide();
+ ```
**[⬆ back to top](#table-of-contents)**
## ECMAScript 5 Compatibility
-
- - [27.1](#es5-compat--kangax) Refer to [Kangax](https://twitter.com/kangax/)’s ES5 [compatibility table](https://compat-table.github.io/compat-table/es5/).
+
+
+- [27.1](#es5-compat--kangax) Refer to [Kangax](https://twitter.com/kangax/)’s ES5 [compatibility table](https://compat-table.github.io/compat-table/es5/).
**[⬆ back to top](#table-of-contents)**
+
## ECMAScript 6+ (ES 2015+) Styles
-
- - [28.1](#es6-styles) This is a collection of links to the various ES6+ features.
+
+
+- [28.1](#es6-styles) This is a collection of links to the various ES6+ features.
1. [Arrow Functions](#arrow-functions)
1. [Classes](#classes--constructors)
@@ -3771,86 +3819,91 @@ Other Style Guides
1. [Iterators and Generators](#iterators-and-generators)
1. [Modules](#modules)
-
- - [28.2](#tc39-proposals) Do not use [TC39 proposals](https://github.com/tc39/proposals) that have not reached stage 3.
+
- > Why? [They are not finalized](https://tc39.github.io/process-document/), and they are subject to change or to be withdrawn entirely. We want to use JavaScript, and proposals are not JavaScript yet.
+- [28.2](#tc39-proposals) Do not use [TC39 proposals](https://github.com/tc39/proposals) that have not reached stage 3.
+
+ > Why? [They are not finalized](https://tc39.github.io/process-document/), and they are subject to change or to be withdrawn entirely. We want to use JavaScript, and proposals are not JavaScript yet.
**[⬆ back to top](#table-of-contents)**
## Standard Library
- The [Standard Library](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects)
- contains utilities that are functionally broken but remain for legacy reasons.
+The [Standard Library](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects)
+contains utilities that are functionally broken but remain for legacy reasons.
+
+
-
- - [29.1](#standard-library--isnan) Use `Number.isNaN` instead of global `isNaN`.
- eslint: [`no-restricted-globals`](https://eslint.org/docs/rules/no-restricted-globals)
+- [29.1](#standard-library--isnan) Use `Number.isNaN` instead of global `isNaN`.
+ eslint: [`no-restricted-globals`](https://eslint.org/docs/rules/no-restricted-globals)
- > Why? The global `isNaN` coerces non-numbers to numbers, returning true for anything that coerces to NaN.
- > If this behavior is desired, make it explicit.
+ > Why? The global `isNaN` coerces non-numbers to numbers, returning true for anything that coerces to NaN.
+ > If this behavior is desired, make it explicit.
- ```javascript
- // bad
- isNaN('1.2'); // false
- isNaN('1.2.3'); // true
+ ```javascript
+ // bad
+ isNaN("1.2"); // false
+ isNaN("1.2.3"); // true
- // good
- Number.isNaN('1.2.3'); // false
- Number.isNaN(Number('1.2.3')); // true
- ```
+ // good
+ Number.isNaN("1.2.3"); // false
+ Number.isNaN(Number("1.2.3")); // true
+ ```
-
- - [29.2](#standard-library--isfinite) Use `Number.isFinite` instead of global `isFinite`.
- eslint: [`no-restricted-globals`](https://eslint.org/docs/rules/no-restricted-globals)
+
- > Why? The global `isFinite` coerces non-numbers to numbers, returning true for anything that coerces to a finite number.
- > If this behavior is desired, make it explicit.
+- [29.2](#standard-library--isfinite) Use `Number.isFinite` instead of global `isFinite`.
+ eslint: [`no-restricted-globals`](https://eslint.org/docs/rules/no-restricted-globals)
- ```javascript
- // bad
- isFinite('2e3'); // true
+ > Why? The global `isFinite` coerces non-numbers to numbers, returning true for anything that coerces to a finite number.
+ > If this behavior is desired, make it explicit.
- // good
- Number.isFinite('2e3'); // false
- Number.isFinite(parseInt('2e3', 10)); // true
- ```
+ ```javascript
+ // bad
+ isFinite("2e3"); // true
+
+ // good
+ Number.isFinite("2e3"); // false
+ Number.isFinite(parseInt("2e3", 10)); // true
+ ```
**[⬆ back to top](#table-of-contents)**
## Testing
-
- - [30.1](#testing--yup) **Yup.**
+
- ```javascript
- function foo() {
- return true;
- }
- ```
+- [30.1](#testing--yup) **Yup.**
+
+ ```javascript
+ function foo() {
+ return true;
+ }
+ ```
+
+
-
- - [30.2](#testing--for-real) **No, but seriously**:
- - Whichever testing framework you use, you should be writing tests!
- - Strive to write many small pure functions, and minimize where mutations occur.
- - Be cautious about stubs and mocks - they can make your tests more brittle.
- - We primarily use [`mocha`](https://www.npmjs.com/package/mocha) and [`jest`](https://www.npmjs.com/package/jest) at Airbnb. [`tape`](https://www.npmjs.com/package/tape) is also used occasionally for small, separate modules.
- - 100% test coverage is a good goal to strive for, even if it’s not always practical to reach it.
- - Whenever you fix a bug, *write a regression test*. A bug fixed without a regression test is almost certainly going to break again in the future.
+- [30.2](#testing--for-real) **No, but seriously**:
+ - Whichever testing framework you use, you should be writing tests!
+ - Strive to write many small pure functions, and minimize where mutations occur.
+ - Be cautious about stubs and mocks - they can make your tests more brittle.
+ - We primarily use [`mocha`](https://www.npmjs.com/package/mocha) and [`jest`](https://www.npmjs.com/package/jest) at Airbnb. [`tape`](https://www.npmjs.com/package/tape) is also used occasionally for small, separate modules.
+ - 100% test coverage is a good goal to strive for, even if it’s not always practical to reach it.
+ - Whenever you fix a bug, _write a regression test_. A bug fixed without a regression test is almost certainly going to break again in the future.
**[⬆ back to top](#table-of-contents)**
## Performance
- - [On Layout & Web Performance](https://www.kellegous.com/j/2013/01/26/layout-performance/)
- - [String vs Array Concat](https://web.archive.org/web/20200414200857/https://jsperf.com/string-vs-array-concat/2)
- - [Try/Catch Cost In a Loop](https://web.archive.org/web/20200414190827/https://jsperf.com/try-catch-in-loop-cost/12)
- - [Bang Function](https://web.archive.org/web/20200414205426/https://jsperf.com/bang-function)
- - [jQuery Find vs Context, Selector](https://web.archive.org/web/20200414200850/https://jsperf.com/jquery-find-vs-context-sel/164)
- - [innerHTML vs textContent for script text](https://web.archive.org/web/20200414205428/https://jsperf.com/innerhtml-vs-textcontent-for-script-text)
- - [Long String Concatenation](https://web.archive.org/web/20200414203914/https://jsperf.com/ya-string-concat/38)
- - [Are JavaScript functions like `map()`, `reduce()`, and `filter()` optimized for traversing arrays?](https://www.quora.com/JavaScript-programming-language-Are-Javascript-functions-like-map-reduce-and-filter-already-optimized-for-traversing-array/answer/Quildreen-Motta)
- - Loading...
+- [On Layout & Web Performance](https://www.kellegous.com/j/2013/01/26/layout-performance/)
+- [String vs Array Concat](https://web.archive.org/web/20200414200857/https://jsperf.com/string-vs-array-concat/2)
+- [Try/Catch Cost In a Loop](https://web.archive.org/web/20200414190827/https://jsperf.com/try-catch-in-loop-cost/12)
+- [Bang Function](https://web.archive.org/web/20200414205426/https://jsperf.com/bang-function)
+- [jQuery Find vs Context, Selector](https://web.archive.org/web/20200414200850/https://jsperf.com/jquery-find-vs-context-sel/164)
+- [innerHTML vs textContent for script text](https://web.archive.org/web/20200414205428/https://jsperf.com/innerhtml-vs-textcontent-for-script-text)
+- [Long String Concatenation](https://web.archive.org/web/20200414203914/https://jsperf.com/ya-string-concat/38)
+- [Are JavaScript functions like `map()`, `reduce()`, and `filter()` optimized for traversing arrays?](https://www.quora.com/JavaScript-programming-language-Are-Javascript-functions-like-map-reduce-and-filter-already-optimized-for-traversing-array/answer/Quildreen-Motta)
+- Loading...
**[⬆ back to top](#table-of-contents)**
@@ -3858,210 +3911,210 @@ Other Style Guides
**Learning ES6+**
- - [Latest ECMA spec](https://tc39.github.io/ecma262/)
- - [ExploringJS](https://exploringjs.com/)
- - [ES6 Compatibility Table](https://compat-table.github.io/compat-table/es6/)
- - [Comprehensive Overview of ES6 Features](https://web.archive.org/web/20240404212626/http://es6-features.org/)
- - [JavaScript Roadmap](https://roadmap.sh/javascript)
+- [Latest ECMA spec](https://tc39.github.io/ecma262/)
+- [ExploringJS](https://exploringjs.com/)
+- [ES6 Compatibility Table](https://compat-table.github.io/compat-table/es6/)
+- [Comprehensive Overview of ES6 Features](https://web.archive.org/web/20240404212626/http://es6-features.org/)
+- [JavaScript Roadmap](https://roadmap.sh/javascript)
**Read This**
- - [Standard ECMA-262](https://www.ecma-international.org/ecma-262/6.0/index.html)
+- [Standard ECMA-262](https://www.ecma-international.org/ecma-262/6.0/index.html)
**Tools**
- - Code Style Linters
- - [ESlint](https://eslint.org/) - [Airbnb Style .eslintrc](https://github.com/airbnb/javascript/blob/master/linters/.eslintrc)
- - [JSHint](https://jshint.com/) - [Airbnb Style .jshintrc](https://github.com/airbnb/javascript/blob/master/linters/.jshintrc)
- - Neutrino Preset - [@neutrinojs/airbnb](https://neutrinojs.org/packages/airbnb/)
+- Code Style Linters
+ - [ESlint](https://eslint.org/) - [Airbnb Style .eslintrc](https://github.com/airbnb/javascript/blob/master/linters/.eslintrc)
+ - [JSHint](https://jshint.com/) - [Airbnb Style .jshintrc](https://github.com/airbnb/javascript/blob/master/linters/.jshintrc)
+- Neutrino Preset - [@neutrinojs/airbnb](https://neutrinojs.org/packages/airbnb/)
**Other Style Guides**
- - [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html)
- - [Google JavaScript Style Guide (Old)](https://google.github.io/styleguide/javascriptguide.xml)
- - [jQuery Core Style Guidelines](https://contribute.jquery.org/style-guide/js/)
- - [Principles of Writing Consistent, Idiomatic JavaScript](https://github.com/rwaldron/idiomatic.js)
- - [StandardJS](https://standardjs.com)
+- [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html)
+- [Google JavaScript Style Guide (Old)](https://google.github.io/styleguide/javascriptguide.xml)
+- [jQuery Core Style Guidelines](https://contribute.jquery.org/style-guide/js/)
+- [Principles of Writing Consistent, Idiomatic JavaScript](https://github.com/rwaldron/idiomatic.js)
+- [StandardJS](https://standardjs.com)
**Other Styles**
- - [Naming this in nested functions](https://gist.github.com/cjohansen/4135065) - Christian Johansen
- - [Conditional Callbacks](https://github.com/airbnb/javascript/issues/52) - Ross Allen
- - [Popular JavaScript Coding Conventions on GitHub](http://sideeffect.kr/popularconvention/#javascript) - JeongHoon Byun
- - [Multiple var statements in JavaScript, not superfluous](https://benalman.com/news/2012/05/multiple-var-statements-javascript/) - Ben Alman
+- [Naming this in nested functions](https://gist.github.com/cjohansen/4135065) - Christian Johansen
+- [Conditional Callbacks](https://github.com/airbnb/javascript/issues/52) - Ross Allen
+- [Popular JavaScript Coding Conventions on GitHub](http://sideeffect.kr/popularconvention/#javascript) - JeongHoon Byun
+- [Multiple var statements in JavaScript, not superfluous](https://benalman.com/news/2012/05/multiple-var-statements-javascript/) - Ben Alman
**Further Reading**
- - [Understanding JavaScript Closures](https://javascriptweblog.wordpress.com/2010/10/25/understanding-javascript-closures/) - Angus Croll
- - [Basic JavaScript for the impatient programmer](https://www.2ality.com/2013/06/basic-javascript.html) - Dr. Axel Rauschmayer
- - [You Might Not Need jQuery](https://youmightnotneedjquery.com/) - Zack Bloom & Adam Schwartz
- - [ES6 Features](https://github.com/lukehoban/es6features) - Luke Hoban
- - [Frontend Guidelines](https://github.com/bendc/frontend-guidelines) - Benjamin De Cock
+- [Understanding JavaScript Closures](https://javascriptweblog.wordpress.com/2010/10/25/understanding-javascript-closures/) - Angus Croll
+- [Basic JavaScript for the impatient programmer](https://www.2ality.com/2013/06/basic-javascript.html) - Dr. Axel Rauschmayer
+- [You Might Not Need jQuery](https://youmightnotneedjquery.com/) - Zack Bloom & Adam Schwartz
+- [ES6 Features](https://github.com/lukehoban/es6features) - Luke Hoban
+- [Frontend Guidelines](https://github.com/bendc/frontend-guidelines) - Benjamin De Cock
**Books**
- - [JavaScript: The Good Parts](https://www.amazon.com/JavaScript-Good-Parts-Douglas-Crockford/dp/0596517742) - Douglas Crockford
- - [JavaScript Patterns](https://www.amazon.com/JavaScript-Patterns-Stoyan-Stefanov/dp/0596806752) - Stoyan Stefanov
- - [Pro JavaScript Design Patterns](https://www.amazon.com/JavaScript-Design-Patterns-Recipes-Problem-Solution/dp/159059908X) - Ross Harmes and Dustin Diaz
- - [High Performance Web Sites: Essential Knowledge for Front-End Engineers](https://www.amazon.com/High-Performance-Web-Sites-Essential/dp/0596529309) - Steve Souders
- - [Maintainable JavaScript](https://www.amazon.com/Maintainable-JavaScript-Nicholas-C-Zakas/dp/1449327680) - Nicholas C. Zakas
- - [JavaScript Web Applications](https://www.amazon.com/JavaScript-Web-Applications-Alex-MacCaw/dp/144930351X) - Alex MacCaw
- - [Pro JavaScript Techniques](https://www.amazon.com/Pro-JavaScript-Techniques-John-Resig/dp/1590597273) - John Resig
- - [Smashing Node.js: JavaScript Everywhere](https://www.amazon.com/Smashing-Node-js-JavaScript-Everywhere-Magazine/dp/1119962595) - Guillermo Rauch
- - [Secrets of the JavaScript Ninja](https://www.amazon.com/Secrets-JavaScript-Ninja-John-Resig/dp/193398869X) - John Resig and Bear Bibeault
- - [Human JavaScript](http://humanjavascript.com/) - Henrik Joreteg
- - [Superhero.js](http://superherojs.com/) - Kim Joar Bekkelund, Mads Mobæk, & Olav Bjorkoy
- - [JSBooks](https://jsbooks.revolunet.com/) - Julien Bouquillon
- - [Third Party JavaScript](https://www.manning.com/books/third-party-javascript) - Ben Vinegar and Anton Kovalyov
- - [Effective JavaScript: 68 Specific Ways to Harness the Power of JavaScript](https://amzn.com/dp/0321812182) - David Herman
- - [Eloquent JavaScript](https://eloquentjavascript.net/) - Marijn Haverbeke
- - [You Don’t Know JS: ES6 & Beyond](https://shop.oreilly.com/product/0636920033769.do) - Kyle Simpson
+- [JavaScript: The Good Parts](https://www.amazon.com/JavaScript-Good-Parts-Douglas-Crockford/dp/0596517742) - Douglas Crockford
+- [JavaScript Patterns](https://www.amazon.com/JavaScript-Patterns-Stoyan-Stefanov/dp/0596806752) - Stoyan Stefanov
+- [Pro JavaScript Design Patterns](https://www.amazon.com/JavaScript-Design-Patterns-Recipes-Problem-Solution/dp/159059908X) - Ross Harmes and Dustin Diaz
+- [High Performance Web Sites: Essential Knowledge for Front-End Engineers](https://www.amazon.com/High-Performance-Web-Sites-Essential/dp/0596529309) - Steve Souders
+- [Maintainable JavaScript](https://www.amazon.com/Maintainable-JavaScript-Nicholas-C-Zakas/dp/1449327680) - Nicholas C. Zakas
+- [JavaScript Web Applications](https://www.amazon.com/JavaScript-Web-Applications-Alex-MacCaw/dp/144930351X) - Alex MacCaw
+- [Pro JavaScript Techniques](https://www.amazon.com/Pro-JavaScript-Techniques-John-Resig/dp/1590597273) - John Resig
+- [Smashing Node.js: JavaScript Everywhere](https://www.amazon.com/Smashing-Node-js-JavaScript-Everywhere-Magazine/dp/1119962595) - Guillermo Rauch
+- [Secrets of the JavaScript Ninja](https://www.amazon.com/Secrets-JavaScript-Ninja-John-Resig/dp/193398869X) - John Resig and Bear Bibeault
+- [Human JavaScript](http://humanjavascript.com/) - Henrik Joreteg
+- [Superhero.js](http://superherojs.com/) - Kim Joar Bekkelund, Mads Mobæk, & Olav Bjorkoy
+- [JSBooks](https://jsbooks.revolunet.com/) - Julien Bouquillon
+- [Third Party JavaScript](https://www.manning.com/books/third-party-javascript) - Ben Vinegar and Anton Kovalyov
+- [Effective JavaScript: 68 Specific Ways to Harness the Power of JavaScript](https://amzn.com/dp/0321812182) - David Herman
+- [Eloquent JavaScript](https://eloquentjavascript.net/) - Marijn Haverbeke
+- [You Don’t Know JS: ES6 & Beyond](https://shop.oreilly.com/product/0636920033769.do) - Kyle Simpson
**Blogs**
- - [JavaScript Weekly](https://javascriptweekly.com/)
- - [JavaScript, JavaScript...](https://javascriptweblog.wordpress.com/)
- - [Bocoup Weblog](https://bocoup.com/weblog)
- - [Adequately Good](https://www.adequatelygood.com/)
- - [NCZOnline](https://www.nczonline.net/)
- - [Perfection Kills](http://perfectionkills.com/)
- - [Ben Alman](https://benalman.com/)
- - [Dmitry Baranovskiy](http://dmitry.baranovskiy.com/)
- - [nettuts](https://code.tutsplus.com/?s=javascript)
+- [JavaScript Weekly](https://javascriptweekly.com/)
+- [JavaScript, JavaScript...](https://javascriptweblog.wordpress.com/)
+- [Bocoup Weblog](https://bocoup.com/weblog)
+- [Adequately Good](https://www.adequatelygood.com/)
+- [NCZOnline](https://www.nczonline.net/)
+- [Perfection Kills](http://perfectionkills.com/)
+- [Ben Alman](https://benalman.com/)
+- [Dmitry Baranovskiy](http://dmitry.baranovskiy.com/)
+- [nettuts](https://code.tutsplus.com/?s=javascript)
**Podcasts**
- - [JavaScript Air](https://javascriptair.com/)
- - [JavaScript Jabber](https://devchat.tv/js-jabber/)
+- [JavaScript Air](https://javascriptair.com/)
+- [JavaScript Jabber](https://devchat.tv/js-jabber/)
**[⬆ back to top](#table-of-contents)**
## In the Wild
- This is a list of organizations that are using this style guide. Send us a pull request and we'll add you to the list.
-
- - **123erfasst**: [123erfasst/javascript](https://github.com/123erfasst/javascript)
- - **4Catalyzer**: [4Catalyzer/javascript](https://github.com/4Catalyzer/javascript)
- - **Aan Zee**: [AanZee/javascript](https://github.com/AanZee/javascript)
- - **Airbnb**: [airbnb/javascript](https://github.com/airbnb/javascript)
- - **AloPeyk**: [AloPeyk](https://github.com/AloPeyk)
- - **AltSchool**: [AltSchool/javascript](https://github.com/AltSchool/javascript)
- - **Apartmint**: [apartmint/javascript](https://github.com/apartmint/javascript)
- - **Ascribe**: [ascribe/javascript](https://github.com/ascribe/javascript)
- - **Avant**: [avantcredit/javascript](https://github.com/avantcredit/javascript)
- - **Axept**: [axept/javascript](https://github.com/axept/javascript)
- - **Billabong**: [billabong/javascript](https://github.com/billabong/javascript)
- - **Bisk**: [bisk](https://github.com/Bisk/)
- - **Brainshark**: [brainshark/javascript](https://github.com/brainshark/javascript)
- - **CaseNine**: [CaseNine/javascript](https://github.com/CaseNine/javascript)
- - **Cerner**: [Cerner](https://github.com/cerner/)
- - **Chartboost**: [ChartBoost/javascript-style-guide](https://github.com/ChartBoost/javascript-style-guide)
- - **Coeur d'Alene Tribe**: [www.cdatribe-nsn.gov](https://www.cdatribe-nsn.gov)
- - **ComparaOnline**: [comparaonline/javascript](https://github.com/comparaonline/javascript-style-guide)
- - **Compass Learning**: [compasslearning/javascript-style-guide](https://github.com/compasslearning/javascript-style-guide)
- - **DailyMotion**: [dailymotion/javascript](https://github.com/dailymotion/javascript)
- - **DoSomething**: [DoSomething/eslint-config](https://github.com/DoSomething/eslint-config)
- - **Digitpaint** [digitpaint/javascript](https://github.com/digitpaint/javascript)
- - **Drupal**: [www.drupal.org](https://git.drupalcode.org/project/drupal/blob/8.6.x/core/.eslintrc.json)
- - **Ecosia**: [ecosia/javascript](https://github.com/ecosia/javascript)
- - **Evolution Gaming**: [evolution-gaming/javascript](https://github.com/evolution-gaming/javascript)
- - **EvozonJs**: [evozonjs/javascript](https://github.com/evozonjs/javascript)
- - **ExactTarget**: [ExactTarget/javascript](https://github.com/ExactTarget/javascript)
- - **Flexberry**: [Flexberry/javascript-style-guide](https://github.com/Flexberry/javascript-style-guide)
- - **Gawker Media**: [gawkermedia](https://github.com/gawkermedia/)
- - **General Electric**: [GeneralElectric/javascript](https://github.com/GeneralElectric/javascript)
- - **Generation Tux**: [GenerationTux/javascript](https://github.com/generationtux/styleguide)
- - **GoodData**: [gooddata/gdc-js-style](https://github.com/gooddata/gdc-js-style)
- - **GreenChef**: [greenchef/javascript](https://github.com/greenchef/javascript)
- - **Grooveshark**: [grooveshark/javascript](https://github.com/grooveshark/javascript)
- - **Grupo-Abraxas**: [Grupo-Abraxas/javascript](https://github.com/Grupo-Abraxas/javascript)
- - **Happeo**: [happeo/javascript](https://github.com/happeo/javascript)
- - **How About We**: [howaboutwe/javascript](https://github.com/howaboutwe/javascript-style-guide)
- - **HubSpot**: [HubSpot/javascript](https://github.com/HubSpot/javascript)
- - **Hyper**: [hyperoslo/javascript-playbook](https://github.com/hyperoslo/javascript-playbook/blob/master/style.md)
- - **ILIAS**: [ILIAS](https://github.com/ILIAS-eLearning/ILIAS)
- - **InterCity Group**: [intercitygroup/javascript-style-guide](https://github.com/intercitygroup/javascript-style-guide)
- - **Jam3**: [Jam3/Javascript-Code-Conventions](https://github.com/Jam3/Javascript-Code-Conventions)
- - **JSSolutions**: [JSSolutions/javascript](https://github.com/JSSolutions/javascript)
- - **Kaplan Komputing**: [kaplankomputing/javascript](https://github.com/kaplankomputing/javascript)
- - **KickorStick**: [kickorstick](https://github.com/kickorstick/)
- - **Kinetica Solutions**: [kinetica/javascript](https://github.com/kinetica/Javascript-style-guide)
- - **LEINWAND**: [LEINWAND/javascript](https://github.com/LEINWAND/javascript)
- - **Lonely Planet**: [lonelyplanet/javascript](https://github.com/lonelyplanet/javascript)
- - **M2GEN**: [M2GEN/javascript](https://github.com/M2GEN/javascript)
- - **Mighty Spring**: [mightyspring/javascript](https://github.com/mightyspring/javascript)
- - **MinnPost**: [MinnPost/javascript](https://github.com/MinnPost/javascript)
- - **MitocGroup**: [MitocGroup/javascript](https://github.com/MitocGroup/javascript)
- - **Muber**: [muber](https://github.com/muber/)
- - **National Geographic Society**: [natgeosociety](https://github.com/natgeosociety/)
- - **NullDev**: [NullDevCo/JavaScript-Styleguide](https://github.com/NullDevCo/JavaScript-Styleguide)
- - **Nulogy**: [nulogy/javascript](https://github.com/nulogy/javascript)
- - **Orange Hill Development**: [orangehill/javascript](https://github.com/orangehill/javascript)
- - **Orion Health**: [orionhealth/javascript](https://github.com/orionhealth/javascript)
- - **Peerby**: [Peerby/javascript](https://github.com/Peerby/javascript)
- - **Pier 1**: [Pier1/javascript](https://github.com/pier1/javascript)
- - **Qotto**: [Qotto/javascript-style-guide](https://github.com/Qotto/javascript-style-guide)
- - **React**: [reactjs.org/docs/how-to-contribute.html#style-guide](https://reactjs.org/docs/how-to-contribute.html#style-guide)
- - **Ripple**: [ripple/javascript-style-guide](https://github.com/ripple/javascript-style-guide)
- - **Sainsbury’s Supermarkets**: [jsainsburyplc](https://github.com/jsainsburyplc)
- - **Shutterfly**: [shutterfly/javascript](https://github.com/shutterfly/javascript)
- - **Sourcetoad**: [sourcetoad/javascript](https://github.com/sourcetoad/javascript)
- - **Springload**: [springload](https://github.com/springload/)
- - **StratoDem Analytics**: [stratodem/javascript](https://github.com/stratodem/javascript)
- - **SteelKiwi Development**: [steelkiwi/javascript](https://github.com/steelkiwi/javascript)
- - **StudentSphere**: [studentsphere/javascript](https://github.com/studentsphere/guide-javascript)
- - **SwoopApp**: [swoopapp/javascript](https://github.com/swoopapp/javascript)
- - **SysGarage**: [sysgarage/javascript-style-guide](https://github.com/sysgarage/javascript-style-guide)
- - **Syzygy Warsaw**: [syzygypl/javascript](https://github.com/syzygypl/javascript)
- - **Target**: [target/javascript](https://github.com/target/javascript)
- - **Terra**: [terra](https://github.com/cerner?utf8=%E2%9C%93&q=terra&type=&language=)
- - **TheLadders**: [TheLadders/javascript](https://github.com/TheLadders/javascript)
- - **The Nerdery**: [thenerdery/javascript-standards](https://github.com/thenerdery/javascript-standards)
- - **Tomify**: [tomprats](https://github.com/tomprats)
- - **Traitify**: [traitify/eslint-config-traitify](https://github.com/traitify/eslint-config-traitify)
- - **T4R Technology**: [T4R-Technology/javascript](https://github.com/T4R-Technology/javascript)
- - **UrbanSim**: [urbansim](https://github.com/urbansim/)
- - **VoxFeed**: [VoxFeed/javascript-style-guide](https://github.com/VoxFeed/javascript-style-guide)
- - **WeBox Studio**: [weboxstudio/javascript](https://github.com/weboxstudio/javascript)
- - **Weggo**: [Weggo/javascript](https://github.com/Weggo/javascript)
- - **Zillow**: [zillow/javascript](https://github.com/zillow/javascript)
- - **Zit Software**: [zit-software/javascript](https://github.com/zit-software/javascript)
- - **ZocDoc**: [ZocDoc/javascript](https://github.com/ZocDoc/javascript)
+This is a list of organizations that are using this style guide. Send us a pull request and we'll add you to the list.
+
+- **123erfasst**: [123erfasst/javascript](https://github.com/123erfasst/javascript)
+- **4Catalyzer**: [4Catalyzer/javascript](https://github.com/4Catalyzer/javascript)
+- **Aan Zee**: [AanZee/javascript](https://github.com/AanZee/javascript)
+- **Airbnb**: [airbnb/javascript](https://github.com/airbnb/javascript)
+- **AloPeyk**: [AloPeyk](https://github.com/AloPeyk)
+- **AltSchool**: [AltSchool/javascript](https://github.com/AltSchool/javascript)
+- **Apartmint**: [apartmint/javascript](https://github.com/apartmint/javascript)
+- **Ascribe**: [ascribe/javascript](https://github.com/ascribe/javascript)
+- **Avant**: [avantcredit/javascript](https://github.com/avantcredit/javascript)
+- **Axept**: [axept/javascript](https://github.com/axept/javascript)
+- **Billabong**: [billabong/javascript](https://github.com/billabong/javascript)
+- **Bisk**: [bisk](https://github.com/Bisk/)
+- **Brainshark**: [brainshark/javascript](https://github.com/brainshark/javascript)
+- **CaseNine**: [CaseNine/javascript](https://github.com/CaseNine/javascript)
+- **Cerner**: [Cerner](https://github.com/cerner/)
+- **Chartboost**: [ChartBoost/javascript-style-guide](https://github.com/ChartBoost/javascript-style-guide)
+- **Coeur d'Alene Tribe**: [www.cdatribe-nsn.gov](https://www.cdatribe-nsn.gov)
+- **ComparaOnline**: [comparaonline/javascript](https://github.com/comparaonline/javascript-style-guide)
+- **Compass Learning**: [compasslearning/javascript-style-guide](https://github.com/compasslearning/javascript-style-guide)
+- **DailyMotion**: [dailymotion/javascript](https://github.com/dailymotion/javascript)
+- **DoSomething**: [DoSomething/eslint-config](https://github.com/DoSomething/eslint-config)
+- **Digitpaint** [digitpaint/javascript](https://github.com/digitpaint/javascript)
+- **Drupal**: [www.drupal.org](https://git.drupalcode.org/project/drupal/blob/8.6.x/core/.eslintrc.json)
+- **Ecosia**: [ecosia/javascript](https://github.com/ecosia/javascript)
+- **Evolution Gaming**: [evolution-gaming/javascript](https://github.com/evolution-gaming/javascript)
+- **EvozonJs**: [evozonjs/javascript](https://github.com/evozonjs/javascript)
+- **ExactTarget**: [ExactTarget/javascript](https://github.com/ExactTarget/javascript)
+- **Flexberry**: [Flexberry/javascript-style-guide](https://github.com/Flexberry/javascript-style-guide)
+- **Gawker Media**: [gawkermedia](https://github.com/gawkermedia/)
+- **General Electric**: [GeneralElectric/javascript](https://github.com/GeneralElectric/javascript)
+- **Generation Tux**: [GenerationTux/javascript](https://github.com/generationtux/styleguide)
+- **GoodData**: [gooddata/gdc-js-style](https://github.com/gooddata/gdc-js-style)
+- **GreenChef**: [greenchef/javascript](https://github.com/greenchef/javascript)
+- **Grooveshark**: [grooveshark/javascript](https://github.com/grooveshark/javascript)
+- **Grupo-Abraxas**: [Grupo-Abraxas/javascript](https://github.com/Grupo-Abraxas/javascript)
+- **Happeo**: [happeo/javascript](https://github.com/happeo/javascript)
+- **How About We**: [howaboutwe/javascript](https://github.com/howaboutwe/javascript-style-guide)
+- **HubSpot**: [HubSpot/javascript](https://github.com/HubSpot/javascript)
+- **Hyper**: [hyperoslo/javascript-playbook](https://github.com/hyperoslo/javascript-playbook/blob/master/style.md)
+- **ILIAS**: [ILIAS](https://github.com/ILIAS-eLearning/ILIAS)
+- **InterCity Group**: [intercitygroup/javascript-style-guide](https://github.com/intercitygroup/javascript-style-guide)
+- **Jam3**: [Jam3/Javascript-Code-Conventions](https://github.com/Jam3/Javascript-Code-Conventions)
+- **JSSolutions**: [JSSolutions/javascript](https://github.com/JSSolutions/javascript)
+- **Kaplan Komputing**: [kaplankomputing/javascript](https://github.com/kaplankomputing/javascript)
+- **KickorStick**: [kickorstick](https://github.com/kickorstick/)
+- **Kinetica Solutions**: [kinetica/javascript](https://github.com/kinetica/Javascript-style-guide)
+- **LEINWAND**: [LEINWAND/javascript](https://github.com/LEINWAND/javascript)
+- **Lonely Planet**: [lonelyplanet/javascript](https://github.com/lonelyplanet/javascript)
+- **M2GEN**: [M2GEN/javascript](https://github.com/M2GEN/javascript)
+- **Mighty Spring**: [mightyspring/javascript](https://github.com/mightyspring/javascript)
+- **MinnPost**: [MinnPost/javascript](https://github.com/MinnPost/javascript)
+- **MitocGroup**: [MitocGroup/javascript](https://github.com/MitocGroup/javascript)
+- **Muber**: [muber](https://github.com/muber/)
+- **National Geographic Society**: [natgeosociety](https://github.com/natgeosociety/)
+- **NullDev**: [NullDevCo/JavaScript-Styleguide](https://github.com/NullDevCo/JavaScript-Styleguide)
+- **Nulogy**: [nulogy/javascript](https://github.com/nulogy/javascript)
+- **Orange Hill Development**: [orangehill/javascript](https://github.com/orangehill/javascript)
+- **Orion Health**: [orionhealth/javascript](https://github.com/orionhealth/javascript)
+- **Peerby**: [Peerby/javascript](https://github.com/Peerby/javascript)
+- **Pier 1**: [Pier1/javascript](https://github.com/pier1/javascript)
+- **Qotto**: [Qotto/javascript-style-guide](https://github.com/Qotto/javascript-style-guide)
+- **React**: [reactjs.org/docs/how-to-contribute.html#style-guide](https://reactjs.org/docs/how-to-contribute.html#style-guide)
+- **Ripple**: [ripple/javascript-style-guide](https://github.com/ripple/javascript-style-guide)
+- **Sainsbury’s Supermarkets**: [jsainsburyplc](https://github.com/jsainsburyplc)
+- **Shutterfly**: [shutterfly/javascript](https://github.com/shutterfly/javascript)
+- **Sourcetoad**: [sourcetoad/javascript](https://github.com/sourcetoad/javascript)
+- **Springload**: [springload](https://github.com/springload/)
+- **StratoDem Analytics**: [stratodem/javascript](https://github.com/stratodem/javascript)
+- **SteelKiwi Development**: [steelkiwi/javascript](https://github.com/steelkiwi/javascript)
+- **StudentSphere**: [studentsphere/javascript](https://github.com/studentsphere/guide-javascript)
+- **SwoopApp**: [swoopapp/javascript](https://github.com/swoopapp/javascript)
+- **SysGarage**: [sysgarage/javascript-style-guide](https://github.com/sysgarage/javascript-style-guide)
+- **Syzygy Warsaw**: [syzygypl/javascript](https://github.com/syzygypl/javascript)
+- **Target**: [target/javascript](https://github.com/target/javascript)
+- **Terra**: [terra](https://github.com/cerner?utf8=%E2%9C%93&q=terra&type=&language=)
+- **TheLadders**: [TheLadders/javascript](https://github.com/TheLadders/javascript)
+- **The Nerdery**: [thenerdery/javascript-standards](https://github.com/thenerdery/javascript-standards)
+- **Tomify**: [tomprats](https://github.com/tomprats)
+- **Traitify**: [traitify/eslint-config-traitify](https://github.com/traitify/eslint-config-traitify)
+- **T4R Technology**: [T4R-Technology/javascript](https://github.com/T4R-Technology/javascript)
+- **UrbanSim**: [urbansim](https://github.com/urbansim/)
+- **VoxFeed**: [VoxFeed/javascript-style-guide](https://github.com/VoxFeed/javascript-style-guide)
+- **WeBox Studio**: [weboxstudio/javascript](https://github.com/weboxstudio/javascript)
+- **Weggo**: [Weggo/javascript](https://github.com/Weggo/javascript)
+- **Zillow**: [zillow/javascript](https://github.com/zillow/javascript)
+- **Zit Software**: [zit-software/javascript](https://github.com/zit-software/javascript)
+- **ZocDoc**: [ZocDoc/javascript](https://github.com/ZocDoc/javascript)
**[⬆ back to top](#table-of-contents)**
## Translation
- This style guide is also available in other languages:
-
- -  **Brazilian Portuguese**: [armoucar/javascript-style-guide](https://github.com/armoucar/javascript-style-guide)
- -  **Bulgarian**: [borislavvv/javascript](https://github.com/borislavvv/javascript)
- -  **Catalan**: [fpmweb/javascript-style-guide](https://github.com/fpmweb/javascript-style-guide)
- -  **Chinese (Simplified)**: [lin-123/javascript](https://github.com/lin-123/javascript)
- -  **Chinese (Traditional)**: [jigsawye/javascript](https://github.com/jigsawye/javascript)
- -  **French**: [nmussy/javascript-style-guide](https://github.com/nmussy/javascript-style-guide)
- -  **German**: [timofurrer/javascript-style-guide](https://github.com/timofurrer/javascript-style-guide)
- -  **Italian**: [sinkswim/javascript-style-guide](https://github.com/sinkswim/javascript-style-guide)
- -  **Japanese**: [mitsuruog/javascript-style-guide](https://github.com/mitsuruog/javascript-style-guide)
- -  **Korean**: [ParkSB/javascript-style-guide](https://github.com/ParkSB/javascript-style-guide)
- -  **Russian**: [leonidlebedev/javascript-airbnb](https://github.com/leonidlebedev/javascript-airbnb)
- -  **Spanish**: [paolocarrasco/javascript-style-guide](https://github.com/paolocarrasco/javascript-style-guide)
- -  **Thai**: [lvarayut/javascript-style-guide](https://github.com/lvarayut/javascript-style-guide)
- -  **Turkish**: [eraycetinay/javascript](https://github.com/eraycetinay/javascript)
- -  **Ukrainian**: [ivanzusko/javascript](https://github.com/ivanzusko/javascript)
- -  **Vietnam**: [dangkyokhoang/javascript-style-guide](https://github.com/dangkyokhoang/javascript-style-guide)
+This style guide is also available in other languages:
+
+-  **Brazilian Portuguese**: [armoucar/javascript-style-guide](https://github.com/armoucar/javascript-style-guide)
+-  **Bulgarian**: [borislavvv/javascript](https://github.com/borislavvv/javascript)
+-  **Catalan**: [fpmweb/javascript-style-guide](https://github.com/fpmweb/javascript-style-guide)
+-  **Chinese (Simplified)**: [lin-123/javascript](https://github.com/lin-123/javascript)
+-  **Chinese (Traditional)**: [jigsawye/javascript](https://github.com/jigsawye/javascript)
+-  **French**: [nmussy/javascript-style-guide](https://github.com/nmussy/javascript-style-guide)
+-  **German**: [timofurrer/javascript-style-guide](https://github.com/timofurrer/javascript-style-guide)
+-  **Italian**: [sinkswim/javascript-style-guide](https://github.com/sinkswim/javascript-style-guide)
+-  **Japanese**: [mitsuruog/javascript-style-guide](https://github.com/mitsuruog/javascript-style-guide)
+-  **Korean**: [ParkSB/javascript-style-guide](https://github.com/ParkSB/javascript-style-guide)
+-  **Russian**: [leonidlebedev/javascript-airbnb](https://github.com/leonidlebedev/javascript-airbnb)
+-  **Spanish**: [paolocarrasco/javascript-style-guide](https://github.com/paolocarrasco/javascript-style-guide)
+-  **Thai**: [lvarayut/javascript-style-guide](https://github.com/lvarayut/javascript-style-guide)
+-  **Turkish**: [eraycetinay/javascript](https://github.com/eraycetinay/javascript)
+-  **Ukrainian**: [ivanzusko/javascript](https://github.com/ivanzusko/javascript)
+-  **Vietnam**: [dangkyokhoang/javascript-style-guide](https://github.com/dangkyokhoang/javascript-style-guide)
## The JavaScript Style Guide Guide
- - [Reference](https://github.com/airbnb/javascript/wiki/The-JavaScript-Style-Guide-Guide)
+- [Reference](https://github.com/airbnb/javascript/wiki/The-JavaScript-Style-Guide-Guide)
## Chat With Us About JavaScript
- - Find us on [gitter](https://gitter.im/airbnb/javascript).
+- Find us on [gitter](https://gitter.im/airbnb/javascript).
## Contributors
- - [View Contributors](https://github.com/airbnb/javascript/graphs/contributors)
+- [View Contributors](https://github.com/airbnb/javascript/graphs/contributors)
## License