diff --git a/.gitignore b/.gitignore index 6f23de9f75..ac10dfe528 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,7 @@ -**/.idea/** -**.iml -**/target/** -**/nbproject/** -**/node_modules/** +# gitignore -jdk/** -node/** +node_modules + +# Only apps should have lockfiles +yarn.lock +package-lock.json diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000000..43c97e719a --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/.travis.yml b/.travis.yml index cd92e86d6a..bc8324b755 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,36 @@ language: node_js node_js: - - v7 - - v6 - - v5 - - v4 - - '0.12' + - "9" + - "8" + - "7" + - "6" + - "5" + - "4" +before_install: + - 'nvm install-latest-npm' +install: + - 'if [ -n "${PACKAGE-}" ]; then cd "packages/${PACKAGE}"; fi' + - 'if [ "${TRAVIS_NODE_VERSION}" = "0.6" ] || [ "${TRAVIS_NODE_VERSION}" = "0.9" ]; then nvm install --latest-npm 0.8 && npm install && nvm use "${TRAVIS_NODE_VERSION}"; else npm install; fi;' + - 'if [ -n "${ESLINT}" ]; then npm install --no-save "eslint@${ESLINT}"; fi' +script: + - 'if [ -n "${PREPUBLISH-}" ]; then npm run pretravis && npm run prepublish && npm run posttravis; elif [ -n "${LINT-}" ]; then npm run lint; else npm run travis; fi' +sudo: false +env: + matrix: + - 'TEST=true ESLINT=4 PACKAGE=eslint-config-airbnb' + - 'TEST=true ESLINT=4 PACKAGE=eslint-config-airbnb-base' +matrix: + fast_finish: true + include: + - node_js: "lts/*" + env: PREPUBLISH=true ESLINT=4 PACKAGE=eslint-config-airbnb + - node_js: "lts/*" + env: PREPUBLISH=true ESLINT=4 PACKAGE=eslint-config-airbnb-base + - node_js: "lts/*" + env: LINT=true + allow_failures: + - node_js: "9" + - node_js: "7" + - node_js: "5" + - env: PREPUBLISH=true ESLINT=4 PACKAGE=eslint-config-airbnb + - env: PREPUBLISH=true ESLINT=4 PACKAGE=eslint-config-airbnb-base diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000000..69d80c0252 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2012 Airbnb + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index fd5de303c8..0ab714930c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +<<<<<<< HEAD # eslint-config-bstd-base [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] > Shareable ESlint config base on AirBnb's coding standard and Idiomatic's rules @@ -25,3 +26,3861 @@ MIT © [Vladimir Cutkovic](www.bytesimple.com) [travis-url]: https://travis-ci.org/cutkovic/eslint-config-bstd-base [daviddm-image]: https://david-dm.org/cutkovic/eslint-config-bstd-base.svg?theme=shields.io [daviddm-url]: https://david-dm.org/cutkovic/eslint-config-bstd-base +======= +# Airbnb JavaScript Style Guide() { + +*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. + +[![Downloads](https://img.shields.io/npm/dm/eslint-config-airbnb.svg)](https://www.npmjs.com/package/eslint-config-airbnb) +[![Downloads](https://img.shields.io/npm/dm/eslint-config-airbnb-base.svg)](https://www.npmjs.com/package/eslint-config-airbnb-base) +[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/airbnb/javascript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) + +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) + +## 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) + +## Types + + + - [1.1](#types--primitives) **Primitives**: When you access a primitive type you work directly on its value. + + - `string` + - `number` + - `boolean` + - `null` + - `undefined` + - `symbol` + + ```javascript + const foo = 1; + let bar = foo; + + bar = 9; + + console.log(foo, bar); // => 1, 9 + ``` + + - Symbols cannot be faithfully polyfilled, so they should not be used when targeting browsers/environments that don't support them natively. + + + - [1.2](#types--complex) **Complex**: When you access a complex type you work on a reference to its value. + + - `object` + - `array` + - `function` + + ```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.html), [`no-const-assign`](https://eslint.org/docs/rules/no-const-assign.html) + + > Why? This ensures that you can’t reassign your references, which can lead to bugs and difficult to comprehend code. + + ```javascript + // bad + var a = 1; + var b = 2; + + // 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.html) + + > Why? `let` is block-scoped rather than function-scoped like `var`. + + ```javascript + // bad + var count = 1; + if (true) { + count += 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. + + ```javascript + // const and let only exist in the blocks they are defined in. + { + let a = 1; + const b = 1; + } + console.log(a); // ReferenceError + console.log(b); // ReferenceError + ``` + +**[⬆ 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.html) + + ```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 + + function getKey(k) { + return `a key named ${k}`; + } + + // bad + const obj = { + id: 5, + name: 'San Francisco', + }; + obj[getKey('enabled')] = true; + + // good + const obj = { + id: 5, + name: 'San Francisco', + [getKey('enabled')]: true, + }; + ``` + + + - [3.3](#es6-object-shorthand) Use object method shorthand. eslint: [`object-shorthand`](https://eslint.org/docs/rules/object-shorthand.html) + + ```javascript + // bad + const atom = { + value: 1, + + addValue: function (value) { + return atom.value + value; + }, + }; + + // good + const atom = { + value: 1, + + addValue(value) { + return atom.value + value; + }, + }; + ``` + + + - [3.4](#es6-object-concise) Use property value shorthand. eslint: [`object-shorthand`](https://eslint.org/docs/rules/object-shorthand.html) + + > Why? It is shorter to write and descriptive. + + ```javascript + const lukeSkywalker = 'Luke Skywalker'; + + // bad + const obj = { + lukeSkywalker: lukeSkywalker, + }; + + // good + 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 + const anakinSkywalker = 'Anakin Skywalker'; + const lukeSkywalker = 'Luke Skywalker'; + + // bad + const obj = { + episodeOne: 1, + twoJediWalkIntoACantina: 2, + lukeSkywalker, + episodeThree: 3, + mayTheFourth: 4, + anakinSkywalker, + }; + + // good + const obj = { + lukeSkywalker, + anakinSkywalker, + episodeOne: 1, + twoJediWalkIntoACantina: 2, + episodeThree: 3, + mayTheFourth: 4, + }; + ``` + + + - [3.6](#objects--quoted-props) Only quote properties that are invalid identifiers. eslint: [`quote-props`](https://eslint.org/docs/rules/quote-props.html) + + > 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, + }; + + // good + const good = { + foo: 3, + bar: 4, + 'data-blah': 5, + }; + ``` + + + - [3.7](#objects--prototype-builtins) Do not call `Object.prototype` methods directly, such as `hasOwnProperty`, `propertyIsEnumerable`, and `isPrototypeOf`. + + > 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)`). + + ```javascript + // bad + console.log(object.hasOwnProperty(key)); + + // good + console.log(Object.prototype.hasOwnProperty.call(object, key)); + + // best + const has = Object.prototype.hasOwnProperty; // cache the lookup once, in module scope. + /* or */ + import has from 'has'; // https://www.npmjs.com/package/has + // ... + console.log(has.call(object, key)); + ``` + + + - [3.8](#objects--rest-spread) Prefer the object spread operator over [`Object.assign`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) to shallow-copy objects. Use the object rest operator to get a new object with certain properties omitted. + + ```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.html) + + ```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 + const someStack = []; + + // bad + someStack[someStack.length] = 'abracadabra'; + + // good + someStack.push('abracadabra'); + ``` + + + - [4.3](#es6-array-spreads) Use array spreads `...` to copy arrays. + + ```javascript + // bad + const len = items.length; + const itemsCopy = []; + let i; + + for (i = 0; i < len; i += 1) { + itemsCopy[i] = items[i]; + } + + // good + const itemsCopy = [...items]; + ``` + + + - [4.4](#arrays--from) To convert an array-like 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 foo = document.querySelectorAll('.foo'); + + // good + const nodes = Array.from(foo); + + // best + const nodes = [...foo]; + ``` + + + - [4.5](#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); + + // good + const baz = Array.from(foo, bar); + ``` + + + - [4.6](#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); + acc[index] = flatten; + }); + + // good + [[0, 1], [2, 3], [4, 5]].reduce((acc, item, index) => { + const flatten = acc.concat(item); + acc[index] = flatten; + 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.7](#arrays--bracket-newline) Use line breaks after open and before close array brackets if an array has multiple lines + + ```javascript + // bad + const arr = [ + [0, 1], [2, 3], [4, 5], + ]; + + const objectInArray = [{ + id: 1, + }, { + id: 2, + }]; + + const numberInArray = [ + 1, 2, + ]; + + // good + const arr = [[0, 1], [2, 3], [4, 5]]; + + const objectInArray = [ + { + id: 1, + }, + { + id: 2, + }, + ]; + + const numberInArray = [ + 1, + 2, + ]; + ``` + +**[⬆ back to top](#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. + + ```javascript + // bad + function getFullName(user) { + const firstName = user.firstName; + const lastName = user.lastName; + + return `${firstName} ${lastName}`; + } + + // good + function getFullName(user) { + const { firstName, lastName } = user; + return `${firstName} ${lastName}`; + } + + // best + function getFullName({ firstName, lastName }) { + return `${firstName} ${lastName}`; + } + ``` + + + - [5.2](#destructuring--array) Use array destructuring. eslint: [`prefer-destructuring`](https://eslint.org/docs/rules/prefer-destructuring) + + ```javascript + const arr = [1, 2, 3, 4]; + + // bad + const first = arr[0]; + const second = arr[1]; + + // 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 + // bad + function processInput(input) { + // then a miracle occurs + return [left, right, top, bottom]; + } + + // the caller needs to think about the order of return data + const [left, __, top] = processInput(input); + + // good + function processInput(input) { + // then a miracle occurs + return { left, right, top, bottom }; + } + + // the caller selects only the data they need + const { left, top } = processInput(input); + ``` + +**[⬆ back to top](#table-of-contents)** + +## Strings + + + - [6.1](#strings--quotes) Use single quotes `''` for strings. eslint: [`quotes`](https://eslint.org/docs/rules/quotes.html) + + ```javascript + // bad + const name = "Capt. Janeway"; + + // bad - template literals should contain interpolation or newlines + const name = `Capt. Janeway`; + + // good + const name = 'Capt. Janeway'; + ``` + + + - [6.2](#strings--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 + // bad + const errorMessage = 'This is a super long error that was thrown because \ + of Batman. When you stop to think about how Batman had anything to do \ + with this, you would get nowhere \ + fast.'; + + // bad + const errorMessage = 'This is a super long error that was thrown because ' + + 'of Batman. When you stop to think about how Batman had anything to do ' + + 'with this, you would get nowhere fast.'; + + // good + const errorMessage = 'This is a super long error that was thrown because of Batman. When you stop to think about how Batman had anything to do with this, you would get nowhere fast.'; + ``` + + + - [6.3](#es6-template-literals) When programmatically building up strings, use template strings instead of concatenation. eslint: [`prefer-template`](https://eslint.org/docs/rules/prefer-template.html) [`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 + // bad + function sayHi(name) { + return 'How are you, ' + name + '?'; + } + + // bad + function sayHi(name) { + return ['How are you, ', name, '?'].join(); + } + + // bad + function sayHi(name) { + return `How are you, ${ name }?`; + } + + // good + function sayHi(name) { + return `How are you, ${name}?`; + } + ``` + + + - [6.4](#strings--eval) Never use `eval()` on a string, it opens too many vulnerabilities. eslint: [`no-eval`](https://eslint.org/docs/rules/no-eval) + + + - [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\' \i\s \"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) + + > 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.html) + + > 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.html) + + + - [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.'); + } + } + + // good + let test; + if (currentUser) { + test = () => { + 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 + // bad + function foo(name, options, arguments) { + // ... + } + + // good + 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 + // bad + function concatenateAll() { + const args = Array.prototype.slice.call(arguments); + return args.join(''); + } + + // 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 || {}; + // ... + } + + // still bad + function handleThings(opts) { + if (opts === void 0) { + opts = {}; + } + // ... + } + + // good + function handleThings(opts = {}) { + // ... + } + ``` + + + - [7.8](#functions--default-side-effects) Avoid side effects with default parameters. + + > Why? They are confusing to reason about. + + ```javascript + var 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. + + ```javascript + // bad + function handleThings(opts = {}, name) { + // ... + } + + // 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) + + > Why? Creating a function in this way evaluates a string similarly to `eval()`, which opens vulnerabilities. + + ```javascript + // bad + var add = new Function('a', 'b', 'return a + b'); + + // still bad + var 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 + // bad + const f = function(){}; + const g = function (){}; + const h = function() {}; + + // 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.html) + + > 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.html) + + > 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; } + // ... + } + + // good + function f3(a) { + const b = a || 1; + // ... + } + + function f4(a = 1) { + // ... + } + ``` + + + - [7.14](#functions--spread-vs-apply) Prefer the use of the spread operator `...` 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 + // bad + const x = [1, 2, 3, 4, 5]; + console.log.apply(console, x); + + // good + const x = [1, 2, 3, 4, 5]; + console.log(...x); + + // bad + new (Function.prototype.bind.apply(Date, [null, 2016, 8, 5])); + + // good + new Date(...[2016, 8, 5]); + ``` + + + - [7.15](#functions--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) { + // ... + } + + // good + function foo( + bar, + baz, + quux, + ) { + // ... + } + + // bad + 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.html), [`arrow-spacing`](https://eslint.org/docs/rules/arrow-spacing.html) + + > Why? It creates a version of the function that executes in the context of `this`, which is usually what you want, and is a more concise syntax. + + > Why not? If you have a fairly complicated function, you might move that logic out into its own named function expression. + + ```javascript + // bad + [1, 2, 3].map(function (x) { + const y = x + 1; + return x * y; + }); + + // good + [1, 2, 3].map((x) => { + const y = x + 1; + return x * y; + }); + ``` + + + - [8.2](#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.html), [`arrow-body-style`](https://eslint.org/docs/rules/arrow-body-style.html) + + > 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}.`; + }); + + // good + [1, 2, 3].map(number => `A string containing the ${number}.`); + + // good + [1, 2, 3].map((number) => { + const nextNumber = number + 1; + return `A string containing the ${nextNumber}.`; + }); + + // good + [1, 2, 3].map((number, index) => ({ + [index]: number, + })); + + // No implicit return with side effects + function foo(callback) { + const val = callback(); + if (val === true) { + // Do something if callback returns true + } + } + + let bool = false; + + // bad + foo(() => bool = true); + + // good + foo(() => { + bool = true; + }); + ``` + + + - [8.3](#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) If your function takes a single argument and doesn’t use braces, omit the parentheses. Otherwise, always include parentheses around arguments for clarity and consistency. Note: it is also acceptable to always use parentheses, in which case use the [“always” option](https://eslint.org/docs/rules/arrow-parens#always) for eslint. eslint: [`arrow-parens`](https://eslint.org/docs/rules/arrow-parens.html) + + > Why? Less visual clutter. + + ```javascript + // bad + [1, 2, 3].map((x) => x * x); + + // good + [1, 2, 3].map(x => x * x); + + // good + [1, 2, 3].map(number => ( + `A long string with the ${number}. It’s so long that we don’t want it to take up space on the .map line!` + )); + + // bad + [1, 2, 3].map(x => { + const y = x + 1; + return x * y; + }); + + // good + [1, 2, 3].map((x) => { + const y = x + 1; + return x * y; + }); + ``` + + + - [8.5](#arrows--confusing) Avoid confusing arrow function syntax (`=>`) with comparison operators (`<=`, `>=`). eslint: [`no-confusing-arrow`](https://eslint.org/docs/rules/no-confusing-arrow) + + ```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. + + > 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; + }; + + // 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`. + + ```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; + }; + + Jedi.prototype.setHeight = function (height) { + this.height = height; + }; + + const luke = new Jedi(); + luke.jump(); // => true + luke.setHeight(20); // => undefined + + // good + class Jedi { + jump() { + this.jumping = true; + return this; + } + + setHeight(height) { + this.height = height; + return this; + } + } + + const luke = new Jedi(); + + luke.jump() + .setHeight(20); + ``` + + + - [9.4](#constructors--tostring) It’s okay to write a custom `toString()` method, just make sure it works successfully and causes no side effects. + + ```javascript + class Jedi { + constructor(options = {}) { + this.name = options.name || 'no name'; + } + + getName() { + return this.name; + } + + toString() { + 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 + // bad + class Jedi { + constructor() {} + + getName() { + return this.name; + } + } + + // bad + class Rey extends Jedi { + constructor(...args) { + super(...args); + } + } + + // good + class Rey extends Jedi { + constructor(...args) { + super(...args); + this.name = 'Rey'; + } + } + ``` + + + - [9.6](#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 + // bad + class Foo { + bar() { return 1; } + bar() { return 2; } + } + + // good + class Foo { + bar() { return 1; } + } + + // good + class Foo { + bar() { return 2; } + } + ``` + +**[⬆ 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; + + // 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/benmosher/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/benmosher/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/benmosher/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. + + > 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/benmosher/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'; + ``` + +**[⬆ 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.html) [`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. + + > 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 + const numbers = [1, 2, 3, 4, 5]; + + // bad + let sum = 0; + for (let num of numbers) { + sum += num; + } + sum === 15; + + // good + let sum = 0; + numbers.forEach((num) => { + sum += num; + }); + sum === 15; + + // best (use the functional force) + const sum = numbers.reduce((total, num) => total + num, 0); + sum === 15; + + // bad + const increasedByOne = []; + for (let i = 0; i < numbers.length; i++) { + increasedByOne.push(numbers[i] + 1); + } + + // good + const increasedByOne = []; + numbers.forEach((num) => { + increasedByOne.push(num + 1); + }); + + // best (keeping it functional) + const increasedByOne = numbers.map(num => num + 1); + ``` + + + - [11.2](#generators--nope) Don’t use generators for now. + + > 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) + + > 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 + // bad + function * foo() { + // ... + } + + // bad + const bar = function * () { + // ... + }; + + // bad + const baz = function *() { + // ... + }; + + // bad + const quux = function*() { + // ... + }; + + // bad + function*foo() { + // ... + } + + // bad + function *foo() { + // ... + } + + // very bad + function + * + foo() { + // ... + } + + // very bad + const wat = function + * + () { + // ... + }; + + // good + function* foo() { + // ... + } + + // good + const foo = function* () { + // ... + }; + ``` + +**[⬆ back to top](#table-of-contents)** + +## Properties + + + - [12.1](#properties--dot) Use dot notation when accessing properties. eslint: [`dot-notation`](https://eslint.org/docs/rules/dot-notation.html) + + ```javascript + const luke = { + jedi: true, + age: 28, + }; + + // bad + const isJedi = luke['jedi']; + + // good + const isJedi = luke.jedi; + ``` + + + - [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'); + ``` + + - [12.3](#es2016-properties--exponentiation-operator) Use exponentiation operator `**` when calculating exponentiations. eslint: [`no-restricted-properties`](https://eslint.org/docs/rules/no-restricted-properties). + + ```javascript + // bad + const binary = Math.pow(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. eslint: [`one-var`](https://eslint.org/docs/rules/one-var.html) + + > 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 previous 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; + } + + return name; + } + + // good + function checkName(hasName) { + if (hasName === 'test') { + return false; + } + + const name = getName(); + + if (name === 'test') { + this.setName(''); + return false; + } + + return name; + } + ``` + + - [13.5](#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 + + const array = [1, 2, 3]; + let num = 1; + num += 1; + num -= 1; + + const sum = array.reduce((a, b) => a + b, 0); + const truthyCount = array.filter(Boolean).length; + ``` + + + - [13.7](#variables--linebreak) Avoid linebreaks before or after `=` in an assignment. If your assignment violates [`max-len`](https://eslint.org/docs/rules/max-len.html), surround the value in parens. eslint [`operator-linebreak`](https://eslint.org/docs/rules/operator-linebreak.html). + + > Why? Linebreaks surrounding `=` can obfuscate the value of an assignment. + + ```javascript + // bad + const foo = + superLongLongLongLongLongLongLongLongFunctionName(); + + // bad + 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. + + ```javascript + // bad + + var some_unused_var = 42; + + // Write-only variables are not considered as used. + var y = 10; + y = 5; + + // A read for a modification of itself is not considered as used. + var z = 0; + z = z + 1; + + // Unused function arguments. + function getX(x, y) { + return x; + } + + // good + + function getXPlusY(x, y) { + return x + y; + } + + var x = 1; + var y = a + 2; + + 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. + var { 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). It’s important to know why [typeof is no longer safe](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'); + }; + } + ``` + + + - [14.3](#hoisting--named-expressions) Named function expressions hoist the variable name, not the function name or the function body. + + ```javascript + function example() { + console.log(named); // => undefined + + named(); // => TypeError named is not a function + + superPower(); // => ReferenceError superPower is not defined + + var named = 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 + + var named = function named() { + console.log('named'); + }; + } + ``` + + + - [14.4](#hoisting--declarations) Function declarations hoist their name and the function body. + + ```javascript + function example() { + superPower(); // => Flying + + function superPower() { + console.log('Flying'); + } + } + ``` + + - For more information refer to [JavaScript Scoping & Hoisting](http://www.adequatelygood.com/2010/2/JavaScript-Scoping-and-Hoisting/) by [Ben Cherry](http://www.adequatelygood.com/). + +**[⬆ back to top](#table-of-contents)** + +## Comparison Operators & Equality + + + - [15.1](#comparison--eqeqeq) Use `===` and `!==` over `==` and `!=`. eslint: [`eqeqeq`](https://eslint.org/docs/rules/eqeqeq.html) + + + - [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: + + - **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 + 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 + // bad + if (isValid === true) { + // ... + } + + // good + if (isValid) { + // ... + } + + // bad + if (name) { + // ... + } + + // good + if (name !== '') { + // ... + } + + // bad + if (collection.length) { + // ... + } + + // 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.html) + + > 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; + } + 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.html) + + ```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.html) + + ```javascript + // bad + const foo = a ? a : b; + const bar = c ? true : false; + const baz = c ? false : true; + + // good + const foo = a || b; + const bar = !!c; + const baz = !c; + ``` + + + - [15.8](#comparison--no-mixed-operators) When mixing operators, enclose them in parentheses. The only exception is the standard arithmetic operators (`+`, `-`, `*`, & `/`) since their precedence is broadly understood. eslint: [`no-mixed-operators`](https://eslint.org/docs/rules/no-mixed-operators.html) + + > Why? This improves readability and clarifies the developer’s intention. + + ```javascript + // bad + const foo = a && b < 0 || c > 0 || d + 1 === 0; + + // bad + const bar = a ** b - 5 % d; + + // bad + // one may be confused into thinking (a || b) && c + if (a || b && c) { + return d; + } + + // good + const foo = (a && b < 0) || c > 0 || (d + 1 === 0); + + // good + const bar = (a ** b) - (5 % d); + + // good + if (a || (b && c)) { + return d; + } + + // good + const bar = a + b / c * d; + ``` + +**[⬆ back to top](#table-of-contents)** + +## Blocks + + + - [16.1](#blocks--braces) Use braces with all multi-line blocks. eslint: [`nonblock-statement-body-position`](https://eslint.org/docs/rules/nonblock-statement-body-position) + + ```javascript + // bad + if (test) + return false; + + // good + if (test) return false; + + // good + if (test) { + return false; + } + + // bad + function foo() { return false; } + + // good + function bar() { + return false; + } + ``` + + + - [16.2](#blocks--cuddled-elses) If you're using multi-line 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.html) + + ```javascript + // bad + if (test) { + thing1(); + thing2(); + } + else { + thing3(); + } + + // 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 { + return y; + } + } + + // bad + function cats() { + 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; + } + + return y; + } + + // good + function cats() { + if (x) { + return x; + } + + if (y) { + return y; + } + } + + // 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. + + ```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(); + } + + // good + if ( + foo === 123 + && bar === 'abc' + ) { + thing1(); + } + + // good + if ( + (foo === 123 || bar === 'abc') + && doesItLookGoodWhenItBecomesThatLong() + && isThisReallyHappening() + ) { + thing1(); + } + + // good + if (foo === 123 && bar === 'abc') { + thing1(); + } + ``` + + + - [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 multi-line 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; + } + + // good + /** + * make() returns a new element + * based on the passed-in tag name + */ + function make(tag) { + + // ... + + 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 + // bad + const active = true; // is current tab + + // 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'; + + return type; + } + + // good + function getType() { + console.log('fetching type...'); + + // set the default type to 'no type' + const type = this.type || 'no type'; + + return type; + } + + // also good + function getType() { + // set the default type to 'no type' + const type = this.type || 'no 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; + + // 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; + } + + // good + /** + * make() returns a new element + * based on the passed-in tag name + */ + function make(tag) { + + // ... + + 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.5](#comments--fixme) Use `// FIXME:` to annotate problems. + + ```javascript + class Calculator extends Abacus { + constructor() { + super(); + + // 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(); + + // 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.html) + + ```javascript + // bad + function foo() { + ∙∙∙∙let name; + } + + // bad + function bar() { + ∙let name; + } + + // good + 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.html) + + ```javascript + // bad + function test(){ + console.log('test'); + } + + // good + function test() { + console.log('test'); + } + + // bad + dog.set('attr',{ + age: '1 year', + breed: 'Bernese Mountain Dog', + }); + + // good + dog.set('attr', { + 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.html) + + ```javascript + // bad + if(isJedi) { + fight (); + } + + // good + if (isJedi) { + fight(); + } + + // bad + function fight () { + console.log ('Swooosh!'); + } + + // good + 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.html) + + ```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://github.com/eslint/eslint/blob/master/docs/rules/eol-last.md) + + ```javascript + // bad + import { es6 } from './AirbnbStyleGuide'; + // ... + export default es6; + ``` + + ```javascript + // bad + import { es6 } from './AirbnbStyleGuide'; + // ... + export default es6;↵ + ↵ + ``` + + ```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); + ``` + + + - [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 + if (foo) { + return bar; + } + + return baz; + + // bad + const obj = { + foo() { + }, + bar() { + }, + }; + return obj; + + // good + const obj = { + foo() { + }, + + bar() { + }, + }; + + return obj; + + // bad + const arr = [ + function foo() { + }, + function bar() { + }, + ]; + return arr; + + // good + const arr = [ + function foo() { + }, + + function bar() { + }, + ]; + + 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.html) + + ```javascript + // bad + function bar() { + + console.log(foo); + + } + + // bad + if (baz) { + + console.log(qux); + } else { + console.log(foo); + + } + + // bad + class Foo { + + constructor(bar) { + this.bar = bar; + } + } + + // good + function bar() { + console.log(foo); + } + + // good + if (baz) { + console.log(qux); + } else { + console.log(foo); + } + ``` + + + - [19.9](#whitespace--in-parens) Do not add spaces inside parentheses. eslint: [`space-in-parens`](https://eslint.org/docs/rules/space-in-parens.html) + + ```javascript + // bad + function bar( foo ) { + return foo; + } + + // good + function bar(foo) { + return foo; + } + + // bad + if ( foo ) { + console.log(foo); + } + + // good + if (foo) { + console.log(foo); + } + ``` + + + - [19.10](#whitespace--in-brackets) Do not add spaces inside brackets. eslint: [`array-bracket-spacing`](https://eslint.org/docs/rules/array-bracket-spacing.html) + + ```javascript + // bad + const foo = [ 1, 2, 3 ]; + console.log(foo[ 0 ]); + + // good + const foo = [1, 2, 3]; + console.log(foo[0]); + ``` + + + - [19.11](#whitespace--in-braces) Add spaces inside curly braces. eslint: [`object-curly-spacing`](https://eslint.org/docs/rules/object-curly-spacing.html) + + ```javascript + // bad + const foo = {clark: 'kent'}; + + // good + const foo = { clark: 'kent' }; + ``` + + + - [19.12](#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.html) + + > 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; + + // good + $.ajax({ + method: 'POST', + url: 'https://airbnb.com/', + data: { name: 'John' }, + }) + .done(() => console.log('Congratulations!')) + .fail(() => console.log('You have failed this city.')); + ``` + + + - [19.13](#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 + // bad + function foo() {return true;} + if (foo) { bar = 0;} + + // good + function foo() { return true; } + if (foo) { bar = 0; } + ``` + + + - [19.14](#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 + var foo = 1,bar = 2; + var arr = [1 , 2]; + + // good + var foo = 1, bar = 2; + var arr = [1, 2]; + ``` + + + - [19.15](#whitespace--computed-property-spacing) Enforce spacing inside of computed properties. eslint: [`computed-property-spacing`](https://eslint.org/docs/rules/computed-property-spacing) + + ```javascript + // bad + obj[foo ] + obj[ 'foo'] + var x = {[ b ]: a} + obj[foo[ bar ]] + + // good + obj[foo] + obj['foo'] + var x = { [b]: a } + obj[foo[bar]] + ``` + + + - [19.16](#whitespace--func-call-spacing) Enforce spacing between functions and their invocations. eslint: [`func-call-spacing`](https://eslint.org/docs/rules/func-call-spacing) + + ```javascript + // bad + func (); + + func + (); + + // good + func(); + ``` + + + - [19.17](#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 + var obj = { "foo" : 42 }; + var obj2 = { "foo":42 }; + + // good + var obj = { "foo": 42 }; + ``` + + + - [19.18](#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.19](#whitespace--no-multiple-empty-lines) Avoid multiple empty lines and only allow one newline at the end of files. eslint: [`no-multiple-empty-lines`](https://eslint.org/docs/rules/no-multiple-empty-lines) + + + ```javascript + // bad + var x = 1; + + + + var y = 2; + + // good + var x = 1; + + var y = 2; + ``` + + +**[⬆ back to top](#table-of-contents)** + +## Commas + + + - [20.1](#commas--leading-trailing) Leading commas: **Nope.** eslint: [`comma-style`](https://eslint.org/docs/rules/comma-style.html) + + ```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.html) + + > 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 + ); + ``` + +**[⬆ back to top](#table-of-contents)** + +## Semicolons + + + - [21.1](#semicolons--required) **Yup.** eslint: [`semi`](https://eslint.org/docs/rules/semi.html) + + > 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 or not 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') + + // 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'; + } + ``` + + [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.2](#coercion--strings) Strings: eslint: [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers) + + ```javascript + // => this.reviewScore = 9; + + // bad + const totalScore = new String(this.reviewScore); // typeof totalScore is "object" not "string" + + // bad + const totalScore = this.reviewScore + ''; // invokes this.reviewScore.valueOf() + + // 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) + + ```javascript + const inputValue = '4'; + + // bad + const val = new Number(inputValue); + + // bad + const val = +inputValue; + + // bad + const val = inputValue >> 0; + + // bad + const val = parseInt(inputValue); + + // good + const val = Number(inputValue); + + // 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://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; + ``` + + + - [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.6](#coercion--booleans) Booleans: eslint: [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers) + + ```javascript + const age = 0; + + // 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() { + // ... + } + + // good + function query() { + // ... + } + ``` + + + - [23.2](#naming--camelCase) Use camelCase when naming objects, functions, and instances. eslint: [`camelcase`](https://eslint.org/docs/rules/camelcase.html) + + ```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.html) + + ```javascript + // bad + function user(options) { + this.name = options.name; + } + + const bad = new user({ + name: 'nope', + }); + + // 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.html) + + > 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://kangax.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); + }; + } + + // bad + function foo() { + const that = this; + return function () { + console.log(that); + }; + } + + // good + function foo() { + return () => { + console.log(this); + }; + } + ``` + + + - [23.6](#naming--filename-matches-export) A base filename should exactly match the name of its default export. + + ```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() { + // ... + } + + export default makeStyleGuide; + ``` + + + - [23.8](#naming--PascalCase-singleton) Use PascalCase when you export a constructor / class / singleton / function library / bare object. + + ```javascript + const AirbnbStyleGuide = { + es6: { + }, + }; + + export default AirbnbStyleGuide; + ``` + + + - [23.9](#naming--Acronyms-and-Initialisms) Acronyms and initialisms should always be all capitalized, or all lowercased. + + > Why? Names are for readability, not to appease a computer algorithm. + + ```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() { + // ... + } + + set age(value) { + // ... + } + } + + // good + class Dragon { + getAge() { + // ... + } + + setAge(value) { + // ... + } + } + ``` + + + - [24.3](#accessors--boolean-prefix) If the property/method is a `boolean`, use `isVal()` or `hasVal()`. + + ```javascript + // bad + if (!dragon.age()) { + return false; + } + + // 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); + + // ... + + $(this).on('listingUpdated', (e, listingID) => { + // do something with listingID + }); + ``` + + prefer: + + ```javascript + // good + $(this).trigger('listingUpdated', { listingID: listing.id }); + + // ... + + $(this).on('listingUpdated', (e, data) => { + // do something with data.listingID + }); + ``` + + **[⬆ back to top](#table-of-contents)** + +## jQuery + + + - [26.1](#jquery--dollar-prefix) Prefix jQuery object variables with a `$`. + + ```javascript + // bad + const sidebar = $('.sidebar'); + + // good + const $sidebar = $('.sidebar'); + + // good + const $sidebarBtn = $('.sidebar-btn'); + ``` + + + - [26.2](#jquery--cache) Cache jQuery lookups. + + ```javascript + // bad + function setSidebar() { + $('.sidebar').hide(); + + // ... + + $('.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](http://jsperf.com/jquery-find-vs-context-sel/16) + + + - [26.4](#jquery--find) Use `find` with scoped jQuery object queries. + + ```javascript + // bad + $('ul', '.sidebar').hide(); + + // bad + $('.sidebar').find('ul').hide(); + + // good + $('.sidebar 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://kangax.github.io/es5-compat-table/). + +**[⬆ 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. + +1. [Arrow Functions](#arrow-functions) +1. [Classes](#classes--constructors) +1. [Object Shorthand](#es6-object-shorthand) +1. [Object Concise](#es6-object-concise) +1. [Object Computed Properties](#es6-computed-properties) +1. [Template Strings](#es6-template-literals) +1. [Destructuring](#destructuring) +1. [Default Parameters](#es6-default-parameters) +1. [Rest](#es6-rest) +1. [Array Spreads](#es6-array-spreads) +1. [Let and Const](#references) +1. [Exponentiation Operator](#es2016-properties--exponentiation-operator) +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. + +**[⬆ 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. + + + - [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. + + ```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 + ``` + + + - [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. + + ```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.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://jsperf.com/string-vs-array-concat/2) + - [Try/Catch Cost In a Loop](https://jsperf.com/try-catch-in-loop-cost) + - [Bang Function](https://jsperf.com/bang-function) + - [jQuery Find vs Context, Selector](https://jsperf.com/jquery-find-vs-context-sel/13) + - [innerHTML vs textContent for script text](https://jsperf.com/innerhtml-vs-textcontent-for-script-text) + - [Long String Concatenation](https://jsperf.com/ya-string-concat) + - [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)** + +## Resources + +**Learning ES6+** + + - [Latest ECMA spec](https://tc39.github.io/ecma262/) + - [ExploringJS](http://exploringjs.com/) + - [ES6 Compatibility Table](https://kangax.github.io/compat-table/es6/) + - [Comprehensive Overview of ES6 Features](http://es6-features.org/) + +**Read This** + + - [Standard ECMA-262](http://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](http://jshint.com/) - [Airbnb Style .jshintrc](https://github.com/airbnb/javascript/blob/master/linters/.jshintrc) + - Neutrino preset - [neutrino-preset-airbnb-base](https://neutrino.js.org/presets/neutrino-preset-airbnb-base/) + +**Other Style Guides** + + - [Google JavaScript Style Guide](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](http://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](http://www.2ality.com/2013/06/basic-javascript.html) - Dr. Axel Rauschmayer + - [You Might Not Need jQuery](http://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](http://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](http://amzn.com/0321812182) - David Herman + - [Eloquent JavaScript](http://eloquentjavascript.net/) - Marijn Haverbeke + - [You Don’t Know JS: ES6 & Beyond](http://shop.oreilly.com/product/0636920033769.do) - Kyle Simpson + +**Blogs** + + - [JavaScript Weekly](http://javascriptweekly.com/) + - [JavaScript, JavaScript...](https://javascriptweblog.wordpress.com/) + - [Bocoup Weblog](https://bocoup.com/weblog) + - [Adequately Good](http://www.adequatelygood.com/) + - [NCZOnline](https://www.nczonline.net/) + - [Perfection Kills](http://perfectionkills.com/) + - [Ben Alman](http://benalman.com/) + - [Dmitry Baranovskiy](http://dmitry.baranovskiy.com/) + - [nettuts](http://code.tutsplus.com/?s=javascript) + +**Podcasts** + + - [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) + - **3blades**: [3Blades](https://github.com/3blades) + - **4Catalyzer**: [4Catalyzer/javascript](https://github.com/4Catalyzer/javascript) + - **Aan Zee**: [AanZee/javascript](https://github.com/AanZee/javascript) + - **Adult Swim**: [adult-swim/javascript](https://github.com/adult-swim/javascript) + - **Airbnb**: [airbnb/javascript](https://github.com/airbnb/javascript) + - **AltSchool**: [AltSchool/javascript](https://github.com/AltSchool/javascript) + - **Apartmint**: [apartmint/javascript](https://github.com/apartmint/javascript) + - **Ascribe**: [ascribe/javascript](https://github.com/ascribe/javascript) + - **Avalara**: [avalara/javascript](https://github.com/avalara/javascript) + - **Avant**: [avantcredit/javascript](https://github.com/avantcredit/javascript) + - **Axept**: [axept/javascript](https://github.com/axept/javascript) + - **BashPros**: [BashPros/javascript](https://github.com/BashPros/javascript) + - **Billabong**: [billabong/javascript](https://github.com/billabong/javascript) + - **Bisk**: [bisk](https://github.com/Bisk/) + - **Bonhomme**: [bonhommeparis/javascript](https://github.com/bonhommeparis/javascript) + - **Brainshark**: [brainshark/javascript](https://github.com/brainshark/javascript) + - **CaseNine**: [CaseNine/javascript](https://github.com/CaseNine/javascript) + - **Chartboost**: [ChartBoost/javascript-style-guide](https://github.com/ChartBoost/javascript-style-guide) + - **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://www.drupal.org/project/drupal) + - **Ecosia**: [ecosia/javascript](https://github.com/ecosia/javascript) + - **Evernote**: [evernote/javascript-style-guide](https://github.com/evernote/javascript-style-guide) + - **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) + - **Expensify** [Expensify/Style-Guide](https://github.com/Expensify/Style-Guide/blob/master/javascript.md) + - **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) + - **Honey**: [honeyscience/javascript](https://github.com/honeyscience/javascript) + - **How About We**: [howaboutwe/javascript](https://github.com/howaboutwe/javascript-style-guide) + - **Huballin**: [huballin](https://github.com/huballin/) + - **HubSpot**: [HubSpot/javascript](https://github.com/HubSpot/javascript) + - **Hyper**: [hyperoslo/javascript-playbook](https://github.com/hyperoslo/javascript-playbook/blob/master/style.md) + - **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) + - **JeopardyBot**: [kesne/jeopardy-bot](https://github.com/kesne/jeopardy-bot/blob/master/STYLEGUIDE.md) + - **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) + - **ModCloth**: [modcloth/javascript](https://github.com/modcloth/javascript) + - **Money Advice Service**: [moneyadviceservice/javascript](https://github.com/moneyadviceservice/javascript) + - **Muber**: [muber](https://github.com/muber/) + - **National Geographic**: [natgeo](https://github.com/natgeo/) + - **Nimbl3**: [nimbl3/javascript](https://github.com/nimbl3/javascript) + - **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) + - **OutBoxSoft**: [OutBoxSoft/javascript](https://github.com/OutBoxSoft/javascript) + - **Peerby**: [Peerby/javascript](https://github.com/Peerby/javascript) + - **Qotto**: [Qotto/javascript-style-guide](https://github.com/Qotto/javascript-style-guide) + - **Razorfish**: [razorfish/javascript-style-guide](https://github.com/razorfish/javascript-style-guide) + - **reddit**: [reddit/styleguide/javascript](https://github.com/reddit/styleguide/tree/master/javascript) + - **React**: [facebook.github.io/react/contributing/how-to-contribute.html#style-guide](https://facebook.github.io/react/contributing/how-to-contribute.html#style-guide) + - **REI**: [reidev/js-style-guide](https://github.com/rei/code-style-guides/) + - **Ripple**: [ripple/javascript-style-guide](https://github.com/ripple/javascript-style-guide) + - **Sainsbury's Supermarkets**: [jsainsburyplc](https://github.com/jsainsburyplc) + - **SeekingAlpha**: [seekingalpha/javascript-style-guide](https://github.com/seekingalpha/javascript-style-guide) + - **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) + - **TheLadders**: [TheLadders/javascript](https://github.com/TheLadders/javascript) + - **The Nerdery**: [thenerdery/javascript-standards](https://github.com/thenerdery/javascript-standards) + - **T4R Technology**: [T4R-Technology/javascript](https://github.com/T4R-Technology/javascript) + - **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) + - **ZocDoc**: [ZocDoc/javascript](https://github.com/ZocDoc/javascript) + +**[⬆ back to top](#table-of-contents)** + +## Translation + + This style guide is also available in other languages: + + - ![br](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Brazil.png) **Brazilian Portuguese**: [armoucar/javascript-style-guide](https://github.com/armoucar/javascript-style-guide) + - ![bg](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Bulgaria.png) **Bulgarian**: [borislavvv/javascript](https://github.com/borislavvv/javascript) + - ![ca](https://raw.githubusercontent.com/fpmweb/javascript-style-guide/master/img/catala.png) **Catalan**: [fpmweb/javascript-style-guide](https://github.com/fpmweb/javascript-style-guide) + - ![cn](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/China.png) **Chinese (Simplified)**: [yuche/javascript](https://github.com/yuche/javascript) + - ![tw](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Taiwan.png) **Chinese (Traditional)**: [jigsawye/javascript](https://github.com/jigsawye/javascript) + - ![fr](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/France.png) **French**: [nmussy/javascript-style-guide](https://github.com/nmussy/javascript-style-guide) + - ![de](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Germany.png) **German**: [timofurrer/javascript-style-guide](https://github.com/timofurrer/javascript-style-guide) + - ![it](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Italy.png) **Italian**: [sinkswim/javascript-style-guide](https://github.com/sinkswim/javascript-style-guide) + - ![jp](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Japan.png) **Japanese**: [mitsuruog/javascript-style-guide](https://github.com/mitsuruog/javascript-style-guide) + - ![kr](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/South-Korea.png) **Korean**: [ParkSB/javascript-style-guide](https://github.com/ParkSB/javascript-style-guide) + - ![ru](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Russia.png) **Russian**: [leonidlebedev/javascript-airbnb](https://github.com/leonidlebedev/javascript-airbnb) + - ![es](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Spain.png) **Spanish**: [paolocarrasco/javascript-style-guide](https://github.com/paolocarrasco/javascript-style-guide) + - ![th](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Thailand.png) **Thai**: [lvarayut/javascript-style-guide](https://github.com/lvarayut/javascript-style-guide) + - ![tr](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Turkey.png) **Turkish**: [eraycetinay/javascript](https://github.com/eraycetinay/javascript) + - ![ua](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Ukraine.png) **Ukrainian**: [ivanzusko/javascript](https://github.com/ivanzusko/javascript) + - ![vn](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Vietnam.png) **Vietnam**: [hngiang/javascript-style-guide](https://github.com/hngiang/javascript-style-guide) + +## 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). + +## Contributors + + - [View Contributors](https://github.com/airbnb/javascript/graphs/contributors) + +## License + +(The MIT License) + +Copyright (c) 2012 Airbnb + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +'Software'), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +**[⬆ back to top](#table-of-contents)** + +## Amendments + +We encourage you to fork this guide and change the rules to fit your team’s style guide. Below, you may list some amendments to the style guide. This allows you to periodically update your style guide without having to deal with merge conflicts. + +# }; +>>>>>>> 103f5e2a5901392878889ec1f1ad4e59c8d65dc3 diff --git a/css-in-javascript/README.md b/css-in-javascript/README.md new file mode 100644 index 0000000000..d6162df55d --- /dev/null +++ b/css-in-javascript/README.md @@ -0,0 +1,432 @@ +# Airbnb CSS-in-JavaScript Style Guide + +*A mostly reasonable approach to CSS-in-JavaScript* + +## Table of Contents + +1. [Naming](#naming) +1. [Ordering](#ordering) +1. [Nesting](#nesting) +1. [Inline](#inline) +1. [Themes](#themes) + +## Naming + + - Use camelCase for object keys (i.e. "selectors"). + + > Why? We access these keys as properties on the `styles` object in the component, so it is most convenient to use camelCase. + + ```js + // bad + { + 'bermuda-triangle': { + display: 'none', + }, + } + + // good + { + bermudaTriangle: { + display: 'none', + }, + } + ``` + + - Use an underscore for modifiers to other styles. + + > Why? Similar to BEM, this naming convention makes it clear that the styles are intended to modify the element preceded by the underscore. Underscores do not need to be quoted, so they are preferred over other characters, such as dashes. + + ```js + // bad + { + bruceBanner: { + color: 'pink', + transition: 'color 10s', + }, + + bruceBannerTheHulk: { + color: 'green', + }, + } + + // good + { + bruceBanner: { + color: 'pink', + transition: 'color 10s', + }, + + bruceBanner_theHulk: { + color: 'green', + }, + } + ``` + + - Use `selectorName_fallback` for sets of fallback styles. + + > Why? Similar to modifiers, keeping the naming consistent helps reveal the relationship of these styles to the styles that override them in more adequate browsers. + + ```js + // bad + { + muscles: { + display: 'flex', + }, + + muscles_sadBears: { + width: '100%', + }, + } + + // good + { + muscles: { + display: 'flex', + }, + + muscles_fallback: { + width: '100%', + }, + } + ``` + + - Use a separate selector for sets of fallback styles. + + > Why? Keeping fallback styles contained in a separate object clarifies their purpose, which improves readability. + + ```js + // bad + { + muscles: { + display: 'flex', + }, + + left: { + flexGrow: 1, + display: 'inline-block', + }, + + right: { + display: 'inline-block', + }, + } + + // good + { + muscles: { + display: 'flex', + }, + + left: { + flexGrow: 1, + }, + + left_fallback: { + display: 'inline-block', + }, + + right_fallback: { + display: 'inline-block', + }, + } + ``` + + - Use device-agnostic names (e.g. "small", "medium", and "large") to name media query breakpoints. + + > Why? Commonly used names like "phone", "tablet", and "desktop" do not match the characteristics of the devices in the real world. Using these names sets the wrong expectations. + + ```js + // bad + const breakpoints = { + mobile: '@media (max-width: 639px)', + tablet: '@media (max-width: 1047px)', + desktop: '@media (min-width: 1048px)', + }; + + // good + const breakpoints = { + small: '@media (max-width: 639px)', + medium: '@media (max-width: 1047px)', + large: '@media (min-width: 1048px)', + }; + ``` + +## Ordering + + - Define styles after the component. + + > Why? We use a higher-order component to theme our styles, which is naturally used after the component definition. Passing the styles object directly to this function reduces indirection. + + ```jsx + // bad + const styles = { + container: { + display: 'inline-block', + }, + }; + + function MyComponent({ styles }) { + return ( +
+ Never doubt that a small group of thoughtful, committed citizens can + change the world. Indeed, it’s the only thing that ever has. +
+ ); + } + + export default withStyles(() => styles)(MyComponent); + + // good + function MyComponent({ styles }) { + return ( +
+ Never doubt that a small group of thoughtful, committed citizens can + change the world. Indeed, it’s the only thing that ever has. +
+ ); + } + + export default withStyles(() => ({ + container: { + display: 'inline-block', + }, + }))(MyComponent); + ``` + +## Nesting + + - Leave a blank line between adjacent blocks at the same indentation level. + + > Why? The whitespace improves readability and reduces the likelihood of merge conflicts. + + ```js + // bad + { + bigBang: { + display: 'inline-block', + '::before': { + content: "''", + }, + }, + universe: { + border: 'none', + }, + } + + // good + { + bigBang: { + display: 'inline-block', + + '::before': { + content: "''", + }, + }, + + universe: { + border: 'none', + }, + } + ``` + +## Inline + + - Use inline styles for styles that have a high cardinality (e.g. uses the value of a prop) and not for styles that have a low cardinality. + + > Why? Generating themed stylesheets can be expensive, so they are best for discrete sets of styles. + + ```jsx + // bad + export default function MyComponent({ spacing }) { + return ( +
+ ); + } + + // good + function MyComponent({ styles, spacing }) { + return ( +
+ ); + } + export default withStyles(() => ({ + periodic: { + display: 'table', + }, + }))(MyComponent); + ``` + +## Themes + + - Use an abstraction layer such as [react-with-styles](https://github.com/airbnb/react-with-styles) that enables theming. *react-with-styles gives us things like `withStyles()`, `ThemedStyleSheet`, and `css()` which are used in some of the examples in this document.* + + > Why? It is useful to have a set of shared variables for styling your components. Using an abstraction layer makes this more convenient. Additionally, this can help prevent your components from being tightly coupled to any particular underlying implementation, which gives you more freedom. + + - Define colors only in themes. + + ```js + // bad + export default withStyles(() => ({ + chuckNorris: { + color: '#bada55', + }, + }))(MyComponent); + + // good + export default withStyles(({ color }) => ({ + chuckNorris: { + color: color.badass, + }, + }))(MyComponent); + ``` + + - Define fonts only in themes. + + ```js + // bad + export default withStyles(() => ({ + towerOfPisa: { + fontStyle: 'italic', + }, + }))(MyComponent); + + // good + export default withStyles(({ font }) => ({ + towerOfPisa: { + fontStyle: font.italic, + }, + }))(MyComponent); + ``` + + - Define fonts as sets of related styles. + + ```js + // bad + export default withStyles(() => ({ + towerOfPisa: { + fontFamily: 'Italiana, "Times New Roman", serif', + fontSize: '2em', + fontStyle: 'italic', + lineHeight: 1.5, + }, + }))(MyComponent); + + // good + export default withStyles(({ font }) => ({ + towerOfPisa: { + ...font.italian, + }, + }))(MyComponent); + ``` + + - Define base grid units in theme (either as a value or a function that takes a multiplier). + + ```js + // bad + export default withStyles(() => ({ + rip: { + bottom: '-6912px', // 6 feet + }, + }))(MyComponent); + + // good + export default withStyles(({ units }) => ({ + rip: { + bottom: units(864), // 6 feet, assuming our unit is 8px + }, + }))(MyComponent); + + // good + export default withStyles(({ unit }) => ({ + rip: { + bottom: 864 * unit, // 6 feet, assuming our unit is 8px + }, + }))(MyComponent); + ``` + + - Define media queries only in themes. + + ```js + // bad + export default withStyles(() => ({ + container: { + width: '100%', + + '@media (max-width: 1047px)': { + width: '50%', + }, + }, + }))(MyComponent); + + // good + export default withStyles(({ breakpoint }) => ({ + container: { + width: '100%', + + [breakpoint.medium]: { + width: '50%', + }, + }, + }))(MyComponent); + ``` + + - Define tricky fallback properties in themes. + + > Why? Many CSS-in-JavaScript implementations merge style objects together which makes specifying fallbacks for the same property (e.g. `display`) a little tricky. To keep the approach unified, put these fallbacks in the theme. + + ```js + // bad + export default withStyles(() => ({ + .muscles { + display: 'flex', + }, + + .muscles_fallback { + 'display ': 'table', + }, + }))(MyComponent); + + // good + export default withStyles(({ fallbacks }) => ({ + .muscles { + display: 'flex', + }, + + .muscles_fallback { + [fallbacks.display]: 'table', + }, + }))(MyComponent); + + // good + export default withStyles(({ fallback }) => ({ + .muscles { + display: 'flex', + }, + + .muscles_fallback { + [fallback('display')]: 'table', + }, + }))(MyComponent); + ``` + + - Create as few custom themes as possible. Many applications may only have one theme. + + - Namespace custom theme settings under a nested object with a unique and descriptive key. + + ```js + // bad + ThemedStyleSheet.registerTheme('mySection', { + mySectionPrimaryColor: 'green', + }); + + // good + ThemedStyleSheet.registerTheme('mySection', { + mySection: { + primaryColor: 'green', + }, + }); + ``` + +--- + +CSS puns adapted from [Saijo George](https://saijogeorge.com/css-puns/). diff --git a/linters/.eslintrc b/linters/.eslintrc new file mode 100644 index 0000000000..9e203a5473 --- /dev/null +++ b/linters/.eslintrc @@ -0,0 +1,5 @@ +// Use this file as a starting point for your project's .eslintrc. +// Copy this file, and add rule overrides as needed. +{ + "extends": "airbnb" +} diff --git a/linters/.jshintrc b/linters/.jshintrc new file mode 100644 index 0000000000..a7a08a349e --- /dev/null +++ b/linters/.jshintrc @@ -0,0 +1,62 @@ +{ + /* + * ENVIRONMENTS + * ================= + */ + + // Define globals exposed by modern browsers. + "browser": true, + + // Define globals exposed by jQuery. + "jquery": true, + + // Define globals exposed by Node.js. + "node": true, + + // Allow ES6. + "esversion": 6, + + /* + * ENFORCING OPTIONS + * ================= + */ + + // Force all variable names to use either camelCase style or UPPER_CASE + // with underscores. + "camelcase": true, + + // Prohibit use of == and != in favor of === and !==. + "eqeqeq": true, + + // Enforce tab width of 2 spaces. + "indent": 2, + + // Prohibit use of a variable before it is defined. + "latedef": true, + + // Enforce line length to 100 characters + "maxlen": 100, + + // Require capitalized names for constructor functions. + "newcap": true, + + // Enforce use of single quotation marks for strings. + "quotmark": "single", + + // Enforce placing 'use strict' at the top function scope + "strict": true, + + // Prohibit use of explicitly undeclared variables. + "undef": true, + + // Warn when variables are defined but never used. + "unused": true, + + /* + * RELAXING OPTIONS + * ================= + */ + + // Suppress warnings about == null comparisons. + "eqnull": true +} diff --git a/linters/.markdownlint.json b/linters/.markdownlint.json new file mode 100644 index 0000000000..e7a019fed8 --- /dev/null +++ b/linters/.markdownlint.json @@ -0,0 +1,154 @@ +{ + "comment": "Be explicit by listing every available rule. https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md", + "comment": "Note that there will be numeric gaps, not every MD number is implemented in markdownlint.", + + "comment": "MD001: Header levels should only increment by one level at a time", + "header-increment": true, + + "comment": "MD002: First header should be a top level header", + "first-header-h1": true, + + "comment": "MD003: Header style: start with hashes", + "header-style": { + "style": "atx" + }, + + "comment": "MD004: Unordered list style", + "ul-style": { + "style": "dash" + }, + + "comment": "MD005: Consistent indentation for list items at the same level", + "list-indent": true, + + "comment": "MD006: Consider starting bulleted lists at the beginning of the line", + "ul-start-left": false, + + "comment": "MD007: Unordered list indentation: 2 spaces", + "ul-indent": { + "indent": 2 + }, + + "comment": "MD009: Disallow trailing spaces", + "no-trailing-spaces": { + "br-spaces": 0, + "comment": "Empty lines inside list items should not be indented", + "list_item_empty_lines": false + }, + + "comment": "MD010: No hard tabs, not even in code blocks", + "no-hard-tabs": { + "code_blocks": true + }, + + "comment": "MD011: Prevent reversed link syntax", + "no-reversed-links": true, + + "comment": "MD012: Disallow multiple consecutive blank lines", + "no-multiple-blanks": { + "maximum": 1 + }, + + "comment": "MD013: Line length", + "line-length": false, + + "comment": "MD014: Disallow dollar signs used before commands without showing output", + "commands-show-output": true, + + "comment": "MD018: Disallow space after hash on atx style header", + "no-missing-space-atx": true, + + "comment": "MD019: Dissalow multiple spaces after hash on atx style header", + "no-multiple-space-atx": true, + + "comment": "MD020: No space inside hashes on closed atx style header", + "no-missing-space-closed-atx": true, + + "comment": "MD021: Disallow multiple spaces inside hashes on closed atx style header", + "no-multiple-space-closed-atx": true, + + "comment": "MD022: Headers should be surrounded by blank lines", + "comment": "Some headers have preceeding HTML anchors. Unfortunate that we have to disable this, as it otherwise catches a real problem that trips up some Markdown renderers", + "blanks-around-headers": false, + + "comment": "MD023: Headers must start at the beginning of the line", + "header-start-left": true, + + "comment": "MD024: Disallow multiple headers with the same content", + "no-duplicate-header": true, + + "comment": "MD025: Disallow multiple top level headers in the same document", + "comment": "Gotta have a matching closing brace at the end", + "single-h1": false, + + "comment": "MD026: Disallow trailing punctuation in header", + "comment": "Gotta have a semicolon after the ending closing brace", + "no-trailing-punctuation": { + "punctuation" : ".,:!?" + }, + "comment": "MD027: Dissalow multiple spaces after blockquote symbol", + "no-multiple-space-blockquote": true, + + "comment": "MD028: Blank line inside blockquote", + "comment": "Some 'Why?' and 'Why not?' blocks are separated by a blank line", + "no-blanks-blockquote": false, + + "comment": "MD029: Ordered list item prefix", + "ol-prefix": { + "style": "one" + }, + + "comment": "MD030: Spaces after list markers", + "list-marker-space": { + "ul_single": 1, + "ol_single": 1, + "ul_multi": 1, + "ol_multi": 1 + }, + + "comment": "MD031: Fenced code blocks should be surrounded by blank lines", + "blanks-around-fences": true, + + "comment": "MD032: Lists should be surrounded by blank lines", + "comment": "Some lists have preceeding HTML anchors. Unfortunate that we have to disable this, as it otherwise catches a real problem that trips up some Markdown renderers", + "blanks-around-lists": false, + + "comment": "MD033: Disallow inline HTML", + "comment": "HTML is needed for explicit anchors", + "no-inline-html": false, + + "comment": "MD034: No bare URLs used", + "no-bare-urls": true, + + "comment": "MD035: Horizontal rule style", + "hr-style": { + "style": "consistent" + }, + + "comment": "MD036: Do not use emphasis instead of a header", + "no-emphasis-as-header": false, + + "comment": "MD037: Disallow spaces inside emphasis markers", + "no-space-in-emphasis": true, + + "comment": "MD038: Disallow spaces inside code span elements", + "no-space-in-code": true, + + "comment": "MD039: Disallow spaces inside link text", + "no-space-in-links": true, + + "comment": "MD040: Fenced code blocks should have a language specified", + "fenced-code-language": true, + + "comment": "MD041: First line in file should be a top level header", + "first-line-h1": true, + + "comment": "MD042: No empty links", + "no-empty-links": true, + + "comment": "MD043: Required header structure", + "required-headers": false, + + "comment": "MD044: Proper names should have the correct capitalization", + "proper-names": false +} diff --git a/linters/SublimeLinter/SublimeLinter.sublime-settings b/linters/SublimeLinter/SublimeLinter.sublime-settings new file mode 100644 index 0000000000..259dbaff6a --- /dev/null +++ b/linters/SublimeLinter/SublimeLinter.sublime-settings @@ -0,0 +1,73 @@ +/** + * Airbnb JSHint settings for use with SublimeLinter and Sublime Text 2. + * + * 1. Install SublimeLinter at https://github.com/SublimeLinter/SublimeLinter + * 2. Open user preferences for the SublimeLinter package in Sublime Text 2 + * * For Mac OS X go to _Sublime Text 2_ > _Preferences_ > _Package Settings_ > _SublimeLinter_ > _Settings - User_ + * 3. Paste the contents of this file into your settings file + * 4. Save the settings file + * + * @version 0.3.0 + * @see https://github.com/SublimeLinter/SublimeLinter + * @see http://www.jshint.com/docs/ + */ +{ + "jshint_options": + { + /* + * ENVIRONMENTS + * ================= + */ + + // Define globals exposed by modern browsers. + "browser": true, + + // Define globals exposed by jQuery. + "jquery": true, + + // Define globals exposed by Node.js. + "node": true, + + /* + * ENFORCING OPTIONS + * ================= + */ + + // Force all variable names to use either camelCase style or UPPER_CASE + // with underscores. + "camelcase": true, + + // Prohibit use of == and != in favor of === and !==. + "eqeqeq": true, + + // Suppress warnings about == null comparisons. + "eqnull": true, + + // Enforce tab width of 2 spaces. + "indent": 2, + + // Prohibit use of a variable before it is defined. + "latedef": true, + + // Require capitalized names for constructor functions. + "newcap": true, + + // Enforce use of single quotation marks for strings. + "quotmark": "single", + + // Prohibit trailing whitespace. + "trailing": true, + + // Prohibit use of explicitly undeclared variables. + "undef": true, + + // Warn when variables are defined but never used. + "unused": true, + + // Enforce line length to 80 characters + "maxlen": 80, + + // Enforce placing 'use strict' at the top function scope + "strict": true + } +} diff --git a/package.json b/package.json index 6c9525a586..ed0f31875c 100644 --- a/package.json +++ b/package.json @@ -1,4 +1,5 @@ { +<<<<<<< HEAD "name": "eslint-config-bstd-base", "version": "1.0.11", "description": "Shareable ESlint config based on AirBnb's coding standard and Idiomatic's rules", @@ -42,4 +43,45 @@ "test": "gulp" }, "license": "MIT" +======= + "name": "airbnb-style", + "version": "2.0.0", + "description": "A mostly reasonable approach to JavaScript.", + "scripts": { + "preinstall": "npm run install:config && npm run install:config:base", + "install:config": "cd packages/eslint-config-airbnb && npm prune && npm install", + "install:config:base": "cd packages/eslint-config-airbnb-base && npm prune && npm install", + "lint": "markdownlint --config linters/.markdownlint.json README.md */README.md", + "pretest": "npm run --silent lint", + "test": "npm run --silent test:config && npm run --silent test:config:base", + "test:config": "cd packages/eslint-config-airbnb; npm test", + "test:config:base": "cd packages/eslint-config-airbnb-base; npm test", + "pretravis": "npm run --silent lint", + "travis": "npm run --silent travis:config && npm run --silent travis:config:base", + "travis:config": "cd packages/eslint-config-airbnb; npm run travis", + "travis:config:base": "cd packages/eslint-config-airbnb-base; npm run travis" + }, + "repository": { + "type": "git", + "url": "https://github.com/airbnb/javascript.git" + }, + "keywords": [ + "style guide", + "lint", + "airbnb", + "es6", + "es2015", + "react", + "jsx" + ], + "author": "Harrison Shoff (https://twitter.com/hshoff)", + "license": "MIT", + "bugs": { + "url": "https://github.com/airbnb/javascript/issues" + }, + "homepage": "https://github.com/airbnb/javascript", + "devDependencies": { + "markdownlint-cli": "^0.3.1" + } +>>>>>>> 103f5e2a5901392878889ec1f1ad4e59c8d65dc3 } diff --git a/packages/eslint-config-airbnb-base/.babelrc b/packages/eslint-config-airbnb-base/.babelrc new file mode 100644 index 0000000000..e0aceaae1c --- /dev/null +++ b/packages/eslint-config-airbnb-base/.babelrc @@ -0,0 +1,3 @@ +{ + "presets": ["airbnb"] +} diff --git a/packages/eslint-config-airbnb-base/.editorconfig b/packages/eslint-config-airbnb-base/.editorconfig new file mode 120000 index 0000000000..1b3ce07def --- /dev/null +++ b/packages/eslint-config-airbnb-base/.editorconfig @@ -0,0 +1 @@ +../../.editorconfig \ No newline at end of file diff --git a/packages/eslint-config-airbnb-base/.eslintrc b/packages/eslint-config-airbnb-base/.eslintrc new file mode 100644 index 0000000000..f9bd289286 --- /dev/null +++ b/packages/eslint-config-airbnb-base/.eslintrc @@ -0,0 +1,10 @@ +{ + "extends": "./index.js", + "rules": { + // disable requiring trailing commas because it might be nice to revert to + // being JSON at some point, and I don't want to make big changes now. + "comma-dangle": 0, + // we support node 4 + "prefer-destructuring": 0, + }, +} diff --git a/packages/eslint-config-airbnb-base/.npmrc b/packages/eslint-config-airbnb-base/.npmrc new file mode 120000 index 0000000000..cba44bb384 --- /dev/null +++ b/packages/eslint-config-airbnb-base/.npmrc @@ -0,0 +1 @@ +../../.npmrc \ No newline at end of file diff --git a/packages/eslint-config-airbnb-base/CHANGELOG.md b/packages/eslint-config-airbnb-base/CHANGELOG.md new file mode 100644 index 0000000000..6dd34427fc --- /dev/null +++ b/packages/eslint-config-airbnb-base/CHANGELOG.md @@ -0,0 +1,245 @@ +12.1.0 / 2017-10-16 +================== + - [deps] update `eslint` to `v4.9` + +12.0.2 / 2017-10-05 +================== + - [deps] update `eslint` + +12.0.1 / 2017-09-27 +================== + - [fix] ensure all JSX elements are ignored by `indent` (#1569) + - [deps] update `eslint` + +12.0.0 / 2017-09-02 +================== + - [deps] [breaking] require `eslint` v4 + - enable `function-paren-newline`, `for-direction`, `getter-return`, `no-compare-neg-zero`, `semi-style`, `object-curly-newline`, `no-buffer-constructor`, `no-restricted-globals`, `switch-colon-spacing`, `template-tag-spacing`, `prefer-promise-reject-errors`, `prefer-destructuring` + - improve `indent`, `no-multi-spaces`, `no-trailing-spaces`, `no-underscore-dangle` + - [breaking] move `comma-dangle` to Stylistic Issues (#1514) + - [breaking] Rules prohibiting global isNaN, isFinite (#1477) + - [patch] also disallow padding in classes and switches (#1403) + - [patch] support Protractor config files in import/no-extraneous-dependencies (#1543) + +11.3.2 / 2017-08-22 +================== + - [patch] Add jest.config.js to import/no-extraneous-dependencies devDeps (#1522) + - [patch] Improve Gruntfile glob pattern (#1503) + - [deps] update `eslint` v4, `tape` + - [docs] Specify yarn-specific install instructions (#1511) + +11.3.1 / 2017-07-24 +================== + - [fix] `legacy`: remove top-level `ecmaFeatures` + +11.3.0 / 2017-07-23 +================== + - [deps] allow eslint v3 or v4 (#1447) + - [deps] update `eslint-plugin-import` + - [minor] Balanced spacing for inline block comments (#1440) + - [minor] `no-return-assign`: strengthen linting against returning assignments + - [patch] Allow jsx extensions for test files (#1427) + - [patch] `no-restricted-globals`: add confusing globals; leave disabled for now (#1420) + - [patch] Support Protractor config files in import/no-extraneous-dependencies (#1456) + - [docs] Remove TODO in prefer-reflect as it's deprecated (#1452) + - [docs] add yarn instructions (#1463, #1464) + +11.2.0 / 2017-05-14 +================== + - [minor] Disallow unused global variables + +11.1.3 / 2017-04-03 +================== + - [patch] add error messages to `no-restricted-syntax` (#1353) + - [deps] update `eslint` + +11.1.2 / 2017-03-25 +================== + - [patch] `no-param-reassign`: add ignorePropertyModificationsFor (#1325) + - [deps] update `eslint` + +11.1.1 / 2017-03-03 +================== + - [deps] update `eslint` + - [patch] enable `ignoreRestSiblings` in `no-unused-vars` + +11.1.0 / 2017-01-08 +================== + - [minor] enable `no-multi-assign` + - [deps] update `eslint`, `babel-preset-airbnb` + - Update a deprecated option (`eqeqeq`) (#1244) + +11.0.1 / 2017-01-08 +================== + - [deps] update `eslint` + - [docs] add note about `install-peerdeps` (#1234) + - [docs] Updated instructions to support non-bash users (#1214) + +11.0.0 / 2016-12-11 +================== + - [breaking] enable `no-await-in-loop` + - [patch] disable `no-duplicate-imports` rule (#1188, #1195, #1054) + - [patch] `import/no-extraneous-dependencies`: add some comments to ignore patterns + - [patch] add `import/no-extraneous-dependencies` ignore patterns for test files (#1174) + - [patch] `import/no-extraneous-dependencies`: added ignore patterns for config files (#1168) + - [deps] update `eslint`, `eslint-plugin-import`, `tape` + +10.0.1 / 2016-11-07 +================== + - [fix] legacy config should not require `**` + +10.0.0 / 2016-11-06 +================== + - [breaking] prefer `**` over `Math.pow` + - [breaking] `comma-dangle`: require trailing commas for functions + - [breaking] enable `no-useless-return` + - [breaking] tighten up `indent` + - [breaking] tighten up `spaced-comment` + - [breaking] enable `import/no-named-default` + - [patch] loosen `max-len` with `ignoreRegExpLiterals` option + - [patch] loosen `no-extraneous-dependencies` for test files (#959, #1089) + - [deps] update `eslint`, `eslint-plugin-import` + - [dev deps] update `eslint-find-rules` + - [Tests] on `node` `v7` + +9.0.0 / 2016-10-16 +================== + - [breaking] Add `ForOfStatement` to `no-restricted-syntax` (#1122, #1134) + - [breaking] enable `import/no-webpack-loader-syntax` (#1123) + - [breaking] [deps] update `eslint` to `v3.8.0` (#1132) + - [breaking] [deps] update `eslint-plugin-import` to v2 (#1101) + - [patch] `new-cap`: add immutable.js exceptions + - [docs] ensure latest version of config is installed + - [dev deps] update `babel-preset-airbnb`, `eslint`, `eslint-find-rules`, `tape`, `safe-publish-latest` + +8.0.0 / 2016-09-24 +================== + - [breaking] enable rules: `no-restricted-properties`, `prefer-numeric-literals`, `lines-around-directive`, `import/extensions`, `import/no-absolute-path`, `import/no-dynamic-require` + +7.2.0 / 2016-09-23 +================== + - [new] set `ecmaVersion` to 2017; enable object rest/spread; update `babel-preset-airbnb` + - [patch] fix category of `no-restricted-properties` + - [deps] update `eslint`, `eslint-plugin-import`, `eslint-find-rules`, `safe-publish-latest` + +7.1.0 / 2016-09-11 +================== + - [minor] enable `arrow-parens` rule + +7.0.1 / 2016-09-10 +================== + - [patch] loosen `max-len` by ignoring strings + - [deps] update to `eslint` `v3.5.0` + +7.0.0 / 2016-09-06 +================== + - [breaking] Add no-plusplus in style.js and added explanation in README (#1012) + +6.0.0 / 2016-09-06 +================== + - [breaking] `valid-typeof`: enable `requireStringLiterals` option + - [breaking] enable `class-methods-use-this` + - [breaking] enable `symbol-description` + - [breaking] enable `no-bitwise` + - [breaking] enable `no-tabs` + - [breaking] enable `func-call-spacing` + - [breaking] enable `no-template-curly-in-string` + - [patch] remove redundant `DebuggerStatement` from `no-restricted-syntax` (#1031) + - [deps] update `eslint`, `eslint-find-rules`, `eslint-plugin-import` + - Update `ecmaVersion` to `2016` + +5.0.3 / 2016-08-21 +================== + - [fix] correct `import/extensions` list (#1013) + - [refactor] Changed ESLint rule configs to use 'off', 'warn', and 'error' instead of numbers for better readability (#946) + - [deps] update `eslint`, `eslint-plugin-react` + +5.0.2 / 2016-08-12 +================== + - [deps] update `eslint`, `eslint-find-rules`, `eslint-plugin-import` + - [tests] add `safe-publish-latest` to `prepublish` + +5.0.1 / 2016-07-29 +================== + - [patch] `no-unused-expressions`: flesh out options + - [deps] update `eslint` to `v3.2`, `eslint-plugin-import` to `v1.12` + - [tests] improve prepublish script + +5.0.0 / 2016-07-24 +================== + - [breaking] enable `import/newline-after-import` + - [breaking] enable overlooked rules: `linebreak-style`, `new-parens`, `no-continue`, `no-lonely-if`, `operator-assignment`, `space-unary-ops`, `dot-location`, `no-extra-boolean-cast`, `no-this-before-super`, `require-yield`, `no-path-concat`, `no-label-var`, `no-void`, `constructor-super`, `prefer-spread`, `no-new-require`, `no-undef-init`, `no-unexpected-multiline` + - [deps] update `eslint`, `eslint-find-rules`, `eslint-plugin-import`, `babel-tape-runner`; add `babel-preset-airbnb` + - [patch] flesh out defaults: `jsx-quotes` + - [docs] update the peer dep install command to dynamically look up the right version numbers when installing peer deps + - [tests] fix prepublish scripts + +4.0.2 / 2016-07-14 +================== + - [fix] repair accidental comma-dangle change + +4.0.1 / 2016-07-14 (unpublished) +================== + - [fix] Prevent trailing commas in the legacy config (#950) + - [deps] update `eslint-plugin-import` + +4.0.0 / 2016-07-02 +================== + - [breaking] [deps] update `eslint` to v3; drop support for < node 4 + - [breaking] enable `rest-spread-spacing` rule + - [breaking] enable `no-mixed-operators` rule + - [breaking] enable `import` rules: `no-named-as-default`, `no-named-as-default-member`, `no-extraneous-dependencies` + - [breaking] enable `object-property-newline` rule + - [breaking] enable `no-prototype-builtins` rule + - [breaking] enable `no-useless-rename` rule + - [breaking] enable `unicode-bom` rule + - [breaking] Enforce proper generator star spacing (#887) + - [breaking] Enable imports/imports-first rule (#882) + - [breaking] re-order rules; put import rules in separate file (#881) + - [patch] `newline-per-chained-call`: bump the limit to 4 + - [patch] `object-shorthand`: do not warn when the concise form would have a string literal as a name + - [patch] Loosen `prefer-const` to not warn when the variable is “read” before being assigned to + - [refactor] fix quoting of rule properties (#885) + - [refactor] `quotes`: Use object option form rather than deprecated string form. + - [deps] update `eslint`, `eslint-plugin-import`, `eslint-find-rules`, `tape` + - [tests] Only run `eslint-find-rules` on prepublish, not in tests + +3.0.1 / 2016-05-08 +================== + - [patch] re-disable `no-extra-parens` (#869, #867) + +3.0.0 / 2016-05-07 +================== + - [breaking] enable `import/no-mutable-exports` + - [breaking] enable `no-class-assign` rule, to pair with `no-func-assign` + - [breaking] widen `no-extra-parens` to include everything, except `nestedBinaryExpressions` + - [breaking] Re-enabling `newline-per-chained-call` (#748) + - [minor] enable `import/no-amd` + - [patch] enable `import/no-duplicates` + - [deps] update `eslint`, `eslint-plugin-import`, `eslint-find-rules` + +2.0.0 / 2016-04-29 +================== + - [breaking] enable `no-unsafe-finally` rule + - [semver-minor] enable `no-useless-computed-key` rule + - [deps] update `eslint`, `eslint-plugin-import` + +1.0.4 / 2016-04-26 +================== + - [deps] update `eslint-find-rules`, `eslint-plugin-import` + +1.0.3 / 2016-04-21 +================== + - [patch: loosen rules] Allow empty class/object methods + +1.0.2 / 2016-04-20 +================== + - [patch: loosen rules] Allow `break` (#840) + +1.0.1 / 2016-04-19 +================== + - [patch: loosen rules] Allow `== null` (#542) + +1.0.0 / 2016-04-19 +================== + - Initial commmit; moved content over from `eslint-config-airbnb` package. diff --git a/packages/eslint-config-airbnb-base/LICENSE.md b/packages/eslint-config-airbnb-base/LICENSE.md new file mode 100644 index 0000000000..69d80c0252 --- /dev/null +++ b/packages/eslint-config-airbnb-base/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2012 Airbnb + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/eslint-config-airbnb-base/README.md b/packages/eslint-config-airbnb-base/README.md new file mode 100644 index 0000000000..fa0152eb04 --- /dev/null +++ b/packages/eslint-config-airbnb-base/README.md @@ -0,0 +1,97 @@ +# eslint-config-airbnb-base + +[![npm version](https://badge.fury.io/js/eslint-config-airbnb-base.svg)](http://badge.fury.io/js/eslint-config-airbnb-base) + +This package provides Airbnb's base JS .eslintrc (without React plugins) as an extensible shared config. + +## Usage + +We export two ESLint configurations for your usage. + +### eslint-config-airbnb-base + +Our default export contains all of our ESLint rules, including ECMAScript 6+. It requires `eslint` and `eslint-plugin-import`. + +If you use yarn, run `npm info "eslint-config-airbnb-base@latest" peerDependencies` to list the peer dependencies and versions, then run `yarn add --dev @` for each listed peer dependency. See below for npm instructions. + +1. Install the correct versions of each package, which are listed by the command: + + ```sh + npm info "eslint-config-airbnb-base@latest" peerDependencies + ``` + + If using **npm 5+**, use this shortcut + + ```sh + npx install-peerdeps --dev eslint-config-airbnb-base + ``` + + If using **npm < 5**, Linux/OSX users can run + + ```sh + ( + export PKG=eslint-config-airbnb-base; + npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest" + ) + ``` + + Which produces and runs a command like: + + ```sh + npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.# + ``` + + If using **npm < 5**, Windows users can either install all the peer dependencies manually, or use the [install-peerdeps](https://github.com/nathanhleung/install-peerdeps) cli tool. + + ```sh + npm install -g install-peerdeps + install-peerdeps --dev eslint-config-airbnb-base + ``` + + The cli will produce and run a command like: + + ```sh + npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.# + ``` + +2. Add `"extends": "airbnb-base"` to your .eslintrc. + +### eslint-config-airbnb-base/legacy + +Lints ES5 and below. Requires `eslint` and `eslint-plugin-import`. + +1. Install the correct versions of each package, which are listed by the command: + + ```sh + npm info "eslint-config-airbnb-base@latest" peerDependencies + ``` + + Linux/OSX users can run + ```sh + ( + export PKG=eslint-config-airbnb-base; + npm info "$PKG" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG" + ) + ``` + + Which produces and runs a command like: + + ```sh + npm install --save-dev eslint-config-airbnb-base eslint@^3.0.1 eslint-plugin-import@^1.10.3 + ``` + +2. Add `"extends": "airbnb-base/legacy"` to your .eslintrc + +See [Airbnb's overarching ESLint config](https://npmjs.com/eslint-config-airbnb), [Airbnb's Javascript styleguide](https://github.com/airbnb/javascript), and the [ESlint config docs](https://eslint.org/docs/user-guide/configuring#extending-configuration-files) for more information. + +### eslint-config-airbnb-base/whitespace + +This entry point that only warns on whitespace rules and sets all other rules to warnings. View the list of whitespace rules [here](https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/whitespace.js). + +## Improving this config + +Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc? + +You can run tests with `npm test`. + +You can make sure this module lints with itself using `npm run lint`. diff --git a/packages/eslint-config-airbnb-base/index.js b/packages/eslint-config-airbnb-base/index.js new file mode 100644 index 0000000000..4de657b075 --- /dev/null +++ b/packages/eslint-config-airbnb-base/index.js @@ -0,0 +1,21 @@ +module.exports = { + extends: [ + './rules/best-practices', + './rules/errors', + './rules/node', + './rules/style', + './rules/variables', + './rules/es6', + './rules/imports', + ].map(require.resolve), + parserOptions: { + ecmaVersion: 2017, + sourceType: 'module', + ecmaFeatures: { + experimentalObjectRestSpread: true, + }, + }, + rules: { + strict: 'error', + }, +}; diff --git a/packages/eslint-config-airbnb-base/legacy.js b/packages/eslint-config-airbnb-base/legacy.js new file mode 100644 index 0000000000..7cc2441ab3 --- /dev/null +++ b/packages/eslint-config-airbnb-base/legacy.js @@ -0,0 +1,31 @@ +module.exports = { + extends: [ + './rules/best-practices', + './rules/errors', + './rules/node', + './rules/style', + './rules/variables' + ].map(require.resolve), + env: { + browser: true, + node: true, + amd: false, + mocha: false, + jasmine: false + }, + rules: { + 'comma-dangle': ['error', 'never'], + 'prefer-numeric-literals': 'off', + 'no-restricted-properties': ['error', { + object: 'arguments', + property: 'callee', + message: 'arguments.callee is deprecated', + }, { + property: '__defineGetter__', + message: 'Please use Object.defineProperty instead.', + }, { + property: '__defineSetter__', + message: 'Please use Object.defineProperty instead.', + }], + } +}; diff --git a/packages/eslint-config-airbnb-base/package.json b/packages/eslint-config-airbnb-base/package.json new file mode 100644 index 0000000000..a4b83cda9c --- /dev/null +++ b/packages/eslint-config-airbnb-base/package.json @@ -0,0 +1,74 @@ +{ + "name": "eslint-config-airbnb-base", + "version": "12.1.0", + "description": "Airbnb's base JS ESLint config, following our styleguide", + "main": "index.js", + "scripts": { + "prelint": "editorconfig-tools check * rules/* test/*", + "lint": "eslint --report-unused-disable-directives .", + "pretests-only": "node ./test/requires", + "tests-only": "babel-tape-runner ./test/test-*.js", + "prepublish": "(in-install || eslint-find-rules --unused) && (not-in-publish || npm test) && safe-publish-latest", + "pretest": "npm run --silent lint", + "test": "npm run --silent tests-only", + "pretravis": ":", + "travis": "npm run --silent test", + "posttravis": ":" + }, + "repository": { + "type": "git", + "url": "https://github.com/airbnb/javascript" + }, + "keywords": [ + "eslint", + "eslintconfig", + "config", + "airbnb", + "javascript", + "styleguide" + ], + "author": "Jake Teton-Landis (https://twitter.com/@jitl)", + "contributors": [ + { + "name": "Jake Teton-Landis", + "url": "https://twitter.com/jitl" + }, + { + "name": "Jordan Harband", + "email": "ljharb@gmail.com", + "url": "http://ljharb.codes" + }, + { + "name": "Harrison Shoff", + "url": "https://twitter.com/hshoff" + } + ], + "license": "MIT", + "bugs": { + "url": "https://github.com/airbnb/javascript/issues" + }, + "homepage": "https://github.com/airbnb/javascript", + "devDependencies": { + "babel-preset-airbnb": "^2.4.0", + "babel-tape-runner": "^2.0.1", + "editorconfig-tools": "^0.1.1", + "eslint": "^4.19.1", + "eslint-find-rules": "^3.2.3", + "eslint-plugin-import": "^2.12.0", + "in-publish": "^2.0.0", + "safe-publish-latest": "^1.1.1", + "tape": "^4.9.0" + }, + "peerDependencies": { + "eslint": "^4.19.1", + "eslint-plugin-import": "^2.12.0" + }, + "engines": { + "node": ">= 4" + }, + "dependencies": { + "eslint-restricted-globals": "^0.1.1", + "object.assign": "^4.1.0", + "object.entries": "^1.0.4" + } +} diff --git a/packages/eslint-config-airbnb-base/rules/best-practices.js b/packages/eslint-config-airbnb-base/rules/best-practices.js new file mode 100644 index 0000000000..b5712d00b2 --- /dev/null +++ b/packages/eslint-config-airbnb-base/rules/best-practices.js @@ -0,0 +1,318 @@ +module.exports = { + rules: { + // enforces getter/setter pairs in objects + 'accessor-pairs': 'off', + + // enforces return statements in callbacks of array's methods + // https://eslint.org/docs/rules/array-callback-return + 'array-callback-return': ['error', { allowImplicit: true }], + + // treat var statements as if they were block scoped + 'block-scoped-var': 'error', + + // specify the maximum cyclomatic complexity allowed in a program + complexity: ['off', 11], + + // enforce that class methods use "this" + // https://eslint.org/docs/rules/class-methods-use-this + 'class-methods-use-this': ['error', { + exceptMethods: [], + }], + + // require return statements to either always or never specify values + 'consistent-return': 'error', + + // specify curly brace conventions for all control statements + curly: ['error', 'multi-line'], + + // require default case in switch statements + 'default-case': ['error', { commentPattern: '^no default$' }], + + // encourages use of dot notation whenever possible + 'dot-notation': ['error', { allowKeywords: true }], + + // enforces consistent newlines before or after dots + // https://eslint.org/docs/rules/dot-location + 'dot-location': ['error', 'property'], + + // require the use of === and !== + // https://eslint.org/docs/rules/eqeqeq + eqeqeq: ['error', 'always', { null: 'ignore' }], + + // make sure for-in loops have an if statement + 'guard-for-in': 'error', + + // disallow the use of alert, confirm, and prompt + 'no-alert': 'warn', + + // disallow use of arguments.caller or arguments.callee + 'no-caller': 'error', + + // disallow lexical declarations in case/default clauses + // https://eslint.org/docs/rules/no-case-declarations.html + 'no-case-declarations': 'error', + + // disallow division operators explicitly at beginning of regular expression + // https://eslint.org/docs/rules/no-div-regex + 'no-div-regex': 'off', + + // disallow else after a return in an if + // https://eslint.org/docs/rules/no-else-return + 'no-else-return': ['error', { allowElseIf: false }], + + // disallow empty functions, except for standalone funcs/arrows + // https://eslint.org/docs/rules/no-empty-function + 'no-empty-function': ['error', { + allow: [ + 'arrowFunctions', + 'functions', + 'methods', + ] + }], + + // disallow empty destructuring patterns + // https://eslint.org/docs/rules/no-empty-pattern + 'no-empty-pattern': 'error', + + // disallow comparisons to null without a type-checking operator + 'no-eq-null': 'off', + + // disallow use of eval() + 'no-eval': 'error', + + // disallow adding to native types + 'no-extend-native': 'error', + + // disallow unnecessary function binding + 'no-extra-bind': 'error', + + // disallow Unnecessary Labels + // https://eslint.org/docs/rules/no-extra-label + 'no-extra-label': 'error', + + // disallow fallthrough of case statements + 'no-fallthrough': 'error', + + // disallow the use of leading or trailing decimal points in numeric literals + 'no-floating-decimal': 'error', + + // disallow reassignments of native objects or read-only globals + // https://eslint.org/docs/rules/no-global-assign + 'no-global-assign': ['error', { exceptions: [] }], + // deprecated in favor of no-global-assign + 'no-native-reassign': 'off', + + // disallow implicit type conversions + // https://eslint.org/docs/rules/no-implicit-coercion + 'no-implicit-coercion': ['off', { + boolean: false, + number: true, + string: true, + allow: [], + }], + + // disallow var and named functions in global scope + // https://eslint.org/docs/rules/no-implicit-globals + 'no-implicit-globals': 'off', + + // disallow use of eval()-like methods + 'no-implied-eval': 'error', + + // disallow this keywords outside of classes or class-like objects + 'no-invalid-this': 'off', + + // disallow usage of __iterator__ property + 'no-iterator': 'error', + + // disallow use of labels for anything other then loops and switches + 'no-labels': ['error', { allowLoop: false, allowSwitch: false }], + + // disallow unnecessary nested blocks + 'no-lone-blocks': 'error', + + // disallow creation of functions within loops + 'no-loop-func': 'error', + + // disallow magic numbers + // https://eslint.org/docs/rules/no-magic-numbers + 'no-magic-numbers': ['off', { + ignore: [], + ignoreArrayIndexes: true, + enforceConst: true, + detectObjects: false, + }], + + // disallow use of multiple spaces + 'no-multi-spaces': ['error', { + ignoreEOLComments: false, + }], + + // disallow use of multiline strings + 'no-multi-str': 'error', + + // disallow use of new operator when not part of the assignment or comparison + 'no-new': 'error', + + // disallow use of new operator for Function object + 'no-new-func': 'error', + + // disallows creating new instances of String, Number, and Boolean + 'no-new-wrappers': 'error', + + // disallow use of (old style) octal literals + 'no-octal': 'error', + + // disallow use of octal escape sequences in string literals, such as + // var foo = 'Copyright \251'; + 'no-octal-escape': 'error', + + // disallow reassignment of function parameters + // disallow parameter object manipulation except for specific exclusions + // rule: https://eslint.org/docs/rules/no-param-reassign.html + 'no-param-reassign': ['error', { + props: true, + ignorePropertyModificationsFor: [ + 'acc', // for reduce accumulators + 'accumulator', // for reduce accumulators + 'e', // for e.returnvalue + 'ctx', // for Koa routing + 'req', // for Express requests + 'request', // for Express requests + 'res', // for Express responses + 'response', // for Express responses + '$scope', // for Angular 1 scopes + ] + }], + + // disallow usage of __proto__ property + 'no-proto': 'error', + + // disallow declaring the same variable more then once + 'no-redeclare': 'error', + + // disallow certain object properties + // https://eslint.org/docs/rules/no-restricted-properties + 'no-restricted-properties': ['error', { + object: 'arguments', + property: 'callee', + message: 'arguments.callee is deprecated', + }, { + object: 'global', + property: 'isFinite', + message: 'Please use Number.isFinite instead', + }, { + object: 'self', + property: 'isFinite', + message: 'Please use Number.isFinite instead', + }, { + object: 'window', + property: 'isFinite', + message: 'Please use Number.isFinite instead', + }, { + object: 'global', + property: 'isNaN', + message: 'Please use Number.isNaN instead', + }, { + object: 'self', + property: 'isNaN', + message: 'Please use Number.isNaN instead', + }, { + object: 'window', + property: 'isNaN', + message: 'Please use Number.isNaN instead', + }, { + property: '__defineGetter__', + message: 'Please use Object.defineProperty instead.', + }, { + property: '__defineSetter__', + message: 'Please use Object.defineProperty instead.', + }, { + object: 'Math', + property: 'pow', + message: 'Use the exponentiation operator (**) instead.', + }], + + // disallow use of assignment in return statement + 'no-return-assign': ['error', 'always'], + + // disallow redundant `return await` + 'no-return-await': 'error', + + // disallow use of `javascript:` urls. + 'no-script-url': 'error', + + // disallow self assignment + // https://eslint.org/docs/rules/no-self-assign + 'no-self-assign': 'error', + + // disallow comparisons where both sides are exactly the same + 'no-self-compare': 'error', + + // disallow use of comma operator + 'no-sequences': 'error', + + // restrict what can be thrown as an exception + 'no-throw-literal': 'error', + + // disallow unmodified conditions of loops + // https://eslint.org/docs/rules/no-unmodified-loop-condition + 'no-unmodified-loop-condition': 'off', + + // disallow usage of expressions in statement position + 'no-unused-expressions': ['error', { + allowShortCircuit: false, + allowTernary: false, + allowTaggedTemplates: false, + }], + + // disallow unused labels + // https://eslint.org/docs/rules/no-unused-labels + 'no-unused-labels': 'error', + + // disallow unnecessary .call() and .apply() + 'no-useless-call': 'off', + + // disallow useless string concatenation + // https://eslint.org/docs/rules/no-useless-concat + 'no-useless-concat': 'error', + + // disallow unnecessary string escaping + // https://eslint.org/docs/rules/no-useless-escape + 'no-useless-escape': 'error', + + // disallow redundant return; keywords + // https://eslint.org/docs/rules/no-useless-return + 'no-useless-return': 'error', + + // disallow use of void operator + // https://eslint.org/docs/rules/no-void + 'no-void': 'error', + + // disallow usage of configurable warning terms in comments: e.g. todo + 'no-warning-comments': ['off', { terms: ['todo', 'fixme', 'xxx'], location: 'start' }], + + // disallow use of the with statement + 'no-with': 'error', + + // require using Error objects as Promise rejection reasons + // https://eslint.org/docs/rules/prefer-promise-reject-errors + 'prefer-promise-reject-errors': ['error', { allowEmptyReject: true }], + + // require use of the second argument for parseInt() + radix: 'error', + + // require `await` in `async function` (note: this is a horrible rule that should never be used) + // https://eslint.org/docs/rules/require-await + 'require-await': 'off', + + // requires to declare all vars on top of their containing scope + 'vars-on-top': 'error', + + // require immediate function invocation to be wrapped in parentheses + // https://eslint.org/docs/rules/wrap-iife.html + 'wrap-iife': ['error', 'outside', { functionPrototypeMethods: false }], + + // require or disallow Yoda conditions + yoda: 'error' + } +}; diff --git a/packages/eslint-config-airbnb-base/rules/errors.js b/packages/eslint-config-airbnb-base/rules/errors.js new file mode 100644 index 0000000000..8cae2b525e --- /dev/null +++ b/packages/eslint-config-airbnb-base/rules/errors.js @@ -0,0 +1,127 @@ +module.exports = { + rules: { + // Enforce “for” loop update clause moving the counter in the right direction + // https://eslint.org/docs/rules/for-direction + 'for-direction': 'error', + + // Enforces that a return statement is present in property getters + // https://eslint.org/docs/rules/getter-return + 'getter-return': ['error', { allowImplicit: true }], + + // Disallow await inside of loops + // https://eslint.org/docs/rules/no-await-in-loop + 'no-await-in-loop': 'error', + + // Disallow comparisons to negative zero + // https://eslint.org/docs/rules/no-compare-neg-zero + 'no-compare-neg-zero': 'error', + + // disallow assignment in conditional expressions + 'no-cond-assign': ['error', 'always'], + + // disallow use of console + 'no-console': 'warn', + + // disallow use of constant expressions in conditions + 'no-constant-condition': 'warn', + + // disallow control characters in regular expressions + 'no-control-regex': 'error', + + // disallow use of debugger + 'no-debugger': 'error', + + // disallow duplicate arguments in functions + 'no-dupe-args': 'error', + + // disallow duplicate keys when creating object literals + 'no-dupe-keys': 'error', + + // disallow a duplicate case label. + 'no-duplicate-case': 'error', + + // disallow empty statements + 'no-empty': 'error', + + // disallow the use of empty character classes in regular expressions + 'no-empty-character-class': 'error', + + // disallow assigning to the exception in a catch block + 'no-ex-assign': 'error', + + // disallow double-negation boolean casts in a boolean context + // https://eslint.org/docs/rules/no-extra-boolean-cast + 'no-extra-boolean-cast': 'error', + + // disallow unnecessary parentheses + // https://eslint.org/docs/rules/no-extra-parens + 'no-extra-parens': ['off', 'all', { + conditionalAssign: true, + nestedBinaryExpressions: false, + returnAssign: false, + ignoreJSX: 'all', // delegate to eslint-plugin-react + enforceForArrowConditionals: false, + }], + + // disallow unnecessary semicolons + 'no-extra-semi': 'error', + + // disallow overwriting functions written as function declarations + 'no-func-assign': 'error', + + // disallow function or variable declarations in nested blocks + 'no-inner-declarations': 'error', + + // disallow invalid regular expression strings in the RegExp constructor + 'no-invalid-regexp': 'error', + + // disallow irregular whitespace outside of strings and comments + 'no-irregular-whitespace': 'error', + + // disallow the use of object properties of the global object (Math and JSON) as functions + 'no-obj-calls': 'error', + + // disallow use of Object.prototypes builtins directly + // https://eslint.org/docs/rules/no-prototype-builtins + 'no-prototype-builtins': 'error', + + // disallow multiple spaces in a regular expression literal + 'no-regex-spaces': 'error', + + // disallow sparse arrays + 'no-sparse-arrays': 'error', + + // Disallow template literal placeholder syntax in regular strings + // https://eslint.org/docs/rules/no-template-curly-in-string + 'no-template-curly-in-string': 'error', + + // Avoid code that looks like two expressions but is actually one + // https://eslint.org/docs/rules/no-unexpected-multiline + 'no-unexpected-multiline': 'error', + + // disallow unreachable statements after a return, throw, continue, or break statement + 'no-unreachable': 'error', + + // disallow return/throw/break/continue inside finally blocks + // https://eslint.org/docs/rules/no-unsafe-finally + 'no-unsafe-finally': 'error', + + // disallow negating the left operand of relational operators + // https://eslint.org/docs/rules/no-unsafe-negation + 'no-unsafe-negation': 'error', + // disallow negation of the left operand of an in expression + // deprecated in favor of no-unsafe-negation + 'no-negated-in-lhs': 'off', + + // disallow comparisons with the value NaN + 'use-isnan': 'error', + + // ensure JSDoc comments are valid + // https://eslint.org/docs/rules/valid-jsdoc + 'valid-jsdoc': 'off', + + // ensure that the results of typeof are compared against a valid string + // https://eslint.org/docs/rules/valid-typeof + 'valid-typeof': ['error', { requireStringLiterals: true }], + } +}; diff --git a/packages/eslint-config-airbnb-base/rules/es6.js b/packages/eslint-config-airbnb-base/rules/es6.js new file mode 100644 index 0000000000..f9e5198c96 --- /dev/null +++ b/packages/eslint-config-airbnb-base/rules/es6.js @@ -0,0 +1,177 @@ +module.exports = { + env: { + es6: true + }, + parserOptions: { + ecmaVersion: 6, + sourceType: 'module', + ecmaFeatures: { + generators: false, + objectLiteralDuplicateProperties: false + } + }, + + rules: { + // enforces no braces where they can be omitted + // https://eslint.org/docs/rules/arrow-body-style + // TODO: enable requireReturnForObjectLiteral? + 'arrow-body-style': ['error', 'as-needed', { + requireReturnForObjectLiteral: false, + }], + + // require parens in arrow function arguments + // https://eslint.org/docs/rules/arrow-parens + 'arrow-parens': ['error', 'as-needed', { + requireForBlockBody: true, + }], + + // require space before/after arrow function's arrow + // https://eslint.org/docs/rules/arrow-spacing + 'arrow-spacing': ['error', { before: true, after: true }], + + // verify super() callings in constructors + 'constructor-super': 'error', + + // enforce the spacing around the * in generator functions + // https://eslint.org/docs/rules/generator-star-spacing + 'generator-star-spacing': ['error', { before: false, after: true }], + + // disallow modifying variables of class declarations + // https://eslint.org/docs/rules/no-class-assign + 'no-class-assign': 'error', + + // disallow arrow functions where they could be confused with comparisons + // https://eslint.org/docs/rules/no-confusing-arrow + 'no-confusing-arrow': ['error', { + allowParens: true, + }], + + // disallow modifying variables that are declared using const + 'no-const-assign': 'error', + + // disallow duplicate class members + // https://eslint.org/docs/rules/no-dupe-class-members + 'no-dupe-class-members': 'error', + + // disallow importing from the same path more than once + // https://eslint.org/docs/rules/no-duplicate-imports + // replaced by https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md + 'no-duplicate-imports': 'off', + + // disallow symbol constructor + // https://eslint.org/docs/rules/no-new-symbol + 'no-new-symbol': 'error', + + // disallow specific imports + // https://eslint.org/docs/rules/no-restricted-imports + 'no-restricted-imports': ['off', { + paths: [], + patterns: [] + }], + + // disallow to use this/super before super() calling in constructors. + // https://eslint.org/docs/rules/no-this-before-super + 'no-this-before-super': 'error', + + // disallow useless computed property keys + // https://eslint.org/docs/rules/no-useless-computed-key + 'no-useless-computed-key': 'error', + + // disallow unnecessary constructor + // https://eslint.org/docs/rules/no-useless-constructor + 'no-useless-constructor': 'error', + + // disallow renaming import, export, and destructured assignments to the same name + // https://eslint.org/docs/rules/no-useless-rename + 'no-useless-rename': ['error', { + ignoreDestructuring: false, + ignoreImport: false, + ignoreExport: false, + }], + + // require let or const instead of var + 'no-var': 'error', + + // require method and property shorthand syntax for object literals + // https://eslint.org/docs/rules/object-shorthand + 'object-shorthand': ['error', 'always', { + ignoreConstructors: false, + avoidQuotes: true, + }], + + // suggest using arrow functions as callbacks + 'prefer-arrow-callback': ['error', { + allowNamedFunctions: false, + allowUnboundThis: true, + }], + + // suggest using of const declaration for variables that are never modified after declared + 'prefer-const': ['error', { + destructuring: 'any', + ignoreReadBeforeAssign: true, + }], + + // Prefer destructuring from arrays and objects + // https://eslint.org/docs/rules/prefer-destructuring + 'prefer-destructuring': ['error', { + VariableDeclarator: { + array: false, + object: true, + }, + AssignmentExpression: { + array: true, + object: true, + }, + }, { + enforceForRenamedProperties: false, + }], + + // disallow parseInt() in favor of binary, octal, and hexadecimal literals + // https://eslint.org/docs/rules/prefer-numeric-literals + 'prefer-numeric-literals': 'error', + + // suggest using Reflect methods where applicable + // https://eslint.org/docs/rules/prefer-reflect + 'prefer-reflect': 'off', + + // use rest parameters instead of arguments + // https://eslint.org/docs/rules/prefer-rest-params + 'prefer-rest-params': 'error', + + // suggest using the spread operator instead of .apply() + // https://eslint.org/docs/rules/prefer-spread + 'prefer-spread': 'error', + + // suggest using template literals instead of string concatenation + // https://eslint.org/docs/rules/prefer-template + 'prefer-template': 'error', + + // disallow generator functions that do not have yield + // https://eslint.org/docs/rules/require-yield + 'require-yield': 'error', + + // enforce spacing between object rest-spread + // https://eslint.org/docs/rules/rest-spread-spacing + 'rest-spread-spacing': ['error', 'never'], + + // import sorting + // https://eslint.org/docs/rules/sort-imports + 'sort-imports': ['off', { + ignoreCase: false, + ignoreMemberSort: false, + memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'], + }], + + // require a Symbol description + // https://eslint.org/docs/rules/symbol-description + 'symbol-description': 'error', + + // enforce usage of spacing in template strings + // https://eslint.org/docs/rules/template-curly-spacing + 'template-curly-spacing': 'error', + + // enforce spacing around the * in yield* expressions + // https://eslint.org/docs/rules/yield-star-spacing + 'yield-star-spacing': ['error', 'after'] + } +}; diff --git a/packages/eslint-config-airbnb-base/rules/imports.js b/packages/eslint-config-airbnb-base/rules/imports.js new file mode 100644 index 0000000000..a8502d554a --- /dev/null +++ b/packages/eslint-config-airbnb-base/rules/imports.js @@ -0,0 +1,245 @@ +module.exports = { + env: { + es6: true + }, + parserOptions: { + ecmaVersion: 6, + sourceType: 'module' + }, + plugins: [ + 'import' + ], + + settings: { + 'import/resolver': { + node: { + extensions: ['.mjs', '.js', '.json'] + } + }, + 'import/extensions': [ + '.js', + '.mjs', + '.jsx', + ], + 'import/core-modules': [ + ], + 'import/ignore': [ + 'node_modules', + '\\.(coffee|scss|css|less|hbs|svg|json)$', + ], + }, + + rules: { + // Static analysis: + + // ensure imports point to files/modules that can be resolved + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unresolved.md + 'import/no-unresolved': ['error', { commonjs: true, caseSensitive: true }], + + // ensure named imports coupled with named exports + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/named.md#when-not-to-use-it + 'import/named': 'error', + + // ensure default import coupled with default export + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/default.md#when-not-to-use-it + 'import/default': 'off', + + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/namespace.md + 'import/namespace': 'off', + + // Helpful warnings: + + // disallow invalid exports, e.g. multiple defaults + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/export.md + 'import/export': 'error', + + // do not allow a default import name to match a named export + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-as-default.md + 'import/no-named-as-default': 'error', + + // warn on accessing default export property names that are also named exports + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-as-default-member.md + 'import/no-named-as-default-member': 'error', + + // disallow use of jsdoc-marked-deprecated imports + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-deprecated.md + 'import/no-deprecated': 'off', + + // Forbid the use of extraneous packages + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md + // paths are treated both as absolute paths, and relative to process.cwd() + 'import/no-extraneous-dependencies': ['error', { + devDependencies: [ + 'test/**', // tape, common npm pattern + 'tests/**', // also common npm pattern + 'spec/**', // mocha, rspec-like pattern + '**/__tests__/**', // jest pattern + '**/__mocks__/**', // jest pattern + 'test.{js,jsx}', // repos with a single test file + 'test-*.{js,jsx}', // repos with multiple top-level test files + '**/*{.,_}{test,spec}.{js,jsx}', // tests where the extension or filename suffix denotes that it is a test + '**/jest.config.js', // jest config + '**/webpack.config.js', // webpack config + '**/webpack.config.*.js', // webpack config + '**/rollup.config.js', // rollup config + '**/rollup.config.*.js', // rollup config + '**/gulpfile.js', // gulp config + '**/gulpfile.*.js', // gulp config + '**/Gruntfile{,.js}', // grunt config + '**/protractor.conf.js', // protractor config + '**/protractor.conf.*.js', // protractor config + ], + optionalDependencies: false, + }], + + // Forbid mutable exports + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-mutable-exports.md + 'import/no-mutable-exports': 'error', + + // Module systems: + + // disallow require() + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-commonjs.md + 'import/no-commonjs': 'off', + + // disallow AMD require/define + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-amd.md + 'import/no-amd': 'error', + + // No Node.js builtin modules + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-nodejs-modules.md + // TODO: enable? + 'import/no-nodejs-modules': 'off', + + // Style guide: + + // disallow non-import statements appearing before import statements + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/first.md + 'import/first': ['error', 'absolute-first'], + + // disallow non-import statements appearing before import statements + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/imports-first.md + // deprecated: use `import/first` + 'import/imports-first': 'off', + + // disallow duplicate imports + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md + 'import/no-duplicates': 'error', + + // disallow namespace imports + // TODO: enable? + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-namespace.md + 'import/no-namespace': 'off', + + // Ensure consistent use of file extension within the import path + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/extensions.md + 'import/extensions': ['error', 'ignorePackages', { + js: 'never', + mjs: 'never', + jsx: 'never', + }], + + // Enforce a convention in module import order + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md + // TODO: enable? + 'import/order': ['off', { + groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'], + 'newlines-between': 'never', + }], + + // Require a newline after the last import/require in a group + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/newline-after-import.md + 'import/newline-after-import': 'error', + + // Require modules with a single export to use a default export + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md + 'import/prefer-default-export': 'error', + + // Restrict which files can be imported in a given folder + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-restricted-paths.md + 'import/no-restricted-paths': 'off', + + // Forbid modules to have too many dependencies + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/max-dependencies.md + 'import/max-dependencies': ['off', { max: 10 }], + + // Forbid import of modules using absolute paths + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-absolute-path.md + 'import/no-absolute-path': 'error', + + // Forbid require() calls with expressions + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-dynamic-require.md + 'import/no-dynamic-require': 'error', + + // prevent importing the submodules of other modules + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-internal-modules.md + 'import/no-internal-modules': ['off', { + allow: [], + }], + + // Warn if a module could be mistakenly parsed as a script by a consumer + // leveraging Unambiguous JavaScript Grammar + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/unambiguous.md + // this should not be enabled until this proposal has at least been *presented* to TC39. + // At the moment, it's not a thing. + 'import/unambiguous': 'off', + + // Forbid Webpack loader syntax in imports + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-webpack-loader-syntax.md + 'import/no-webpack-loader-syntax': 'error', + + // Prevent unassigned imports + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unassigned-import.md + // importing for side effects is perfectly acceptable, if you need side effects. + 'import/no-unassigned-import': 'off', + + // Prevent importing the default as if it were named + // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-default.md + 'import/no-named-default': 'error', + + // Reports if a module's default export is unnamed + // https://github.com/benmosher/eslint-plugin-import/blob/d9b712ac7fd1fddc391f7b234827925c160d956f/docs/rules/no-anonymous-default-export.md + 'import/no-anonymous-default-export': ['off', { + allowArray: false, + allowArrowFunction: false, + allowAnonymousClass: false, + allowAnonymousFunction: false, + allowLiteral: false, + allowObject: false, + }], + + // This rule enforces that all exports are declared at the bottom of the file. + // https://github.com/benmosher/eslint-plugin-import/blob/98acd6afd04dcb6920b81330114e146dc8532ea4/docs/rules/exports-last.md + // TODO: enable? + 'import/exports-last': 'off', + + // Reports when named exports are not grouped together in a single export declaration + // or when multiple assignments to CommonJS module.exports or exports object are present + // in a single file. + // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/group-exports.md + 'import/group-exports': 'off', + + // forbid default exports. this is a terrible rule, do not use it. + // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-default-export.md + 'import/no-default-export': 'off', + + // Forbid a module from importing itself + // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-self-import.md + 'import/no-self-import': 'error', + + // Forbid cyclical dependencies between modules + // https://github.com/benmosher/eslint-plugin-import/blob/d81f48a2506182738409805f5272eff4d77c9348/docs/rules/no-cycle.md + 'import/no-cycle': ['error', { maxDepth: Infinity }], + + // Ensures that there are no useless path segments + // https://github.com/benmosher/eslint-plugin-import/blob/ebafcbf59ec9f653b2ac2a0156ca3bcba0a7cf57/docs/rules/no-useless-path-segments.md + 'import/no-useless-path-segments': 'error', + + // dynamic imports require a leading comment with a webpackChunkName + // https://github.com/benmosher/eslint-plugin-import/blob/ebafcbf59ec9f653b2ac2a0156ca3bcba0a7cf57/docs/rules/dynamic-import-chunkname.md + 'import/dynamic-import-chunkname': ['off', { + importFunctions: [], + webpackChunknameFormat: '[0-9a-zA-Z-_/.]+', + }], + }, +}; diff --git a/packages/eslint-config-airbnb-base/rules/node.js b/packages/eslint-config-airbnb-base/rules/node.js new file mode 100644 index 0000000000..b178d7f909 --- /dev/null +++ b/packages/eslint-config-airbnb-base/rules/node.js @@ -0,0 +1,43 @@ +module.exports = { + env: { + node: true + }, + + rules: { + // enforce return after a callback + 'callback-return': 'off', + + // require all requires be top-level + // https://eslint.org/docs/rules/global-require + 'global-require': 'error', + + // enforces error handling in callbacks (node environment) + 'handle-callback-err': 'off', + + // disallow use of the Buffer() constructor + // https://eslint.org/docs/rules/no-buffer-constructor + 'no-buffer-constructor': 'error', + + // disallow mixing regular variable and require declarations + 'no-mixed-requires': ['off', false], + + // disallow use of new operator with the require function + 'no-new-require': 'error', + + // disallow string concatenation with __dirname and __filename + // https://eslint.org/docs/rules/no-path-concat + 'no-path-concat': 'error', + + // disallow use of process.env + 'no-process-env': 'off', + + // disallow process.exit() + 'no-process-exit': 'off', + + // restrict usage of specified node modules + 'no-restricted-modules': 'off', + + // disallow use of synchronous methods (off by default) + 'no-sync': 'off', + } +}; diff --git a/packages/eslint-config-airbnb-base/rules/strict.js b/packages/eslint-config-airbnb-base/rules/strict.js new file mode 100644 index 0000000000..67cfd5e8a3 --- /dev/null +++ b/packages/eslint-config-airbnb-base/rules/strict.js @@ -0,0 +1,6 @@ +module.exports = { + rules: { + // babel inserts `'use strict';` for us + strict: ['error', 'never'] + } +}; diff --git a/packages/eslint-config-airbnb-base/rules/style.js b/packages/eslint-config-airbnb-base/rules/style.js new file mode 100644 index 0000000000..ca8fc07ae6 --- /dev/null +++ b/packages/eslint-config-airbnb-base/rules/style.js @@ -0,0 +1,501 @@ +module.exports = { + rules: { + // enforce line breaks after opening and before closing array brackets + // https://eslint.org/docs/rules/array-bracket-newline + // TODO: enable? semver-major + 'array-bracket-newline': ['off', 'consistent'], // object option alternative: { multiline: true, minItems: 3 } + + // enforce line breaks between array elements + // https://eslint.org/docs/rules/array-element-newline + // TODO: enable? semver-major + 'array-element-newline': ['off', { multiline: true, minItems: 3 }], + + // enforce spacing inside array brackets + 'array-bracket-spacing': ['error', 'never'], + + // enforce spacing inside single-line blocks + // https://eslint.org/docs/rules/block-spacing + 'block-spacing': ['error', 'always'], + + // enforce one true brace style + 'brace-style': ['error', '1tbs', { allowSingleLine: true }], + + // require camel case names + camelcase: ['error', { properties: 'never' }], + + // enforce or disallow capitalization of the first letter of a comment + // https://eslint.org/docs/rules/capitalized-comments + 'capitalized-comments': ['off', 'never', { + line: { + ignorePattern: '.*', + ignoreInlineComments: true, + ignoreConsecutiveComments: true, + }, + block: { + ignorePattern: '.*', + ignoreInlineComments: true, + ignoreConsecutiveComments: true, + }, + }], + + // require trailing commas in multiline object literals + 'comma-dangle': ['error', { + arrays: 'always-multiline', + objects: 'always-multiline', + imports: 'always-multiline', + exports: 'always-multiline', + functions: 'always-multiline', + }], + + // enforce spacing before and after comma + 'comma-spacing': ['error', { before: false, after: true }], + + // enforce one true comma style + 'comma-style': ['error', 'last', { + exceptions: { + ArrayExpression: false, + ArrayPattern: false, + ArrowFunctionExpression: false, + CallExpression: false, + FunctionDeclaration: false, + FunctionExpression: false, + ImportDeclaration: false, + ObjectExpression: false, + ObjectPattern: false, + VariableDeclaration: false, + NewExpression: false, + } + }], + + // disallow padding inside computed properties + 'computed-property-spacing': ['error', 'never'], + + // enforces consistent naming when capturing the current execution context + 'consistent-this': 'off', + + // enforce newline at the end of file, with no multiple empty lines + 'eol-last': ['error', 'always'], + + // enforce spacing between functions and their invocations + // https://eslint.org/docs/rules/func-call-spacing + 'func-call-spacing': ['error', 'never'], + + // requires function names to match the name of the variable or property to which they are + // assigned + // https://eslint.org/docs/rules/func-name-matching + 'func-name-matching': ['off', 'always', { + includeCommonJSModuleExports: false + }], + + // require function expressions to have a name + // https://eslint.org/docs/rules/func-names + 'func-names': 'warn', + + // enforces use of function declarations or expressions + // https://eslint.org/docs/rules/func-style + // TODO: enable + 'func-style': ['off', 'expression'], + + // enforce consistent line breaks inside function parentheses + // https://eslint.org/docs/rules/function-paren-newline + 'function-paren-newline': ['error', 'consistent'], + + // Blacklist certain identifiers to prevent them being used + // https://eslint.org/docs/rules/id-blacklist + 'id-blacklist': 'off', + + // this option enforces minimum and maximum identifier lengths + // (variable names, property names etc.) + 'id-length': 'off', + + // require identifiers to match the provided regular expression + 'id-match': 'off', + + // Enforce the location of arrow function bodies with implicit returns + // https://eslint.org/docs/rules/implicit-arrow-linebreak + 'implicit-arrow-linebreak': ['error', 'beside'], + + // this option sets a specific tab width for your code + // https://eslint.org/docs/rules/indent + indent: ['error', 2, { + SwitchCase: 1, + VariableDeclarator: 1, + outerIIFEBody: 1, + // MemberExpression: null, + FunctionDeclaration: { + parameters: 1, + body: 1 + }, + FunctionExpression: { + parameters: 1, + body: 1 + }, + CallExpression: { + arguments: 1 + }, + ArrayExpression: 1, + ObjectExpression: 1, + ImportDeclaration: 1, + flatTernaryExpressions: false, + // list derived from https://github.com/benjamn/ast-types/blob/HEAD/def/jsx.js + ignoredNodes: ['JSXElement', 'JSXElement > *', 'JSXAttribute', 'JSXIdentifier', 'JSXNamespacedName', 'JSXMemberExpression', 'JSXSpreadAttribute', 'JSXExpressionContainer', 'JSXOpeningElement', 'JSXClosingElement', 'JSXText', 'JSXEmptyExpression', 'JSXSpreadChild'], + ignoreComments: false + }], + + // specify whether double or single quotes should be used in JSX attributes + // https://eslint.org/docs/rules/jsx-quotes + 'jsx-quotes': ['off', 'prefer-double'], + + // enforces spacing between keys and values in object literal properties + 'key-spacing': ['error', { beforeColon: false, afterColon: true }], + + // require a space before & after certain keywords + 'keyword-spacing': ['error', { + before: true, + after: true, + overrides: { + return: { after: true }, + throw: { after: true }, + case: { after: true } + } + }], + + // enforce position of line comments + // https://eslint.org/docs/rules/line-comment-position + // TODO: enable? + 'line-comment-position': ['off', { + position: 'above', + ignorePattern: '', + applyDefaultPatterns: true, + }], + + // disallow mixed 'LF' and 'CRLF' as linebreaks + // https://eslint.org/docs/rules/linebreak-style + 'linebreak-style': ['error', 'unix'], + + // require or disallow an empty line between class members + // https://eslint.org/docs/rules/lines-between-class-members + 'lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: false }], + + // enforces empty lines around comments + 'lines-around-comment': 'off', + + // require or disallow newlines around directives + // https://eslint.org/docs/rules/lines-around-directive + 'lines-around-directive': ['error', { + before: 'always', + after: 'always', + }], + + // specify the maximum depth that blocks can be nested + 'max-depth': ['off', 4], + + // specify the maximum length of a line in your program + // https://eslint.org/docs/rules/max-len + 'max-len': ['error', 100, 2, { + ignoreUrls: true, + ignoreComments: false, + ignoreRegExpLiterals: true, + ignoreStrings: true, + ignoreTemplateLiterals: true, + }], + + // specify the max number of lines in a file + // https://eslint.org/docs/rules/max-lines + 'max-lines': ['off', { + max: 300, + skipBlankLines: true, + skipComments: true + }], + + // specify the maximum depth callbacks can be nested + 'max-nested-callbacks': 'off', + + // limits the number of parameters that can be used in the function declaration. + 'max-params': ['off', 3], + + // specify the maximum number of statement allowed in a function + 'max-statements': ['off', 10], + + // restrict the number of statements per line + // https://eslint.org/docs/rules/max-statements-per-line + 'max-statements-per-line': ['off', { max: 1 }], + + // enforce a particular style for multiline comments + // https://eslint.org/docs/rules/multiline-comment-style + 'multiline-comment-style': ['off', 'starred-block'], + + // require multiline ternary + // https://eslint.org/docs/rules/multiline-ternary + // TODO: enable? + 'multiline-ternary': ['off', 'never'], + + // require a capital letter for constructors + 'new-cap': ['error', { + newIsCap: true, + newIsCapExceptions: [], + capIsNew: false, + capIsNewExceptions: ['Immutable.Map', 'Immutable.Set', 'Immutable.List'], + }], + + // disallow the omission of parentheses when invoking a constructor with no arguments + // https://eslint.org/docs/rules/new-parens + 'new-parens': 'error', + + // allow/disallow an empty newline after var statement + 'newline-after-var': 'off', + + // https://eslint.org/docs/rules/newline-before-return + 'newline-before-return': 'off', + + // enforces new line after each method call in the chain to make it + // more readable and easy to maintain + // https://eslint.org/docs/rules/newline-per-chained-call + 'newline-per-chained-call': ['error', { ignoreChainWithDepth: 4 }], + + // disallow use of the Array constructor + 'no-array-constructor': 'error', + + // disallow use of bitwise operators + // https://eslint.org/docs/rules/no-bitwise + 'no-bitwise': 'error', + + // disallow use of the continue statement + // https://eslint.org/docs/rules/no-continue + 'no-continue': 'error', + + // disallow comments inline after code + 'no-inline-comments': 'off', + + // disallow if as the only statement in an else block + // https://eslint.org/docs/rules/no-lonely-if + 'no-lonely-if': 'error', + + // disallow un-paren'd mixes of different operators + // https://eslint.org/docs/rules/no-mixed-operators + 'no-mixed-operators': ['error', { + // the list of arthmetic groups disallows mixing `%` and `**` + // with other arithmetic operators. + groups: [ + ['%', '**'], + ['%', '+'], + ['%', '-'], + ['%', '*'], + ['%', '/'], + ['**', '+'], + ['**', '-'], + ['**', '*'], + ['**', '/'], + ['&', '|', '^', '~', '<<', '>>', '>>>'], + ['==', '!=', '===', '!==', '>', '>=', '<', '<='], + ['&&', '||'], + ['in', 'instanceof'] + ], + allowSamePrecedence: false + }], + + // disallow mixed spaces and tabs for indentation + 'no-mixed-spaces-and-tabs': 'error', + + // disallow use of chained assignment expressions + // https://eslint.org/docs/rules/no-multi-assign + 'no-multi-assign': ['error'], + + // disallow multiple empty lines and only one newline at the end + 'no-multiple-empty-lines': ['error', { max: 2, maxEOF: 0 }], + + // disallow negated conditions + // https://eslint.org/docs/rules/no-negated-condition + 'no-negated-condition': 'off', + + // disallow nested ternary expressions + 'no-nested-ternary': 'error', + + // disallow use of the Object constructor + 'no-new-object': 'error', + + // disallow use of unary operators, ++ and -- + // https://eslint.org/docs/rules/no-plusplus + 'no-plusplus': 'error', + + // disallow certain syntax forms + // https://eslint.org/docs/rules/no-restricted-syntax + 'no-restricted-syntax': [ + 'error', + { + selector: 'ForInStatement', + message: 'for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.', + }, + { + selector: 'ForOfStatement', + message: 'iterators/generators require regenerator-runtime, which is too heavyweight for this guide to allow them. Separately, loops should be avoided in favor of array iterations.', + }, + { + selector: 'LabeledStatement', + message: 'Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.', + }, + { + selector: 'WithStatement', + message: '`with` is disallowed in strict mode because it makes code impossible to predict and optimize.', + }, + ], + + // disallow space between function identifier and application + 'no-spaced-func': 'error', + + // disallow tab characters entirely + 'no-tabs': 'error', + + // disallow the use of ternary operators + 'no-ternary': 'off', + + // disallow trailing whitespace at the end of lines + 'no-trailing-spaces': ['error', { + skipBlankLines: false, + ignoreComments: false, + }], + + // disallow dangling underscores in identifiers + 'no-underscore-dangle': ['error', { + allow: [], + allowAfterThis: false, + allowAfterSuper: false, + enforceInMethodNames: false, + }], + + // disallow the use of Boolean literals in conditional expressions + // also, prefer `a || b` over `a ? a : b` + // https://eslint.org/docs/rules/no-unneeded-ternary + 'no-unneeded-ternary': ['error', { defaultAssignment: false }], + + // disallow whitespace before properties + // https://eslint.org/docs/rules/no-whitespace-before-property + 'no-whitespace-before-property': 'error', + + // enforce the location of single-line statements + // https://eslint.org/docs/rules/nonblock-statement-body-position + 'nonblock-statement-body-position': ['error', 'beside', { overrides: {} }], + + // require padding inside curly braces + 'object-curly-spacing': ['error', 'always'], + + // enforce line breaks between braces + // https://eslint.org/docs/rules/object-curly-newline + 'object-curly-newline': ['error', { + ObjectExpression: { minProperties: 4, multiline: true, consistent: true }, + ObjectPattern: { minProperties: 4, multiline: true, consistent: true }, + ImportDeclaration: { minProperties: 4, multiline: true, consistent: true }, + ExportDeclaration: { minProperties: 4, multiline: true, consistent: true }, + }], + + // enforce "same line" or "multiple line" on object properties. + // https://eslint.org/docs/rules/object-property-newline + 'object-property-newline': ['error', { + allowAllPropertiesOnSameLine: true, + }], + + // allow just one var statement per function + 'one-var': ['error', 'never'], + + // require a newline around variable declaration + // https://eslint.org/docs/rules/one-var-declaration-per-line + 'one-var-declaration-per-line': ['error', 'always'], + + // require assignment operator shorthand where possible or prohibit it entirely + // https://eslint.org/docs/rules/operator-assignment + 'operator-assignment': ['error', 'always'], + + // Requires operator at the beginning of the line in multiline statements + // https://eslint.org/docs/rules/operator-linebreak + 'operator-linebreak': ['error', 'before', { overrides: { '=': 'none' } }], + + // disallow padding within blocks + 'padded-blocks': ['error', { blocks: 'never', classes: 'never', switches: 'never' }], + + // Require or disallow padding lines between statements + // https://eslint.org/docs/rules/padding-line-between-statements + 'padding-line-between-statements': 'off', + + // require quotes around object literal property names + // https://eslint.org/docs/rules/quote-props.html + 'quote-props': ['error', 'as-needed', { keywords: false, unnecessary: true, numbers: false }], + + // specify whether double or single quotes should be used + quotes: ['error', 'single', { avoidEscape: true }], + + // do not require jsdoc + // https://eslint.org/docs/rules/require-jsdoc + 'require-jsdoc': 'off', + + // require or disallow use of semicolons instead of ASI + semi: ['error', 'always'], + + // enforce spacing before and after semicolons + 'semi-spacing': ['error', { before: false, after: true }], + + // Enforce location of semicolons + // https://eslint.org/docs/rules/semi-style + 'semi-style': ['error', 'last'], + + // requires object keys to be sorted + 'sort-keys': ['off', 'asc', { caseSensitive: false, natural: true }], + + // sort variables within the same declaration block + 'sort-vars': 'off', + + // require or disallow space before blocks + 'space-before-blocks': 'error', + + // require or disallow space before function opening parenthesis + // https://eslint.org/docs/rules/space-before-function-paren + 'space-before-function-paren': ['error', { + anonymous: 'always', + named: 'never', + asyncArrow: 'always' + }], + + // require or disallow spaces inside parentheses + 'space-in-parens': ['error', 'never'], + + // require spaces around operators + 'space-infix-ops': 'error', + + // Require or disallow spaces before/after unary operators + // https://eslint.org/docs/rules/space-unary-ops + 'space-unary-ops': ['error', { + words: true, + nonwords: false, + overrides: { + }, + }], + + // require or disallow a space immediately following the // or /* in a comment + // https://eslint.org/docs/rules/spaced-comment + 'spaced-comment': ['error', 'always', { + line: { + exceptions: ['-', '+'], + markers: ['=', '!'], // space here to support sprockets directives + }, + block: { + exceptions: ['-', '+'], + markers: ['=', '!'], // space here to support sprockets directives + balanced: true, + } + }], + + // Enforce spacing around colons of switch statements + // https://eslint.org/docs/rules/switch-colon-spacing + 'switch-colon-spacing': ['error', { after: true, before: false }], + + // Require or disallow spacing between template tags and their literals + // https://eslint.org/docs/rules/template-tag-spacing + 'template-tag-spacing': ['error', 'never'], + + // require or disallow the Unicode Byte Order Mark + // https://eslint.org/docs/rules/unicode-bom + 'unicode-bom': ['error', 'never'], + + // require regex literals to be wrapped in parentheses + 'wrap-regex': 'off' + } +}; diff --git a/packages/eslint-config-airbnb-base/rules/variables.js b/packages/eslint-config-airbnb-base/rules/variables.js new file mode 100644 index 0000000000..aeab992320 --- /dev/null +++ b/packages/eslint-config-airbnb-base/rules/variables.js @@ -0,0 +1,44 @@ +const restrictedGlobals = require('eslint-restricted-globals'); + +module.exports = { + rules: { + // enforce or disallow variable initializations at definition + 'init-declarations': 'off', + + // disallow the catch clause parameter name being the same as a variable in the outer scope + 'no-catch-shadow': 'off', + + // disallow deletion of variables + 'no-delete-var': 'error', + + // disallow labels that share a name with a variable + // https://eslint.org/docs/rules/no-label-var + 'no-label-var': 'error', + + // disallow specific globals + 'no-restricted-globals': ['error', 'isFinite', 'isNaN'].concat(restrictedGlobals), + + // disallow declaration of variables already declared in the outer scope + 'no-shadow': 'error', + + // disallow shadowing of names such as arguments + 'no-shadow-restricted-names': 'error', + + // disallow use of undeclared variables unless mentioned in a /*global */ block + 'no-undef': 'error', + + // disallow use of undefined when initializing variables + 'no-undef-init': 'error', + + // disallow use of undefined variable + // https://eslint.org/docs/rules/no-undefined + // TODO: enable? + 'no-undefined': 'off', + + // disallow declaration of variables that are not used in the code + 'no-unused-vars': ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true }], + + // disallow use of variables before they are defined + 'no-use-before-define': ['error', { functions: true, classes: true, variables: true }], + } +}; diff --git a/packages/eslint-config-airbnb-base/test/.eslintrc b/packages/eslint-config-airbnb-base/test/.eslintrc new file mode 100644 index 0000000000..5808be6186 --- /dev/null +++ b/packages/eslint-config-airbnb-base/test/.eslintrc @@ -0,0 +1,8 @@ +{ + "rules": { + // disabled because I find it tedious to write tests while following this rule + "no-shadow": 0, + // tests uses `t` for tape + "id-length": [2, {"min": 2, "properties": "never", "exceptions": ["t"]}], + } +} diff --git a/packages/eslint-config-airbnb-base/test/requires.js b/packages/eslint-config-airbnb-base/test/requires.js new file mode 100644 index 0000000000..180a09bf42 --- /dev/null +++ b/packages/eslint-config-airbnb-base/test/requires.js @@ -0,0 +1,16 @@ +/* eslint + strict: 0, + global-require: 0, + */ + +'use strict'; + +const test = require('tape'); + +test('all entry points parse', (t) => { + t.doesNotThrow(() => require('..'), 'index does not throw'); + t.doesNotThrow(() => require('../legacy'), 'legacy does not throw'); + t.doesNotThrow(() => require('../whitespace'), 'whitespace does not throw'); + + t.end(); +}); diff --git a/packages/eslint-config-airbnb-base/test/test-base.js b/packages/eslint-config-airbnb-base/test/test-base.js new file mode 100644 index 0000000000..07d17b1027 --- /dev/null +++ b/packages/eslint-config-airbnb-base/test/test-base.js @@ -0,0 +1,32 @@ +import fs from 'fs'; +import path from 'path'; +import test from 'tape'; + +import index from '..'; + +const files = { ...{ index } }; // object spread is to test parsing + +fs.readdirSync(path.join(__dirname, '../rules')).forEach((name) => { + // eslint-disable-next-line import/no-dynamic-require + files[name] = require(`../rules/${name}`); // eslint-disable-line global-require +}); + +Object.keys(files).forEach(( + name, // trailing function comma is to test parsing +) => { + const config = files[name]; + + test(`${name}: does not reference react`, (t) => { + t.plan(2); + + // scan plugins for react and fail if it is found + const hasReactPlugin = Object.prototype.hasOwnProperty.call(config, 'plugins') + && config.plugins.indexOf('react') !== -1; + t.notOk(hasReactPlugin, 'there is no react plugin'); + + // scan rules for react/ and fail if any exist + const reactRuleIds = Object.keys(config.rules) + .filter(ruleId => ruleId.indexOf('react/') === 0); + t.deepEquals(reactRuleIds, [], 'there are no react/ rules'); + }); +}); diff --git a/packages/eslint-config-airbnb-base/whitespace.js b/packages/eslint-config-airbnb-base/whitespace.js new file mode 100644 index 0000000000..66a05e52b9 --- /dev/null +++ b/packages/eslint-config-airbnb-base/whitespace.js @@ -0,0 +1,77 @@ +const baseConfig = require('.'); +const assign = require('object.assign'); +const entries = require('object.entries'); +const CLIEngine = require('eslint').CLIEngine; + +function onlyErrorOnRules(rulesToError, config) { + const errorsOnly = assign({}, config); + const cli = new CLIEngine({ baseConfig: config, useEslintrc: false }); + const baseRules = cli.getConfigForFile('./').rules; + + entries(baseRules).forEach((rule) => { + const ruleName = rule[0]; + const ruleConfig = rule[1]; + + if (rulesToError.indexOf(ruleName) === -1) { + if (Array.isArray(ruleConfig)) { + errorsOnly.rules[ruleName] = ['warn'].concat(ruleConfig.slice(1)); + } else if (typeof ruleConfig === 'number') { + errorsOnly.rules[ruleName] = 1; + } else { + errorsOnly.rules[ruleName] = 'warn'; + } + } + }); + + return errorsOnly; +} + +module.exports = onlyErrorOnRules([ + 'array-bracket-newline', + 'array-bracket-spacing', + 'array-element-newline', + 'arrow-spacing', + 'block-spacing', + 'comma-spacing', + 'computed-property-spacing', + 'dot-location', + 'eol-last', + 'func-call-spacing', + 'function-paren-newline', + 'generator-star-spacing', + 'implicit-arrow-linebreak', + 'indent', + 'key-spacing', + 'keyword-spacing', + 'line-comment-position', + 'linebreak-style', + 'multiline-ternary', + 'newline-per-chained-call', + 'no-irregular-whitespace', + 'no-mixed-spaces-and-tabs', + 'no-multi-spaces', + 'no-regex-spaces', + 'no-spaced-func', + 'no-trailing-spaces', + 'no-whitespace-before-property', + 'nonblock-statement-body-position', + 'object-curly-newline', + 'object-curly-spacing', + 'object-property-newline', + 'one-var-declaration-per-line', + 'operator-linebreak', + 'padded-blocks', + 'padding-line-between-statements', + 'rest-spread-spacing', + 'semi-spacing', + 'semi-style', + 'space-before-blocks', + 'space-before-function-paren', + 'space-in-parens', + 'space-infix-ops', + 'space-unary-ops', + 'spaced-comment', + 'switch-colon-spacing', + 'template-tag-spacing', + 'import/newline-after-import', +], baseConfig); diff --git a/packages/eslint-config-airbnb/.babelrc b/packages/eslint-config-airbnb/.babelrc new file mode 100644 index 0000000000..e0aceaae1c --- /dev/null +++ b/packages/eslint-config-airbnb/.babelrc @@ -0,0 +1,3 @@ +{ + "presets": ["airbnb"] +} diff --git a/packages/eslint-config-airbnb/.editorconfig b/packages/eslint-config-airbnb/.editorconfig new file mode 120000 index 0000000000..1b3ce07def --- /dev/null +++ b/packages/eslint-config-airbnb/.editorconfig @@ -0,0 +1 @@ +../../.editorconfig \ No newline at end of file diff --git a/packages/eslint-config-airbnb/.eslintrc b/packages/eslint-config-airbnb/.eslintrc new file mode 100644 index 0000000000..f9bd289286 --- /dev/null +++ b/packages/eslint-config-airbnb/.eslintrc @@ -0,0 +1,10 @@ +{ + "extends": "./index.js", + "rules": { + // disable requiring trailing commas because it might be nice to revert to + // being JSON at some point, and I don't want to make big changes now. + "comma-dangle": 0, + // we support node 4 + "prefer-destructuring": 0, + }, +} diff --git a/packages/eslint-config-airbnb/.npmrc b/packages/eslint-config-airbnb/.npmrc new file mode 120000 index 0000000000..cba44bb384 --- /dev/null +++ b/packages/eslint-config-airbnb/.npmrc @@ -0,0 +1 @@ +../../.npmrc \ No newline at end of file diff --git a/packages/eslint-config-airbnb/CHANGELOG.md b/packages/eslint-config-airbnb/CHANGELOG.md new file mode 100644 index 0000000000..d19acfc7f2 --- /dev/null +++ b/packages/eslint-config-airbnb/CHANGELOG.md @@ -0,0 +1,349 @@ +16.1.0 / 2017-10-16 +================== +- [deps] update `eslint-config-airbnb-base`, `eslint` to v4.9 + +16.0.0 / 2017-10-06 +================== +- [breaking] [deps] require `eslint` `v4`, update `eslint-config-airbnb-base` +- [breaking] [deps] Upgrade `eslint-plugin-jsx-a11y` to `v6`; enable more a11y rules (#1482) +- [breaking] enable/add react rules: `react/jsx-curly-brace-presence`, `react/no-typos`, `react/no-unused-state`, `react/no-redundant-should-component-update`, `react/default-props-match-prop-types` +- [new] add `propWrapperFunctions` default settings for `eslint-plugin-react` +- [new] Enable `react/jsx-closing-tag-location` (#1533) +- [deps] update `eslint` v4, `eslint-plugin-react`, `tape` +- [docs] Specify yarn-specific install instructions (#1511) + +15.1.0 / 2017-07-24 +================== +- [deps] allow eslint v3 or v4 (#1447) +- [deps] update `eslint-plugin-import`, `eslint-config-airbnb-base` + +15.0.2 / 2017-07-04 +================== +- [fix] jsx should be enabled via parserOptions, not via a root ecmaFeatures +- [deps] update `babel-preset-airbnb`, `eslint-find-rules`, `eslint-plugin-import`, `eslint-plugin-jsx-a11y`, `eslint-plugin-react`, `tape` + +15.0.1 / 2017-05-15 +================== +- [fix] set default React version to 15.0 (#1415) + +15.0.0 / 2017-05-14 +================== +- [breaking] set default React version to 0.15 +- [breaking] `update eslint-plugin-jsx-a11y` to v5, enable new rules +- [breaking] `update eslint-plugin-react` to v7, enable new rules +- [minor] enable rules: `jsx-max-props-per-line`, `void-dom-elements-no-children` +- [patch] Turn `ignorePureComponents` option on for react/prefer-stateless-function (#1378, #1398) +- [deps] update `eslint`, `eslint-plugin-react`, `eslint-config-airbnb-base` + +14.1.0 / 2017-02-05 +================== +- [patch] allow `eslint-plugin-jsx-a11y` to be v3 or v4. Remove `no-marquee` rule temporarily. +- [deps] update `eslint-config-airbnb-base`, `babel-preset-airbnb`, `eslint` + +14.0.0 / 2017-01-08 +================== +- [breaking] enable `react/no-array-index-key`, `react/require-default-props` +- [breaking] [deps] update `eslint`, `eslint-plugin-import`, `eslint-plugin-react`, `eslint-config-airbnb-base` +- [breaking] [deps] update `eslint-plugin-jsx-a11y` to v3 (#1166) +- [docs] add note about `install-peerdeps` (#1234) +- [docs] Updated instructions to support non-bash users (#1214) + +13.0.0 / 2016-11-06 +================== +- [breaking] Enable `import/no-webpack-loader-syntax` rule (#1123) +- [patch] `class-methods-use-this`: exempt React `getChildContext` (#1094) +- [patch] set `react/no-unused-prop-types` skipShapeProps (#1099) +- [deps] [breaking] update `eslint`, `eslint-config-airbnb-base`, `eslint-plugin-jsx-a11y`, `eslint-plugin-react`, `eslint-plugin-import` +- [dev deps] update `babel-preset-airbnb`, `eslint`, `eslint-find-rules`, `tape`, `safe-publish-latest` +- [Tests] on `node` `v7` +- [docs] ensure latest version of config is installed (#1121) + +12.0.0 / 2016-09-24 +================== +- [breaking] Enable react rules: `react/no-unescaped-entities`, `react/no-children-prop` +- [breaking] [deps] update `eslint-config-airbnb-base` +- [patch] disable deprecated and redundant `react/require-extension` rule (#978) + +11.2.0 / 2016-09-23 +================== +- [new] set `ecmaVersion` to 2017; enable object rest/spread; update `babel-preset-airbnb` +- [deps] update `eslint`, `eslint-config-airbnb-base`, `eslint-plugin-import`, `eslint-plugin-jsx-a11y`, `eslint-plugin-react`, `eslint-find-rules`, `safe-publish-latest` + +11.1.0 / 2016-09-11 +================== +- [deps] update `eslint-config-airbnb-base`, `eslint` + +11.0.0 / 2016-09-08 +================== +- [breaking] enable `react` rules: `react/no-danger-with-children`, `react/no-unused-prop-types`, `react/style-prop-object`, `react/forbid-prop-types`, `react/jsx-no-duplicate-props`; set `react/no-danger` to “warn” +- [breaking] enable `jsx-a11y` rules: `jsx-a11y/anchor-has-content`, `jsx-a11y/tabindex-no-positive`, `jsx-a11y/no-static-element-interactions` +- [deps] update `eslint`, `eslint-plugin-react`, `eslint-config-airbnb-base`, `eslint-find-rules`, `eslint-plugin-import`, `eslint-plugin-jsx-a11y` +- [patch] set `ignoreCase` to `true` in disabled rules. +- [docs] use “#” in example command rather than version numbers (#984) + +10.0.1 / 2016-08-12 +================== +- [deps] update `eslint`, `eslint-find-rules`, `eslint-plugin-jsx-a11y`, `eslint-plugin-import`, `eslint-config-airbnb-base` + +10.0.0 / 2016-08-01 +================== +- [breaking] enable jsx-a11y rules: + - `jsx-a11y/heading-has-content` + - `jsx-a11y/html-has-lang` + - `jsx-a11y/lang` + - `jsx-a11y/no-marquee` + - `jsx-a11y/scope` + - `jsx-a11y/href-no-hash` + - `jsx-a11y/label-has-for` +- [breaking] enable aria rules: + - `jsx-a11y/aria-props` + - `jsx-a11y/aria-proptypes` + - `jsx-a11y/aria-unsupported-elements` + - `jsx-a11y/role-has-required-aria-props` + - `jsx-a11y/role-supports-aria-props` +- [breaking] enable react rules: + - `react/jsx-filename-extension` + - `react/jsx-no-comment-textnodes` + - `react/jsx-no-target-blank` + - `react/require-extension` + - `react/no-render-return-value` + - `react/no-find-dom-node` + - `react/no-deprecated` +- [deps] [breaking] update `eslint` to v3, `eslint-config-airbnb-base` to v5, `eslint-find-rules`, `eslint-plugin-import`, `eslint-plugin-jsx-a11y` to v2, `eslint-plugin-react` to v6, `tape`. drop node < 4 support. +- [deps] update `eslint-config-airbnb-base`, `eslint-plugin-react`, `eslint-plugin-import`, `eslint-plugin-jsx-a11y`, `babel-tape-runner`, add `babel-preset-airbnb`. ensure react is `>=` 0.13.0 +- [patch] loosen `jsx-pascal-case` rule to allow all caps component names +- [tests] stop testing < node 4 +- [tests] use `in-publish` because coffeescript screwed up the prepublish script for everyone +- [tests] Only run `eslint-find-rules` on prepublish, not in tests +- [tests] Even though the base config may not be up to date in the main package, let’s `npm link` the base package into the main one for the sake of travis-ci tests +- [docs] update the peer dep install command to dynamically look up the right version numbers when installing peer deps +- add `safe-publish-latest` to `prepublish` + +9.0.1 / 2016-05-08 +================== +- [patch] update `eslint-config-airbnb-base` to v3.0.1 + +9.0.0 / 2016-05-07 +================== +- [breaking] update `eslint-config-airbnb-base` to v3 +- [deps] update `eslint-find-rules`, `eslint-plugin-import`, `eslint-plugin-jsx-a11y` + +8.0.0 / 2016-04-21 +================== +- [breaking] Migrate non-React rules to a separate linter config (`eslint-config-airbnb-base`) +- [breaking] disallow empty methods +- [breaking] disallow empty restructuring patterns +- [breaking] enable `no-restricted-syntax` rule +- [breaking] enable `global-require` rule +- [breaking] [react] enable `react/jsx-curly-spacing` rule ([#693](https://github.com/airbnb/javascript/issues/693)) +- [semver-minor] [react] Add `react/jsx-first-prop-new-line` rule +- [semver-minor] [react] enable `jsx-equals-spacing` rule +- [semver-minor] [react] enable `jsx-indent` rule +- [semver-minor] enforce spacing inside single-line blocks +- [semver-minor] enforce `no-underscore-dangle` +- [semver-minor] Enable import/no-unresolved and import/export rules ([#825](https://github.com/airbnb/javascript/issues/825)) +- [semver-patch] Enable `no-useless-concat` rule which `prefer-template` already covers +- [semver-patch] Allow `== null` ([#542](https://github.com/airbnb/javascript/issues/542)) +- [dev deps / peer deps] update `eslint`, `eslint-plugin-react`, `eslint-plugin-import` +- [dev deps / peer deps] update `eslint-plugin-jsx-a11y` and rename rules ([#838](https://github.com/airbnb/javascript/issues/838)) +- [refactor] [react] separate a11y rules to their own file +- [refactor] Add missing disabled rules. +- [tests] Add `eslint-find-rules` to prevent missing rules + +7.0.0 / 2016-04-11 +================== +- [react] [breaking] Add accessibility rules to the React style guide + `eslint-plugin-a11y` +- [breaking] enable `react/require-render-return` +- [breaking] Add `no-dupe-class-members` rule + section ([#785](https://github.com/airbnb/javascript/issues/785)) +- [breaking] error on debugger statements +- [breaking] add `no-useless-escape` rule +- [breaking] add `no-duplicate-imports` rule +- [semver-minor] enable `jsx-pascal-case` rule +- [deps] update `eslint`, `react` +- [dev deps] update `eslint`, `eslint-plugin-react` + +6.2.0 / 2016-03-22 +================== +- [new] Allow arrow functions in JSX props +- [fix] re-enable `no-confusing-arrow` rule, with `allowParens` option enabled ([#752](https://github.com/airbnb/javascript/issues/752), [#791](https://github.com/airbnb/javascript/issues/791)) +- [dev deps] update `tape`, `eslint`, `eslint-plugin-react` +- [peer deps] update `eslint`, `eslint-plugin-react` + +6.1.0 / 2016-02-22 +================== +- [new] enable [`react/prefer-stateless-function`][react/prefer-stateless-function] +- [dev deps] update `react-plugin-eslint`, `eslint`, `tape` + +6.0.2 / 2016-02-22 +================== +- [fix] disable [`no-confusing-arrow`][no-confusing-arrow] due to an `eslint` bug ([#752](https://github.com/airbnb/javascript/issues/752)) + +6.0.1 / 2016-02-21 +================== +- [fix] disable [`newline-per-chained-call`][newline-per-chained-call] due to an `eslint` bug ([#748](https://github.com/airbnb/javascript/issues/748)) + +6.0.0 / 2016-02-21 +================== +- [breaking] enable [`array-callback-return`][array-callback-return] +- [breaking] enable [`no-confusing-arrow`][no-confusing-arrow] +- [breaking] enable [`no-new-symbol`][no-new-symbol] +- [breaking] enable [`no-restricted-imports`][no-restricted-imports] +- [breaking] enable [`no-useless-constructor`][no-useless-constructor] +- [breaking] enable [`prefer-rest-params`][prefer-rest-params] +- [breaking] enable [`template-curly-spacing`][template-curly-spacing] +- [breaking] enable [`newline-per-chained-call`][newline-per-chained-call] +- [breaking] enable [`one-var-declaration-per-line`][one-var-declaration-per-line] +- [breaking] enable [`no-self-assign`][no-self-assign] +- [breaking] enable [`no-whitespace-before-property`][no-whitespace-before-property] +- [breaking] [react] enable [`react/jsx-space-before-closing`][react/jsx-space-before-closing] +- [breaking] [react] enable `static-methods` at top of [`react/sort-comp`][react/sort-comp] +- [breaking] [react] don't `ignoreTranspilerName` for [`react/display-name`][react/display-name] +- [peer+dev deps] update `eslint`, `eslint-plugin-react` ([#730](https://github.com/airbnb/javascript/issues/730)) + +5.0.1 / 2016-02-13 +================== +- [fix] `eslint` peerDep should not include breaking changes + +5.0.0 / 2016-02-03 +================== +- [breaking] disallow unneeded ternary expressions +- [breaking] Avoid lexical declarations in case/default clauses +- [dev deps] update `babel-tape-runner`, `eslint-plugin-react`, `react`, `tape` + +4.0.0 / 2016-01-22 +================== +- [breaking] require outer IIFE wrapping; flesh out guide section +- [minor] Add missing [`arrow-body-style`][arrow-body-style], [`prefer-template`][prefer-template] rules ([#678](https://github.com/airbnb/javascript/issues/678)) +- [minor] Add [`prefer-arrow-callback`][prefer-arrow-callback] to ES6 rules (to match the guide) ([#677](https://github.com/airbnb/javascript/issues/677)) +- [Tests] run `npm run lint` as part of tests; fix errors +- [Tests] use `parallelshell` to parallelize npm run-scripts + +3.1.0 / 2016-01-07 +================== +- [minor] Allow multiple stateless components in a single file + +3.0.2 / 2016-01-06 +================== +- [fix] Ignore URLs in [`max-len`][max-len] ([#664](https://github.com/airbnb/javascript/issues/664)) + +3.0.1 / 2016-01-06 +================== +- [fix] because we use babel, keywords should not be quoted + +3.0.0 / 2016-01-04 +================== +- [breaking] enable [`quote-props`][quote-props] rule ([#632](https://github.com/airbnb/javascript/issues/632)) +- [breaking] Define a max line length of 100 characters ([#639](https://github.com/airbnb/javascript/issues/639)) +- [breaking] [react] Minor cleanup for the React styleguide, add [`react/jsx-no-bind`][react/jsx-no-bind] ([#619](https://github.com/airbnb/javascript/issues/619)) +- [breaking] update best-practices config to prevent parameter object manipulation ([#627](https://github.com/airbnb/javascript/issues/627)) +- [minor] Enable [`react/no-is-mounted`][react/no-is-mounted] rule (#635, #633) +- [minor] Sort [`react/prefer-es6-class`][react/prefer-es6-class] alphabetically ([#634](https://github.com/airbnb/javascript/issues/634)) +- [minor] enable [`react/prefer-es6-class`][react/prefer-es6-class] rule +- Permit strict mode in "legacy" config +- [react] add missing rules from `eslint-plugin-react` (enforcing where necessary) ([#581](https://github.com/airbnb/javascript/issues/581)) +- [dev deps] update `eslint-plugin-react` + +2.1.1 / 2015-12-15 +================== +- [fix] Remove deprecated [`react/jsx-quotes`][react/jsx-quotes] ([#622](https://github.com/airbnb/javascript/issues/622)) + +2.1.0 / 2015-12-15 +================== +- [fix] use `require.resolve` to allow nested `extend`s ([#582](https://github.com/airbnb/javascript/issues/582)) +- [new] enable [`object-shorthand`][object-shorthand] rule ([#621](https://github.com/airbnb/javascript/issues/621)) +- [new] enable [`arrow-spacing`][arrow-spacing] rule ([#517](https://github.com/airbnb/javascript/issues/517)) +- [docs] flesh out react rule defaults ([#618](https://github.com/airbnb/javascript/issues/618)) + +2.0.0 / 2015-12-03 +================== +- [breaking] [`space-before-function-paren`][space-before-function-paren]: require function spacing: `function (` ([#605](https://github.com/airbnb/javascript/issues/605)) +- [breaking] [`indent`][indent]: Fix switch statement indentation rule ([#606](https://github.com/airbnb/javascript/issues/606)) +- [breaking] [`array-bracket-spacing`][array-bracket-spacing], [`computed-property-spacing`][computed-property-spacing]: disallow spacing inside brackets ([#594](https://github.com/airbnb/javascript/issues/594)) +- [breaking] [`object-curly-spacing`][object-curly-spacing]: require padding inside curly braces ([#594](https://github.com/airbnb/javascript/issues/594)) +- [breaking] [`space-in-parens`][space-in-parens]: disallow spaces in parens ([#594](https://github.com/airbnb/javascript/issues/594)) + +1.0.2 / 2015-11-25 +================== +- [breaking] [`no-multiple-empty-lines`][no-multiple-empty-lines]: only allow 1 blank line at EOF ([#578](https://github.com/airbnb/javascript/issues/578)) +- [new] `restParams`: enable rest params ([#592](https://github.com/airbnb/javascript/issues/592)) + +1.0.1 / 2015-11-25 +================== +- *erroneous publish* + +1.0.0 / 2015-11-08 +================== +- require `eslint` `v1.0.0` or higher +- remove `babel-eslint` dependency + +0.1.1 / 2015-11-05 +================== +- remove [`id-length`][id-length] rule ([#569](https://github.com/airbnb/javascript/issues/569)) +- enable [`no-mixed-spaces-and-tabs`][no-mixed-spaces-and-tabs] ([#539](https://github.com/airbnb/javascript/issues/539)) +- enable [`no-const-assign`][no-const-assign] ([#560](https://github.com/airbnb/javascript/issues/560)) +- enable [`space-before-keywords`][space-before-keywords] ([#554](https://github.com/airbnb/javascript/issues/554)) + +0.1.0 / 2015-11-05 +================== +- switch to modular rules files courtesy the [eslint-config-default][ecd] project and [@taion][taion]. [PR][pr-modular] +- export `eslint-config-airbnb/legacy` for ES5-only users. `eslint-config-airbnb/legacy` does not require the `babel-eslint` parser. [PR][pr-legacy] + +0.0.9 / 2015-09-24 +================== +- add rule [`no-undef`][no-undef] +- add rule [`id-length`][id-length] + +0.0.8 / 2015-08-21 +================== +- now has a changelog +- now is modular (see instructions above for with react and without react versions) + +0.0.7 / 2015-07-30 +================== +- TODO: fill in + + +[ecd]: https://github.com/walmartlabs/eslint-config-defaults +[taion]: https://github.com/taion +[pr-modular]: https://github.com/airbnb/javascript/pull/526 +[pr-legacy]: https://github.com/airbnb/javascript/pull/527 + +[array-bracket-spacing]: https://eslint.org/docs/rules/array-bracket-spacing +[array-callback-return]: https://eslint.org/docs/rules/array-callback-return +[arrow-body-style]: https://eslint.org/docs/rules/arrow-body-style +[arrow-spacing]: https://eslint.org/docs/rules/arrow-spacing +[computed-property-spacing]: https://eslint.org/docs/rules/computed-property-spacing +[id-length]: https://eslint.org/docs/rules/id-length +[indent]: https://eslint.org/docs/rules/indent +[max-len]: https://eslint.org/docs/rules/max-len +[newline-per-chained-call]: https://eslint.org/docs/rules/newline-per-chained-call +[no-confusing-arrow]: https://eslint.org/docs/rules/no-confusing-arrow +[no-const-assign]: https://eslint.org/docs/rules/no-const-assign +[no-mixed-spaces-and-tabs]: https://eslint.org/docs/rules/no-mixed-spaces-and-tabs +[no-multiple-empty-lines]: https://eslint.org/docs/rules/no-multiple-empty-lines +[no-new-symbol]: https://eslint.org/docs/rules/no-new-symbol +[no-restricted-imports]: https://eslint.org/docs/rules/no-restricted-imports +[no-self-assign]: https://eslint.org/docs/rules/no-self-assign +[no-undef]: https://eslint.org/docs/rules/no-undef +[no-useless-constructor]: https://eslint.org/docs/rules/no-useless-constructor +[no-whitespace-before-property]: https://eslint.org/docs/rules/no-whitespace-before-property +[object-curly-spacing]: https://eslint.org/docs/rules/object-curly-spacing +[object-shorthand]: https://eslint.org/docs/rules/object-shorthand +[one-var-declaration-per-line]: https://eslint.org/docs/rules/one-var-declaration-per-line +[prefer-arrow-callback]: https://eslint.org/docs/rules/prefer-arrow-callback +[prefer-rest-params]: https://eslint.org/docs/rules/prefer-rest-params +[prefer-template]: https://eslint.org/docs/rules/prefer-template +[quote-props]: https://eslint.org/docs/rules/quote-props +[space-before-function-paren]: https://eslint.org/docs/rules/space-before-function-paren +[space-before-keywords]: https://eslint.org/docs/rules/space-before-keywords +[space-in-parens]: https://eslint.org/docs/rules/space-in-parens +[template-curly-spacing]: https://eslint.org/docs/rules/template-curly-spacing + +[react/jsx-space-before-closing]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-space-before-closing.md +[react/sort-comp]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md +[react/display-name]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/display-name.md +[react/jsx-no-bind]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-bind.md +[react/no-is-mounted]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-is-mounted.md +[react/prefer-es6-class]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-es6-class.md +[react/jsx-quotes]: https://github.com/yannickcr/eslint-plugin-react/blob/f817e37beddddc84b4788969f07c524fa7f0823b/docs/rules/jsx-quotes.md +[react/prefer-stateless-function]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-stateless-function.md diff --git a/packages/eslint-config-airbnb/LICENSE.md b/packages/eslint-config-airbnb/LICENSE.md new file mode 100644 index 0000000000..69d80c0252 --- /dev/null +++ b/packages/eslint-config-airbnb/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2012 Airbnb + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/eslint-config-airbnb/README.md b/packages/eslint-config-airbnb/README.md new file mode 100644 index 0000000000..2f341ec187 --- /dev/null +++ b/packages/eslint-config-airbnb/README.md @@ -0,0 +1,80 @@ +# eslint-config-airbnb + +[![npm version](https://badge.fury.io/js/eslint-config-airbnb.svg)](http://badge.fury.io/js/eslint-config-airbnb) + +This package provides Airbnb's .eslintrc as an extensible shared config. + +## Usage + +We export three ESLint configurations for your usage. + +### eslint-config-airbnb + +Our default export contains all of our ESLint rules, including ECMAScript 6+ and React. It requires `eslint`, `eslint-plugin-import`, `eslint-plugin-react`, and `eslint-plugin-jsx-a11y`. If you don't need React, see [eslint-config-airbnb-base](https://npmjs.com/eslint-config-airbnb-base). + +If you use yarn, run `npm info "eslint-config-airbnb@latest" peerDependencies` to list the peer dependencies and versions, then run `yarn add --dev @` for each listed peer dependency. See below for npm instructions. + +1. Install the correct versions of each package, which are listed by the command: + + ```sh + npm info "eslint-config-airbnb@latest" peerDependencies + ``` + + If using **npm 5+**, use this shortcut + + ```sh + npx install-peerdeps --dev eslint-config-airbnb + ``` + + If using **npm < 5**, Linux/OSX users can run + + ```sh + ( + export PKG=eslint-config-airbnb; + npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest" + ) + ``` + + Which produces and runs a command like: + + ```sh + npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.# + ``` + + If using **npm < 5**, Windows users can either install all the peer dependencies manually, or use the [install-peerdeps](https://github.com/nathanhleung/install-peerdeps) cli tool. + + ```sh + npm install -g install-peerdeps + install-peerdeps --dev eslint-config-airbnb + ``` + The cli will produce and run a command like: + + ```sh + npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.# + ``` + +2. Add `"extends": "airbnb"` to your .eslintrc + +### eslint-config-airbnb/whitespace + +This entry point that only warns on whitespace rules and sets all other rules to warnings. View the list of whitespace rules [here](https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb/whitespace.js). + +### eslint-config-airbnb/base + +This entry point is deprecated. See [eslint-config-airbnb-base](https://npmjs.com/eslint-config-airbnb-base). + +### eslint-config-airbnb/legacy + +This entry point is deprecated. See [eslint-config-airbnb-base](https://npmjs.com/eslint-config-airbnb-base). + +See [Airbnb's Javascript styleguide](https://github.com/airbnb/javascript) and +the [ESlint config docs](https://eslint.org/docs/user-guide/configuring#extending-configuration-files) +for more information. + +## Improving this config + +Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc? + +You can run tests with `npm test`. + +You can make sure this module lints with itself using `npm run lint`. diff --git a/packages/eslint-config-airbnb/base.js b/packages/eslint-config-airbnb/base.js new file mode 100644 index 0000000000..bb1ea39118 --- /dev/null +++ b/packages/eslint-config-airbnb/base.js @@ -0,0 +1,4 @@ +module.exports = { + extends: ['eslint-config-airbnb-base'].map(require.resolve), + rules: {}, +}; diff --git a/packages/eslint-config-airbnb/index.js b/packages/eslint-config-airbnb/index.js new file mode 100644 index 0000000000..ddd3bfb712 --- /dev/null +++ b/packages/eslint-config-airbnb/index.js @@ -0,0 +1,9 @@ +module.exports = { + extends: [ + 'eslint-config-airbnb-base', + 'eslint-config-airbnb-base/rules/strict', + './rules/react', + './rules/react-a11y', + ].map(require.resolve), + rules: {} +}; diff --git a/packages/eslint-config-airbnb/legacy.js b/packages/eslint-config-airbnb/legacy.js new file mode 100644 index 0000000000..e88f71224a --- /dev/null +++ b/packages/eslint-config-airbnb/legacy.js @@ -0,0 +1,4 @@ +module.exports = { + extends: ['eslint-config-airbnb-base/legacy'].map(require.resolve), + rules: {}, +}; diff --git a/packages/eslint-config-airbnb/package.json b/packages/eslint-config-airbnb/package.json new file mode 100644 index 0000000000..faee46ec90 --- /dev/null +++ b/packages/eslint-config-airbnb/package.json @@ -0,0 +1,79 @@ +{ + "name": "eslint-config-airbnb", + "version": "16.1.0", + "description": "Airbnb's ESLint config, following our styleguide", + "main": "index.js", + "scripts": { + "prelint": "editorconfig-tools check * rules/* test/*", + "lint": "eslint .", + "pretests-only": "node ./test/requires", + "tests-only": "babel-tape-runner ./test/test-*.js", + "prepublish": "(in-install || eslint-find-rules --unused) && (not-in-publish || npm test) && safe-publish-latest", + "pretest": "npm run --silent lint", + "test": "npm run --silent tests-only", + "pretravis": "cd ../eslint-config-airbnb-base && npm install && npm link && cd - && npm link --no-save eslint-config-airbnb-base", + "travis": "npm run --silent test", + "posttravis": "npm unlink --no-save eslint-config-airbnb-base >/dev/null &" + }, + "repository": { + "type": "git", + "url": "https://github.com/airbnb/javascript" + }, + "keywords": [ + "eslint", + "eslintconfig", + "config", + "airbnb", + "javascript", + "styleguide" + ], + "author": "Jake Teton-Landis (https://twitter.com/@jitl)", + "contributors": [ + { + "name": "Jake Teton-Landis", + "url": "https://twitter.com/jitl" + }, + { + "name": "Jordan Harband", + "email": "ljharb@gmail.com", + "url": "http://ljharb.codes" + }, + { + "name": "Harrison Shoff", + "url": "https://twitter.com/hshoff" + } + ], + "license": "MIT", + "bugs": { + "url": "https://github.com/airbnb/javascript/issues" + }, + "homepage": "https://github.com/airbnb/javascript", + "dependencies": { + "eslint-config-airbnb-base": "^12.1.0", + "object.assign": "^4.1.0", + "object.entries": "^1.0.4" + }, + "devDependencies": { + "babel-preset-airbnb": "^2.4.0", + "babel-tape-runner": "^2.0.1", + "editorconfig-tools": "^0.1.1", + "eslint": "^4.19.1", + "eslint-find-rules": "^3.2.3", + "eslint-plugin-import": "^2.12.0", + "eslint-plugin-jsx-a11y": "^6.0.3", + "eslint-plugin-react": "^7.9.1", + "in-publish": "^2.0.0", + "react": ">= 0.13.0", + "safe-publish-latest": "^1.1.1", + "tape": "^4.9.0" + }, + "peerDependencies": { + "eslint": "^4.19.1", + "eslint-plugin-import": "^2.12.0", + "eslint-plugin-jsx-a11y": "^6.0.3", + "eslint-plugin-react": "^7.9.1" + }, + "engines": { + "node": ">= 4" + } +} diff --git a/packages/eslint-config-airbnb/rules/react-a11y.js b/packages/eslint-config-airbnb/rules/react-a11y.js new file mode 100644 index 0000000000..f53b3d22f6 --- /dev/null +++ b/packages/eslint-config-airbnb/rules/react-a11y.js @@ -0,0 +1,200 @@ +module.exports = { + plugins: [ + 'jsx-a11y', + 'react' + ], + + parserOptions: { + ecmaFeatures: { + jsx: true, + }, + }, + + rules: { + // Enforce that anchors have content + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/anchor-has-content.md + 'jsx-a11y/anchor-has-content': ['error', { components: [] }], + + // Require ARIA roles to be valid and non-abstract + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-role.md + 'jsx-a11y/aria-role': ['error', { ignoreNonDom: false }], + + // Enforce all aria-* props are valid. + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-props.md + 'jsx-a11y/aria-props': 'error', + + // Enforce ARIA state and property values are valid. + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-proptypes.md + 'jsx-a11y/aria-proptypes': 'error', + + // Enforce that elements that do not support ARIA roles, states, and + // properties do not have those attributes. + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-unsupported-elements.md + 'jsx-a11y/aria-unsupported-elements': 'error', + + // Enforce that all elements that require alternative text have meaningful information + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/alt-text.md + 'jsx-a11y/alt-text': ['error', { + elements: ['img', 'object', 'area', 'input[type="image"]'], + img: [], + object: [], + area: [], + 'input[type="image"]': [], + }], + + // Prevent img alt text from containing redundant words like "image", "picture", or "photo" + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/img-redundant-alt.md + 'jsx-a11y/img-redundant-alt': 'error', + + // require that JSX labels use "htmlFor" + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/label-has-for.md + 'jsx-a11y/label-has-for': ['error', { + components: [], + required: { + every: ['nesting', 'id'], + }, + allowChildren: false, + }], + + // require that mouseover/out come with focus/blur, for keyboard-only users + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/mouse-events-have-key-events.md + 'jsx-a11y/mouse-events-have-key-events': 'error', + + // Prevent use of `accessKey` + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-access-key.md + 'jsx-a11y/no-access-key': 'error', + + // require onBlur instead of onChange + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-onchange.md + 'jsx-a11y/no-onchange': 'off', + + // Elements with an interactive role and interaction handlers must be focusable + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/interactive-supports-focus.md + 'jsx-a11y/interactive-supports-focus': 'error', + + // Enforce that elements with ARIA roles must have all required attributes + // for that role. + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/role-has-required-aria-props.md + 'jsx-a11y/role-has-required-aria-props': 'error', + + // Enforce that elements with explicit or implicit roles defined contain + // only aria-* properties supported by that role. + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/role-supports-aria-props.md + 'jsx-a11y/role-supports-aria-props': 'error', + + // Enforce tabIndex value is not greater than zero. + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/tabindex-no-positive.md + 'jsx-a11y/tabindex-no-positive': 'error', + + // ensure tags have content and are not aria-hidden + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/heading-has-content.md + 'jsx-a11y/heading-has-content': ['error', { components: [''] }], + + // require HTML elements to have a "lang" prop + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/html-has-lang.md + 'jsx-a11y/html-has-lang': 'error', + + // require HTML element's lang prop to be valid + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/lang.md + 'jsx-a11y/lang': 'error', + + // prevent distracting elements, like and + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-distracting-elements.md + 'jsx-a11y/no-distracting-elements': ['error', { + elements: ['marquee', 'blink'], + }], + + // only allow to have the "scope" attr + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/scope.md + 'jsx-a11y/scope': 'error', + + // require onClick be accompanied by onKeyUp/onKeyDown/onKeyPress + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/click-events-have-key-events.md + 'jsx-a11y/click-events-have-key-events': 'error', + + // Enforce that DOM elements without semantic behavior not have interaction handlers + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-static-element-interactions.md + 'jsx-a11y/no-static-element-interactions': ['error', { + handlers: [ + 'onClick', + 'onMouseDown', + 'onMouseUp', + 'onKeyPress', + 'onKeyDown', + 'onKeyUp', + ] + }], + + // A non-interactive element does not support event handlers (mouse and key handlers) + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-noninteractive-element-interactions.md + 'jsx-a11y/no-noninteractive-element-interactions': ['error', { + handlers: [ + 'onClick', + 'onMouseDown', + 'onMouseUp', + 'onKeyPress', + 'onKeyDown', + 'onKeyUp', + ] + }], + + // ensure emoji are accessible + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/accessible-emoji.md + 'jsx-a11y/accessible-emoji': 'error', + + // elements with aria-activedescendant must be tabbable + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-activedescendant-has-tabindex.md + 'jsx-a11y/aria-activedescendant-has-tabindex': 'error', + + // ensure iframe elements have a unique title + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/iframe-has-title.md + 'jsx-a11y/iframe-has-title': 'error', + + // prohibit autoFocus prop + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-autofocus.md + 'jsx-a11y/no-autofocus': ['error', { ignoreNonDOM: true }], + + // ensure HTML elements do not specify redundant ARIA roles + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-redundant-roles.md + 'jsx-a11y/no-redundant-roles': 'error', + + // media elements must have captions + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/media-has-caption.md + 'jsx-a11y/media-has-caption': ['error', { + audio: [], + video: [], + track: [], + }], + + // WAI-ARIA roles should not be used to convert an interactive element to non-interactive + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-interactive-element-to-noninteractive-role.md + 'jsx-a11y/no-interactive-element-to-noninteractive-role': ['error', { + tr: ['none', 'presentation'], + }], + + // WAI-ARIA roles should not be used to convert a non-interactive element to interactive + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-noninteractive-element-to-interactive-role.md + 'jsx-a11y/no-noninteractive-element-to-interactive-role': ['error', { + ul: ['listbox', 'menu', 'menubar', 'radiogroup', 'tablist', 'tree', 'treegrid'], + ol: ['listbox', 'menu', 'menubar', 'radiogroup', 'tablist', 'tree', 'treegrid'], + li: ['menuitem', 'option', 'row', 'tab', 'treeitem'], + table: ['grid'], + td: ['gridcell'], + }], + + // Tab key navigation should be limited to elements on the page that can be interacted with. + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-noninteractive-tabindex.md + 'jsx-a11y/no-noninteractive-tabindex': ['error', { + tags: [], + roles: ['tabpanel'], + }], + + // ensure tags are valid + // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/0745af376cdc8686d85a361ce36952b1fb1ccf6e/docs/rules/anchor-is-valid.md + 'jsx-a11y/anchor-is-valid': ['error', { + components: ['Link'], + specialLink: ['to'], + aspects: ['noHref', 'invalidHref', 'preferButton'], + }], + }, +}; diff --git a/packages/eslint-config-airbnb/rules/react.js b/packages/eslint-config-airbnb/rules/react.js new file mode 100644 index 0000000000..f5a807faac --- /dev/null +++ b/packages/eslint-config-airbnb/rules/react.js @@ -0,0 +1,461 @@ +module.exports = { + plugins: [ + 'react', + ], + + parserOptions: { + ecmaFeatures: { + jsx: true, + }, + }, + + // View link below for react rules documentation + // https://github.com/yannickcr/eslint-plugin-react#list-of-supported-rules + rules: { + // Specify whether double or single quotes should be used in JSX attributes + // https://eslint.org/docs/rules/jsx-quotes + 'jsx-quotes': ['error', 'prefer-double'], + + 'class-methods-use-this': ['error', { + exceptMethods: [ + 'render', + 'getInitialState', + 'getDefaultProps', + 'getChildContext', + 'componentWillMount', + 'componentDidMount', + 'componentWillReceiveProps', + 'shouldComponentUpdate', + 'componentWillUpdate', + 'componentDidUpdate', + 'componentWillUnmount', + 'componentDidCatch', + ], + }], + + // Prevent missing displayName in a React component definition + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/display-name.md + 'react/display-name': ['off', { ignoreTranspilerName: false }], + + // Forbid certain propTypes (any, array, object) + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/forbid-prop-types.md + 'react/forbid-prop-types': ['error', { + forbid: ['any', 'array', 'object'], + checkContextTypes: true, + checkChildContextTypes: true, + }], + + // Forbid certain props on DOM Nodes + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/forbid-dom-props.md + 'react/forbid-dom-props': ['off', { forbid: [] }], + + // Enforce boolean attributes notation in JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-boolean-value.md + 'react/jsx-boolean-value': ['error', 'never', { always: [] }], + + // Validate closing bracket location in JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-bracket-location.md + 'react/jsx-closing-bracket-location': ['error', 'line-aligned'], + + // Validate closing tag location in JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-tag-location.md + 'react/jsx-closing-tag-location': 'error', + + // Enforce or disallow spaces inside of curly braces in JSX attributes + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-curly-spacing.md + 'react/jsx-curly-spacing': ['error', 'never', { allowMultiline: true }], + + // Enforce event handler naming conventions in JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-handler-names.md + 'react/jsx-handler-names': ['off', { + eventHandlerPrefix: 'handle', + eventHandlerPropPrefix: 'on', + }], + + // Validate props indentation in JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-indent-props.md + 'react/jsx-indent-props': ['error', 2], + + // Validate JSX has key prop when in array or iterator + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-key.md + 'react/jsx-key': 'off', + + // Limit maximum of props on a single line in JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-max-props-per-line.md + 'react/jsx-max-props-per-line': ['error', { maximum: 1, when: 'multiline' }], + + // Prevent usage of .bind() in JSX props + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-bind.md + 'react/jsx-no-bind': ['error', { + ignoreRefs: true, + allowArrowFunctions: true, + allowBind: false, + }], + + // Prevent duplicate props in JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-duplicate-props.md + 'react/jsx-no-duplicate-props': ['error', { ignoreCase: true }], + + // Prevent usage of unwrapped JSX strings + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-literals.md + 'react/jsx-no-literals': ['off', { noStrings: true }], + + // Disallow undeclared variables in JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-undef.md + 'react/jsx-no-undef': 'error', + + // Enforce PascalCase for user-defined JSX components + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-pascal-case.md + 'react/jsx-pascal-case': ['error', { + allowAllCaps: true, + ignore: [], + }], + + // Enforce propTypes declarations alphabetical sorting + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-prop-types.md + 'react/sort-prop-types': ['off', { + ignoreCase: true, + callbacksLast: false, + requiredFirst: false, + sortShapeProp: true, + }], + + // Deprecated in favor of react/jsx-sort-props + 'react/jsx-sort-prop-types': 'off', + + // Enforce props alphabetical sorting + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-sort-props.md + 'react/jsx-sort-props': ['off', { + ignoreCase: true, + callbacksLast: false, + shorthandFirst: false, + shorthandLast: false, + noSortAlphabetically: false, + reservedFirst: true, + }], + + // Enforce defaultProps declarations alphabetical sorting + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/jsx-sort-default-props.md + 'react/jsx-sort-default-props': ['off', { + ignoreCase: true, + }], + + // Prevent React to be incorrectly marked as unused + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-uses-react.md + 'react/jsx-uses-react': ['error'], + + // Prevent variables used in JSX to be incorrectly marked as unused + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-uses-vars.md + 'react/jsx-uses-vars': 'error', + + // Prevent usage of dangerous JSX properties + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-danger.md + 'react/no-danger': 'warn', + + // Prevent usage of deprecated methods + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-deprecated.md + 'react/no-deprecated': ['error'], + + // Prevent usage of setState in componentDidMount + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-did-mount-set-state.md + // this is necessary for server-rendering + 'react/no-did-mount-set-state': 'off', + + // Prevent usage of setState in componentDidUpdate + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-did-update-set-state.md + 'react/no-did-update-set-state': 'error', + + // Prevent usage of setState in componentWillUpdate + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-will-update-set-state.md + 'react/no-will-update-set-state': 'error', + + // Prevent direct mutation of this.state + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-direct-mutation-state.md + 'react/no-direct-mutation-state': 'off', + + // Prevent usage of isMounted + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-is-mounted.md + 'react/no-is-mounted': 'error', + + // Prevent multiple component definition per file + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-multi-comp.md + 'react/no-multi-comp': ['error', { ignoreStateless: true }], + + // Prevent usage of setState + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-set-state.md + 'react/no-set-state': 'off', + + // Prevent using string references + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-string-refs.md + 'react/no-string-refs': 'error', + + // Prevent usage of unknown DOM property + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unknown-property.md + 'react/no-unknown-property': 'error', + + // Require ES6 class declarations over React.createClass + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-es6-class.md + 'react/prefer-es6-class': ['error', 'always'], + + // Require stateless functions when not using lifecycle methods, setState or ref + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-stateless-function.md + 'react/prefer-stateless-function': ['error', { ignorePureComponents: true }], + + // Prevent missing props validation in a React component definition + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prop-types.md + 'react/prop-types': ['error', { + ignore: [], + customValidators: [], + skipUndeclared: false + }], + + // Prevent missing React when using JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/react-in-jsx-scope.md + 'react/react-in-jsx-scope': 'error', + + // Require render() methods to return something + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-render-return.md + 'react/require-render-return': 'error', + + // Prevent extra closing tags for components without children + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/self-closing-comp.md + 'react/self-closing-comp': 'error', + + // Enforce component methods order + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/sort-comp.md + 'react/sort-comp': ['error', { + order: [ + 'static-methods', + 'instance-variables', + 'lifecycle', + '/^on.+$/', + 'getters', + 'setters', + '/^(get|set)(?!(InitialState$|DefaultProps$|ChildContext$)).+$/', + 'instance-methods', + 'everything-else', + 'rendering', + ], + groups: { + lifecycle: [ + 'displayName', + 'propTypes', + 'contextTypes', + 'childContextTypes', + 'mixins', + 'statics', + 'defaultProps', + 'constructor', + 'getDefaultProps', + 'getInitialState', + 'state', + 'getChildContext', + 'componentWillMount', + 'componentDidMount', + 'componentWillReceiveProps', + 'shouldComponentUpdate', + 'componentWillUpdate', + 'componentDidUpdate', + 'componentWillUnmount', + ], + rendering: [ + '/^render.+$/', + 'render' + ], + }, + }], + + // Prevent missing parentheses around multilines JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/jsx-wrap-multilines.md + 'react/jsx-wrap-multilines': ['error', { + declaration: 'parens-new-line', + assignment: 'parens-new-line', + return: 'parens-new-line', + arrow: 'parens-new-line', + condition: 'parens-new-line', + logical: 'parens-new-line', + prop: 'parens-new-line', + }], + + // Require that the first prop in a JSX element be on a new line when the element is multiline + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-first-prop-new-line.md + 'react/jsx-first-prop-new-line': ['error', 'multiline-multiprop'], + + // Enforce spacing around jsx equals signs + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-equals-spacing.md + 'react/jsx-equals-spacing': ['error', 'never'], + + // Enforce JSX indentation + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-indent.md + 'react/jsx-indent': ['error', 2], + + // Disallow target="_blank" on links + // https://github.com/yannickcr/eslint-plugin-react/blob/ac102885765be5ff37847a871f239c6703e1c7cc/docs/rules/jsx-no-target-blank.md + 'react/jsx-no-target-blank': ['error', { enforceDynamicLinks: 'always' }], + + // only .jsx files may have JSX + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-filename-extension.md + 'react/jsx-filename-extension': ['error', { extensions: ['.jsx'] }], + + // prevent accidental JS comments from being injected into JSX as text + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-comment-textnodes.md + 'react/jsx-no-comment-textnodes': 'error', + + // disallow using React.render/ReactDOM.render's return value + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-render-return-value.md + 'react/no-render-return-value': 'error', + + // require a shouldComponentUpdate method, or PureRenderMixin + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-optimization.md + 'react/require-optimization': ['off', { allowDecorators: [] }], + + // warn against using findDOMNode() + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-find-dom-node.md + 'react/no-find-dom-node': 'error', + + // Forbid certain props on Components + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-component-props.md + 'react/forbid-component-props': ['off', { forbid: [] }], + + // Forbid certain elements + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-elements.md + 'react/forbid-elements': ['off', { forbid: [], }], + + // Prevent problem with children and props.dangerouslySetInnerHTML + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-danger-with-children.md + 'react/no-danger-with-children': 'error', + + // Prevent unused propType definitions + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unused-prop-types.md + 'react/no-unused-prop-types': ['error', { + customValidators: [ + ], + skipShapeProps: true, + }], + + // Require style prop value be an object or var + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/style-prop-object.md + 'react/style-prop-object': 'error', + + // Prevent invalid characters from appearing in markup + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unescaped-entities.md + 'react/no-unescaped-entities': 'error', + + // Prevent passing of children as props + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-children-prop.md + 'react/no-children-prop': 'error', + + // Validate whitespace in and around the JSX opening and closing brackets + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/jsx-tag-spacing.md + 'react/jsx-tag-spacing': ['error', { + closingSlash: 'never', + beforeSelfClosing: 'always', + afterOpening: 'never', + beforeClosing: 'never', + }], + + // Enforce spaces before the closing bracket of self-closing JSX elements + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-space-before-closing.md + // Deprecated in favor of jsx-tag-spacing + 'react/jsx-space-before-closing': ['off', 'always'], + + // Prevent usage of Array index in keys + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-array-index-key.md + 'react/no-array-index-key': 'error', + + // Enforce a defaultProps definition for every prop that is not a required prop + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/require-default-props.md + 'react/require-default-props': ['error', { + forbidDefaultForRequired: true, + }], + + // Forbids using non-exported propTypes + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-foreign-prop-types.md + // TODO: enable? + 'react/forbid-foreign-prop-types': ['off', { allowInPropTypes: true }], + + // Prevent void DOM elements from receiving children + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/void-dom-elements-no-children.md + 'react/void-dom-elements-no-children': 'error', + + // Enforce all defaultProps have a corresponding non-required PropType + // https://github.com/yannickcr/eslint-plugin-react/blob/9e13ae2c51e44872b45cc15bf1ac3a72105bdd0e/docs/rules/default-props-match-prop-types.md + 'react/default-props-match-prop-types': ['error', { allowRequiredDefaults: false }], + + // Prevent usage of shouldComponentUpdate when extending React.PureComponent + // https://github.com/yannickcr/eslint-plugin-react/blob/9e13ae2c51e44872b45cc15bf1ac3a72105bdd0e/docs/rules/no-redundant-should-component-update.md + 'react/no-redundant-should-component-update': 'error', + + // Prevent unused state values + // https://github.com/yannickcr/eslint-plugin-react/pull/1103/ + 'react/no-unused-state': 'error', + + // Enforces consistent naming for boolean props + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/boolean-prop-naming.md + 'react/boolean-prop-naming': ['off', { + propTypeNames: ['bool', 'mutuallyExclusiveTrueProps'], + rule: '^(is|has)[A-Z]([A-Za-z0-9]?)+', + message: '', + }], + + // Prevents common casing typos + // https://github.com/yannickcr/eslint-plugin-react/blob/73abadb697034b5ccb514d79fb4689836fe61f91/docs/rules/no-typos.md + 'react/no-typos': 'error', + + // Enforce curly braces or disallow unnecessary curly braces in JSX props and/or children + // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-curly-brace-presence.md + 'react/jsx-curly-brace-presence': ['error', { props: 'never', children: 'never' }], + + // One JSX Element Per Line + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/jsx-one-expression-per-line.md + 'react/jsx-one-expression-per-line': 'error', + + // Enforce consistent usage of destructuring assignment of props, state, and context + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/destructuring-assignment.md + 'react/destructuring-assignment': ['error', 'always'], + + // Prevent using this.state within a this.setState + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/no-access-state-in-setstate.md + 'react/no-access-state-in-setstate': 'error', + + // Prevent usage of button elements without an explicit type attribute + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/button-has-type.md + 'react/button-has-type': ['error', { + button: true, + submit: true, + reset: false, + }], + + // Ensures inline tags are not rendered without spaces between them + 'react/jsx-child-element-spacing': 'off', + + // Prevent this from being used in stateless functional components + // https://github.com/yannickcr/eslint-plugin-react/blob/843d71a432baf0f01f598d7cf1eea75ad6896e4b/docs/rules/no-this-in-sfc.md + 'react/no-this-in-sfc': 'error', + + // Validate JSX maximum depth + // https://github.com/yannickcr/eslint-plugin-react/blob/abe8381c0d6748047224c430ce47f02e40160ed0/docs/rules/jsx-max-depth.md + 'react/jsx-max-depth': 'off', + + // Disallow multiple spaces between inline JSX props + // https://github.com/yannickcr/eslint-plugin-react/blob/ac102885765be5ff37847a871f239c6703e1c7cc/docs/rules/jsx-props-no-multi-spaces.md + 'react/jsx-props-no-multi-spaces': 'error', + }, + + settings: { + 'import/resolver': { + node: { + extensions: ['.js', '.jsx', '.json'] + } + }, + react: { + pragma: 'React', + version: '16.0' + }, + propWrapperFunctions: [ + 'forbidExtraProps', // https://www.npmjs.com/package/airbnb-prop-types + 'exact', // https://www.npmjs.com/package/prop-types-exact + 'Object.freeze', // https://tc39.github.io/ecma262/#sec-object.freeze + ], + } +}; diff --git a/packages/eslint-config-airbnb/test/.eslintrc b/packages/eslint-config-airbnb/test/.eslintrc new file mode 100644 index 0000000000..9c23197fab --- /dev/null +++ b/packages/eslint-config-airbnb/test/.eslintrc @@ -0,0 +1,9 @@ +{ + "rules": { + // disabled because I find it tedious to write tests while following this rule + "no-shadow": 0, + + // tests uses `t` for tape + "id-length": [2, {"min": 2, "properties": "never", "exceptions": ["t"]}] + } +} diff --git a/packages/eslint-config-airbnb/test/requires.js b/packages/eslint-config-airbnb/test/requires.js new file mode 100644 index 0000000000..0ab4aae58d --- /dev/null +++ b/packages/eslint-config-airbnb/test/requires.js @@ -0,0 +1,17 @@ +/* eslint + strict: 0, + global-require: 0, + */ + +'use strict'; + +const test = require('tape'); + +test('all entry points parse', (t) => { + t.doesNotThrow(() => require('..'), 'index does not throw'); + t.doesNotThrow(() => require('../base'), 'base does not throw'); + t.doesNotThrow(() => require('../legacy'), 'legacy does not throw'); + t.doesNotThrow(() => require('../whitespace'), 'whitespace does not throw'); + + t.end(); +}); diff --git a/packages/eslint-config-airbnb/test/test-base.js b/packages/eslint-config-airbnb/test/test-base.js new file mode 100644 index 0000000000..807191dfe3 --- /dev/null +++ b/packages/eslint-config-airbnb/test/test-base.js @@ -0,0 +1,34 @@ +import fs from 'fs'; +import path from 'path'; +import test from 'tape'; + +const base = require('../base'); + +const files = { base }; + +fs.readdirSync(path.join(__dirname, '../rules')).forEach((name) => { + if (name === 'react.js' || name === 'react-a11y.js') { + return; + } + + // eslint-disable-next-line import/no-dynamic-require + files[name] = require(`../rules/${name}`); // eslint-disable-line global-require +}); + +Object.keys(files).forEach((name) => { + const config = files[name]; + + test(`${name}: does not reference react`, (t) => { + t.plan(2); + + // scan plugins for react and fail if it is found + const hasReactPlugin = Object.prototype.hasOwnProperty.call(config, 'plugins') + && config.plugins.indexOf('react') !== -1; + t.notOk(hasReactPlugin, 'there is no react plugin'); + + // scan rules for react/ and fail if any exist + const reactRuleIds = Object.keys(config.rules) + .filter(ruleId => ruleId.indexOf('react/') === 0); + t.deepEquals(reactRuleIds, [], 'there are no react/ rules'); + }); +}); diff --git a/packages/eslint-config-airbnb/test/test-react-order.js b/packages/eslint-config-airbnb/test/test-react-order.js new file mode 100644 index 0000000000..2527f04e19 --- /dev/null +++ b/packages/eslint-config-airbnb/test/test-react-order.js @@ -0,0 +1,94 @@ +import test from 'tape'; +import { CLIEngine } from 'eslint'; +import eslintrc from '..'; +import reactRules from '../rules/react'; +import reactA11yRules from '../rules/react-a11y'; + +const cli = new CLIEngine({ + useEslintrc: false, + baseConfig: eslintrc, + + rules: { + // It is okay to import devDependencies in tests. + 'import/no-extraneous-dependencies': [2, { devDependencies: true }], + // this doesn't matter for tests + 'lines-between-class-members': 0, + }, +}); + +function lint(text) { + // @see https://eslint.org/docs/developer-guide/nodejs-api.html#executeonfiles + // @see https://eslint.org/docs/developer-guide/nodejs-api.html#executeontext + const linter = cli.executeOnText(text); + return linter.results[0]; +} + +function wrapComponent(body) { + return ` +import React from 'react'; + +export default class MyComponent extends React.Component { +/* eslint no-empty-function: 0, class-methods-use-this: 0 */ +${body} +} +`; +} + +test('validate react prop order', (t) => { + t.test('make sure our eslintrc has React and JSX linting dependencies', (t) => { + t.plan(2); + t.deepEqual(reactRules.plugins, ['react']); + t.deepEqual(reactA11yRules.plugins, ['jsx-a11y', 'react']); + }); + + t.test('passes a good component', (t) => { + t.plan(3); + const result = lint(wrapComponent(` + componentWillMount() {} + componentDidMount() {} + setFoo() {} + getFoo() {} + setBar() {} + someMethod() {} + renderDogs() {} + render() { return
; }`)); + + t.notOk(result.warningCount, 'no warnings'); + t.notOk(result.errorCount, 'no errors'); + t.deepEquals(result.messages, [], 'no messages in results'); + }); + + t.test('order: when random method is first', (t) => { + t.plan(2); + const result = lint(wrapComponent(` + someMethod() {} + componentWillMount() {} + componentDidMount() {} + setFoo() {} + getFoo() {} + setBar() {} + renderDogs() {} + render() { return
; } +`)); + + t.ok(result.errorCount, 'fails'); + t.equal(result.messages[0].ruleId, 'react/sort-comp', 'fails due to sort'); + }); + + t.test('order: when random method after lifecycle methods', (t) => { + t.plan(2); + const result = lint(wrapComponent(` + componentWillMount() {} + componentDidMount() {} + someMethod() {} + setFoo() {} + getFoo() {} + setBar() {} + renderDogs() {} + render() { return
; } +`)); + + t.ok(result.errorCount, 'fails'); + t.equal(result.messages[0].ruleId, 'react/sort-comp', 'fails due to sort'); + }); +}); diff --git a/packages/eslint-config-airbnb/whitespace.js b/packages/eslint-config-airbnb/whitespace.js new file mode 100644 index 0000000000..ba36569a99 --- /dev/null +++ b/packages/eslint-config-airbnb/whitespace.js @@ -0,0 +1,91 @@ +const baseConfig = require('.'); +const assign = require('object.assign'); +const entries = require('object.entries'); +const CLIEngine = require('eslint').CLIEngine; + +function onlyErrorOnRules(rulesToError, config) { + const errorsOnly = assign({}, config); + const cli = new CLIEngine({ baseConfig: config, useEslintrc: false }); + const baseRules = cli.getConfigForFile('./').rules; + + entries(baseRules).forEach((rule) => { + const ruleName = rule[0]; + const ruleConfig = rule[1]; + + if (rulesToError.indexOf(ruleName) === -1) { + if (Array.isArray(ruleConfig)) { + errorsOnly.rules[ruleName] = ['warn'].concat(ruleConfig.slice(1)); + } else if (typeof ruleConfig === 'number') { + errorsOnly.rules[ruleName] = 1; + } else { + errorsOnly.rules[ruleName] = 'warn'; + } + } + }); + + return errorsOnly; +} + +module.exports = onlyErrorOnRules([ + 'array-bracket-newline', + 'array-bracket-spacing', + 'array-element-newline', + 'arrow-spacing', + 'block-spacing', + 'comma-spacing', + 'computed-property-spacing', + 'dot-location', + 'eol-last', + 'func-call-spacing', + 'function-paren-newline', + 'generator-star-spacing', + 'implicit-arrow-linebreak', + 'indent', + 'key-spacing', + 'keyword-spacing', + 'line-comment-position', + 'linebreak-style', + 'multiline-ternary', + 'newline-per-chained-call', + 'no-irregular-whitespace', + 'no-mixed-spaces-and-tabs', + 'no-multi-spaces', + 'no-regex-spaces', + 'no-spaced-func', + 'no-trailing-spaces', + 'no-whitespace-before-property', + 'nonblock-statement-body-position', + 'object-curly-newline', + 'object-curly-spacing', + 'object-property-newline', + 'one-var-declaration-per-line', + 'operator-linebreak', + 'padded-blocks', + 'padding-line-between-statements', + 'rest-spread-spacing', + 'semi-spacing', + 'semi-style', + 'space-before-blocks', + 'space-before-function-paren', + 'space-in-parens', + 'space-infix-ops', + 'space-unary-ops', + 'spaced-comment', + 'switch-colon-spacing', + 'template-tag-spacing', + 'import/newline-after-import', + // eslint-plugin-react rules + 'react/jsx-child-element-spacing', + 'react/jsx-closing-bracket-location', + 'react/jsx-closing-tag-location', + 'react/jsx-curly-spacing', + 'react/jsx-equals-spacing', + 'react/jsx-first-prop-newline', + 'react/jsx-indent', + 'react/jsx-indent-props', + 'react/jsx-max-props-per-line', + 'react/jsx-one-expression-per-line', + 'react/jsx-space-before-closing', + 'react/jsx-tag-spacing', + 'react/jsx-wrap-multilines', +], baseConfig); diff --git a/react/README.md b/react/README.md new file mode 100644 index 0000000000..c4fcf76d56 --- /dev/null +++ b/react/README.md @@ -0,0 +1,698 @@ +# Airbnb React/JSX Style Guide + +*A mostly reasonable approach to React and JSX* + +This style guide is mostly based on the standards that are currently prevalent in JavaScript, although some conventions (i.e async/await or static class fields) may still be included or prohibited on a case-by-case basis. Currently, anything prior to stage 3 is not included nor recommended in this guide. + +## Table of Contents + + 1. [Basic Rules](#basic-rules) + 1. [Class vs `React.createClass` vs stateless](#class-vs-reactcreateclass-vs-stateless) + 1. [Mixins](#mixins) + 1. [Naming](#naming) + 1. [Declaration](#declaration) + 1. [Alignment](#alignment) + 1. [Quotes](#quotes) + 1. [Spacing](#spacing) + 1. [Props](#props) + 1. [Refs](#refs) + 1. [Parentheses](#parentheses) + 1. [Tags](#tags) + 1. [Methods](#methods) + 1. [Ordering](#ordering) + 1. [`isMounted`](#ismounted) + +## Basic Rules + + - Only include one React component per file. + - However, multiple [Stateless, or Pure, Components](https://facebook.github.io/react/docs/reusable-components.html#stateless-functions) are allowed per file. eslint: [`react/no-multi-comp`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-multi-comp.md#ignorestateless). + - Always use JSX syntax. + - Do not use `React.createElement` unless you're initializing the app from a file that is not JSX. + +## Class vs `React.createClass` vs stateless + + - If you have internal state and/or refs, prefer `class extends React.Component` over `React.createClass`. eslint: [`react/prefer-es6-class`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-es6-class.md) [`react/prefer-stateless-function`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-stateless-function.md) + + ```jsx + // bad + const Listing = React.createClass({ + // ... + render() { + return
{this.state.hello}
; + } + }); + + // good + class Listing extends React.Component { + // ... + render() { + return
{this.state.hello}
; + } + } + ``` + + And if you don't have state or refs, prefer normal functions (not arrow functions) over classes: + + ```jsx + // bad + class Listing extends React.Component { + render() { + return
{this.props.hello}
; + } + } + + // bad (relying on function name inference is discouraged) + const Listing = ({ hello }) => ( +
{hello}
+ ); + + // good + function Listing({ hello }) { + return
{hello}
; + } + ``` + +## Mixins + + - [Do not use mixins](https://facebook.github.io/react/blog/2016/07/13/mixins-considered-harmful.html). + + > Why? Mixins introduce implicit dependencies, cause name clashes, and cause snowballing complexity. Most use cases for mixins can be accomplished in better ways via components, higher-order components, or utility modules. + +## Naming + + - **Extensions**: Use `.jsx` extension for React components. + - **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/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-pascal-case.md) + + ```jsx + // bad + import reservationCard from './ReservationCard'; + + // good + import ReservationCard from './ReservationCard'; + + // bad + const ReservationItem = ; + + // 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 + // bad + import Footer from './Footer/Footer'; + + // bad + import Footer from './Footer/index'; + + // 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 + // bad + export default function withFoo(WrappedComponent) { + return function WithFoo(props) { + return ; + } + } + + // good + export default function withFoo(WrappedComponent) { + function WithFoo(props) { + return ; + } + + const wrappedComponentName = WrappedComponent.displayName + || WrappedComponent.name + || 'Component'; + + 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 + // bad + + + // bad + + + // good + + ``` + +## Declaration + + - Do not use `displayName` for naming components. Instead, name the component by reference. + + ```jsx + // bad + export default React.createClass({ + displayName: 'ReservationCard', + // stuff goes here + }); + + // 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/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-bracket-location.md) [`react/jsx-closing-tag-location`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-tag-location.md) + + ```jsx + // bad + + + // good + + + // if props fit in one line then keep it on the same line + + + // children get indented normally + + + + ``` + +## Quotes + + - Always use double quotes (`"`) for JSX attributes, but single quotes (`'`) for all other JS. eslint: [`jsx-quotes`](https://eslint.org/docs/rules/jsx-quotes) + + > Why? Regular HTML attributes also typically use double quotes instead of single, so JSX attributes mirror this convention. + + ```jsx + // bad + + + // good + + + // bad + + + // 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/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-tag-spacing.md) + + ```jsx + // bad + + + // very bad + + + // bad + + + // good + + ``` + + - Do not pad JSX curly braces with spaces. eslint: [`react/jsx-curly-spacing`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-curly-spacing.md) + + ```jsx + // bad + + + // good + + ``` + +## Props + + - Always use camelCase for prop names. + + ```jsx + // bad + + + // good + + ``` + + - Omit the value of the prop when it is explicitly `true`. eslint: [`react/jsx-boolean-value`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-boolean-value.md) + + ```jsx + // bad +
+ + // bad - abstract ARIA role +
+ + // good +
+ ``` + + - Do not use `accessKey` on elements. eslint: [`jsx-a11y/no-access-key`](https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-access-key.md) + + > Why? Inconsistencies between keyboard shortcuts and keyboard commands used by people using screenreaders and keyboards complicate accessibility. + + ```jsx + // bad +
+ + // good +
+ ``` + + - Avoid using an array index as `key` prop, prefer a unique ID. ([why?](https://medium.com/@robinpokorny/index-as-a-key-is-an-anti-pattern-e0349aece318)) + + ```jsx + // bad + {todos.map((todo, index) => + + )} + + // good + {todos.map(todo => ( + + ))} + ``` + + - Always define explicit defaultProps for all non-required props. + + > Why? propTypes are a form of documentation, and providing defaultProps means the reader of your code doesn’t have to assume as much. In addition, it can mean that your code can omit certain type checks. + + ```jsx + // bad + function SFC({ foo, bar, children }) { + return
{foo}{bar}{children}
; + } + SFC.propTypes = { + foo: PropTypes.number.isRequired, + bar: PropTypes.string, + children: PropTypes.node, + }; + + // good + function SFC({ foo, bar, children }) { + return
{foo}{bar}{children}
; + } + SFC.propTypes = { + foo: PropTypes.number.isRequired, + bar: PropTypes.string, + children: PropTypes.node, + }; + SFC.defaultProps = { + bar: '', + children: null, + }; + ``` + + - Use spread props sparingly. + > Why? Otherwise you're more likely to pass unnecessary props down to components. And for React v15.6.1 and older, you could [pass invalid HTML attributes to the DOM](https://reactjs.org/blog/2017/09/08/dom-attributes-in-react-16.html). + + Exceptions: + + - HOCs that proxy down props and hoist propTypes + + ```jsx + function HOC(WrappedComponent) { + return class Proxy extends React.Component { + Proxy.propTypes = { + text: PropTypes.string, + isLoading: PropTypes.bool + }; + + render() { + return + } + } + } + ``` + + - Spreading objects with known, explicit props. This can be particularly useful when testing React components with Mocha's beforeEach construct. + + ```jsx + export default function Foo { + const props = { + text: '', + isPublished: false + } + + return (
); + } + ``` + + Notes for use: + Filter out unnecessary props when possible. Also, use [prop-types-exact](https://www.npmjs.com/package/prop-types-exact) to help prevent bugs. + + ```jsx + // good + render() { + const { irrelevantProp, ...relevantProps } = this.props; + return + } + + // bad + render() { + const { irrelevantProp, ...relevantProps } = this.props; + return + } + ``` + +## Refs + + - Always use ref callbacks. eslint: [`react/no-string-refs`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-string-refs.md) + + ```jsx + // bad + + + // good + { this.myRef = ref; }} + /> + ``` + +## Parentheses + + - Wrap JSX tags in parentheses when they span more than one line. eslint: [`react/jsx-wrap-multilines`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-wrap-multilines.md) + + ```jsx + // bad + render() { + return + + ; + } + + // good + render() { + return ( + + + + ); + } + + // good, when single line + render() { + const body =
hello
; + return {body}; + } + ``` + +## Tags + + - Always self-close tags that have no children. eslint: [`react/self-closing-comp`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/self-closing-comp.md) + + ```jsx + // bad + + + // good + + ``` + + - If your component has multi-line properties, close its tag on a new line. eslint: [`react/jsx-closing-bracket-location`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-bracket-location.md) + + ```jsx + // bad + + + // good + + ``` + +## Methods + + - Use arrow functions to close over local variables. + + ```jsx + function ItemList(props) { + return ( +
    + {props.items.map((item, index) => ( + doSomethingWith(item.name, index)} + /> + ))} +
