diff --git a/README.md b/README.md index bd91faf2ea..b9e2d15ac2 100644 --- a/README.md +++ b/README.md @@ -75,14 +75,14 @@ Other Style Guides
- ```javascript +```javascript const foo = 1; let bar = foo; bar = 9; console.log(foo, bar); // => 1, 9 - ``` +``` - Symbols and BigInts cannot be faithfully polyfilled, so they should not be used when targeting browsers/environments that don’t support them natively. @@ -95,14 +95,14 @@ Other Style Guides
- ```javascript +```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)** @@ -113,7 +113,7 @@ Other Style Guides > Why? This ensures that you can’t reassign your references, which can lead to bugs and difficult to comprehend code. - ```javascript +```javascript // bad var a = 1; var b = 2; @@ -121,14 +121,14 @@ Other Style Guides // good const a = 1; const 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) > Why? `let` is block-scoped rather than function-scoped like `var`. - ```javascript +```javascript // bad var count = 1; if (true) { @@ -140,12 +140,12 @@ Other Style Guides if (true) { count += 1; } - ``` +``` - [2.3](#references--block-scope) Note that both `let` and `const` are block-scoped, whereas `var` is function-scoped. - ```javascript +```javascript // const and let only exist in the blocks they are defined in. { let a = 1; @@ -155,7 +155,7 @@ Other Style Guides 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. @@ -166,20 +166,20 @@ Other Style Guides - [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 +```javascript // bad const item = new Object(); // good const item = {}; - ``` +``` - [3.2](#es6-computed-properties) Use computed property names when creating objects with dynamic property names. > Why? They allow you to define all the properties of an object in one place. - ```javascript +```javascript function getKey(k) { return `a key named ${k}`; @@ -198,12 +198,12 @@ Other Style Guides name: 'San Francisco', [getKey('enabled')]: true, }; - ``` +``` - [3.3](#es6-object-shorthand) Use object method shorthand. eslint: [`object-shorthand`](https://eslint.org/docs/rules/object-shorthand) - ```javascript +```javascript // bad const atom = { value: 1, @@ -221,14 +221,14 @@ Other Style Guides return atom.value + value; }, }; - ``` +``` - [3.4](#es6-object-concise) Use property value shorthand. eslint: [`object-shorthand`](https://eslint.org/docs/rules/object-shorthand) > Why? It is shorter and descriptive. - ```javascript +```javascript const lukeSkywalker = 'Luke Skywalker'; // bad @@ -240,14 +240,14 @@ Other Style Guides const obj = { lukeSkywalker, }; - ``` +``` - [3.5](#objects--grouped-shorthand) Group your shorthand properties at the beginning of your object declaration. > Why? It’s easier to tell which properties are using the shorthand. - ```javascript +```javascript const anakinSkywalker = 'Anakin Skywalker'; const lukeSkywalker = 'Luke Skywalker'; @@ -270,14 +270,14 @@ Other Style Guides 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) > 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 +```javascript // bad const bad = { 'foo': 3, @@ -291,14 +291,14 @@ Other Style Guides bar: 4, 'data-blah': 5, }; - ``` +``` - [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? 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`. - ```javascript +```javascript // bad console.log(object.hasOwnProperty(key)); @@ -317,12 +317,12 @@ Other Style Guides console.log(has(object, key)); /* or */ console.log(Object.hasOwn(object, key)); // https://www.npmjs.com/package/object.hasown - ``` +``` - [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 +```javascript // very bad const original = { a: 1, b: 2 }; const copy = Object.assign(original, { c: 3 }); // this mutates `original` ಠ_ಠ @@ -337,7 +337,7 @@ Other Style Guides 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)** @@ -346,18 +346,18 @@ Other Style Guides - [4.1](#arrays--literals) Use the literal syntax for array creation. eslint: [`no-array-constructor`](https://eslint.org/docs/rules/no-array-constructor) - ```javascript +```javascript // bad const items = new Array(); // good const items = []; - ``` +``` - [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. - ```javascript +```javascript const someStack = []; // bad @@ -365,12 +365,12 @@ Other Style Guides // good someStack.push('abracadabra'); - ``` +``` - [4.3](#es6-array-spreads) Use array spreads `...` to copy arrays. - ```javascript +```javascript // bad const len = items.length; const itemsCopy = []; @@ -382,13 +382,13 @@ Other Style Guides // good const itemsCopy = [...items]; - ``` +``` - [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 +```javascript const foo = document.querySelectorAll('.foo'); // good @@ -396,12 +396,12 @@ Other Style Guides // 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. - ```javascript +```javascript const arrLike = { 0: 'foo', 1: 'bar', 2: 'baz', length: 3 }; // bad @@ -409,23 +409,23 @@ Other Style Guides // good const arr = Array.from(arrLike); - ``` +``` - [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 +```javascript // bad const baz = [...foo].map(bar); // good const baz = Array.from(foo, bar); - ``` +``` - [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 +```javascript // good [1, 2, 3].map((x) => { const y = x + 1; @@ -465,12 +465,12 @@ Other Style Guides 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 +```javascript // bad const arr = [ [0, 1], [2, 3], [4, 5], @@ -502,7 +502,7 @@ Other Style Guides 1, 2, ]; - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -513,7 +513,7 @@ Other Style Guides > 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. - ```javascript +```javascript // bad function getFullName(user) { const firstName = user.firstName; @@ -532,12 +532,12 @@ Other Style Guides function getFullName({ firstName, lastName }) { return `${firstName} ${lastName}`; } - ``` +``` - [5.2](#destructuring--array) Use array destructuring. eslint: [`prefer-destructuring`](https://eslint.org/docs/rules/prefer-destructuring) - ```javascript +```javascript const arr = [1, 2, 3, 4]; // bad @@ -546,14 +546,14 @@ Other Style Guides // good const [first, second] = arr; - ``` +``` - [5.3](#destructuring--object-over-array) Use object destructuring for multiple return values, not array destructuring. > Why? You can add new properties over time or change the order of things without breaking call sites. - ```javascript +```javascript // bad function processInput(input) { // then a miracle occurs @@ -571,7 +571,7 @@ Other Style Guides // the caller selects only the data they need const { left, top } = processInput(input); - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -580,7 +580,7 @@ Other Style Guides - [6.1](#strings--quotes) Use single quotes `''` for strings. eslint: [`quotes`](https://eslint.org/docs/rules/quotes) - ```javascript +```javascript // bad const name = "Capt. Janeway"; @@ -589,14 +589,14 @@ Other Style Guides // good 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. > Why? Broken strings are painful to work with and make code less searchable. - ```javascript +```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 \ @@ -610,14 +610,14 @@ Other Style Guides // good const errorMessage = 'This is a super long error that was thrown because of Batman. When you stop to think about how Batman had anything to do with this, you would get nowhere fast.'; - ``` +``` - [6.3](#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) > Why? Template strings give you a readable, concise syntax with proper newlines and string interpolation features. - ```javascript +```javascript // bad function sayHi(name) { return 'How are you, ' + name + '?'; @@ -637,7 +637,7 @@ Other Style Guides function sayHi(name) { return `How are you, ${name}?`; } - ``` +``` - [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) @@ -647,14 +647,14 @@ Other Style Guides > Why? Backslashes harm readability, thus they should only be present when necessary. - ```javascript +```javascript // bad const foo = '\'this\' \i\s \"quoted\"'; // good const foo = '\'this\' is "quoted"'; const foo = `my name is '${name}'`; - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -665,7 +665,7 @@ Other Style Guides > 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 +```javascript // bad function foo() { // ... @@ -681,19 +681,19 @@ Other Style Guides 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 +```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) @@ -701,7 +701,7 @@ Other Style Guides - [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 +```javascript // bad if (currentUser) { function test() { @@ -716,12 +716,12 @@ Other Style Guides console.log('Yup.'); }; } - ``` +``` - [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. - ```javascript +```javascript // bad function foo(name, options, arguments) { // ... @@ -731,14 +731,14 @@ Other Style Guides function foo(name, options, args) { // ... } - ``` +``` - [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) > Why? `...` is explicit about which arguments you want pulled. Plus, rest arguments are a real Array, and not merely Array-like like `arguments`. - ```javascript +```javascript // bad function concatenateAll() { const args = Array.prototype.slice.call(arguments); @@ -749,12 +749,12 @@ Other Style Guides function concatenateAll(...args) { return args.join(''); } - ``` +``` - [7.7](#es6-default-parameters) Use default parameter syntax rather than mutating function arguments. - ```javascript +```javascript // really bad function handleThings(opts) { // No! We shouldn’t mutate function arguments. @@ -776,14 +776,14 @@ Other Style Guides function handleThings(opts = {}) { // ... } - ``` +``` - [7.8](#functions--default-side-effects) Avoid side effects with default parameters. > Why? They are confusing to reason about. - ```javascript +```javascript let b = 1; // bad function count(a = b++) { @@ -793,12 +793,12 @@ Other Style Guides 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 +```javascript // bad function handleThings(opts = {}, name) { // ... @@ -808,27 +808,27 @@ Other Style Guides 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) > Why? Creating a function in this way evaluates a string similarly to `eval()`, which opens vulnerabilities. - ```javascript +```javascript // bad const add = new 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. - ```javascript +```javascript // bad const f = function(){}; const g = function (){}; @@ -837,14 +837,14 @@ Other Style Guides // good const x = function () {}; const y = function a() {}; - ``` +``` - [7.12](#functions--mutate-params) Never mutate parameters. eslint: [`no-param-reassign`](https://eslint.org/docs/rules/no-param-reassign) > Why? Manipulating objects passed in as parameters can cause unwanted variable side effects in the original caller. - ```javascript +```javascript // bad function f1(obj) { obj.key = 1; @@ -854,14 +854,14 @@ Other Style Guides 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. - ```javascript +```javascript // bad function f1(a) { a = 1; @@ -882,14 +882,14 @@ Other Style Guides 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) > Why? It’s cleaner, you don’t need to supply a context, and you can not easily compose `new` with `apply`. - ```javascript +```javascript // bad const x = [1, 2, 3, 4, 5]; console.log.apply(console, x); @@ -903,12 +903,12 @@ Other Style Guides // 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 +```javascript // bad function foo(bar, baz, @@ -936,7 +936,7 @@ Other Style Guides bar, baz, ); - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -949,7 +949,7 @@ Other Style Guides > Why not? If you have a fairly complicated function, you might move that logic out into its own named function expression. - ```javascript +```javascript // bad [1, 2, 3].map(function (x) { const y = x + 1; @@ -961,14 +961,14 @@ Other Style Guides 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) > Why? Syntactic sugar. It reads well when multiple functions are chained together. - ```javascript +```javascript // bad [1, 2, 3].map((number) => { const nextNumber = number + 1; @@ -1006,14 +1006,14 @@ Other Style Guides 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 +```javascript // bad ['get', 'post', 'put'].map((httpMethod) => Object.prototype.hasOwnProperty.call( httpMagicObjectWithAVeryLongName, @@ -1028,14 +1028,14 @@ Other Style Guides 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 +```javascript // bad [1, 2, 3].map(x => x * x); @@ -1063,12 +1063,12 @@ Other Style Guides 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) - ```javascript +```javascript // bad const itemHeight = (item) => item.height <= 256 ? item.largeSize : item.smallSize; @@ -1083,12 +1083,12 @@ Other Style Guides 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 +```javascript // bad (foo) => bar; @@ -1102,7 +1102,7 @@ Other Style Guides (foo) => ( bar ) - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -1113,7 +1113,7 @@ Other Style Guides > Why? `class` syntax is more concise and easier to reason about. - ```javascript +```javascript // bad function Queue(contents = []) { this.queue = [...contents]; @@ -1135,14 +1135,14 @@ Other Style Guides return value; } } - ``` +``` - [9.2](#constructors--extends) Use `extends` for inheritance. > Why? It is a built-in way to inherit prototype functionality without breaking `instanceof`. - ```javascript +```javascript // bad const inherits = require('inherits'); function PeekableQueue(contents) { @@ -1159,12 +1159,12 @@ Other Style Guides return this.queue[0]; } } - ``` +``` - [9.3](#constructors--chaining) Methods can return `this` to help with method chaining. - ```javascript +```javascript // bad Jedi.prototype.jump = function () { this.jumping = true; @@ -1196,12 +1196,12 @@ Other Style Guides luke.jump() .setHeight(20); - ``` +``` - [9.4](#constructors--tostring) It’s okay to write a custom `toString()` method, just make sure it works successfully and causes no side effects. - ```javascript +```javascript class Jedi { constructor(options = {}) { this.name = options.name || 'no name'; @@ -1215,12 +1215,12 @@ Other Style Guides return `Jedi - ${this.getName()}`; } } - ``` +``` - [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 +```javascript // bad class Jedi { constructor() {} @@ -1244,14 +1244,14 @@ Other Style Guides 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. - ```javascript +```javascript // bad class Foo { bar() { return 1; } @@ -1267,12 +1267,12 @@ Other Style Guides 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 +```javascript // bad class Foo { bar() { @@ -1300,7 +1300,7 @@ Other Style Guides console.log('bar'); } } - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -1311,7 +1311,7 @@ Other Style Guides > Why? Modules are the future, let’s start using the future now. - ```javascript +```javascript // bad const AirbnbStyleGuide = require('./AirbnbStyleGuide'); module.exports = AirbnbStyleGuide.es6; @@ -1323,27 +1323,27 @@ Other Style Guides // 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 +```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 +```javascript // bad // filename es6.js export { es6 as default } from './AirbnbStyleGuide'; @@ -1352,14 +1352,14 @@ Other Style Guides // 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 +```javascript // bad import foo from 'foo'; // … some other imports … // @@ -1373,14 +1373,14 @@ Other Style Guides 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 +```javascript // bad let foo = 3; export { foo }; @@ -1388,27 +1388,27 @@ Other Style Guides // 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 +```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 +```javascript // bad import foo from 'foo'; foo.init(); @@ -1420,7 +1420,7 @@ Other Style Guides 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. @@ -1428,7 +1428,7 @@ Other Style Guides > 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 +```javascript // bad import {longNameA, longNameB, longNameC, longNameD, longNameE} from 'path'; @@ -1440,14 +1440,14 @@ Other Style Guides 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 +```javascript // bad import fooSass from 'css!sass!foo.scss'; import barCss from 'style!css!bar.css'; @@ -1455,14 +1455,14 @@ Other Style Guides // 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 +```javascript // bad import foo from './foo.js'; import bar from './bar.jsx'; @@ -1472,7 +1472,7 @@ Other Style Guides import foo from './foo'; import bar from './bar'; import baz from './baz'; - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -1485,7 +1485,7 @@ Other Style Guides > 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. - ```javascript +```javascript const numbers = [1, 2, 3, 4, 5]; // bad @@ -1520,7 +1520,7 @@ Other Style Guides // best (keeping it functional) const increasedByOne = numbers.map((num) => num + 1); - ``` +``` - [11.2](#generators--nope) Don’t use generators for now. @@ -1532,7 +1532,7 @@ Other Style Guides > Why? `function` and `*` are part of the same conceptual keyword - `*` is not a modifier for `function`, `function*` is a unique construct, different from `function`. - ```javascript +```javascript // bad function * foo() { // ... @@ -1586,7 +1586,7 @@ Other Style Guides const foo = function* () { // ... }; - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -1595,7 +1595,7 @@ Other Style Guides - [12.1](#properties--dot) Use dot notation when accessing properties. eslint: [`dot-notation`](https://eslint.org/docs/rules/dot-notation) - ```javascript +```javascript const luke = { jedi: true, age: 28, @@ -1606,12 +1606,12 @@ Other Style Guides // good const isJedi = luke.jedi; - ``` +``` - [12.2](#properties--bracket) Use bracket notation `[]` when accessing properties with a variable. - ```javascript +```javascript const luke = { jedi: true, age: 28, @@ -1622,18 +1622,18 @@ Other Style Guides } 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). - ```javascript +```javascript // bad const binary = Math.pow(2, 10); // good const binary = 2 ** 10; - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -1642,20 +1642,20 @@ Other Style Guides - [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 +```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 +```javascript // bad const items = getItems(), goSportsTeam = true, @@ -1671,14 +1671,14 @@ Other Style Guides 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 +```javascript // bad let i, len, dragonball, items = getItems(), @@ -1697,14 +1697,14 @@ Other Style Guides 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 +```javascript // bad - unnecessary function call function checkName(hasName) { const name = getName(); @@ -1736,14 +1736,14 @@ Other Style Guides 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 +```javascript // bad (function example() { // JavaScript interprets this as @@ -1769,14 +1769,14 @@ Other Style Guides 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 +```javascript // bad const array = [1, 2, 3]; @@ -1803,14 +1803,14 @@ Other Style Guides 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. - ```javascript +```javascript // bad const foo = superLongLongLongLongLongLongLongLongFunctionName(); @@ -1826,14 +1826,14 @@ Other Style Guides // 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. - ```javascript +```javascript // bad const some_unused_var = 42; @@ -1866,7 +1866,7 @@ Other Style Guides // 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)** @@ -1875,7 +1875,7 @@ Other Style Guides - [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 +```javascript // we know this wouldn’t work (assuming there // is no notDefined global variable) function example() { @@ -1906,12 +1906,12 @@ Other Style Guides 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 +```javascript function example() { console.log(anonymous); // => undefined @@ -1921,12 +1921,12 @@ Other Style Guides console.log('anonymous function expression'); }; } - ``` +``` - [14.3](#hoisting--named-expressions) Named function expressions hoist the variable name, not the function name or the function body. - ```javascript +```javascript function example() { console.log(named); // => undefined @@ -1950,12 +1950,12 @@ Other Style Guides console.log('named'); }; } - ``` +``` - [14.4](#hoisting--declarations) Function declarations hoist their name and the function body. - ```javascript +```javascript function example() { superPower(); // => Flying @@ -1963,14 +1963,14 @@ Other Style Guides console.log('Flying'); } } - ``` +``` - [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) > 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. - ```javascript +```javascript // bad // Variable a is being used before it is being defined. @@ -2013,7 +2013,7 @@ Other Style Guides 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/). @@ -2034,17 +2034,17 @@ Other Style Guides - **Numbers** evaluate to **false** if **+0, -0, or NaN**, otherwise **true** - **Strings** evaluate to **false** if an empty string `''`, otherwise **true** - ```javascript +```javascript if ([0] && []) { // true // an array (even an empty one) is an object, objects will evaluate to true } - ``` +``` - [15.3](#comparison--shortcuts) Use shortcuts for booleans, but explicit comparisons for strings and numbers. - ```javascript +```javascript // bad if (isValid === true) { // ... @@ -2074,7 +2074,7 @@ Other Style Guides 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. @@ -2084,7 +2084,7 @@ Other Style Guides > 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 +```javascript // bad switch (foo) { case 1: @@ -2125,12 +2125,12 @@ Other Style Guides 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 +```javascript // bad const foo = maybe1 > maybe2 ? 'bar' @@ -2146,12 +2146,12 @@ Other Style Guides // 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 +```javascript // bad const foo = a ? a : b; const bar = c ? true : false; @@ -2163,7 +2163,7 @@ Other Style Guides 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. @@ -2171,7 +2171,7 @@ Other Style Guides > Why? This improves readability and clarifies the developer’s intention. - ```javascript +```javascript // bad const foo = a && b < 0 || c > 0 || d + 1 === 0; @@ -2200,14 +2200,14 @@ Other Style Guides // 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. - ```javascript +```javascript // bad const value = 0 ?? 'default'; // returns 0, not 'default' @@ -2227,7 +2227,7 @@ Other Style Guides }; const age = user.age ?? 18; // returns 18 - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -2236,7 +2236,7 @@ Other Style Guides - [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 +```javascript // bad if (test) return false; @@ -2256,12 +2256,12 @@ Other Style Guides function bar() { 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) - ```javascript +```javascript // bad if (test) { thing1(); @@ -2278,12 +2278,12 @@ Other Style Guides } 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 +```javascript // bad function foo() { if (x) { @@ -2343,7 +2343,7 @@ Other Style Guides return z; } } - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -2354,7 +2354,7 @@ Other Style Guides > 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. - ```javascript +```javascript // bad if ((foo === 123 || bar === 'abc') && doesItLookGoodWhenItBecomesThatLong() && isThisReallyHappening()) { thing1(); @@ -2401,12 +2401,12 @@ Other Style Guides if (foo === 123 && bar === 'abc') { thing1(); } - ``` +``` - [17.2](#control-statements--value-selection) Don't use selection operators in place of control statements. - ```javascript +```javascript // bad !isRunning && startRunning(); @@ -2414,7 +2414,7 @@ Other Style Guides if (!isRunning) { startRunning(); } - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -2423,7 +2423,7 @@ Other Style Guides - [18.1](#comments--multiline) Use `/** ... */` for multiline comments. - ```javascript +```javascript // bad // make() returns a new element // based on the passed in tag name @@ -2448,12 +2448,12 @@ Other Style Guides 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. - ```javascript +```javascript // bad const active = true; // is current tab @@ -2487,12 +2487,12 @@ Other Style Guides 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 +```javascript // bad //is current tab const active = true; @@ -2524,7 +2524,7 @@ Other Style Guides 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`. @@ -2532,7 +2532,7 @@ Other Style Guides - [18.5](#comments--fixme) Use `// FIXME:` to annotate problems. - ```javascript +```javascript class Calculator extends Abacus { constructor() { super(); @@ -2541,12 +2541,12 @@ Other Style Guides total = 0; } } - ``` +``` - [18.6](#comments--todo) Use `// TODO:` to annotate solutions to problems. - ```javascript +```javascript class Calculator extends Abacus { constructor() { super(); @@ -2555,7 +2555,7 @@ Other Style Guides this.total = 0; } } - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -2564,7 +2564,7 @@ Other Style Guides - [19.1](#whitespace--spaces) Use soft tabs (space character) set to 2 spaces. eslint: [`indent`](https://eslint.org/docs/rules/indent) - ```javascript +```javascript // bad function foo() { ∙∙∙∙let name; @@ -2579,12 +2579,12 @@ Other Style Guides function baz() { ∙∙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) - ```javascript +```javascript // bad function test(){ console.log('test'); @@ -2606,12 +2606,12 @@ Other Style Guides age: '1 year', breed: 'Bernese Mountain Dog', }); - ``` +``` - [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) - ```javascript +```javascript // bad if(isJedi) { fight (); @@ -2631,49 +2631,49 @@ Other Style Guides function fight() { console.log('Swooosh!'); } - ``` +``` - [19.4](#whitespace--infix-ops) Set off operators with spaces. eslint: [`space-infix-ops`](https://eslint.org/docs/rules/space-infix-ops) - ```javascript +```javascript // bad const x=y+5; // good const x = y + 5; - ``` +``` - [19.5](#whitespace--newline-at-end) End files with a single newline character. eslint: [`eol-last`](https://eslint.org/docs/rules/eol-last) - ```javascript +```javascript // bad import { es6 } from './AirbnbStyleGuide'; // ... export default es6; - ``` +``` - ```javascript +```javascript // bad import { es6 } from './AirbnbStyleGuide'; // ... export default es6;↵ ↵ - ``` +``` - ```javascript +```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 +```javascript // bad $('#items').find('.selected').highlight().end().find('.open').updateCount(); @@ -2715,12 +2715,12 @@ Other Style Guides 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 +```javascript // bad if (foo) { return bar; @@ -2773,12 +2773,12 @@ Other Style Guides ]; return arr; - ``` +``` - [19.8](#whitespace--padded-blocks) Do not pad your blocks with blank lines. eslint: [`padded-blocks`](https://eslint.org/docs/rules/padded-blocks) - ```javascript +```javascript // bad function bar() { @@ -2814,13 +2814,13 @@ Other Style Guides } else { 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) - ```javascript +```javascript // bad class Person { constructor(fullName, email, birthday) { @@ -2868,12 +2868,12 @@ Other Style Guides // .. } } - ``` +``` - [19.10](#whitespace--in-parens) Do not add spaces inside parentheses. eslint: [`space-in-parens`](https://eslint.org/docs/rules/space-in-parens) - ```javascript +```javascript // bad function bar( foo ) { return foo; @@ -2893,12 +2893,12 @@ Other Style Guides 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 +```javascript // bad const foo = [ 1, 2, 3 ]; console.log(foo[ 0 ]); @@ -2906,25 +2906,25 @@ Other Style Guides // 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 +```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 +```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; @@ -2955,12 +2955,12 @@ Other Style Guides }) .done(() => console.log('Congratulations!')) .fail(() => console.log('You have failed this city.')); - ``` +``` - [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) - ```javascript +```javascript // bad function foo() {return true;} if (foo) { bar = 0;} @@ -2968,12 +2968,12 @@ Other Style Guides // good function foo() { return true; } if (foo) { bar = 0; } - ``` +``` - [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 +```javascript // bad const foo = 1,bar = 2; const arr = [1 , 2]; @@ -2981,12 +2981,12 @@ Other Style Guides // 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) - ```javascript +```javascript // bad obj[foo ] obj[ 'foo'] @@ -2998,12 +2998,12 @@ Other Style Guides obj['foo'] const x = { [b]: a } obj[foo[bar]] - ``` +``` - [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) - ```javascript +```javascript // bad func (); @@ -3012,19 +3012,19 @@ Other Style Guides // good func(); - ``` +``` - [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 +```javascript // bad const obj = { foo : 42 }; const obj2 = { foo:42 }; // 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) @@ -3033,7 +3033,7 @@ Other Style Guides - [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 +```javascript // bad - multiple empty lines const x = 1; @@ -3054,7 +3054,7 @@ Other Style Guides const x = 1; const y = 2; - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -3064,7 +3064,7 @@ Other Style Guides - [20.1](#commas--leading-trailing) Leading commas: **Nope.** eslint: [`comma-style`](https://eslint.org/docs/rules/comma-style) - ```javascript +```javascript // bad const story = [ once @@ -3094,14 +3094,14 @@ Other Style Guides 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 +```diff // bad - git diff without trailing comma const hero = { firstName: 'Florence', @@ -3116,9 +3116,9 @@ Other Style Guides lastName: 'Nightingale', + inventorOf: ['coxcomb chart', 'modern nursing'], }; - ``` +``` - ```javascript +```javascript // bad const hero = { firstName: 'Dana', @@ -3190,7 +3190,7 @@ Other Style Guides inventorOf, ...heroArgs ); - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -3201,7 +3201,7 @@ Other Style Guides > 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 +```javascript // bad - raises exception const luke = {} const leia = {} @@ -3238,7 +3238,7 @@ Other Style Guides 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). @@ -3252,7 +3252,7 @@ Other Style Guides - [22.2](#coercion--strings) Strings: eslint: [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers) - ```javascript +```javascript // => this.reviewScore = 9; // bad @@ -3266,14 +3266,14 @@ Other Style Guides // 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) > 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 +```javascript const inputValue = '4'; // bad @@ -3293,12 +3293,12 @@ Other Style Guides // 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. - ```javascript +```javascript // good /** * parseInt was the reason my code was slow. @@ -3306,21 +3306,21 @@ Other Style Guides * 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 +```javascript 2147483647 >> 0; // => 2147483647 2147483648 >> 0; // => -2147483648 2147483649 >> 0; // => -2147483647 - ``` +``` - [22.6](#coercion--booleans) Booleans: eslint: [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers) - ```javascript +```javascript const age = 0; // bad @@ -3331,7 +3331,7 @@ Other Style Guides // best const hasAge = !!age; - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -3340,7 +3340,7 @@ Other Style Guides - [23.1](#naming--descriptive) Avoid single letter names. Be descriptive with your naming. eslint: [`id-length`](https://eslint.org/docs/rules/id-length) - ```javascript +```javascript // bad function q() { // ... @@ -3350,12 +3350,12 @@ Other Style Guides function query() { // ... } - ``` +``` - [23.2](#naming--camelCase) Use camelCase when naming objects, functions, and instances. eslint: [`camelcase`](https://eslint.org/docs/rules/camelcase) - ```javascript +```javascript // bad const OBJEcttsssss = {}; const this_is_my_object = {}; @@ -3364,12 +3364,12 @@ Other Style Guides // 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) - ```javascript +```javascript // bad function user(options) { this.name = options.name; @@ -3389,14 +3389,14 @@ Other Style Guides 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 +```javascript // bad this.__firstName__ = 'Panda'; this.firstName_ = 'Panda'; @@ -3409,12 +3409,12 @@ Other Style Guides // 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 +```javascript // bad function foo() { const self = this; @@ -3437,12 +3437,12 @@ Other Style Guides console.log(this); }; } - ``` +``` - [23.6](#naming--filename-matches-export) A base filename should exactly match the name of its default export. - ```javascript +```javascript // file 1 contents class CheckBox { // ... @@ -3473,37 +3473,37 @@ Other Style Guides 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 +```javascript function makeStyleGuide() { // ... } export default makeStyleGuide; - ``` +``` - [23.8](#naming--PascalCase-singleton) Use PascalCase when you export a constructor / class / singleton / function library / bare object. - ```javascript +```javascript const AirbnbStyleGuide = { es6: { }, }; export default AirbnbStyleGuide; - ``` +``` - [23.9](#naming--Acronyms-and-Initialisms) Acronyms and initialisms should always be all uppercased, or all lowercased. > Why? Names are for readability, not to appease a computer algorithm. - ```javascript +```javascript // bad import SmsContainer from './containers/SmsContainer'; @@ -3532,7 +3532,7 @@ Other Style Guides 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. @@ -3541,7 +3541,7 @@ Other Style Guides - 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 +```javascript // bad const PRIVATE_VARIABLE = 'should not be unnecessarily uppercased within a file'; @@ -3570,7 +3570,7 @@ Other Style Guides export const MAPPING = { key: 'value', }; - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -3582,7 +3582,7 @@ Other Style Guides - [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 +```javascript // bad class Dragon { get age() { @@ -3604,12 +3604,12 @@ Other Style Guides // ... } } - ``` +``` - [24.3](#accessors--boolean-prefix) If the property/method is a `boolean`, use `isVal()` or `hasVal()`. - ```javascript +```javascript // bad if (!dragon.age()) { return false; @@ -3619,12 +3619,12 @@ Other Style Guides if (!dragon.hasAge()) { return false; } - ``` +``` - [24.4](#accessors--consistent) It’s okay to create `get()` and `set()` functions, but be consistent. - ```javascript +```javascript class Jedi { constructor(options = {}) { const lightsaber = options.lightsaber || 'blue'; @@ -3639,7 +3639,7 @@ Other Style Guides return this[key]; } } - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -3648,7 +3648,7 @@ Other Style Guides - [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 +```javascript // bad $(this).trigger('listingUpdated', listing.id); @@ -3657,11 +3657,11 @@ Other Style Guides $(this).on('listingUpdated', (e, listingID) => { // do something with listingID }); - ``` +``` prefer: - ```javascript +```javascript // good $(this).trigger('listingUpdated', { listingID: listing.id }); @@ -3670,7 +3670,7 @@ Other Style Guides $(this).on('listingUpdated', (e, data) => { // do something with data.listingID }); - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -3679,7 +3679,7 @@ Other Style Guides - [26.1](#jquery--dollar-prefix) Prefix jQuery object variables with a `$`. - ```javascript +```javascript // bad const sidebar = $('.sidebar'); @@ -3688,12 +3688,12 @@ Other Style Guides // good const $sidebarBtn = $('.sidebar-btn'); - ``` +``` - [26.2](#jquery--cache) Cache jQuery lookups. - ```javascript +```javascript // bad function setSidebar() { $('.sidebar').hide(); @@ -3716,7 +3716,7 @@ Other Style Guides '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) @@ -3724,7 +3724,7 @@ Other Style Guides - [26.4](#jquery--find) Use `find` with scoped jQuery object queries. - ```javascript +```javascript // bad $('ul', '.sidebar').hide(); @@ -3739,7 +3739,7 @@ Other Style Guides // good $sidebar.find('ul').hide(); - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -3790,7 +3790,7 @@ Other Style Guides > 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 +```javascript // bad isNaN('1.2'); // false isNaN('1.2.3'); // true @@ -3798,7 +3798,7 @@ Other Style Guides // 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`. @@ -3807,14 +3807,14 @@ Other Style Guides > 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. - ```javascript +```javascript // bad isFinite('2e3'); // true // good Number.isFinite('2e3'); // false Number.isFinite(parseInt('2e3', 10)); // true - ``` +``` **[⬆ back to top](#table-of-contents)** @@ -3823,11 +3823,11 @@ Other Style Guides - [30.1](#testing--yup) **Yup.** - ```javascript +```javascript function foo() { return true; } - ``` +``` - [30.2](#testing--for-real) **No, but seriously**: diff --git a/react/README.md b/react/README.md index f61602d161..73c0a1d3fd 100644 --- a/react/README.md +++ b/react/README.md @@ -34,7 +34,7 @@ This style guide is mostly based on the standards that are currently prevalent i - If you have internal state and/or refs, prefer `class extends React.Component` over `React.createClass`. eslint: [`react/prefer-es6-class`](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/prefer-es6-class.md) [`react/prefer-stateless-function`](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/prefer-stateless-function.md) - ```jsx +```jsx // bad const Listing = React.createClass({ // ... @@ -50,11 +50,11 @@ This style guide is mostly based on the standards that are currently prevalent i return
{this.state.hello}
; } } - ``` +``` And if you don’t have state or refs, prefer normal functions (not arrow functions) over classes: - ```jsx +```jsx // bad class Listing extends React.Component { render() { @@ -71,7 +71,7 @@ This style guide is mostly based on the standards that are currently prevalent i function Listing({ hello }) { return
{hello}
; } - ``` +``` ## Mixins @@ -85,7 +85,7 @@ This style guide is mostly based on the standards that are currently prevalent i - **Filename**: Use PascalCase for filenames. E.g., `ReservationCard.jsx`. - **Reference Naming**: Use PascalCase for React components and camelCase for their instances. eslint: [`react/jsx-pascal-case`](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-pascal-case.md) - ```jsx +```jsx // bad import reservationCard from './ReservationCard'; @@ -97,11 +97,11 @@ This style guide is mostly based on the standards that are currently prevalent i // good const reservationItem = ; - ``` +``` - **Component Naming**: Use the filename as the component name. For example, `ReservationCard.jsx` should have a reference name of `ReservationCard`. However, for root components of a directory, use `index.jsx` as the filename and use the directory name as the component name: - ```jsx +```jsx // bad import Footer from './Footer/Footer'; @@ -110,13 +110,13 @@ This style guide is mostly based on the standards that are currently prevalent i // good import Footer from './Footer'; - ``` +``` - **Higher-order Component Naming**: Use a composite of the higher-order component’s name and the passed-in component’s name as the `displayName` on the generated component. For example, the higher-order component `withFoo()`, when passed a component `Bar` should produce a component with a `displayName` of `withFoo(Bar)`. > Why? A component’s `displayName` may be used by developer tools or in error messages, and having a value that clearly expresses this relationship helps people understand what is happening. - ```jsx +```jsx // bad export default function withFoo(WrappedComponent) { return function WithFoo(props) { @@ -137,13 +137,13 @@ This style guide is mostly based on the standards that are currently prevalent i WithFoo.displayName = `withFoo(${wrappedComponentName})`; return WithFoo; } - ``` +``` - **Props Naming**: Avoid using DOM component prop names for different purposes. > Why? People expect props like `style` and `className` to mean one specific thing. Varying this API for a subset of your app makes the code less readable and less maintainable, and may cause bugs. - ```jsx +```jsx // bad @@ -152,13 +152,13 @@ This style guide is mostly based on the standards that are currently prevalent i // good - ``` +``` ## Declaration - Do not use `displayName` for naming components. Instead, name the component by reference. - ```jsx +```jsx // bad export default React.createClass({ displayName: 'ReservationCard', @@ -168,13 +168,13 @@ This style guide is mostly based on the standards that are currently prevalent i // good export default class ReservationCard extends React.Component { } - ``` +``` ## Alignment - Follow these alignment styles for JSX syntax. eslint: [`react/jsx-closing-bracket-location`](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-closing-bracket-location.md) [`react/jsx-closing-tag-location`](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-closing-tag-location.md) - ```jsx +```jsx // bad @@ -235,7 +235,7 @@ This style guide is mostly based on the standards that are currently prevalent i anotherSuperLongParam="baz" /> )} - ``` +``` ## Quotes @@ -243,7 +243,7 @@ This style guide is mostly based on the standards that are currently prevalent i > Why? Regular HTML attributes also typically use double quotes instead of single, so JSX attributes mirror this convention. - ```jsx +```jsx // bad @@ -255,13 +255,13 @@ This style guide is mostly based on the standards that are currently prevalent i // good - ``` +``` ## Spacing - Always include a single space in your self-closing tag. eslint: [`no-multi-spaces`](https://eslint.org/docs/rules/no-multi-spaces), [`react/jsx-tag-spacing`](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-tag-spacing.md) - ```jsx +```jsx // bad @@ -274,23 +274,23 @@ This style guide is mostly based on the standards that are currently prevalent i // good - ``` +``` - Do not pad JSX curly braces with spaces. eslint: [`react/jsx-curly-spacing`](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-curly-spacing.md) - ```jsx +```jsx // bad // good - ``` +``` ## Props - Always use camelCase for prop names, or PascalCase if the prop value is a React component. - ```jsx +```jsx // bad - ``` +``` - Omit the value of the prop when it is explicitly `true`. eslint: [`react/jsx-boolean-value`](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-boolean-value.md) - ```jsx +```jsx // bad