+ ); + } + ``` + + - Bind event handlers for the render method in the constructor. eslint: [`react/jsx-no-bind`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-bind.md) + + > Why? A bind call in the render path creates a brand new function on every single render. + + ```jsx + // bad + class extends React.Component { + onClickDiv() { + // do stuff + } + + render() { + return
; + } + } + + // good + class extends React.Component { + constructor(props) { + super(props); + + this.onClickDiv = this.onClickDiv.bind(this); + } + + onClickDiv() { + // do stuff + } + + render() { + return
; + } + } + ``` + + - Do not use underscore prefix for internal methods of a React component. + > Why? Underscore prefixes are sometimes used as a convention in other languages to denote privacy. But, unlike those languages, there is no native support for privacy in JavaScript, everything is public. Regardless of your intentions, adding underscore prefixes to your properties does not actually make them private, and any property (underscore-prefixed or not) should be treated as being public. See issues [#1024](https://github.com/airbnb/javascript/issues/1024), and [#490](https://github.com/airbnb/javascript/issues/490) for a more in-depth discussion. + + ```jsx + // bad + React.createClass({ + _onClickSubmit() { + // do stuff + }, + + // other stuff + }); + + // good + class extends React.Component { + onClickSubmit() { + // do stuff + } + + // other stuff + } + ``` + + - Be sure to return a value in your `render` methods. eslint: [`react/require-render-return`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-render-return.md) + + ```jsx + // bad + render() { + (
); + } + + // good + render() { + return (
); + } + ``` + +## Ordering + + - Ordering for `class extends React.Component`: + + 1. optional `static` methods + 1. `constructor` + 1. `getChildContext` + 1. `componentWillMount` + 1. `componentDidMount` + 1. `componentWillReceiveProps` + 1. `shouldComponentUpdate` + 1. `componentWillUpdate` + 1. `componentDidUpdate` + 1. `componentWillUnmount` + 1. *clickHandlers or eventHandlers* like `onClickSubmit()` or `onChangeDescription()` + 1. *getter methods for `render`* like `getSelectReason()` or `getFooterContent()` + 1. *optional render methods* like `renderNavigation()` or `renderProfilePicture()` + 1. `render` + + - How to define `propTypes`, `defaultProps`, `contextTypes`, etc... + + ```jsx + import React from 'react'; + import PropTypes from 'prop-types'; + + const propTypes = { + id: PropTypes.number.isRequired, + url: PropTypes.string.isRequired, + text: PropTypes.string, + }; + + const defaultProps = { + text: 'Hello World', + }; + + class Link extends React.Component { + static methodsAreOk() { + return true; + } + + render() { + return {this.props.text}; + } + } + + Link.propTypes = propTypes; + Link.defaultProps = defaultProps; + + export default Link; + ``` + + - Ordering for `React.createClass`: eslint: [`react/sort-comp`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md) + + 1. `displayName` + 1. `propTypes` + 1. `contextTypes` + 1. `childContextTypes` + 1. `mixins` + 1. `statics` + 1. `defaultProps` + 1. `getDefaultProps` + 1. `getInitialState` + 1. `getChildContext` + 1. `componentWillMount` + 1. `componentDidMount` + 1. `componentWillReceiveProps` + 1. `shouldComponentUpdate` + 1. `componentWillUpdate` + 1. `componentDidUpdate` + 1. `componentWillUnmount` + 1. *clickHandlers or eventHandlers* like `onClickSubmit()` or `onChangeDescription()` + 1. *getter methods for `render`* like `getSelectReason()` or `getFooterContent()` + 1. *optional render methods* like `renderNavigation()` or `renderProfilePicture()` + 1. `render` + +## `isMounted` + + - Do not use `isMounted`. eslint: [`react/no-is-mounted`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-is-mounted.md) + + > Why? [`isMounted` is an anti-pattern][anti-pattern], is not available when using ES6 classes, and is on its way to being officially deprecated. + + [anti-pattern]: https://facebook.github.io/react/blog/2015/12/16/ismounted-antipattern.html + +## Translation + + This JSX/React style guide is also available in other languages: + + - ![cn](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/China.png) **Chinese (Simplified)**: [JasonBoy/javascript](https://github.com/JasonBoy/javascript/tree/master/react) + - ![tw](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Taiwan.png) **Chinese (Traditional)**: [jigsawye/javascript](https://github.com/jigsawye/javascript/tree/master/react) + - ![es](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Spain.png) **Español**: [agrcrobles/javascript](https://github.com/agrcrobles/javascript/tree/master/react) + - ![jp](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Japan.png) **Japanese**: [mitsuruog/javascript-style-guide](https://github.com/mitsuruog/javascript-style-guide/tree/master/react) + - ![kr](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/South-Korea.png) **Korean**: [apple77y/javascript](https://github.com/apple77y/javascript/tree/master/react) + - ![pl](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Poland.png) **Polish**: [pietraszekl/javascript](https://github.com/pietraszekl/javascript/tree/master/react) + - ![Br](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Brazil.png) **Portuguese**: [ronal2do/javascript](https://github.com/ronal2do/airbnb-react-styleguide) + - ![ru](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Russia.png) **Russian**: [leonidlebedev/javascript-airbnb](https://github.com/leonidlebedev/javascript-airbnb/tree/master/react) + - ![th](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Thailand.png) **Thai**: [lvarayut/javascript-style-guide](https://github.com/lvarayut/javascript-style-guide/tree/master/react) + - ![tr](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Turkey.png) **Turkish**: [alioguzhan/react-style-guide](https://github.com/alioguzhan/react-style-guide) + - ![ua](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Ukraine.png) **Ukrainian**: [ivanzusko/javascript](https://github.com/ivanzusko/javascript/tree/master/react) + - ![vn](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Vietnam.png) **Vietnam**: [uetcodecamp/jsx-style-guide](https://github.com/UETCodeCamp/jsx-style-guide) + +**[⬆ back to top](#table-of-contents)**