From 8162ba776ad59d36094dac55b0e874f9f445505b Mon Sep 17 00:00:00 2001 From: Chris Nordhougen Date: Fri, 20 Aug 2021 09:03:31 -0500 Subject: [PATCH 01/29] Progress - 2021-08-20 FAWG Mtg --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index b4e9d4f7a4..6fbd87cff4 100644 --- a/README.md +++ b/README.md @@ -238,6 +238,7 @@ Other Style Guides }; ``` +## DISAGREEMENT - [3.5](#objects--grouped-shorthand) Group your shorthand properties at the beginning of your object declaration. @@ -289,6 +290,7 @@ Other Style Guides }; ``` +## MEH - [3.7](#objects--prototype-builtins) Do not call `Object.prototype` methods directly, such as `hasOwnProperty`, `propertyIsEnumerable`, and `isPrototypeOf`. eslint: [`no-prototype-builtins`](https://eslint.org/docs/rules/no-prototype-builtins) @@ -333,6 +335,7 @@ Other Style Guides ## Arrays +## TODO: Add case where it is actually useful - [4.1](#arrays--literals) Use the literal syntax for array creation. eslint: [`no-array-constructor`](https://eslint.org/docs/rules/no-array-constructor.html) @@ -412,6 +415,8 @@ Other Style Guides const baz = Array.from(foo, bar); ``` + +## DISAGREEMENT - [4.7](#arrays--callback-return) Use return statements in array method callbacks. It’s ok to omit the return if the function body consists of a single statement returning an expression without side effects, following [8.2](#arrows--implicit-return). eslint: [`array-callback-return`](https://eslint.org/docs/rules/array-callback-return) @@ -567,6 +572,7 @@ Other Style Guides ## Strings +## DISAGREEMENT - [6.1](#strings--quotes) Use single quotes `''` for strings. eslint: [`quotes`](https://eslint.org/docs/rules/quotes.html) @@ -650,6 +656,7 @@ Other Style Guides ## Functions +## NOPE - [7.1](#functions--declarations) Use named function expressions instead of function declarations. eslint: [`func-style`](https://eslint.org/docs/rules/func-style) @@ -708,6 +715,7 @@ Other Style Guides } ``` +## COMBINE 7.5 and 7.6 - [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. @@ -829,6 +837,7 @@ Other Style Guides const y = function a() {}; ``` +## UPDATE EXAMPLE - [7.12](#functions--mutate-params) Never mutate parameters. eslint: [`no-param-reassign`](https://eslint.org/docs/rules/no-param-reassign.html) From c9670b1f65eacd1b226727ff64fbd19aa6628622 Mon Sep 17 00:00:00 2001 From: Chris Nordhougen Date: Fri, 3 Sep 2021 11:02:50 -0500 Subject: [PATCH 02/29] Update README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 6fbd87cff4..75a48b80ce 100644 --- a/README.md +++ b/README.md @@ -1324,6 +1324,7 @@ Other Style Guides export default es6; ``` +## REMOVE - [10.2](#modules--no-wildcard) Do not use wildcard imports. @@ -1337,6 +1338,7 @@ Other Style Guides import AirbnbStyleGuide from './AirbnbStyleGuide'; ``` +## REMOVE - [10.3](#modules--no-export-from-import) And do not export directly from an import. @@ -1389,6 +1391,7 @@ Other Style Guides export { foo }; ``` +## KILL IT - [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) @@ -1421,6 +1424,7 @@ Other Style Guides foo.init(); ``` +## RECONCILE WITH PRETTIER - [10.8](#modules--multiline-imports-over-newlines) Multiline imports should be indented just like multiline array and object literals. eslint: [`object-curly-newline`](https://eslint.org/docs/rules/object-curly-newline) @@ -1477,6 +1481,7 @@ Other Style Guides ## Iterators and Generators +## UPDATE - for-of is fine - [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) @@ -1521,6 +1526,7 @@ Other Style Guides const increasedByOne = numbers.map((num) => num + 1); ``` +## BYE - [11.2](#generators--nope) Don’t use generators for now. @@ -1607,6 +1613,7 @@ Other Style Guides const isJedi = luke.jedi; ``` +## THAT'S JUST HOW IT WORKS - [12.2](#properties--bracket) Use bracket notation `[]` when accessing properties with a variable. @@ -1623,6 +1630,7 @@ Other Style Guides const isJedi = getProp('jedi'); ``` +## NAH - [12.3](#es2016-properties--exponentiation-operator) Use exponentiation operator `**` when calculating exponentiations. eslint: [`no-restricted-properties`](https://eslint.org/docs/rules/no-restricted-properties). @@ -2028,6 +2036,7 @@ Other Style Guides - [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. +## JUST BE CONSISTENT - [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) @@ -2153,6 +2162,7 @@ Other Style Guides ## Blocks +## Prettier does this - [16.1](#blocks--braces) Use braces with all multiline blocks. eslint: [`nonblock-statement-body-position`](https://eslint.org/docs/rules/nonblock-statement-body-position) @@ -2200,6 +2210,7 @@ Other Style Guides } ``` +## DISAGREEMENT - [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) @@ -2869,6 +2880,7 @@ Other Style Guides .fail(() => console.log('You have failed this city.')); ``` +## CAN'T DO THIS ANYWAY - [19.14](#whitespace--block-spacing) Require consistent spacing inside an open block token and the next token on the same line. This rule also enforces consistent spacing inside a close block token and previous token on the same line. eslint: [`block-spacing`](https://eslint.org/docs/rules/block-spacing) From a5890bb68e5efab0104a81d5f9c3c4260543d8fd Mon Sep 17 00:00:00 2001 From: Chris Nordhougen Date: Fri, 10 Sep 2021 08:17:41 -0500 Subject: [PATCH 03/29] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 75a48b80ce..088e3436ad 100644 --- a/README.md +++ b/README.md @@ -3399,6 +3399,7 @@ Other Style Guides // ^ supports both insideDirectory.js and insideDirectory/index.js ``` +## REDUNDANT - [23.7](#naming--camelCase-default-export) Use camelCase when you export-default a function. Your filename should be identical to your function’s name. @@ -3569,6 +3570,7 @@ Other Style Guides ## Events +## UPDATE EXAMPLES - [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: @@ -3598,6 +3600,7 @@ Other Style Guides **[⬆ back to top](#table-of-contents)** +## NO JQUERY ## jQuery @@ -3758,8 +3761,9 @@ Other Style Guides - 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. + ## UPDATE v - 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. + - 100% test coverage is a good goal to strive for, even if it’s not always practical to reach it. Don't write crappy tests just to bump the number. - 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)** From 06330358a6c7572dd27ff91f4be820fd788de7c3 Mon Sep 17 00:00:00 2001 From: Chris Nordhougen Date: Tue, 21 Sep 2021 13:48:05 -0500 Subject: [PATCH 04/29] Update all the things --- README.md | 6428 ++++++++++++++++++++++++-------------------------- eslint.svg | 17 + prettier.svg | 1 + 3 files changed, 3120 insertions(+), 3326 deletions(-) create mode 100644 eslint.svg create mode 100644 prettier.svg diff --git a/README.md b/README.md index 088e3436ad..35ed2b0716 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,13 @@ -# Airbnb JavaScript Style Guide() { +# SPS Commerce TypeScript Style Guide() { -*A mostly reasonable approach to JavaScript* +**TODO:** Write description -> **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) +**TODO:** What about these other guides? Other Style Guides - - - [ES5 (Deprecated)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5) - [React](react/) - - [CSS-in-JavaScript](css-in-javascript/) + - [CSS-in-JS](css-in-javascript/) - [CSS & Sass](https://github.com/airbnb/css) - - [Ruby](https://github.com/airbnb/ruby) ## Table of Contents @@ -33,7 +24,6 @@ Other Style Guides 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) @@ -45,3983 +35,3769 @@ Other Style Guides 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. [Language Proposals](#language-proposals) 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. + +[**1.1**](#types--primitives) ‣ Primitives: When you access a primitive type you work directly on its value. + +- `string` +- `number` +- `boolean` +- `null` +- `undefined` +- `symbol` +- `bigint` - - `string` - - `number` - - `boolean` - - `null` - - `undefined` - - `symbol` - - `bigint` - ```javascript - const foo = 1; - let bar = foo; - bar = 9; +```typescript +const foo = 1; +let bar = foo; - console.log(foo, bar); // => 1, 9 - ``` +bar = 9; - - Symbols and BigInts cannot be faithfully polyfilled, so they should not be used when targeting browsers/environments that don’t support them natively. +console.log(foo, bar); // => 1, 9 +``` - - - [1.2](#types--complex) **Complex**: When you access a complex type you work on a reference to its value. +Symbols and BigInts cannot be faithfully polyfilled, so they should not be used when targeting browsers/environments that don’t support them natively. - - `object` - - `array` - - `function` +--- - ```javascript - const foo = [1, 2]; - const bar = foo; + +[**1.2**](#types--complex) ‣ Complex: When you access a complex type you work on a reference to its value. - bar[0] = 9; + - `object` + - `array` + - `function` - console.log(foo[0], bar[0]); // => 9, 9 - ``` + ```typescript + 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) + +[**2.1**](#references--prefer-const) ‣ Use `const` for all of your references; avoid using `var`. - > Why? This ensures that you can’t reassign your references, which can lead to bugs and difficult to comprehend code. + [`prefer-const`](https://eslint.org/docs/rules/prefer-const.html), [`no-const-assign`](https://eslint.org/docs/rules/no-const-assign.html) - ```javascript - // bad - var a = 1; - var b = 2; +> Why? This ensures that you can’t reassign your references, which can lead to bugs and difficult to comprehend code. - // good - const a = 1; - const b = 2; - ``` +```typescript +// bad +var a = 1; +var b = 2; - - - [2.2](#references--disallow-var) If you must reassign references, use `let` instead of `var`. eslint: [`no-var`](https://eslint.org/docs/rules/no-var.html) +// good +const a = 1; +const b = 2; +``` - > Why? `let` is block-scoped rather than function-scoped like `var`. +--- - ```javascript - // bad - var count = 1; - if (true) { - count += 1; - } + +[**2.2**](#references--disallow-var) ‣ If you must reassign references, use `let` instead of `var`. - // good, use the let. - let count = 1; - if (true) { - count += 1; - } - ``` + [`no-var`](https://eslint.org/docs/rules/no-var.html) - - - [2.3](#references--block-scope) Note that both `let` and `const` are block-scoped, whereas `var` is function-scoped. +> Why? `let` is block-scoped rather than function-scoped like `var`. - ```javascript - // const and let only exist in the blocks they are defined in. - { - let a = 1; - const b = 1; - var c = 1; - } - console.log(a); // ReferenceError - console.log(b); // ReferenceError - console.log(c); // Prints 1 - ``` +```typescript +// 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, whereas `var` is function-scoped. + +```typescript +// const and let only exist in the blocks they are defined in. +{ + let a = 1; + const b = 1; + var c = 1; +} +console.log(a); // ReferenceError +console.log(b); // ReferenceError +console.log(c); // Prints 1 +``` - In the above code, you can see that referencing `a` and `b` will produce a ReferenceError, while `c` contains the number. This is because `a` and `b` are block scoped, while `c` is scoped to the containing function. +In the above code, you can see that referencing `a` and `b` will produce a ReferenceError, while `c` contains the number. This is because `a` and `b` are block scoped, while `c` is scoped to the containing function. **[⬆ back to top](#table-of-contents)** ## Objects - - - [3.1](#objects--no-new) Use the literal syntax for object creation. eslint: [`no-new-object`](https://eslint.org/docs/rules/no-new-object.html) + +[**3.1**](#objects--no-new) ‣ Use the literal syntax for object creation. - ```javascript - // bad - const item = new Object(); + [`no-new-object`](https://eslint.org/docs/rules/no-new-object.html) - // good - const item = {}; - ``` +```typescript +// bad +const item = new Object(); - - - [3.2](#es6-computed-properties) Use computed property names when creating objects with dynamic property names. +// good +const item = {}; +``` - > Why? They allow you to define all the properties of an object in one place. +--- - ```javascript + +[**3.2**](#es6-computed-properties) ‣ Use computed property names when creating objects with dynamic property names. - function getKey(k) { - return `a key named ${k}`; - } +> Why? They allow you to define all the properties of an object in one place. + +```typescript +function getKey(k: string) { + 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. + + [`object-shorthand`](https://eslint.org/docs/rules/object-shorthand.html) + +```typescript +// bad +const atom = { + value: 1, + + addValue: function (value: number) { + return atom.value + value; + }, +}; + +// good +const atom = { + value: 1, + + addValue(value: number) { + return atom.value + value; + }, +}; +``` + +--- + + +[**3.4**](#es6-object-concise) ‣ Use property value shorthand. - // 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 and descriptive. - - ```javascript - const lukeSkywalker = 'Luke Skywalker'; - - // bad - const obj = { - lukeSkywalker: lukeSkywalker, - }; - - // good - const obj = { - lukeSkywalker, - }; - ``` - -## DISAGREEMENT - - - [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, - }; - ``` - -## MEH - - - [3.7](#objects--prototype-builtins) Do not call `Object.prototype` methods directly, such as `hasOwnProperty`, `propertyIsEnumerable`, and `isPrototypeOf`. eslint: [`no-prototype-builtins`](https://eslint.org/docs/rules/no-prototype-builtins) - - > Why? These methods may be shadowed by properties on the object in question - consider `{ hasOwnProperty: false }` - or, the object may be a null object (`Object.create(null)`). - - ```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. - console.log(has.call(object, key)); - /* or */ - import has from 'has'; // https://www.npmjs.com/package/has - console.log(has(object, key)); - ``` - - - - [3.8](#objects--rest-spread) Prefer the object spread syntax over [`Object.assign`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) to shallow-copy objects. Use the object rest operator to get a new object with certain properties omitted. eslint: [`prefer-object-spread`](https://eslint.org/docs/rules/prefer-object-spread) - - ```javascript - // very bad - const original = { a: 1, b: 2 }; - const copy = Object.assign(original, { c: 3 }); // this mutates `original` ಠ_ಠ - delete copy.a; // so does this - - // bad - const original = { a: 1, b: 2 }; - const copy = Object.assign({}, original, { c: 3 }); // copy => { a: 1, b: 2, c: 3 } - - // good - const original = { a: 1, b: 2 }; - const copy = { ...original, c: 3 }; // copy => { a: 1, b: 2, c: 3 } - - const { a, ...noA } = copy; // noA => { b: 2, c: 3 } - ``` + [`object-shorthand`](https://eslint.org/docs/rules/object-shorthand.html) + +> Why? It is shorter and descriptive. + +```typescript +const lukeSkywalker = 'Luke Skywalker'; + +// bad +const obj = { + lukeSkywalker: lukeSkywalker, +}; + +// good +const obj = { + lukeSkywalker, +}; +``` + +--- + +**TODO:** Further discussion required + + +[**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. + +```typescript +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. + + **Enforced by Prettier** + + [`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. + +```typescript +// bad +const bad = { + 'foo': 3, + 'bar': 4, + 'data-blah': 5, +}; + +// good +const good = { + foo: 3, + bar: 4, + 'data-blah': 5, +}; +``` + +--- + + +[**3.7**](#objects--rest-spread) ‣ Prefer the object spread syntax over [`Object.assign`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) to shallow-copy objects. Use the object rest operator to get a new object with certain properties omitted. + + [`prefer-object-spread`](https://eslint.org/docs/rules/prefer-object-spread) + +```typescript +// 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 -## TODO: Add case where it is actually useful - - - [4.1](#arrays--literals) Use the literal syntax for array creation. eslint: [`no-array-constructor`](https://eslint.org/docs/rules/no-array-constructor.html) + +[**4.1**](#arrays--literals) ‣ Use the literal syntax for array creation, except in the case of initializing a sparse array with a specific size. - ```javascript - // bad - const items = new Array(); + [`no-array-constructor`](https://eslint.org/docs/rules/no-array-constructor.html) - // good - const items = []; - ``` +```typescript +// bad +const items = new Array(); - - - [4.2](#arrays--push) Use [Array#push](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/push) instead of direct assignment to add items to an array. +// good +const items = []; - ```javascript - const someStack = []; +// good +const items = new Array(8); +``` - // bad - someStack[someStack.length] = 'abracadabra'; +--- - // good - someStack.push('abracadabra'); - ``` + +[**4.2**](#arrays--push) ‣ Use [Array#push](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/push) instead of direct assignment to add items to an array. - - - [4.3](#es6-array-spreads) Use array spreads `...` to copy arrays. +```typescript +const someStack = []; - ```javascript - // bad - const len = items.length; - const itemsCopy = []; - let i; +// bad +someStack[someStack.length] = 'abracadabra'; - for (i = 0; i < len; i += 1) { - itemsCopy[i] = items[i]; - } +// good +someStack.push('abracadabra'); +``` - // good - const itemsCopy = [...items]; - ``` - - - - - [4.4](#arrays--from-iterable) To convert an iterable object to an array, use spreads `...` instead of [`Array.from`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from). - - ```javascript - const foo = document.querySelectorAll('.foo'); - - // good - const nodes = Array.from(foo); - - // best - const nodes = [...foo]; - ``` - - - - [4.5](#arrays--from-array-like) Use [`Array.from`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from) for converting an array-like object to an array. - - ```javascript - const arrLike = { 0: 'foo', 1: 'bar', 2: 'baz', length: 3 }; - - // bad - const arr = Array.prototype.slice.call(arrLike); - - // good - const arr = Array.from(arrLike); - ``` - - - - [4.6](#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); - ``` - - -## DISAGREEMENT - - - [4.7](#arrays--callback-return) Use return statements in array method callbacks. It’s ok to omit the return if the function body consists of a single statement returning an expression without side effects, following [8.2](#arrows--implicit-return). eslint: [`array-callback-return`](https://eslint.org/docs/rules/array-callback-return) - - ```javascript - // good - [1, 2, 3].map((x) => { - const y = x + 1; - return x * y; - }); - - // good - [1, 2, 3].map((x) => x + 1); - - // bad - no returned value means `acc` becomes undefined after the first iteration - [[0, 1], [2, 3], [4, 5]].reduce((acc, item, index) => { - const flatten = acc.concat(item); - }); - - // good - [[0, 1], [2, 3], [4, 5]].reduce((acc, item, index) => { - const flatten = acc.concat(item); - return flatten; - }); - - // bad - inbox.filter((msg) => { - const { subject, author } = msg; - if (subject === 'Mockingbird') { - return author === 'Harper Lee'; - } else { - return false; - } - }); - - // good - inbox.filter((msg) => { - const { subject, author } = msg; - if (subject === 'Mockingbird') { - return author === 'Harper Lee'; - } - - return false; - }); - ``` - - - - [4.8](#arrays--bracket-newline) Use line breaks after 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, - ]; - ``` +--- + + +[**4.3**](#es6-array-spreads) ‣ Use array spreads `...` to copy arrays. + +```typescript +// 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-iterable) ‣ To convert an iterable object to an array, use spreads `...` instead of [`Array.from`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from). + +```typescript +const foo = document.querySelectorAll('.foo'); + +// good +const nodes = Array.from(foo); + +// best +const nodes = [...foo]; +``` + +--- + + +[**4.5**](#arrays--from-array-like) ‣ Use [`Array.from`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from) for converting an array-like object to an array. + +```typescript +const arrLike = { 0: 'foo', 1: 'bar', 2: 'baz', length: 3 }; + +// bad +const arr = Array.prototype.slice.call(arrLike); + +// good +const arr = Array.from(arrLike); +``` + +--- + + +[**4.6**](#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. + +```typescript +// bad +const baz = [...foo].map(bar); + +// good +const baz = Array.from(foo, bar); +``` + +--- + +**TODO:** Further discussion required + + +[**4.7**](#arrays--callback-return) ‣ Use return statements in array method callbacks. It’s ok to omit the return if the function body consists of a single statement returning an expression without side effects, following [**8.2**](#arrows--implicit-return). + + [`array-callback-return`](https://eslint.org/docs/rules/array-callback-return) + +```typescript +// good +[1, 2, 3].map((x) => { + const y = x + 1; + return x * y; +}); + +// good +[1, 2, 3].map((x) => x + 1); + +// bad - no returned value means `acc` becomes undefined after the first iteration +[[0, 1], [2, 3], [4, 5]].reduce((acc, item, index) => { + const flatten = acc.concat(item); +}); + +// good +[[0, 1], [2, 3], [4, 5]].reduce((acc, item, index) => { + const flatten = acc.concat(item); + return flatten; +}); + +// bad +inbox.filter((msg) => { + const { subject, author } = msg; + if (subject === 'Mockingbird') { + return author === 'Harper Lee'; + } else { + return false; + } +}); + +// good +inbox.filter((msg) => { + const { subject, author } = msg; + if (subject === 'Mockingbird') { + return author === 'Harper Lee'; + } + + return false; +}); +``` + +--- + + +[**4.8**](#arrays--bracket-newline) ‣ Use line breaks after open and before close array brackets if an array has multiple lines. + + **Enforced by Prettier** + +```typescript +// bad +const arr = [ + [0, 1], +]; + +const objectInArray = [{ + id: 1, +}, { + id: 2, +}]; + +const numberInArray = [ + 1, 2, +]; + +// good +const arr = [[0, 1]]; + +const objectInArray = [ + { + id: 1, + }, + { + id: 2, + }, +]; + +const stringInArray = [ + 'foofoofoofoofoofoofoofoo', + 'foofoofoofoofoofoofoofoo', + 'foofoofoofoofoofoofoofoo', +]; +``` **[⬆ 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) + +[**5.1**](#destructuring--object) ‣ Use object destructuring when accessing and using multiple properties of an object. - > Why? Destructuring saves you from creating temporary references for those properties, and from repetitive access of the object. Repeating object access creates more repetitive code, requires more reading, and creates more opportunities for mistakes. Destructuring objects also provides a single site of definition of the object structure that is used in the block, rather than requiring reading the entire block to determine what is used. + [`prefer-destructuring`](https://eslint.org/docs/rules/prefer-destructuring) - ```javascript - // bad - function getFullName(user) { - const firstName = user.firstName; - const lastName = user.lastName; +> Why? Destructuring saves you from creating temporary references for those properties, and from repetitive access of the object. Repeating object access creates more repetitive code, requires more reading, and creates more opportunities for mistakes. Destructuring objects also provides a single site of definition of the object structure that is used in the block, rather than requiring reading the entire block to determine what is used. - return `${firstName} ${lastName}`; - } +```typescript +// bad +function getFullName(user) { + const firstName = user.firstName; + const lastName = user.lastName; - // good - function getFullName(user) { - const { firstName, lastName } = user; - return `${firstName} ${lastName}`; - } + return `${firstName} ${lastName}`; +} - // best - function getFullName({ firstName, lastName }) { - return `${firstName} ${lastName}`; - } - ``` +// good +function getFullName(user) { + const { firstName, lastName } = user; + return `${firstName} ${lastName}`; +} - - - [5.2](#destructuring--array) Use array destructuring. eslint: [`prefer-destructuring`](https://eslint.org/docs/rules/prefer-destructuring) +// best +function getFullName({ firstName, lastName }) { + return `${firstName} ${lastName}`; +} +``` - ```javascript - const arr = [1, 2, 3, 4]; +--- - // bad - const first = arr[0]; - const second = arr[1]; + +[**5.2**](#destructuring--array) ‣ Use array destructuring. - // good - const [first, second] = arr; - ``` + [`prefer-destructuring`](https://eslint.org/docs/rules/prefer-destructuring) - - - [5.3](#destructuring--object-over-array) Use object destructuring for multiple return values, not array destructuring. +```typescript +const arr = [1, 2, 3, 4]; - > Why? You can add new properties over time or change the order of things without breaking call sites. +// bad +const first = arr[0]; +const second = arr[1]; - ```javascript - // bad - function processInput(input) { - // then a miracle occurs - return [left, right, top, bottom]; - } +// good +const [first, second] = arr; +``` - // 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 }; - } + +[**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. - // the caller selects only the data they need - const { left, top } = processInput(input); - ``` +```typescript +// 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 -## DISAGREEMENT - - - [6.1](#strings--quotes) Use single quotes `''` for strings. eslint: [`quotes`](https://eslint.org/docs/rules/quotes.html) +**TODO:** Further discussion required - Prettier does double quotes by default, but can be configured for single quotes. - ```javascript - // bad - const name = "Capt. Janeway"; + +[**6.1**](#strings--quotes) ‣ Use single quotes `''` for strings. - // bad - template literals should contain interpolation or newlines - const name = `Capt. Janeway`; + **Enforced by Prettier** - // good - const name = 'Capt. Janeway'; - ``` + [`quotes`](https://eslint.org/docs/rules/quotes.html) - - - [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. +```typescript +// bad +const name = "Capt. Janeway"; - > Why? Broken strings are painful to work with and make code less searchable. +// bad - template literals should contain interpolation or newlines +const name = `Capt. Janeway`; - ```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.'; +// good +const name = 'Capt. Janeway'; +``` - // 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.2**](#strings--line-length) ‣ Strings that cause the line to go over 100 characters should not be written across multiple lines using string concatenation. - - - [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? Broken strings are painful to work with and make code less searchable. - > Why? Template strings give you a readable, concise syntax with proper newlines and string interpolation features. +```typescript +// 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.'; - ```javascript - // bad - function sayHi(name) { - return 'How are you, ' + name + '?'; - } +// 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 - function sayHi(name) { - return ['How are you, ', name, '?'].join(); - } +// 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.'; +``` - // bad - function sayHi(name) { - return `How are you, ${ name }?`; - } +--- - // good - function sayHi(name) { - return `How are you, ${name}?`; - } - ``` + +[**6.3**](#es6-template-literals) ‣ When programmatically building up strings, use template strings instead of concatenation. + + [`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. + +```typescript +// 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) + +[**6.4**](#strings--eval) ‣ Never use `eval()` on a string, it opens too many vulnerabilities. - > Why? Backslashes harm readability, thus they should only be present when necessary. + [`no-eval`](https://eslint.org/docs/rules/no-eval) - ```javascript - // bad - const foo = '\'this\' \i\s \"quoted\"'; +--- - // good - const foo = '\'this\' is "quoted"'; - const foo = `my name is '${name}'`; - ``` + +[**6.5**](#strings--escaping) ‣ Do not unnecessarily escape characters in strings. + + **Enforced by Prettier** + + [`no-useless-escape`](https://eslint.org/docs/rules/no-useless-escape) + +> Why? Backslashes harm readability, thus they should only be present when necessary. + +```typescript +// 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 -## NOPE - - - [7.1](#functions--declarations) Use named function expressions instead of function declarations. eslint: [`func-style`](https://eslint.org/docs/rules/func-style) + +[**7.1**](#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. + + [`no-loop-func`](https://eslint.org/docs/rules/no-loop-func.html) - > 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() { - // ... - } + +[**7.2**](#functions--note-on-blocks) ‣ **Note:** ECMA-262 defines a `block` as a list of statements. A function declaration is not a statement. - // 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.'); - } - } +```typescript +// bad +if (currentUser) { + function test() { + console.log('Nope.'); + } +} - // good - let test; - if (currentUser) { - test = () => { - console.log('Yup.'); - }; - } - ``` +// good +let test; +if (currentUser) { + test = () => { + console.log('Yup.'); + }; +} +``` -## COMBINE 7.5 and 7.6 - - - [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) { - // ... - } + +[**7.3**](#es6-rest) ‣ Never use `arguments`, opt to use rest syntax `...` instead. - // good - function foo(name, options, args) { - // ... - } - ``` + [`prefer-rest-params`](https://eslint.org/docs/rules/prefer-rest-params) - - - [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`. - > Why? `...` is explicit about which arguments you want pulled. Plus, rest arguments are a real Array, and not merely Array-like like `arguments`. +```typescript +// bad +function concatenateAll() { + const args = Array.prototype.slice.call(arguments); + return args.join(''); +} - ```javascript - // bad - function concatenateAll() { - const args = Array.prototype.slice.call(arguments); - return args.join(''); - } +// good +function concatenateAll(...args) { + 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 = {}; - } - // ... - } + +[**7.4**](#es6-default-parameters) ‣ Use default parameter syntax rather than mutating function arguments. - // good - function handleThings(opts = {}) { - // ... - } - ``` +```typescript +// 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 || {}; + // ... +} - - - [7.8](#functions--default-side-effects) Avoid side effects with default parameters. +// still bad +function handleThings(opts) { + if (opts === void 0) { + opts = {}; + } + // ... +} - > Why? They are confusing to reason about. +// good +function handleThings(opts = {}) { + // ... +} +``` - ```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. eslint: [`default-param-last`](https://eslint.org/docs/rules/default-param-last) - - ```javascript - // bad - function handleThings(opts = {}, name) { - // ... - } +--- - // good - function handleThings(name, opts = {}) { - // ... - } - ``` + +[**7.5**](#functions--default-side-effects) ‣ Avoid side effects with default parameters. - - - [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? They are confusing to reason about. - > 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'); +```typescript +let b = 1; - // still bad - var subtract = Function('a', 'b', 'return a - b'); - ``` +// bad +function count(a = b++) { + console.log(a); +} +count(); // 1 +count(); // 2 +count(3); // 3 +count(); // 3 +``` - - - [7.11](#functions--signature-spacing) Spacing in a function signature. eslint: [`space-before-function-paren`](https://eslint.org/docs/rules/space-before-function-paren) [`space-before-blocks`](https://eslint.org/docs/rules/space-before-blocks) +--- - > Why? Consistency is good, and you shouldn’t have to add or remove a space when adding or removing a name. + +[**7.6**](#functions--defaults-last) ‣ Always put default parameters last. - ```javascript - // bad - const f = function(){}; - const g = function (){}; - const h = function() {}; + [`default-param-last`](https://eslint.org/docs/rules/default-param-last) - // good - const x = function () {}; - const y = function a() {}; - ``` +```typescript +// bad +function handleThings(opts: IHandleThingsOpts = {}, name: string) { + // ... +} -## UPDATE EXAMPLE - - - [7.12](#functions--mutate-params) Never mutate parameters. eslint: [`no-param-reassign`](https://eslint.org/docs/rules/no-param-reassign.html) +// good +function handleThings(name: string, opts: IHandleThingsOpts = {}) { + // ... +} +``` - > Why? Manipulating objects passed in as parameters can cause unwanted variable side effects in the original caller. +--- - ```javascript - // bad - function f1(obj) { - obj.key = 1; - } + +[**7.7**](#functions--constructor) ‣ Never use the Function constructor to create a new function. - // good - function f2(obj) { - const key = Object.prototype.hasOwnProperty.call(obj, 'key') ? obj.key : 1; - } - ``` + [`no-new-func`](https://eslint.org/docs/rules/no-new-func) - - - [7.13](#functions--reassign-params) Never reassign parameters. eslint: [`no-param-reassign`](https://eslint.org/docs/rules/no-param-reassign.html) +> Why? Creating a function in this way evaluates a string similarly to `eval()`, which opens vulnerabilities. - > Why? Reassigning parameters can lead to unexpected behavior, especially when accessing the `arguments` object. It can also cause optimization issues, especially in V8. +```typescript +// bad +const add = new Function('a', 'b', 'return a + b'); - ```javascript - // bad - function f1(a) { - a = 1; - // ... - } +// still bad +const subtract = Function('a', 'b', 'return a - b'); +``` - function f2(a) { - if (!a) { a = 1; } - // ... - } +--- - // good - function f3(a) { - const b = a || 1; - // ... - } + +[**7.8**](#functions--signature-spacing) ‣ Spacing in a function signature. - function f4(a = 1) { - // ... - } - ``` + **Enforced by Prettier** - - - [7.14](#functions--spread-vs-apply) Prefer the use of the spread syntax `...` to call variadic functions. eslint: [`prefer-spread`](https://eslint.org/docs/rules/prefer-spread) + [`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? It’s cleaner, you don’t need to supply a context, and you can not easily compose `new` with `apply`. +> Why? Consistency is good, and you shouldn’t have to add or remove a space when adding or removing a name. - ```javascript - // bad - const x = [1, 2, 3, 4, 5]; - console.log.apply(console, x); +```typescript +// bad +const f = function(){}; +const g = function (){}; +const h = function() {}; - // good - const x = [1, 2, 3, 4, 5]; - console.log(...x); +// good +const x = function () {}; +const y = function a() {}; +``` - // bad - new (Function.prototype.bind.apply(Date, [null, 2016, 8, 5])); +--- - // good - new Date(...[2016, 8, 5]); - ``` + +[**7.10**](#functions--mutate-params) ‣ Never mutate parameters. - - - [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) + [`no-param-reassign`](https://eslint.org/docs/rules/no-param-reassign.html) - ```javascript - // bad - function foo(bar, - baz, - quux) { - // ... - } +> Why? Manipulating objects passed in as parameters can cause unwanted variable side effects in the original caller. - // good - function foo( - bar, - baz, - quux, - ) { - // ... - } +```typescript +// bad +function f1(obj: ObjType) { + obj.key = 1; + // ... +} + +// good +function f2(obj: ObjType) { + const objCopy = { + ...obj, + key: 1, + }; + // ... +} +``` - // bad - console.log(foo, - bar, - baz); +--- - // good - console.log( - foo, - bar, - baz, - ); - ``` + +[**7.11**](#functions--reassign-params) ‣ Never reassign parameters. + + [`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. + +```typescript +// bad +function f1(a: number) { + a = 1; + // ... +} + +function f2(a: number) { + if (!a) { a = 1; } + // ... +} + +// good +function f3(a: number) { + const b = a || 1; + // ... +} + +function f4(a: number = 1) { + // ... +} +``` + +--- + + +[**7.12**](#functions--spread-vs-apply) ‣ Prefer the use of the spread syntax `...` to call variadic functions. + + [`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`. + +```typescript +// 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.13**](#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. + + **Enforced by Prettier** + + [`function-paren-newline`](https://eslint.org/docs/rules/function-paren-newline) + +```typescript +// bad +function foo(bar: string, + baz: number, + quux: boolean) { + // ... +} + +// good +function foo( + bar: string, + baz: number, + quux: boolean, +) { + // ... +} + +// 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 + 1}.`); - - // good - [1, 2, 3].map((number) => { - const nextNumber = number + 1; - return `A string containing the ${nextNumber}.`; - }); - - // good - [1, 2, 3].map((number, index) => ({ - [index]: number, - })); - - // No implicit return with side effects - function foo(callback) { - const val = callback(); - if (val === true) { - // Do something if callback returns true - } - } + +[**8.1**](#arrows--use-them) ‣ When you must use an anonymous function (as when passing an inline callback), use arrow function notation. - 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) Always include parentheses around arguments for clarity and consistency. eslint: [`arrow-parens`](https://eslint.org/docs/rules/arrow-parens.html) - - > Why? Minimizes diff churn when adding or removing arguments. - - ```javascript - // bad - [1, 2, 3].map(x => x * x); - - // good - [1, 2, 3].map((x) => x * x); - - // bad - [1, 2, 3].map(number => ( - `A long string with the ${number}. It’s so long that we don’t want it to take up space on the .map line!` - )); - - // good - [1, 2, 3].map((number) => ( - `A long string with the ${number}. It’s so long that we don’t want it to take up space on the .map line!` - )); - - // bad - [1, 2, 3].map(x => { - const y = x + 1; - return x * y; - }); - - // good - [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 - ) - ``` + [`prefer-arrow-callback`](https://eslint.org/docs/rules/prefer-arrow-callback.html), [`arrow-spacing`](https://eslint.org/docs/rules/arrow-spacing.html) -**[⬆ back to top](#table-of-contents)** +> 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. -## Classes & Constructors +> Why not? If you have a fairly complicated function, you might move that logic out into its own named function expression. - - - [9.1](#constructors--use-class) Always use `class`. Avoid manipulating `prototype` directly. +```typescript +// bad +[1, 2, 3].map(function (x) { + const y = x + 1; + return x * y; +}); - > Why? `class` syntax is more concise and easier to reason about. +// good +[1, 2, 3].map((x) => { + const y = x + 1; + return x * y; +}); +``` - ```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. + +[**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. - > Why? It is a built-in way to inherit prototype functionality without breaking `instanceof`. + [`arrow-parens`](https://eslint.org/docs/rules/arrow-parens.html), [`arrow-body-style`](https://eslint.org/docs/rules/arrow-body-style.html) - ```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; - } - } +> Why? Syntactic sugar. It reads well when multiple functions are chained together. - const luke = new Jedi(); +```typescript +// bad +[1, 2, 3].map((number) => { + const nextNumber = number + 1; + `A string containing the ${nextNumber}.`; +}); - luke.jump() - .setHeight(20); - ``` +// good +[1, 2, 3].map((number) => `A string containing the ${number + 1}.`); - - - [9.4](#constructors--tostring) It’s okay to write a custom `toString()` method, just make sure it works successfully and causes no side effects. +// good +[1, 2, 3].map((number) => { + const nextNumber = number + 1; + return `A string containing the ${nextNumber}.`; +}); - ```javascript - class Jedi { - constructor(options = {}) { - this.name = options.name || 'no name'; - } +// good +[1, 2, 3].map((number, index) => ({ + [index]: number, +})); - getName() { - return this.name; - } +// No implicit return with side effects +function foo(callback: () => boolean) { + const val = callback(); + if (val === true) { + // Do something if callback returns true + } +} - toString() { - return `Jedi - ${this.getName()}`; - } - } - ``` +let bool = false; - - - [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) +// bad +foo(() => bool = true); - ```javascript - // bad - class Jedi { - constructor() {} +// good +foo(() => { + bool = true; +}); +``` - getName() { - return this.name; - } - } +--- - // bad - class Rey extends Jedi { - constructor(...args) { - super(...args); - } - } + +[**8.3**](#arrows--paren-wrap) ‣ In case the expression spans over multiple lines, wrap it in parentheses for better readability. - // good - class Rey extends Jedi { - constructor(...args) { - super(...args); - this.name = 'Rey'; - } - } - ``` +> Why? It shows clearly where the function starts and ends. - - - [9.6](#classes--no-duplicate-members) Avoid duplicate class members. eslint: [`no-dupe-class-members`](https://eslint.org/docs/rules/no-dupe-class-members) +```typescript +// bad +['get', 'post', 'put'].map((httpMethod) => Object.prototype.hasOwnProperty.call( + httpMagicObjectWithAVeryLongName, + httpMethod, + ) +); - > Why? Duplicate class member declarations will silently prefer the last one - having duplicates is almost certainly a bug. +// good +['get', 'post', 'put'].map((httpMethod) => ( + Object.prototype.hasOwnProperty.call( + httpMagicObjectWithAVeryLongName, + httpMethod, + ) +)); +``` - ```javascript - // bad - class Foo { - bar() { return 1; } - bar() { return 2; } - } +--- - // good - class Foo { - bar() { return 1; } - } + +[**8.4**](#arrows--one-arg-parens) ‣ Always include parentheses around arguments for clarity and consistency. - // good - class Foo { - bar() { return 2; } - } - ``` + **Enforced by Prettier** - - - [9.7](#classes--methods-use-this) Class methods should use `this` or be made into a static method unless an external library or framework requires using specific non-static methods. Being an instance method should indicate that it behaves differently based on properties of the receiver. eslint: [`class-methods-use-this`](https://eslint.org/docs/rules/class-methods-use-this) + [`arrow-parens`](https://eslint.org/docs/rules/arrow-parens.html) - ```javascript - // bad - class Foo { - bar() { - console.log('bar'); - } - } +> Why? Minimizes diff churn when adding or removing arguments. - // good - this is used - class Foo { - bar() { - console.log(this.bar); - } - } +```typescript +// bad +[1, 2, 3].map(x => x * x); - // good - constructor is exempt - class Foo { - constructor() { - // ... - } - } +// good +[1, 2, 3].map((x) => x * x); - // good - static methods aren't expected to use this - class Foo { - static bar() { - console.log('bar'); - } - } - ``` +// bad +[1, 2, 3].map(number => ( + `A long string with the ${number}. It’s so long that we don’t want it to take up space on the .map line!` +)); -**[⬆ back to top](#table-of-contents)** +// 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!` +)); -## Modules +// 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 (`<=`, `>=`). + + [`no-confusing-arrow`](https://eslint.org/docs/rules/no-confusing-arrow) + +```typescript +// bad +const itemHeight = (item: ItemType) => item.height <= 256 ? item.largeSize : item.smallSize; + +// bad +const itemHeight = (item: ItemType) => item.height >= 256 ? item.largeSize : item.smallSize; + +// good +const itemHeight = (item: ItemType) => (item.height <= 256 ? item.largeSize : item.smallSize); + +// good +const itemHeight = (item: ItemType) => { + 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. + + **Enforced by Prettier** + + [`implicit-arrow-linebreak`](https://eslint.org/docs/rules/implicit-arrow-linebreak) - - - [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; - ``` - -## REMOVE - - - [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'; - ``` - -## REMOVE - - - [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 }; - ``` - -## KILL IT - - - [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(); - ``` - -## RECONCILE WITH PRETTIER - - - [10.8](#modules--multiline-imports-over-newlines) Multiline imports should be indented just like multiline array and object literals. - eslint: [`object-curly-newline`](https://eslint.org/docs/rules/object-curly-newline) - - > Why? The curly braces follow the same indentation rules as every other curly brace block in the style guide, as do the trailing commas. - - ```javascript - // bad - import {longNameA, longNameB, longNameC, longNameD, longNameE} from 'path'; - - // good - import { - longNameA, - longNameB, - longNameC, - longNameD, - longNameE, - } from 'path'; - ``` - - - - [10.9](#modules--no-webpack-loader-syntax) Disallow Webpack loader syntax in module import statements. - eslint: [`import/no-webpack-loader-syntax`](https://github.com/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'; - ``` - - - - [10.10](#modules--import-extensions) Do not include JavaScript filename extensions - eslint: [`import/extensions`](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/extensions.md) - > Why? Including extensions inhibits refactoring, and inappropriately hardcodes implementation details of the module you're importing in every consumer. - - ```javascript - // bad - import foo from './foo.js'; - import bar from './bar.jsx'; - import baz from './baz/index.jsx'; - - // good - import foo from './foo'; - import bar from './bar'; - import baz from './baz'; - ``` +```typescript +// bad +(foo) => + bar; + +(foo) => + (bar); + +// good +(foo) => bar; +(foo) => (bar); +(foo) => ( + bar +) +``` **[⬆ back to top](#table-of-contents)** -## Iterators and Generators +## Classes & Constructors -## UPDATE - for-of is fine - - - [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) + +[**9.1**](#constructors--use-class) ‣ Always use `class`. Avoid manipulating `prototype` directly. + +> Why? `class` syntax is more concise and easier to reason about. + +```typescript +// 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 { + queue: T[]; + + constructor(contents: T[] = []) { + this.queue = [...contents]; + } + + pop(): T { + 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`. + +```typescript +// 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(): T { + return this.queue[0]; + } +} +``` + +--- + + +[**9.3**](#constructors--chaining) ‣ Methods can return `this` to help with method chaining. + +```typescript +// 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 { + jumping = false; + height: number; + + jump(): this { + this.jumping = true; + return this; + } + + setHeight(height: number): this { + 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. + +```typescript +class Jedi { + name: string; + + constructor(options: IJediOptions = {}) { + this.name = options.name || 'no name'; + } + + getName(): string { + return this.name; + } + + toString(): string { + 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. + + [`no-useless-constructor`](https://eslint.org/docs/rules/no-useless-constructor) + +```typescript +// bad +class Jedi { + name: string; + + 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. + + [`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. + +```typescript +// bad +class Foo { + bar() { return 1; } + bar() { return 2; } +} + +// good +class Foo { + bar() { return 1; } +} + +// good +class Foo { + bar() { return 2; } +} +``` + +--- + + +[**9.7**](#classes--methods-use-this) ‣ Class methods should use `this` or be made into a static method unless an external library or framework requires using specific non-static methods. Being an instance method should indicate that it behaves differently based on properties of the receiver. + + [`class-methods-use-this`](https://eslint.org/docs/rules/class-methods-use-this) - > Why? This enforces our immutable rule. Dealing with pure functions that return values is easier to reason about than side effects. +```typescript +// bad +class Foo { + bar() { + console.log('bar'); + } +} - > 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. +// good - this is used +class Foo { + bar() { + console.log(this.bar); + } +} + +// good - constructor is exempt +class Foo { + constructor() { + // ... + } +} - ```javascript - const numbers = [1, 2, 3, 4, 5]; +// good - static methods aren't expected to use this +class Foo { + static bar() { + console.log('bar'); + } +} +``` - // 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); - } +**[⬆ back to top](#table-of-contents)** - // good - const increasedByOne = []; - numbers.forEach((num) => { - increasedByOne.push(num + 1); - }); +## Modules - // best (keeping it functional) - const increasedByOne = numbers.map((num) => num + 1); - ``` + +[**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. -## BYE - - - [11.2](#generators--nope) Don’t use generators for now. +> Why? Modules are the future, let’s start using the future now. - > Why? They don’t transpile well to ES5. +```typescript +// bad +const AirbnbStyleGuide = require('./AirbnbStyleGuide'); +module.exports = AirbnbStyleGuide.es6; - - - [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) +// ok +import AirbnbStyleGuide from './AirbnbStyleGuide'; +export default AirbnbStyleGuide.es6; - > Why? `function` and `*` are part of the same conceptual keyword - `*` is not a modifier for `function`, `function*` is a unique construct, different from `function`. +// best +import { es6 } from './AirbnbStyleGuide'; +export default es6; +``` - ```javascript - // bad - function * foo() { - // ... - } +--- - // bad - const bar = function * () { - // ... - }; + +[**10.2**](#modules--no-duplicate-imports) ‣ Only import from a path in one place. - // bad - const baz = function *() { - // ... - }; + [`no-duplicate-imports`](https://eslint.org/docs/rules/no-duplicate-imports) - // bad - const quux = function*() { - // ... - }; +> Why? Having multiple lines that import from the same path can make code harder to maintain. - // bad - function*foo() { - // ... - } +```typescript +// bad +import foo from 'foo'; +// … some other imports … // +import { named1, named2 } from 'foo'; - // bad - function *foo() { - // ... - } +// good +import foo, { named1, named2 } from 'foo'; - // very bad - function - * - foo() { - // ... - } +// good +import foo, { + named1, + named2, +} from 'foo'; +``` - // very bad - const wat = function - * - () { - // ... - }; +--- - // good - function* foo() { - // ... - } + +[**10.3**](#modules--no-mutable-exports) ‣ Do not export mutable bindings. - // good - const foo = function* () { - // ... - }; - ``` + [`import/no-mutable-exports`](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-mutable-exports.md) -**[⬆ back to top](#table-of-contents)** +> 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. -## Properties +```typescript +// bad +let foo = 3; +export { foo }; - - - [12.1](#properties--dot) Use dot notation when accessing properties. eslint: [`dot-notation`](https://eslint.org/docs/rules/dot-notation.html) +// good +const foo = 3; +export { foo }; +``` - ```javascript - const luke = { - jedi: true, - age: 28, - }; +--- - // bad - const isJedi = luke['jedi']; + +[**10.4**](#modules--imports-first) ‣ Put all `import`s above non-import statements. - // good - const isJedi = luke.jedi; - ``` + [`import/first`](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/first.md) -## THAT'S JUST HOW IT WORKS - - - [12.2](#properties--bracket) Use bracket notation `[]` when accessing properties with a variable. +> Why? Since `import`s are hoisted, keeping them all at the top prevents surprising behavior. - ```javascript - const luke = { - jedi: true, - age: 28, - }; +```typescript +// bad +import foo from 'foo'; +foo.init(); - function getProp(prop) { - return luke[prop]; - } +import bar from 'bar'; - const isJedi = getProp('jedi'); - ``` +// good +import foo from 'foo'; +import bar from 'bar'; -## NAH - - - [12.3](#es2016-properties--exponentiation-operator) Use exponentiation operator `**` when calculating exponentiations. eslint: [`no-restricted-properties`](https://eslint.org/docs/rules/no-restricted-properties). +foo.init(); +``` - ```javascript - // bad - const binary = Math.pow(2, 10); +--- - // good - const binary = 2 ** 10; - ``` + +[**10.5**](#modules--multiline-imports-over-newlines) ‣ Multiline imports should be indented just like multiline array and object literals. -**[⬆ back to top](#table-of-contents)** + **Enforced by Prettier** -## Variables + [`object-curly-newline`](https://eslint.org/docs/rules/object-curly-newline) - - - [13.1](#variables--const) Always use `const` or `let` to declare variables. Not doing so will result in global variables. We want to avoid polluting the global namespace. Captain Planet warned us of that. eslint: [`no-undef`](https://eslint.org/docs/rules/no-undef) [`prefer-const`](https://eslint.org/docs/rules/prefer-const) - - ```javascript - // bad - superPower = new SuperPower(); - - // good - const superPower = new SuperPower(); - ``` - - - - [13.2](#variables--one-const) Use one `const` or `let` declaration per variable or assignment. eslint: [`one-var`](https://eslint.org/docs/rules/one-var.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 previously assigned variables. - - ```javascript - // bad - let i, len, dragonball, - items = getItems(), - goSportsTeam = true; - - // bad - let i; - const items = getItems(); - let dragonball; - const goSportsTeam = true; - let len; - - // good - const goSportsTeam = true; - const items = getItems(); - let dragonball; - let i; - let length; - ``` - - - - [13.4](#variables--define-where-used) Assign variables where you need them, but place them in a reasonable place. - - > Why? `let` and `const` are block scoped and not function scoped. - - ```javascript - // bad - unnecessary function call - function checkName(hasName) { - const name = getName(); - - if (hasName === 'test') { - return false; - } - - if (name === 'test') { - this.setName(''); - return false; - } - - return name; - } +> Why? The curly braces follow the same indentation rules as every other curly brace block in the style guide, as do the trailing commas. - // good - function checkName(hasName) { - if (hasName === 'test') { - return false; - } +```typescript +// bad +import { longNameA, longNameB, longNameC, + longNameD, longNameE, longNameF } from 'path'; - const name = getName(); +// good +import { + longNameA, + longNameB, + longNameC, + longNameD, + longNameE, +} from 'path'; +``` - 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++; - } - } + +[**10.6**](#modules--no-webpack-loader-syntax) ‣ Disallow Webpack loader syntax in module import statements. - // good + [`import/no-webpack-loader-syntax`](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-webpack-loader-syntax.md) - const array = [1, 2, 3]; - let num = 1; - num += 1; - num -= 1; +> Why? Since using Webpack syntax in the imports couples the code to a module bundler. Prefer using the loader syntax in `webpack.config.js`. - const sum = array.reduce((a, b) => a + b, 0); - const truthyCount = array.filter(Boolean).length; - ``` +```typescript +// bad +import fooSass from 'css!sass!foo.scss'; +import barCss from 'style!css!bar.css'; - - - [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). +// good +import fooSass from 'foo.scss'; +import barCss from 'bar.css'; +``` - > Why? Linebreaks surrounding `=` can obfuscate the value of an assignment. +--- - ```javascript - // bad - const foo = - superLongLongLongLongLongLongLongLongFunctionName(); + +[**10.7**](#modules--import-extensions) ‣ Do not include JavaScript filename extensions - // bad - const foo - = 'superLongLongLongLongLongLongLongLongString'; + [`import/extensions`](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/extensions.md) - // good - const foo = ( - superLongLongLongLongLongLongLongLongFunctionName() - ); + > Why? Including extensions inhibits refactoring, and inappropriately hardcodes implementation details of the module you're importing in every consumer. - // good - const foo = 'superLongLongLongLongLongLongLongLongString'; - ``` + ```typescript + // bad + import foo from './foo.js'; + import bar from './bar.jsx'; + import baz from './baz/index.jsx'; - - - [13.8](#variables--no-unused-vars) Disallow unused variables. eslint: [`no-unused-vars`](https://eslint.org/docs/rules/no-unused-vars) + // good + import foo from './foo'; + import bar from './bar'; + import baz from './baz'; + ``` - > 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. +**[⬆ back to top](#table-of-contents)** - ```javascript - // bad +## Iterators and Generators - var some_unused_var = 42; + +[**11.1**](#iterators--prefer-functional) ‣ Prefer JavaScript’s higher-order functions instead of `for`/`for-of` loops, particularly when iterating to build up a value. - // Write-only variables are not considered as used. - var y = 10; - y = 5; +> Why? This enforces our immutable rule. Dealing with pure functions that return values is easier to reason about than side effects. - // A read for a modification of itself is not considered as used. - var z = 0; - z = z + 1; +> Sometimes you genuinely will need to mutate or do something side-effecty in a loop, and in that case `for-of` or a traditional `for` loop are acceptable. But avoid this whenerever possible. - // Unused function arguments. - function getX(x, y) { - return x; - } +> 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. - // good +```typescript +const numbers = [1, 2, 3, 4, 5]; - function getXPlusY(x, y) { - return x + y; - } +// bad +let sum = 0; +for (let num of numbers) { + sum += num; +} +sum === 15; + +// bad +let sum = 0; +numbers.forEach((num) => { + sum += num; +}); +sum === 15; + +// good +const sum = numbers.reduce((total, num) => total + num, 0); +sum === 15; - var x = 1; - var y = a + 2; +// bad +const increasedByOne = []; +for (let i = 0; i < numbers.length; i++) { + increasedByOne.push(numbers[i] + 1); +} + +// bad +const increasedByOne = []; +numbers.forEach((num) => { + increasedByOne.push(num + 1); +}); - alert(getXPlusY(x, y)); +// good +const increasedByOne = numbers.map((num) => num + 1); +``` + +--- + + +[**11.2**](#iterators--no-for-in) ‣ Do not use `for-in`. + + [`no-restricted-syntax`](https://eslint.org/docs/rules/no-restricted-syntax) + +> Why? `for-in` has confusing and unexpected behavior. For this reason, `for-of` was added to the language and should be used instead. + +```typescript +const obj = { a: 'foo', b: 'bar' }; + +// bad +for (const key in obj) { + console.log(key, obj[key]); +} + +// avoids the inherited properties issue, but still bad +for (const key in obj) { + if (obj.hasOwnProperty(key)) { + console.log(key, obj[key]); + } +} + +// good +for (const key of Object.keys(obj)) { + console.log(key, obj[key]); +} + +// best, if you're working on both the keys and values +for (const [key, value] of Object.entries(obj)) { + console.log(key, value); +} +``` + +--- + + +[**11.3**](#generators--spacing) ‣ A generator's function signature should be spaced with `function*` as a single unit surrounded by spaces. + + **Enforced by Prettier** + + [`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`. + +```typescript +// 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() { + // ... +} - // '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. - ``` +// good +const foo = function* () { + // ... +}; +``` **[⬆ back to top](#table-of-contents)** -## Hoisting +## Properties - - - [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](https://web.archive.org/web/20200121061528/http://es-discourse.com/t/why-typeof-is-no-longer-safe/15). + +[**12.1**](#properties--dot) ‣ Use dot notation when accessing properties. - ```javascript - // we know this wouldn’t work (assuming there - // is no notDefined global variable) - function example() { - console.log(notDefined); // => throws a ReferenceError - } + [`dot-notation`](https://eslint.org/docs/rules/dot-notation.html) - // 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; - } +```typescript +const luke = { + jedi: true, + age: 28, +}; - // 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; - } +// bad +const isJedi = luke['jedi']; - // using const and let - function example() { - console.log(declaredButNotAssigned); // => throws a ReferenceError - console.log(typeof declaredButNotAssigned); // => throws a ReferenceError - const declaredButNotAssigned = true; - } - ``` +// good +const isJedi = luke.jedi; +``` - - - [14.2](#hoisting--anon-expressions) Anonymous function expressions hoist their variable name, but not the function assignment. - ```javascript - function example() { - console.log(anonymous); // => undefined +**[⬆ back to top](#table-of-contents)** - anonymous(); // => TypeError anonymous is not a function +## Variables - var anonymous = function () { - console.log('anonymous function expression'); - }; - } - ``` + +[**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. - - - [14.3](#hoisting--named-expressions) Named function expressions hoist the variable name, not the function name or the function body. + [`no-undef`](https://eslint.org/docs/rules/no-undef), [`prefer-const`](https://eslint.org/docs/rules/prefer-const) - ```javascript - function example() { - console.log(named); // => undefined +```typescript +// bad +superPower = new SuperPower(); - named(); // => TypeError named is not a function +// good +const superPower = new SuperPower(); +``` - superPower(); // => ReferenceError superPower is not defined +--- - var named = function superPower() { - console.log('Flying'); - }; - } + +[**13.2**](#variables--one-const) ‣ Use one `const` or `let` declaration per variable or assignment. - // the same is true when the function name - // is the same as the variable name. - function example() { - console.log(named); // => undefined + [`one-var`](https://eslint.org/docs/rules/one-var.html) - named(); // => TypeError named is not a function +> 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. - var named = function named() { - console.log('named'); - }; - } - ``` +```typescript +// bad +const items = getItems(), + goSportsTeam = true, + dragonball = 'z'; - - - [14.4](#hoisting--declarations) Function declarations hoist their name and the function body. +// bad +// (compare to above, and try to spot the mistake) +const items = getItems(), + goSportsTeam = true; + dragonball = 'z'; - ```javascript - function example() { - superPower(); // => Flying +// good +const items = getItems(); +const goSportsTeam = true; +const dragonball = 'z'; +``` - 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/). + +[**13.3**](#variables--const-let-group) ‣ Group all your `const`s and then group all your `let`s. -**[⬆ back to top](#table-of-contents)** +> Why? This is helpful when later on you might need to assign a variable depending on one of the previously assigned variables. -## Comparison Operators & Equality +```typescript +// bad +let i, len, dragonball, + items = getItems(), + goSportsTeam = true; - - - [15.1](#comparison--eqeqeq) Use `===` and `!==` over `==` and `!=`. eslint: [`eqeqeq`](https://eslint.org/docs/rules/eqeqeq.html) +// bad +let i: number; +const items = getItems(); +let dragonball: Dragonball; +const goSportsTeam = true; +let len: number; - - - [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: +// good +const goSportsTeam = true; +const items = getItems(); +let dragonball: Dragonball; +let i: number; +let length: number; +``` - - **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 - } - ``` + +[**13.4**](#variables--define-where-used) ‣ Assign variables where you need them, but place them in a reasonable place. - - - [15.3](#comparison--shortcuts) Use shortcuts for booleans, but explicit comparisons for strings and numbers. +> Why? `let` and `const` are block scoped and not function scoped. - ```javascript - // bad - if (isValid === true) { - // ... - } +```typescript +// bad - unnecessary function call +function checkName(hasName) { + const name = getName(); - // good - if (isValid) { - // ... - } + if (hasName === 'test') { + return false; + } - // bad - if (name) { - // ... - } + if (name === 'test') { + this.setName(''); + return false; + } - // good - if (name !== '') { - // ... - } + return name; +} - // bad - if (collection.length) { - // ... - } +// good +function checkName(hasName) { + if (hasName === 'test') { + return false; + } - // 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. - -## JUST BE CONSISTENT - - - [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 {} - } + const name = getName(); - // 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 {} - } - } - ``` + if (name === 'test') { + this.setName(''); + return false; + } - - - [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) + return name; +} +``` - ```javascript - // bad - const foo = maybe1 > maybe2 - ? "bar" - : value1 > value2 ? "baz" : null; + +[**13.5**](#variables--no-chain-assignment) ‣ Don’t chain variable assignments. - // split into 2 separated ternary expressions - const maybeNull = value1 > value2 ? 'baz' : null; + [`no-multi-assign`](https://eslint.org/docs/rules/no-multi-assign) - // better - const foo = maybe1 > maybe2 - ? 'bar' - : maybeNull; +> Why? Chaining variable assignments creates implicit global variables. - // best - const foo = maybe1 > maybe2 ? 'bar' : maybeNull; - ``` +```typescript +// 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; +}()); - - - [15.7](#comparison--unneeded-ternary) Avoid unneeded ternary statements. eslint: [`no-unneeded-ternary`](https://eslint.org/docs/rules/no-unneeded-ternary.html) +console.log(a); // throws ReferenceError +console.log(b); // 1 +console.log(c); // 1 - ```javascript - // bad - const foo = a ? a : b; - const bar = c ? true : false; - const baz = c ? false : true; +// good +(function example() { + let a = 1; + let b = a; + let c = a; +}()); - // good - const foo = a || b; - const bar = !!c; - const baz = !c; - ``` +console.log(a); // throws ReferenceError +console.log(b); // throws ReferenceError +console.log(c); // throws ReferenceError - - - [15.8](#comparison--no-mixed-operators) When mixing operators, enclose them in parentheses. The only exception is the standard arithmetic operators: `+`, `-`, and `**` since their precedence is broadly understood. We recommend enclosing `/` and `*` in parentheses because their precedence can be ambiguous when they are mixed. - eslint: [`no-mixed-operators`](https://eslint.org/docs/rules/no-mixed-operators.html) +// the same applies for `const` +``` - > Why? This improves readability and clarifies the developer’s intention. +--- - ```javascript - // bad - const foo = a && b < 0 || c > 0 || d + 1 === 0; + +[**13.6**](#variables--unary-increment-decrement) ‣ Avoid using unary increments and decrements (`++`, `--`). + + [`no-plusplus`](https://eslint.org/docs/rules/no-plusplus) - // bad - const bar = a ** b - 5 % d; +> 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. - // bad - // one may be confused into thinking (a || b) && c - if (a || b && c) { - return d; - } +```typescript +// bad - // bad - const bar = a + b / c * d; +const array = [1, 2, 3]; +let num = 1; +num++; +--num; - // good - const foo = (a && b < 0) || c > 0 || (d + 1 === 0); +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 bar = a ** b - (5 % d); +// good - // good - if (a || (b && c)) { - return d; - } +const array = [1, 2, 3]; +let num = 1; +num += 1; +num -= 1; - // good - const bar = a + (b / c) * d; - ``` +const sum = array.reduce((a, b) => a + b, 0); +const truthyCount = array.filter(Boolean).length; +``` -**[⬆ back to top](#table-of-contents)** +--- -## Blocks + +[**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. -## Prettier does this - - - [16.1](#blocks--braces) Use braces with all multiline blocks. eslint: [`nonblock-statement-body-position`](https://eslint.org/docs/rules/nonblock-statement-body-position) + **Enforced by Prettier** - ```javascript - // bad - if (test) - return false; + [`operator-linebreak`](https://eslint.org/docs/rules/operator-linebreak.html) - // good - if (test) return false; +> Why? Linebreaks surrounding `=` can obfuscate the value of an assignment. - // good - if (test) { - return false; - } +```typescript +// bad +const foo = + superLongLongLongLongLongLongLongLongFunctionName(); - // bad - function foo() { return false; } +// bad +const foo + = 'superLongLongLongLongLongLongLongLongString'; - // good - function bar() { - return false; - } - ``` +// good +const foo = ( + superLongLongLongLongLongLongLongLongFunctionName() +); - - - [16.2](#blocks--cuddled-elses) If you’re using multiline blocks with `if` and `else`, put `else` on the same line as your `if` block’s closing brace. eslint: [`brace-style`](https://eslint.org/docs/rules/brace-style.html) +// good +const foo = 'superLongLongLongLongLongLongLongLongString'; +``` - ```javascript - // bad - if (test) { - thing1(); - thing2(); - } - else { - thing3(); - } +--- - // good - if (test) { - thing1(); - thing2(); - } else { - thing3(); - } - ``` - -## DISAGREEMENT - - - [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; - } - } + +[**13.8**](#variables--no-unused-vars) ‣ Disallow unused variables. - // bad - function cats() { - if (x) { - return x; - } else if (y) { - return y; - } - } + [`no-unused-vars`](https://eslint.org/docs/rules/no-unused-vars) - // bad - function dogs() { - if (x) { - return x; - } else { - if (y) { - return y; - } - } - } +> 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. - // good - function foo() { - if (x) { - return x; - } +```typescript +// bad +const some_unused_var = 42; - return y; - } +// Write-only variables are not considered as used. +let y = 10; +y = 5; - // good - function cats() { - if (x) { - return x; - } +// A read for a modification of itself is not considered as used. +let z = 0; +z = z + 1; - if (y) { - return y; - } - } +// Unused function arguments. +function getX(x: number, y: number): number { + return x; +} - // good - function dogs(x) { - if (x) { - if (z) { - return y; - } - } else { - return z; - } - } - ``` +// good +function getXPlusY(x: number, y: number): number { + return x + y; +} + +const x = 1; +const 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. +const { type, ...coords } = data; +// 'coords' is now the 'data' object without its 'type' property. +``` **[⬆ 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. +## Comparison Operators & Equality - > 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. + +[**14.1**](#comparison--eqeqeq) ‣ Use `===` and `!==` over `==` and `!=`. - ```javascript - // bad - if ((foo === 123 || bar === 'abc') && doesItLookGoodWhenItBecomesThatLong() && isThisReallyHappening()) { - thing1(); - } + [`eqeqeq`](https://eslint.org/docs/rules/eqeqeq.html) - // bad - if (foo === 123 && - bar === 'abc') { - thing1(); - } +--- - // bad - if (foo === 123 - && bar === 'abc') { - thing1(); - } + +[**14.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: - // bad - if ( - foo === 123 && - bar === 'abc' - ) { - thing1(); - } +- **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** - // good - if ( - foo === 123 - && bar === 'abc' - ) { - thing1(); - } +```typescript +if ([0] && []) { + // true + // an array (even an empty one) is an object, objects will evaluate to true +} +``` - // good - if ( - (foo === 123 || bar === 'abc') - && doesItLookGoodWhenItBecomesThatLong() - && isThisReallyHappening() - ) { - thing1(); - } +--- - // good - if (foo === 123 && bar === 'abc') { - thing1(); - } - ``` + +[**14.3**](#comparison--shortcuts) ‣ Use shortcuts for booleans, but explicit comparisons for strings and numbers. - - - [17.2](#control-statements--value-selection) Don't use selection operators in place of control statements. +```typescript +// bad +if (isValid === true) { + // ... +} - ```javascript - // bad - !isRunning && startRunning(); +// good +if (isValid) { + // ... +} - // good - if (!isRunning) { - startRunning(); - } - ``` +// bad +if (name) { + // ... +} -**[⬆ back to top](#table-of-contents)** +// good +if (name !== '') { + // ... +} -## Comments +// bad +if (collection.length) { + // ... +} - - - [18.1](#comments--multiline) Use `/** ... */` for multiline comments. +// good +if (collection.length > 0) { + // ... +} +``` - ```javascript - // bad - // make() returns a new element - // based on the passed in tag name - // - // @param {String} tag - // @return {Element} element - function make(tag) { +--- - // ... + +[**14.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. - return element; - } +--- - // good - /** - * make() returns a new element - * based on the passed-in tag name - */ - function make(tag) { + +[**14.5**](#comparison--switch-blocks) ‣ In switch statements, use braces to create blocks for all `case` and `default` clauses, or none of them. Be consistent. - // ... +```typescript +// bad +switch (foo) { + case 1: + // ... + break; + case 2: { + // ... + break; + } + case 3: + // ... + break; + default: { + // ... + } +} - return element; - } - ``` +// good +switch (foo) { + case 1: + // ... + break; + case 2: + // ... + break; + case 3: + // ... + break; + default: + // ... +} - - - [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. +// good +switch (foo) { + case 1: { + // ... + break; + } + case 2: { + // ... + break; + } + case 3: { + // ... + break; + } + default: { + // ... + } +} +``` - ```javascript - // bad - const active = true; // is current tab +--- - // good - // is current tab - const active = true; + +[**14.6**](#comparison--nested-ternaries) ‣ Ternaries should not be nested and generally be single line expressions. - // bad - function getType() { - console.log('fetching type...'); - // set the default type to 'no type' - const type = this.type || 'no type'; + [`no-nested-ternary`](https://eslint.org/docs/rules/no-nested-ternary.html) - return type; - } +```typescript +// bad +const foo = maybe1 > maybe2 + ? "bar" + : value1 > value2 ? "baz" : null; - // good - function getType() { - console.log('fetching type...'); +// split into 2 separated ternary expressions +const maybeNull = value1 > value2 ? 'baz' : null; - // set the default type to 'no type' - const type = this.type || 'no type'; +// better +const foo = maybe1 > maybe2 + ? 'bar' + : maybeNull; - return type; - } +// best +const foo = maybe1 > maybe2 ? 'bar' : maybeNull; +``` - // also good - function getType() { - // set the default type to 'no type' - const type = this.type || 'no type'; +--- - return type; - } - ``` + +[**14.7**](#comparison--unneeded-ternary) ‣ Avoid unneeded ternary statements. - - - [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) + [`no-unneeded-ternary`](https://eslint.org/docs/rules/no-unneeded-ternary.html) - ```javascript - // bad - //is current tab - const active = true; +```typescript +// bad +const foo = a ? a : b; +const bar = c ? true : false; +const baz = c ? false : true; - // good - // is current tab - const active = true; +// good +const foo = a || b; +const bar = !!c; +const baz = !c; +``` - // bad - /** - *make() returns a new element - *based on the passed-in tag name - */ - function make(tag) { +--- - // ... + +[**14.8**](#comparison--no-mixed-operators) ‣ When mixing operators, enclose them in parentheses. The only exception is the standard arithmetic operators: `+`, `-`, and `**` since their precedence is broadly understood. We recommend enclosing `/` and `*` in parentheses because their precedence can be ambiguous when they are mixed. - return element; - } + [`no-mixed-operators`](https://eslint.org/docs/rules/no-mixed-operators.html) - // good - /** - * make() returns a new element - * based on the passed-in tag name - */ - function make(tag) { +> Why? This improves readability and clarifies the developer’s intention. - // ... +```typescript +// bad +const foo = a && b < 0 || c > 0 || d + 1 === 0; - return element; - } - ``` +// bad +const bar = a ** b - 5 % d; - - - [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`. +// bad +// one may be confused into thinking (a || b) && c +if (a || b && c) { + return d; +} - - - [18.5](#comments--fixme) Use `// FIXME:` to annotate problems. +// bad +const bar = a + b / c * d; - ```javascript - class Calculator extends Abacus { - constructor() { - super(); +// good +const foo = (a && b < 0) || c > 0 || (d + 1 === 0); - // FIXME: shouldn’t use a global here - total = 0; - } - } - ``` +// good +const bar = a ** b - (5 % d); - - - [18.6](#comments--todo) Use `// TODO:` to annotate solutions to problems. +// good +if (a || (b && c)) { + return d; +} - ```javascript - class Calculator extends Abacus { - constructor() { - super(); +// good +const bar = a + (b / c) * d; +``` - // TODO: total should be configurable by an options param - this.total = 0; - } +**[⬆ back to top](#table-of-contents)** + +## Blocks + + +[**15.1**](#blocks--cuddled-elses) ‣ If you’re using multiline blocks with `if` and `else`, put `else` on the same line as your `if` block’s closing brace. + + **Enforced by Prettier** + + [`brace-style`](https://eslint.org/docs/rules/brace-style.html) + +```typescript +// bad +if (test) { + thing1(); + thing2(); +} +else { + thing3(); +} + +// good +if (test) { + thing1(); + thing2(); +} else { + thing3(); +} +``` + +--- + +**TODO:** Further discussion required + + +[**15.2**](#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. + + [`no-else-return`](https://eslint.org/docs/rules/no-else-return) + +```typescript +// 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)** -## Whitespace +## Control Statements - - - [19.1](#whitespace--spaces) Use soft tabs (space character) set to 2 spaces. eslint: [`indent`](https://eslint.org/docs/rules/indent.html) + +[**16.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. + + **Enforced by Prettier** + +> Why? This improves readability by making it easier to visually follow complex logic. + +```typescript +// bad +if ((foo === 123 || bar === 'abc') && doesItLookGoodWhenItBecomesThatLong() && isThisReallyHappening()) { + thing1(); +} + +// bad +if ((foo === 123 || bar === 'abc') && + doesItLookGoodWhenItBecomesThatLong() && + isThisReallyHappening()) { + thing1(); +} + +// good +if ( + (foo === 123 || bar === 'abc') && + doesItLookGoodWhenItBecomesThatLong() && + isThisReallyHappening() +) { + thing1(); +} + +// good +if ( + (foo === 123 || + bar === 'abc' || + someOtherReallyLongFunctionName()) && + doesItLookGoodWhenItBecomesThatLong() && + isThisReallyHappening() +) { + thing1(); +} + +// good +if (foo === 123 && bar === 'abc') { + thing1(); +} +``` + +--- + + +[**16.2**](#control-statements--value-selection) ‣ Don't use selection operators in place of control statements. + +```typescript +// bad +!isRunning && startRunning(); + +// good +if (!isRunning) { + startRunning(); +} +``` - ```javascript - // bad - function foo() { - ∙∙∙∙let name; - } +**[⬆ back to top](#table-of-contents)** - // bad - function bar() { - ∙let name; - } +## Comments - // good - function baz() { - ∙∙let name; - } - ``` + +[**17.1**](#comments--multiline) ‣ Use `/** ... */` for multiline comments. - - - [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) +```typescript +// bad +// make() returns a new element +// based on the passed in tag name +function make(tag: string): Element { - ```javascript - // bad - function test(){ - console.log('test'); - } + // ... - // good - function test() { - console.log('test'); - } + return element; +} - // 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 +/** + * make() returns a new element + * based on the passed-in tag name + */ +function make(tag: string): Element { - // good - if (isJedi) { - fight(); - } + // ... - // bad - function fight () { - console.log ('Swooosh!'); - } + return element; +} +``` - // 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); - const svg = leds.enter().append('svg:svg'); - svg.classed('led', true).attr('width', (radius + margin) * 2); - const g = svg.append('svg:g'); - g.attr('transform', `translate(${radius + margin},${radius + margin})`).call(tron.led); - ``` - - - - [19.7](#whitespace--after-blocks) Leave a blank line after blocks and before the next statement. - - ```javascript - // bad - if (foo) { - return bar; - } - return baz; +--- - // good - if (foo) { - return bar; - } + +[**17.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. - return baz; +```typescript +// bad +const active = true; // is current tab - // bad - const obj = { - foo() { - }, - bar() { - }, - }; - return obj; +// good +// is current tab +const active = true; - // good - const obj = { - foo() { - }, +// bad +function getType() { + console.log('fetching type...'); + // set the default type to 'no type' + const type = this.type || 'no type'; - bar() { - }, - }; + return type; +} - return obj; +// good +function getType() { + console.log('fetching type...'); - // bad - const arr = [ - function foo() { - }, - function bar() { - }, - ]; - return arr; + // set the default type to 'no type' + const type = this.type || 'no type'; - // good - const arr = [ - function foo() { - }, + return type; +} - function bar() { - }, - ]; +// also good +function getType() { + // set the default type to 'no type' + const type = this.type || 'no type'; - return arr; - ``` + return type; +} +``` - - - [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() { + +[**17.3**](#comments--spaces) ‣ Start all comments with a space to make it easier to read. - console.log(foo); + [`spaced-comment`](https://eslint.org/docs/rules/spaced-comment) - } +```typescript +// bad +//is current tab +const active = true; - // bad - if (baz) { +// good +// is current tab +const active = true; - console.log(qux); - } else { - console.log(foo); +// bad +/** + *make() returns a new element + *based on the passed-in tag name + */ +function make(tag: string): Element { - } + // ... - // bad - class Foo { + return element; +} - constructor(bar) { - this.bar = bar; - } - } +// good +/** + * make() returns a new element + * based on the passed-in tag name + */ +function make(tag: string): Element { - // good - function bar() { - console.log(foo); - } + // ... - // good - if (baz) { - console.log(qux); - } else { - console.log(foo); - } - ``` + return element; +} +``` - - - [19.9](#whitespace--no-multiple-blanks) Do not use multiple blank lines to pad your code. eslint: [`no-multiple-empty-lines`](https://eslint.org/docs/rules/no-multiple-empty-lines) +--- - - ```javascript - // bad - class Person { - constructor(fullName, email, birthday) { - this.fullName = fullName; + +[**17.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`. +```typescript +class Calculator extends Abacus { + constructor() { + super(); - this.email = email; + // FIXME: shouldn’t use a global here + total = 0; + } +} +``` +```typescript +class Calculator extends Abacus { + constructor() { + super(); - this.setAge(birthday); - } + // TODO: total should be configurable by an options param + this.total = 0; + } +} +``` +**[⬆ back to top](#table-of-contents)** - setAge(birthday) { - const today = new Date(); +## Whitespace + +[**18.1**](#whitespace--spaces) ‣ Use soft tabs (space character) set to 2 spaces. - const age = this.getAge(today, birthday); + **Enforced by Prettier** + [`indent`](https://eslint.org/docs/rules/indent.html) - this.age = age; - } +```typescript +// bad +function foo() { +∙∙∙∙let name; +} +// bad +function bar() { +∙let name; +} - getAge(today, birthday) { - // .. - } - } +// good +function baz() { +∙∙let name; +} +``` - // good - class Person { - constructor(fullName, email, birthday) { - this.fullName = fullName; - this.email = email; - this.setAge(birthday); - } - - setAge(birthday) { - const today = new Date(); - const age = getAge(today, birthday); - this.age = age; - } - - getAge(today, birthday) { - // .. - } - } - ``` +--- - - - [19.10](#whitespace--in-parens) Do not add spaces inside parentheses. eslint: [`space-in-parens`](https://eslint.org/docs/rules/space-in-parens.html) + +[**18.2**](#whitespace--before-blocks) ‣ Place 1 space before the leading brace. - ```javascript - // bad - function bar( foo ) { - return foo; - } + **Enforced by Prettier** - // good - function bar(foo) { - return foo; - } + [`space-before-blocks`](https://eslint.org/docs/rules/space-before-blocks.html) - // bad - if ( foo ) { - console.log(foo); - } +```typescript +// bad +function test(){ + console.log('test'); +} - // good - if (foo) { - console.log(foo); - } - ``` - - - - [19.11](#whitespace--in-brackets) Do not add spaces inside brackets. eslint: [`array-bracket-spacing`](https://eslint.org/docs/rules/array-bracket-spacing.html) - - ```javascript - // bad - const foo = [ 1, 2, 3 ]; - console.log(foo[ 0 ]); - - // good - const foo = [1, 2, 3]; - console.log(foo[0]); - ``` - - - - [19.12](#whitespace--in-braces) Add spaces inside curly braces. eslint: [`object-curly-spacing`](https://eslint.org/docs/rules/object-curly-spacing.html) - - ```javascript - // bad - const foo = {clark: 'kent'}; - - // good - const foo = { clark: 'kent' }; - ``` - - - - [19.13](#whitespace--max-len) Avoid having lines of code that are longer than 100 characters (including whitespace). Note: per [above](#strings--line-length), long strings are exempt from this rule, and should not be broken up. eslint: [`max-len`](https://eslint.org/docs/rules/max-len.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 +function test() { + console.log('test'); +} - // good - $.ajax({ - method: 'POST', - url: 'https://airbnb.com/', - data: { name: 'John' }, - }) - .done(() => console.log('Congratulations!')) - .fail(() => console.log('You have failed this city.')); - ``` +// bad +dog.set('attr',{ + age: '1 year', + breed: 'Bernese Mountain Dog', +}); -## CAN'T DO THIS ANYWAY - - - [19.14](#whitespace--block-spacing) Require consistent spacing inside an open block token and the next token on the same line. This rule also enforces consistent spacing inside a close block token and previous token on the same line. eslint: [`block-spacing`](https://eslint.org/docs/rules/block-spacing) +// good +dog.set('attr', { + age: '1 year', + breed: 'Bernese Mountain Dog', +}); +``` - ```javascript - // bad - function foo() {return true;} - if (foo) { bar = 0;} +--- - // good - function foo() { return true; } - if (foo) { bar = 0; } - ``` + +[**18.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. - - - [19.15](#whitespace--comma-spacing) Avoid spaces before commas and require a space after commas. eslint: [`comma-spacing`](https://eslint.org/docs/rules/comma-spacing) + **Enforced by Prettier** - ```javascript - // bad - var foo = 1,bar = 2; - var arr = [1 , 2]; + [`keyword-spacing`](https://eslint.org/docs/rules/keyword-spacing.html) - // good - var foo = 1, bar = 2; - var arr = [1, 2]; - ``` +```typescript +// bad +if(isJedi) { + fight (); +} - - - [19.16](#whitespace--computed-property-spacing) Enforce spacing inside of computed property brackets. eslint: [`computed-property-spacing`](https://eslint.org/docs/rules/computed-property-spacing) +// good +if (isJedi) { + fight(); +} - ```javascript - // bad - obj[foo ] - obj[ 'foo'] - var x = {[ b ]: a} - obj[foo[ bar ]] +// bad +function fight () { + console.log ('Swooosh!'); +} - // good - obj[foo] - obj['foo'] - var x = { [b]: a } - obj[foo[bar]] - ``` +// good +function fight() { + console.log('Swooosh!'); +} +``` - - - [19.17](#whitespace--func-call-spacing) Avoid spaces between functions and their invocations. eslint: [`func-call-spacing`](https://eslint.org/docs/rules/func-call-spacing) +--- - ```javascript - // bad - func (); + +[**18.4**](#whitespace--infix-ops) ‣ Set off operators with spaces. - func - (); + **Enforced by Prettier** + + [`space-infix-ops`](https://eslint.org/docs/rules/space-infix-ops.html) + +```typescript +// bad +const x=y+5; + +// good +const x = y + 5; +``` + +--- + + +[**18.5**](#whitespace--newline-at-end) ‣ End files with a single newline character. + + **Enforced by Prettier** + + [`eol-last`](https://github.com/eslint/eslint/blob/master/docs/rules/eol-last.md) + +```typescript +// bad +import { es6 } from './AirbnbStyleGuide'; + // ... +export default es6; +``` + +```typescript +// bad +import { es6 } from './AirbnbStyleGuide'; + // ... +export default es6;↵ +↵ +``` + +```typescript +// good +import { es6 } from './AirbnbStyleGuide'; + // ... +export default es6;↵ +``` + +--- + + +[**18.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. + + **Enforced by Prettier** - // good - func(); - ``` + [`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) - - - [19.18](#whitespace--key-spacing) Enforce spacing between keys and values in object literal properties. eslint: [`key-spacing`](https://eslint.org/docs/rules/key-spacing) +```typescript +// bad +const foo = bar.qwer('.baz').tyui(data).op().asdf('beep').ghjkl('baz', true) + .zxc('substance', (ecto + plasm) * 2).asdf('green'). + zxc('try', `contain(${ecto + plasm}, ${ecto + plasm})`) + .call(tron.baz); - ```javascript - // bad - var obj = { foo : 42 }; - var obj2 = { foo:42 }; +// good +const foo = bar + .qwer('.baz') + .tyui(data) + .op() + .asdf('beep') + .ghjkl('baz', true) + .zxc('substance', (ecto + plasm) * 2) + .asdf('green') + .zxc('try', `contain(${ecto + plasm}, ${ecto + plasm})`) + .call(tron.baz); +``` - // good - var obj = { foo: 42 }; - ``` +--- + + +[**18.7**](#whitespace--after-blocks) ‣ Leave a blank line after blocks and before the next statement. + +```typescript +// bad +if (foo) { + return bar; +} +return baz; - - - [19.19](#whitespace--no-trailing-spaces) Avoid trailing spaces at the end of lines. eslint: [`no-trailing-spaces`](https://eslint.org/docs/rules/no-trailing-spaces) +// good +if (foo) { + return bar; +} - - - [19.20](#whitespace--no-multiple-empty-lines) Avoid multiple empty lines, only allow one newline at the end of files, and avoid a newline at the beginning of files. eslint: [`no-multiple-empty-lines`](https://eslint.org/docs/rules/no-multiple-empty-lines) +return baz; - - ```javascript - // bad - multiple empty lines - var x = 1; +// bad +const obj = { + foo() { + }, + bar() { + }, +}; +return obj; +// good +const obj = { + foo() { + }, - var y = 2; + bar() { + }, +}; - // bad - 2+ newlines at end of file - var x = 1; - var y = 2; +return obj; +// bad +const arr = [ + function foo() { + }, + function bar() { + }, +]; +return arr; - // bad - 1+ newline(s) at beginning of file +// good +const arr = [ + function foo() { + }, - var x = 1; - var y = 2; + function bar() { + }, +]; - // good - var x = 1; - var y = 2; +return arr; +``` - ``` - +--- -**[⬆ back to top](#table-of-contents)** + +[**18.8**](#whitespace--padded-blocks) ‣ Do not pad your blocks with blank lines. -## Commas + **Enforced by Prettier** - - - [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 - } + [`padded-blocks`](https://eslint.org/docs/rules/padded-blocks.html) - // good - function createHero( - firstName, - lastName, - inventorOf, - ) { - // does nothing - } +```typescript +// bad +function bar() { - // good (note that a comma must not appear after a "rest" element) - function createHero( - firstName, - lastName, - inventorOf, - ...heroArgs - ) { - // does nothing - } + console.log(foo); - // 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)** +// bad +if (baz) { -## Semicolons + console.log(qux); +} else { + console.log(foo); - - - [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 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. +// bad +class Foo { + bar: Bar; - ```javascript - // bad - raises exception - const luke = {} - const leia = {} - [luke, leia].forEach((jedi) => jedi.father = 'vader') + constructor(bar: Bar) { + this.bar = bar; + } +} - // bad - raises exception - const reaction = "No! That’s impossible!" - (async function meanwhileOnTheFalcon() { - // handle `leia`, `lando`, `chewie`, `r2`, `c3p0` - // ... - }()) +// good +function bar() { + console.log(foo); +} - // 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 +if (baz) { + console.log(qux); +} else { + console.log(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). + +[**18.9**](#whitespace--no-multiple-blanks) ‣ Do not use multiple blank lines to pad your code. -**[⬆ back to top](#table-of-contents)** + **Enforced by Prettier** -## Type Casting & Coercion + [`no-multiple-empty-lines`](https://eslint.org/docs/rules/no-multiple-empty-lines) - - - [22.1](#coercion--explicit) Perform type coercion at the beginning of the statement. +```typescript +// bad +class Person { + fullName: string; + email: string; + birthday: Date; + age: number; - - - [22.2](#coercion--strings) Strings: eslint: [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers) + constructor(fullName: string, email: string, birthday: Date) { + this.fullName = fullName; - ```javascript - // => this.reviewScore = 9; - // bad - const totalScore = new String(this.reviewScore); // typeof totalScore is "object" not "string" + this.email = email; - // bad - const totalScore = this.reviewScore + ''; // invokes this.reviewScore.valueOf() - // bad - const totalScore = this.reviewScore.toString(); // isn’t guaranteed to return a string + this.setAge(birthday); + } - // 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) + setAge(birthday: Date) { + const today = new Date(); - > Why? The `parseInt` function produces an integer value dictated by interpretation of the contents of the string argument according to the specified radix. Leading whitespace in string is ignored. If radix is `undefined` or `0`, it is assumed to be `10` except when the number begins with the character pairs `0x` or `0X`, in which case a radix of 16 is assumed. This differs from ECMAScript 3, which merely discouraged (but allowed) octal interpretation. Many implementations have not adopted this behavior as of 2013. And, because older browsers must be supported, always specify a radix. - ```javascript - const inputValue = '4'; + const age = this.getAge(today, birthday); - // bad - const val = new Number(inputValue); - // bad - const val = +inputValue; + this.age = age; + } - // bad - const val = inputValue >> 0; - // bad - const val = parseInt(inputValue); + getAge(today: Date, birthday: Date): number { + // .. + } +} - // good - const val = Number(inputValue); +// good +class Person { + fullName: string; + email: string; + birthday: Date; + age: number; - // good - const val = parseInt(inputValue, 10); - ``` + constructor(fullName: string, email: string, birthday: Date) { + this.fullName = fullName; + this.email = email; + this.setAge(birthday); + } - - - [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. + setAge(birthday: Date) { + const today = new Date(); + const age = getAge(today, birthday); + this.age = age; + } - ```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; - ``` + getAge(today: Date, birthday: Date): number { + // .. + } +} +``` - - - [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 - ``` + +[**18.10**](#whitespace--in-parens) ‣ Do not add spaces inside parentheses. - - - [22.6](#coercion--booleans) Booleans: eslint: [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers) + **Enforced by Prettier** - ```javascript - const age = 0; + [`space-in-parens`](https://eslint.org/docs/rules/space-in-parens.html) - // bad - const hasAge = new Boolean(age); +```typescript +// bad +function bar( foo ) { + return foo; +} - // good - const hasAge = Boolean(age); +// good +function bar(foo) { + return foo; +} - // best - const hasAge = !!age; - ``` +// bad +if ( foo ) { + console.log(foo); +} -**[⬆ back to top](#table-of-contents)** +// good +if (foo) { + console.log(foo); +} +``` -## 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) + +[**18.11**](#whitespace--in-brackets) ‣ Do not add spaces inside brackets. - ```javascript - // bad - function q() { - // ... - } + **Enforced by Prettier** - // good - function query() { - // ... - } - ``` + [`array-bracket-spacing`](https://eslint.org/docs/rules/array-bracket-spacing.html) - - - [23.2](#naming--camelCase) Use camelCase when naming objects, functions, and instances. eslint: [`camelcase`](https://eslint.org/docs/rules/camelcase.html) +```typescript +// bad +const foo = [ 1, 2, 3 ]; +console.log(foo[ 0 ]); - ```javascript - // bad - const OBJEcttsssss = {}; - const this_is_my_object = {}; - function c() {} +// good +const foo = [1, 2, 3]; +console.log(foo[0]); +``` - // 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) + +[**18.12**](#whitespace--in-braces) ‣ Add spaces inside curly braces. - ```javascript - // bad - function user(options) { - this.name = options.name; - } + **Enforced by Prettier** - const bad = new user({ - name: 'nope', - }); + [`object-curly-spacing`](https://eslint.org/docs/rules/object-curly-spacing.html) - // good - class User { - constructor(options) { - this.name = options.name; - } - } +```typescript +// bad +const foo = {clark: 'kent'}; - 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); - }; - } +// good +const foo = { clark: 'kent' }; +``` - // bad - function foo() { - const that = this; - return function () { - console.log(that); - }; - } +--- - // good - function foo() { - return () => { - console.log(this); - }; - } - ``` + +[**18.13**](#whitespace--max-len) ‣ Avoid having lines of code that are longer than 100 characters (including whitespace). Note: per [above](#strings--line-length), long strings are exempt from this rule, and should not be broken up. - - - [23.6](#naming--filename-matches-export) A base filename should exactly match the name of its default export. +Prettier does not enforce this specifically, but will wrap lines at _roughly_ 80 characters, meaning that after it has done its formatting your code will - except in extremely rare circumstances - fit within the 100 character limit. Please refer to [Prettier's documentation on the print width option](https://prettier.io/docs/en/options.html#print-width) for more information. - ```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 - ``` - -## REDUNDANT - - - [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() { - // ... - } + [`max-len`](https://eslint.org/docs/rules/max-len.html) + +> Why? This ensures readability and maintainability. + +```typescript +// bad +const foo = jsonData && jsonData.foo && jsonData.foo.bar && jsonData.foo.bar.baz && jsonData.foo.bar.baz.quux && jsonData.foo.bar.baz.quux.xyzzy; + +// good +const foo = jsonData + && jsonData.foo + && jsonData.foo.bar + && jsonData.foo.bar.baz + && jsonData.foo.bar.baz.quux + && jsonData.foo.bar.baz.quux.xyzzy; +``` + +--- + + +[**18.14**](#whitespace--comma-spacing) ‣ Avoid spaces before commas and require a space after commas. + + **Enforced by Prettier** + + [`comma-spacing`](https://eslint.org/docs/rules/comma-spacing) + +```typescript +// bad +const arr = [1 , 2]; + +// good +const arr = [1, 2]; +``` - export default makeStyleGuide; - ``` +--- - - - [23.8](#naming--PascalCase-singleton) Use PascalCase when you export a constructor / class / singleton / function library / bare object. + +[**18.15**](#whitespace--computed-property-spacing) ‣ Enforce spacing inside of computed property brackets. - ```javascript - const AirbnbStyleGuide = { - es6: { - }, - }; + **Enforced by Prettier** - export default AirbnbStyleGuide; - ``` + [`computed-property-spacing`](https://eslint.org/docs/rules/computed-property-spacing) - - - [23.9](#naming--Acronyms-and-Initialisms) Acronyms and initialisms should always be all uppercased, or all lowercased. +```typescript +// bad +obj[foo ] +obj[ 'foo'] +const x = {[ b ]: a} +obj[foo[ bar ]] - > Why? Names are for readability, not to appease a computer algorithm. +// good +obj[foo] +obj['foo'] +const x = { [b]: a } +obj[foo[bar]] +``` - ```javascript - // bad - import SmsContainer from './containers/SmsContainer'; +--- - // bad - const HttpRequests = [ - // ... - ]; + +[**18.16**](#whitespace--func-call-spacing) ‣ Avoid spaces between functions and their invocations. - // good - import SMSContainer from './containers/SMSContainer'; + **Enforced by Prettier** - // good - const HTTPRequests = [ - // ... - ]; + [`func-call-spacing`](https://eslint.org/docs/rules/func-call-spacing) - // also good - const httpRequests = [ - // ... - ]; +```typescript +// bad +func (); - // best - import TextMessageContainer from './containers/TextMessageContainer'; +func +(); - // best - const requests = [ - // ... - ]; - ``` +// good +func(); +``` - - - [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. + +[**18.17**](#whitespace--key-spacing) ‣ Enforce spacing between keys and values in object literal properties. - ```javascript - // bad - const PRIVATE_VARIABLE = 'should not be unnecessarily uppercased within a file'; + **Enforced by Prettier** - // bad - export const THING_TO_BE_CHANGED = 'should obviously not be uppercased'; + [`key-spacing`](https://eslint.org/docs/rules/key-spacing) - // bad - export let REASSIGNABLE_VARIABLE = 'do not use let with uppercase variables'; +```typescript +// bad +const obj = { foo : 42 }; +const obj2 = { foo:42 }; - // --- +// good +const obj = { foo: 42 }; +``` - // allowed but does not supply semantic value - export const apiKey = 'SOMEKEY'; +--- - // better in most cases - export const API_KEY = 'SOMEKEY'; + +[**18.18**](#whitespace--no-trailing-spaces) ‣ Avoid trailing spaces at the end of lines. - // --- + **Enforced by Prettier** - // bad - unnecessarily uppercases key while adding no semantic value - export const MAPPING = { - KEY: 'value' - }; + [`no-trailing-spaces`](https://eslint.org/docs/rules/no-trailing-spaces) + +```typescript +// bad +const foo = 'bar';∙ + +// good +const foo = 'bar'; +``` - // good - export const MAPPING = { - key: 'value' - }; - ``` **[⬆ back to top](#table-of-contents)** -## Accessors +## Commas - - - [24.1](#accessors--not-required) Accessor functions for properties are not required. + +[**19.1**](#commas--leading-trailing) ‣ Leading commas: **Nope.** + + **Enforced by Prettier** + + [`comma-style`](https://eslint.org/docs/rules/comma-style.html) + +```typescript +// 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', +}; +``` + +--- + + +[**19.2**](#commas--dangling) ‣ Additional trailing comma: **Yup.** + + **Enforced by Prettier** + + [`comma-dangle`](https://eslint.org/docs/rules/comma-dangle.html) + +> Why? This leads to cleaner git diffs. + +```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'], +}; +``` + +```typescript +// 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: string, + lastName: string, + inventorOf: Invention +) { + // does nothing +} + +// good +function createHero( + firstName: string, + lastName: string, + inventorOf: Invention, +) { + // does nothing +} + +// good (note that a comma must not appear after a "rest" element) +function createHero( + firstName: string, + lastName: string, + inventorOf: Invention, + ...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 +); +``` - - - [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')`. +**[⬆ back to top](#table-of-contents)** - ```javascript - // bad - class Dragon { - get age() { - // ... - } +## Semicolons - set age(value) { - // ... - } - } + +[**20.1**](#semicolons--required) ‣ **Yup.** - // good - class Dragon { - getAge() { - // ... - } + **Enforced by Prettier** - setAge(value) { - // ... - } - } - ``` + [`semi`](https://eslint.org/docs/rules/semi.html) - - - [24.3](#accessors--boolean-prefix) If the property/method is a `boolean`, use `isVal()` or `hasVal()`. +> Why? When JavaScript encounters a line break without a semicolon, it uses a set of rules called [Automatic Semicolon Insertion](https://tc39.github.io/ecma262/#sec-automatic-semicolon-insertion) to determine whether it should regard that line break as the end of a statement, and (as the name implies) place a semicolon into your code before the line break if it thinks so. ASI contains a few eccentric behaviors, though, and your code will break if JavaScript misinterprets your line break. These rules will become more complicated as new features become a part of JavaScript. Explicitly terminating your statements and configuring your linter to catch missing semicolons will help prevent you from encountering issues. - ```javascript - // bad - if (!dragon.age()) { - return false; - } +```typescript +// bad - raises exception +const luke = {} +const leia = {} +[luke, leia].forEach((jedi) => jedi.father = 'vader') - // good - if (!dragon.hasAge()) { - return false; - } - ``` +// bad - raises exception +const reaction = "No! That’s impossible!" +(async function meanwhileOnTheFalcon() { + // handle `leia`, `lando`, `chewie`, `r2`, `c3p0` + // ... +}()) - - - [24.4](#accessors--consistent) It’s okay to create `get()` and `set()` functions, but be consistent. +// 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' +} - ```javascript - class Jedi { - constructor(options = {}) { - const lightsaber = options.lightsaber || 'blue'; - this.set('lightsaber', lightsaber); - } +// good +const luke = {}; +const leia = {}; +[luke, leia].forEach((jedi) => { + jedi.father = 'vader'; +}); - set(key, val) { - this[key] = val; - } +// good +const reaction = "No! That’s impossible!"; +(async function meanwhileOnTheFalcon() { + // handle `leia`, `lando`, `chewie`, `r2`, `c3p0` + // ... +}()); - get(key) { - return this[key]; - } - } - ``` +// 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)** -## Events +## Type Casting & Coercion -## UPDATE EXAMPLES - - - [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: + +[**21.1**](#coercion--explicit) ‣ Perform type coercion at the beginning of the statement. - ```javascript - // bad - $(this).trigger('listingUpdated', listing.id); +--- - // ... + +[**21.2**](#coercion--strings) ‣ Strings: - $(this).on('listingUpdated', (e, listingID) => { - // do something with listingID - }); - ``` + [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers) - prefer: +```typescript +// => this.reviewScore = 9; - ```javascript - // good - $(this).trigger('listingUpdated', { listingID: listing.id }); +// bad +const totalScore = new String(this.reviewScore); // typeof totalScore is "object" not "string" - // ... +// bad +const totalScore = this.reviewScore + ''; // invokes this.reviewScore.valueOf() - $(this).on('listingUpdated', (e, data) => { - // do something with data.listingID - }); - ``` +// bad +const totalScore = this.reviewScore.toString(); // isn’t guaranteed to return a string - **[⬆ back to top](#table-of-contents)** +// good +const totalScore = String(this.reviewScore); +``` -## NO JQUERY -## jQuery +--- - - - [26.1](#jquery--dollar-prefix) Prefix jQuery object variables with a `$`. + +[**21.3**](#coercion--numbers) ‣ Numbers: Use `Number` for type casting and `parseInt` always with a radix for parsing strings. - ```javascript - // bad - const sidebar = $('.sidebar'); + [`radix`](https://eslint.org/docs/rules/radix), [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers) - // good - const $sidebar = $('.sidebar'); +> Why? The `parseInt` function produces an integer value dictated by interpretation of the contents of the string argument according to the specified radix. Leading whitespace in string is ignored. If radix is `undefined` or `0`, it is assumed to be `10` except when the number begins with the character pairs `0x` or `0X`, in which case a radix of 16 is assumed. This differs from ECMAScript 3, which merely discouraged (but allowed) octal interpretation. Many implementations have not adopted this behavior as of 2013. And, because older browsers must be supported, always specify a radix. - // good - const $sidebarBtn = $('.sidebar-btn'); - ``` +```typescript +const inputValue = '4'; - - - [26.2](#jquery--cache) Cache jQuery lookups. +// bad +const val = new Number(inputValue); - ```javascript - // bad - function setSidebar() { - $('.sidebar').hide(); +// bad +const val = +inputValue; - // ... +// bad +const val = inputValue >> 0; - $('.sidebar').css({ - 'background-color': 'pink', - }); - } +// bad +const val = parseInt(inputValue); - // good - function setSidebar() { - const $sidebar = $('.sidebar'); - $sidebar.hide(); +// good +const val = Number(inputValue); - // ... +// good +const val = parseInt(inputValue, 10); +``` - $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) + +[**21.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. - - - [26.4](#jquery--find) Use `find` with scoped jQuery object queries. +```typescript +// good +/** + * parseInt was the reason my code was slow. + * Bitshifting the String to coerce it to a + * Number made it a lot faster. + */ +const val = inputValue >> 0; +``` - ```javascript - // bad - $('ul', '.sidebar').hide(); +--- - // bad - $('.sidebar').find('ul').hide(); + +[**21.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: - // good - $('.sidebar ul').hide(); +```typescript +2147483647 >> 0; // => 2147483647 +2147483648 >> 0; // => -2147483648 +2147483649 >> 0; // => -2147483647 +``` - // good - $('.sidebar > ul').hide(); +--- - // good - $sidebar.find('ul').hide(); - ``` + +[**21.6**](#coercion--booleans) ‣ Booleans: -**[⬆ back to top](#table-of-contents)** + [`no-new-wrappers`](https://eslint.org/docs/rules/no-new-wrappers) + +```typescript +const age = 0; -## ECMAScript 5 Compatibility +// bad +const hasAge = new Boolean(age); - - - [27.1](#es5-compat--kangax) Refer to [Kangax](https://twitter.com/kangax/)’s ES5 [compatibility table](https://kangax.github.io/es5-compat-table/). +// good +const hasAge = Boolean(age); + +// best +const hasAge = !!age; +``` **[⬆ back to top](#table-of-contents)** - -## ECMAScript 6+ (ES 2015+) Styles +## Naming Conventions - - - [28.1](#es6-styles) This is a collection of links to the various ES6+ features. + +[**22.1**](#naming--descriptive) ‣ Avoid single letter names. Be descriptive with your naming. -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) + [`id-length`](https://eslint.org/docs/rules/id-length) - - - [28.2](#tc39-proposals) Do not use [TC39 proposals](https://github.com/tc39/proposals) that have not reached stage 3. +```typescript +// bad +function q() { + // ... +} - > 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. +// good +function query() { + // ... +} +``` + +--- + + +[**22.2**](#naming--camelCase) ‣ Use camelCase when naming objects, functions, and instances. -**[⬆ back to top](#table-of-contents)** + [`camelcase`](https://eslint.org/docs/rules/camelcase.html) -## Standard Library +```typescript +// bad +const OBJEcttsssss = {}; +const this_is_my_object = {}; +function c() {} - 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. +// good +const thisIsMyObject = {}; +function thisIsMyFunction() {} +``` + +--- - - - [29.1](#standard-library--isnan) Use `Number.isNaN` instead of global `isNaN`. - eslint: [`no-restricted-globals`](https://eslint.org/docs/rules/no-restricted-globals) + +[**22.3**](#naming--PascalCase) ‣ Use PascalCase only when naming constructors or classes. + + [`new-cap`](https://eslint.org/docs/rules/new-cap.html) - > 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. +```typescript +// 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', +}); +``` + +--- + + +[**22.4**](#naming--leading-underscore) ‣ Do not use trailing or leading underscores. + + [`no-underscore-dangle`](https://eslint.org/docs/rules/no-underscore-dangle.html) + +> Why? JavaScript is only now, in ES2022, adding the concept of privacy in terms of properties or methods. Although a leading underscore has long been 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. + +```typescript +// bad +this.__firstName__ = 'Panda'; +this.firstName_ = 'Panda'; +this._firstName = 'Panda'; + +// good +this.firstName = 'Panda'; - ```javascript - // bad - isNaN('1.2'); // false - isNaN('1.2.3'); // true +// 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'); +``` + +--- - // good - Number.isNaN('1.2.3'); // false - Number.isNaN(Number('1.2.3')); // true - ``` + +[**22.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). + +```typescript +// 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); + }; +} +``` + +--- + + +[**22.6**](#naming--filename-matches-export) ‣ A base filename should exactly match the name of its default export. + +```typescript +// file 1 contents +class CheckBox { + // ... +} +export default CheckBox; - - - [29.2](#standard-library--isfinite) Use `Number.isFinite` instead of global `isFinite`. - eslint: [`no-restricted-globals`](https://eslint.org/docs/rules/no-restricted-globals) +// file 2 contents +export default function fortyTwo() { return 42; } - > 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. +// file 3 contents +export default function insideDirectory() {} - ```javascript - // bad - isFinite('2e3'); // true +// 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 - // good - Number.isFinite('2e3'); // false - Number.isFinite(parseInt('2e3', 10)); // true - ``` +// 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 +``` -**[⬆ back to top](#table-of-contents)** +--- -## Testing + +[**22.7**](#naming--PascalCase-singleton) ‣ Use PascalCase when you export a constructor / class / singleton / function library / bare object. - - - [30.1](#testing--yup) **Yup.** +```typescript +const AirbnbStyleGuide = { + es6: { + }, +}; - ```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. - ## UPDATE v - - 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. Don't write crappy tests just to bump the number. - - 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. +export default AirbnbStyleGuide; +``` -**[⬆ back to top](#table-of-contents)** +--- + + +[**22.8**](#naming--Acronyms-and-Initialisms) ‣ Acronyms and initialisms should always be all uppercased, or all lowercased. + +> Why? Names are for readability, not to appease a computer algorithm. + +```typescript +// bad +import SmsContainer from './containers/SmsContainer'; + +// bad +const HttpRequests = [ + // ... +]; -## Performance +// good +import SMSContainer from './containers/SMSContainer'; + +// good +const HTTPRequests = [ + // ... +]; + +// also good +const httpRequests = [ + // ... +]; - - [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/12) - - [Bang Function](https://jsperf.com/bang-function) - - [jQuery Find vs Context, Selector](https://jsperf.com/jquery-find-vs-context-sel/164) - - [innerHTML vs textContent for script text](https://jsperf.com/innerhtml-vs-textcontent-for-script-text) - - [Long String Concatenation](https://jsperf.com/ya-string-concat/38) - - [Are JavaScript functions like `map()`, `reduce()`, and `filter()` optimized for traversing arrays?](https://www.quora.com/JavaScript-programming-language-Are-Javascript-functions-like-map-reduce-and-filter-already-optimized-for-traversing-array/answer/Quildreen-Motta) - - Loading... +// best +import TextMessageContainer from './containers/TextMessageContainer'; -**[⬆ back to top](#table-of-contents)** +// best +const requests = [ + // ... +]; +``` -## Resources +--- + + +[**22.9**](#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. + +```typescript +// 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'; + +// --- -**Learning ES6+** +// bad - unnecessarily uppercases key while adding no semantic value +export const MAPPING = { + KEY: 'value' +}; - - [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/) +// good +export const MAPPING = { + key: 'value' +}; +``` -**Read This** +**[⬆ back to top](#table-of-contents)** - - [Standard ECMA-262](http://www.ecma-international.org/ecma-262/6.0/index.html) +## Accessors -**Tools** + +[**23.1**](#accessors--not-required) ‣ Accessor functions for properties are not required. - - 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 - [@neutrinojs/airbnb](https://neutrinojs.org/packages/airbnb/) +--- -**Other Style Guides** + +[**23.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')`. - - [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html) - - [Google JavaScript Style Guide (Old)](https://google.github.io/styleguide/javascriptguide.xml) - - [jQuery Core Style Guidelines](https://contribute.jquery.org/style-guide/js/) - - [Principles of Writing Consistent, Idiomatic JavaScript](https://github.com/rwaldron/idiomatic.js) - - [StandardJS](https://standardjs.com) +```typescript +// bad +class Dragon { + get age(): number { + // ... + } -**Other Styles** + set age(value: number) { + // ... + } +} - - [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 +// good +class Dragon { + getAge(): number { + // ... + } + + setAge(value: number) { + // ... + } +} +``` -**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 + +[**23.3**](#accessors--boolean-prefix) ‣ If the property/method is a `boolean`, use `isVal()` or `hasVal()`. -**Books** +```typescript +// bad +if (!dragon.age()) { + return false; +} - - [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 +// good +if (!dragon.hasAge()) { + return false; +} +``` -**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) + +[**23.4**](#accessors--consistent) ‣ It’s okay in rare cases to create `get()` and `set()` functions, but be consistent. -**Podcasts** +```typescript +class Jedi { + constructor(options: IJediOptions = {}) { + const lightsaber = options.lightsaber || 'blue'; + this.set('lightsaber', lightsaber); + } - - [JavaScript Air](https://javascriptair.com/) - - [JavaScript Jabber](https://devchat.tv/js-jabber/) + set(key: string, val: any) { + this[key] = val; + } + + get(key: string): T { + return this[key]; + } +} +``` **[⬆ back to top](#table-of-contents)** -## In the Wild - - This is a list of organizations that are using this style guide. Send us a pull request and we'll add you to the list. - - - **123erfasst**: [123erfasst/javascript](https://github.com/123erfasst/javascript) - - **4Catalyzer**: [4Catalyzer/javascript](https://github.com/4Catalyzer/javascript) - - **Aan Zee**: [AanZee/javascript](https://github.com/AanZee/javascript) - - **Airbnb**: [airbnb/javascript](https://github.com/airbnb/javascript) - - **AloPeyk**: [AloPeyk](https://github.com/AloPeyk) - - **AltSchool**: [AltSchool/javascript](https://github.com/AltSchool/javascript) - - **Apartmint**: [apartmint/javascript](https://github.com/apartmint/javascript) - - **Ascribe**: [ascribe/javascript](https://github.com/ascribe/javascript) - - **Avant**: [avantcredit/javascript](https://github.com/avantcredit/javascript) - - **Axept**: [axept/javascript](https://github.com/axept/javascript) - - **Billabong**: [billabong/javascript](https://github.com/billabong/javascript) - - **Bisk**: [bisk](https://github.com/Bisk/) - - **Bonhomme**: [bonhommeparis/javascript](https://github.com/bonhommeparis/javascript) - - **Brainshark**: [brainshark/javascript](https://github.com/brainshark/javascript) - - **CaseNine**: [CaseNine/javascript](https://github.com/CaseNine/javascript) - - **Cerner**: [Cerner](https://github.com/cerner/) - - **Chartboost**: [ChartBoost/javascript-style-guide](https://github.com/ChartBoost/javascript-style-guide) - - **Coeur d'Alene Tribe**: [www.cdatribe-nsn.gov](https://www.cdatribe-nsn.gov) - - **ComparaOnline**: [comparaonline/javascript](https://github.com/comparaonline/javascript-style-guide) - - **Compass Learning**: [compasslearning/javascript-style-guide](https://github.com/compasslearning/javascript-style-guide) - - **DailyMotion**: [dailymotion/javascript](https://github.com/dailymotion/javascript) - - **DoSomething**: [DoSomething/eslint-config](https://github.com/DoSomething/eslint-config) - - **Digitpaint** [digitpaint/javascript](https://github.com/digitpaint/javascript) - - **Drupal**: [www.drupal.org](https://git.drupalcode.org/project/drupal/blob/8.6.x/core/.eslintrc.json) - - **Ecosia**: [ecosia/javascript](https://github.com/ecosia/javascript) - - **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) - - **Flexberry**: [Flexberry/javascript-style-guide](https://github.com/Flexberry/javascript-style-guide) - - **Gawker Media**: [gawkermedia](https://github.com/gawkermedia/) - - **General Electric**: [GeneralElectric/javascript](https://github.com/GeneralElectric/javascript) - - **Generation Tux**: [GenerationTux/javascript](https://github.com/generationtux/styleguide) - - **GoodData**: [gooddata/gdc-js-style](https://github.com/gooddata/gdc-js-style) - - **GreenChef**: [greenchef/javascript](https://github.com/greenchef/javascript) - - **Grooveshark**: [grooveshark/javascript](https://github.com/grooveshark/javascript) - - **Grupo-Abraxas**: [Grupo-Abraxas/javascript](https://github.com/Grupo-Abraxas/javascript) - - **Happeo**: [happeo/javascript](https://github.com/happeo/javascript) - - **Honey**: [honeyscience/javascript](https://github.com/honeyscience/javascript) - - **How About We**: [howaboutwe/javascript](https://github.com/howaboutwe/javascript-style-guide) - - **HubSpot**: [HubSpot/javascript](https://github.com/HubSpot/javascript) - - **Hyper**: [hyperoslo/javascript-playbook](https://github.com/hyperoslo/javascript-playbook/blob/master/style.md) - - **InterCity Group**: [intercitygroup/javascript-style-guide](https://github.com/intercitygroup/javascript-style-guide) - - **Jam3**: [Jam3/Javascript-Code-Conventions](https://github.com/Jam3/Javascript-Code-Conventions) - - **JSSolutions**: [JSSolutions/javascript](https://github.com/JSSolutions/javascript) - - **Kaplan Komputing**: [kaplankomputing/javascript](https://github.com/kaplankomputing/javascript) - - **KickorStick**: [kickorstick](https://github.com/kickorstick/) - - **Kinetica Solutions**: [kinetica/javascript](https://github.com/kinetica/Javascript-style-guide) - - **LEINWAND**: [LEINWAND/javascript](https://github.com/LEINWAND/javascript) - - **Lonely Planet**: [lonelyplanet/javascript](https://github.com/lonelyplanet/javascript) - - **M2GEN**: [M2GEN/javascript](https://github.com/M2GEN/javascript) - - **Mighty Spring**: [mightyspring/javascript](https://github.com/mightyspring/javascript) - - **MinnPost**: [MinnPost/javascript](https://github.com/MinnPost/javascript) - - **MitocGroup**: [MitocGroup/javascript](https://github.com/MitocGroup/javascript) - - **Muber**: [muber](https://github.com/muber/) - - **National Geographic**: [natgeo](https://github.com/natgeo/) - - **NullDev**: [NullDevCo/JavaScript-Styleguide](https://github.com/NullDevCo/JavaScript-Styleguide) - - **Nulogy**: [nulogy/javascript](https://github.com/nulogy/javascript) - - **Orange Hill Development**: [orangehill/javascript](https://github.com/orangehill/javascript) - - **Orion Health**: [orionhealth/javascript](https://github.com/orionhealth/javascript) - - **OutBoxSoft**: [OutBoxSoft/javascript](https://github.com/OutBoxSoft/javascript) - - **Peerby**: [Peerby/javascript](https://github.com/Peerby/javascript) - - **Pier 1**: [Pier1/javascript](https://github.com/pier1/javascript) - - **Qotto**: [Qotto/javascript-style-guide](https://github.com/Qotto/javascript-style-guide) - - **React**: [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) - - **Shutterfly**: [shutterfly/javascript](https://github.com/shutterfly/javascript) - - **Sourcetoad**: [sourcetoad/javascript](https://github.com/sourcetoad/javascript) - - **Springload**: [springload](https://github.com/springload/) - - **StratoDem Analytics**: [stratodem/javascript](https://github.com/stratodem/javascript) - - **SteelKiwi Development**: [steelkiwi/javascript](https://github.com/steelkiwi/javascript) - - **StudentSphere**: [studentsphere/javascript](https://github.com/studentsphere/guide-javascript) - - **SwoopApp**: [swoopapp/javascript](https://github.com/swoopapp/javascript) - - **SysGarage**: [sysgarage/javascript-style-guide](https://github.com/sysgarage/javascript-style-guide) - - **Syzygy Warsaw**: [syzygypl/javascript](https://github.com/syzygypl/javascript) - - **Target**: [target/javascript](https://github.com/target/javascript) - - **Terra**: [terra](https://github.com/cerner?utf8=%E2%9C%93&q=terra&type=&language=) - - **TheLadders**: [TheLadders/javascript](https://github.com/TheLadders/javascript) - - **The Nerdery**: [thenerdery/javascript-standards](https://github.com/thenerdery/javascript-standards) - - **Tomify**: [tomprats](https://github.com/tomprats) - - **Traitify**: [traitify/eslint-config-traitify](https://github.com/traitify/eslint-config-traitify) - - **T4R Technology**: [T4R-Technology/javascript](https://github.com/T4R-Technology/javascript) - - **UrbanSim**: [urbansim](https://github.com/urbansim/) - - **VoxFeed**: [VoxFeed/javascript-style-guide](https://github.com/VoxFeed/javascript-style-guide) - - **WeBox Studio**: [weboxstudio/javascript](https://github.com/weboxstudio/javascript) - - **Weggo**: [Weggo/javascript](https://github.com/Weggo/javascript) - - **Zillow**: [zillow/javascript](https://github.com/zillow/javascript) - - **ZocDoc**: [ZocDoc/javascript](https://github.com/ZocDoc/javascript) +## Events + + +[**24.1**](#events--hash) ‣ When attaching data payloads to events, pass an object literal 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: + +```typescript +// bad +const event = new CustomEvent('listingUpdated', { detail: listing.id }); + +someElement.addEventListener('listingUpdated', (event: CustomEvent) => { + // do something with event.detail +}); + +someElement.dispatchEvent(event); +``` + +prefer: + +```typescript +// good +interface ListingUpdatedEventDetail { + listingId: string; +} +const event = new CustomEvent( + 'listingUpdated', + { + detail: { + listingId: listing.id, + }, + }, +); + +someElement.addEventListener( + 'listingUpdated', + (event: CustomEvent) => { + // do something with event.detail.listingId + }, +); + +someElement.dispatchEvent(event); +``` **[⬆ back to top](#table-of-contents)** -## Translation +## 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. + + +[**25.1**](#standard-library--isnan) ‣ Use `Number.isNaN` instead of global `isNaN`. - 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)**: [lin-123/javascript](https://github.com/lin-123/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**: [dangkyokhoang/javascript-style-guide](https://github.com/dangkyokhoang/javascript-style-guide) + [`no-restricted-globals`](https://eslint.org/docs/rules/no-restricted-globals) -## The JavaScript Style Guide Guide +> 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. - - [Reference](https://github.com/airbnb/javascript/wiki/The-JavaScript-Style-Guide-Guide) +```typescript +// bad +isNaN('1.2'); // false +isNaN('1.2.3'); // true -## Chat With Us About JavaScript +// good +Number.isNaN('1.2.3'); // false +Number.isNaN(Number('1.2.3')); // true +``` - - Find us on [gitter](https://gitter.im/airbnb/javascript). +--- -## Contributors + +[**25.2**](#standard-library--isfinite) ‣ Use `Number.isFinite` instead of global `isFinite`. - - [View Contributors](https://github.com/airbnb/javascript/graphs/contributors) + [`no-restricted-globals`](https://eslint.org/docs/rules/no-restricted-globals) -## License +> 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. -(The MIT License) +```typescript +// bad +isFinite('2e3'); // true -Copyright (c) 2012 Airbnb +// good +Number.isFinite('2e3'); // false +Number.isFinite(parseInt('2e3', 10)); // true +``` -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: +**[⬆ back to top](#table-of-contents)** + +## Language Proposals -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. + +[**26.1**](#tc39-proposals) ‣ Do not use [TC39 proposals](https://github.com/tc39/proposals) that have not reached stage 3. -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. +> 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)** -## Amendments +## Testing + + +[**27.1**](#testing--yup) ‣ **Yup.** + +```typescript +function foo() { + return true; +} +``` + +--- + + +[**27.2**](#testing--for-real) ‣ **No, but seriously**: +- Refer to the [Web UI Frameworks & Tools guardrail](https://atlassian.spscommerce.com/wiki/pages/viewpage.action?spaceKey=Guardrails&title=Web+UI+Frameworks+and+Tools) for guidance on what testing tools we use and what kinds of testing you should be doing. +- 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. +- 100% test coverage is a good goal to strive for, even if it’s not always practical to reach it. Don't write crappy tests just to bump the number. +- 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. -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. +**[⬆ back to top](#table-of-contents)** + +## Resources + +**TODO:** Create list of resources we recommend - blog posts, books, YouTube videos, etc + +**[⬆ back to top](#table-of-contents)** # }; diff --git a/eslint.svg b/eslint.svg new file mode 100644 index 0000000000..dd535a8906 --- /dev/null +++ b/eslint.svg @@ -0,0 +1,17 @@ + + + + + + + + + diff --git a/prettier.svg b/prettier.svg new file mode 100644 index 0000000000..1574eaf7fa --- /dev/null +++ b/prettier.svg @@ -0,0 +1 @@ +prettier-icon-light \ No newline at end of file From 9b60ce6280ef866c50eeaa32256e63e2e2d3ce9e Mon Sep 17 00:00:00 2001 From: Chris Nordhougen Date: Mon, 27 Sep 2021 08:32:30 -0500 Subject: [PATCH 05/29] set up eslint config package --- .npmrc | 1 - .travis.yml | 108 ---- README.md | 190 ++---- linters/.eslintrc | 5 - linters/.jshintrc | 62 -- linters/.markdownlint.json | 155 ----- .../SublimeLinter.sublime-settings | 73 --- package.json | 36 +- .../code-style-typescript/index.ts | 40 ++ .../code-style-typescript/package.json | 42 ++ .../rules/bestPractices.ts | 383 ++++++++++++ .../code-style-typescript/rules/es6.ts | 147 +++++ .../rules/imports/helpfulWarnings.ts | 31 + .../rules/imports/index.ts | 4 + .../rules/imports/moduleSystems.ts | 23 + .../rules/imports/staticAnalysis.ts | 59 ++ .../rules/imports/styleGuide.ts | 69 +++ .../rules/possibleErrors.ts | 183 ++++++ .../code-style-typescript/rules/strictMode.ts | 8 + .../rules/stylisticIssues.ts | 426 +++++++++++++ .../code-style-typescript/rules/variables.ts | 63 ++ .../code-style-typescript/tsconfig.json | 15 + packages/eslint-config-airbnb-base/.babelrc | 3 - .../eslint-config-airbnb-base/.editorconfig | 1 - packages/eslint-config-airbnb-base/.eslintrc | 10 - packages/eslint-config-airbnb-base/.npmrc | 1 - .../eslint-config-airbnb-base/CHANGELOG.md | 355 ----------- packages/eslint-config-airbnb-base/LICENSE.md | 21 - packages/eslint-config-airbnb-base/README.md | 99 --- packages/eslint-config-airbnb-base/index.js | 17 - packages/eslint-config-airbnb-base/legacy.js | 34 -- .../eslint-config-airbnb-base/package.json | 79 --- .../rules/best-practices.js | 412 ------------- .../eslint-config-airbnb-base/rules/errors.js | 182 ------ .../eslint-config-airbnb-base/rules/es6.js | 186 ------ .../rules/imports.js | 275 --------- .../eslint-config-airbnb-base/rules/node.js | 43 -- .../eslint-config-airbnb-base/rules/strict.js | 6 - .../eslint-config-airbnb-base/rules/style.js | 533 ----------------- .../rules/variables.js | 56 -- .../eslint-config-airbnb-base/test/.eslintrc | 8 - .../test/requires.js | 13 - .../test/test-base.js | 32 - .../eslint-config-airbnb-base/whitespace.js | 91 --- packages/eslint-config-airbnb/.babelrc | 3 - packages/eslint-config-airbnb/.editorconfig | 1 - packages/eslint-config-airbnb/.eslintrc | 8 - packages/eslint-config-airbnb/.npmrc | 1 - packages/eslint-config-airbnb/CHANGELOG.md | 444 -------------- packages/eslint-config-airbnb/LICENSE.md | 21 - packages/eslint-config-airbnb/README.md | 85 --- packages/eslint-config-airbnb/base.js | 4 - packages/eslint-config-airbnb/hooks.js | 6 - packages/eslint-config-airbnb/index.js | 8 - packages/eslint-config-airbnb/legacy.js | 4 - packages/eslint-config-airbnb/package.json | 87 --- .../eslint-config-airbnb/rules/react-a11y.js | 251 -------- .../eslint-config-airbnb/rules/react-hooks.js | 21 - packages/eslint-config-airbnb/rules/react.js | 566 ------------------ packages/eslint-config-airbnb/test/.eslintrc | 9 - .../eslint-config-airbnb/test/requires.js | 15 - .../eslint-config-airbnb/test/test-base.js | 34 -- .../test/test-react-order.js | 136 ----- packages/eslint-config-airbnb/whitespace.js | 105 ---- 64 files changed, 1547 insertions(+), 4842 deletions(-) delete mode 100644 .npmrc delete mode 100644 .travis.yml delete mode 100644 linters/.eslintrc delete mode 100644 linters/.jshintrc delete mode 100644 linters/.markdownlint.json delete mode 100644 linters/SublimeLinter/SublimeLinter.sublime-settings create mode 100644 packages/@spscommerce/code-style-typescript/index.ts create mode 100644 packages/@spscommerce/code-style-typescript/package.json create mode 100644 packages/@spscommerce/code-style-typescript/rules/bestPractices.ts create mode 100644 packages/@spscommerce/code-style-typescript/rules/es6.ts create mode 100644 packages/@spscommerce/code-style-typescript/rules/imports/helpfulWarnings.ts create mode 100644 packages/@spscommerce/code-style-typescript/rules/imports/index.ts create mode 100644 packages/@spscommerce/code-style-typescript/rules/imports/moduleSystems.ts create mode 100644 packages/@spscommerce/code-style-typescript/rules/imports/staticAnalysis.ts create mode 100644 packages/@spscommerce/code-style-typescript/rules/imports/styleGuide.ts create mode 100644 packages/@spscommerce/code-style-typescript/rules/possibleErrors.ts create mode 100644 packages/@spscommerce/code-style-typescript/rules/strictMode.ts create mode 100644 packages/@spscommerce/code-style-typescript/rules/stylisticIssues.ts create mode 100644 packages/@spscommerce/code-style-typescript/rules/variables.ts create mode 100644 packages/@spscommerce/code-style-typescript/tsconfig.json delete mode 100644 packages/eslint-config-airbnb-base/.babelrc delete mode 120000 packages/eslint-config-airbnb-base/.editorconfig delete mode 100644 packages/eslint-config-airbnb-base/.eslintrc delete mode 120000 packages/eslint-config-airbnb-base/.npmrc delete mode 100644 packages/eslint-config-airbnb-base/CHANGELOG.md delete mode 100644 packages/eslint-config-airbnb-base/LICENSE.md delete mode 100644 packages/eslint-config-airbnb-base/README.md delete mode 100644 packages/eslint-config-airbnb-base/index.js delete mode 100644 packages/eslint-config-airbnb-base/legacy.js delete mode 100644 packages/eslint-config-airbnb-base/package.json delete mode 100644 packages/eslint-config-airbnb-base/rules/best-practices.js delete mode 100644 packages/eslint-config-airbnb-base/rules/errors.js delete mode 100644 packages/eslint-config-airbnb-base/rules/es6.js delete mode 100644 packages/eslint-config-airbnb-base/rules/imports.js delete mode 100644 packages/eslint-config-airbnb-base/rules/node.js delete mode 100644 packages/eslint-config-airbnb-base/rules/strict.js delete mode 100644 packages/eslint-config-airbnb-base/rules/style.js delete mode 100644 packages/eslint-config-airbnb-base/rules/variables.js delete mode 100644 packages/eslint-config-airbnb-base/test/.eslintrc delete mode 100644 packages/eslint-config-airbnb-base/test/requires.js delete mode 100644 packages/eslint-config-airbnb-base/test/test-base.js delete mode 100644 packages/eslint-config-airbnb-base/whitespace.js delete mode 100644 packages/eslint-config-airbnb/.babelrc delete mode 120000 packages/eslint-config-airbnb/.editorconfig delete mode 100644 packages/eslint-config-airbnb/.eslintrc delete mode 120000 packages/eslint-config-airbnb/.npmrc delete mode 100644 packages/eslint-config-airbnb/CHANGELOG.md delete mode 100644 packages/eslint-config-airbnb/LICENSE.md delete mode 100644 packages/eslint-config-airbnb/README.md delete mode 100644 packages/eslint-config-airbnb/base.js delete mode 100644 packages/eslint-config-airbnb/hooks.js delete mode 100644 packages/eslint-config-airbnb/index.js delete mode 100644 packages/eslint-config-airbnb/legacy.js delete mode 100644 packages/eslint-config-airbnb/package.json delete mode 100644 packages/eslint-config-airbnb/rules/react-a11y.js delete mode 100644 packages/eslint-config-airbnb/rules/react-hooks.js delete mode 100644 packages/eslint-config-airbnb/rules/react.js delete mode 100644 packages/eslint-config-airbnb/test/.eslintrc delete mode 100644 packages/eslint-config-airbnb/test/requires.js delete mode 100644 packages/eslint-config-airbnb/test/test-base.js delete mode 100644 packages/eslint-config-airbnb/test/test-react-order.js delete mode 100644 packages/eslint-config-airbnb/whitespace.js diff --git a/.npmrc b/.npmrc deleted file mode 100644 index 43c97e719a..0000000000 --- a/.npmrc +++ /dev/null @@ -1 +0,0 @@ -package-lock=false diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index b7eb96d7ae..0000000000 --- a/.travis.yml +++ /dev/null @@ -1,108 +0,0 @@ -language: node_js -node_js: - - "14" - - "12" - - "10" -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' - - 'if [ -n "${REACT_HOOKS}" ]; then npm install --no-save "eslint-plugin-react-hooks@${REACT_HOOKS}"; 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=7 PACKAGE=eslint-config-airbnb-base' - - 'TEST=true ESLINT=7 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=7 REACT_HOOKS=3 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=7 REACT_HOOKS=2.3 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=7 REACT_HOOKS=1.7 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=6 PACKAGE=eslint-config-airbnb-base' - - 'TEST=true ESLINT=6 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=6 REACT_HOOKS=3 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=6 REACT_HOOKS=2.3 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=6 REACT_HOOKS=1.7 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=5 PACKAGE=eslint-config-airbnb-base' - - 'TEST=true ESLINT=5 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=5 REACT_HOOKS=3 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=5 REACT_HOOKS=2.3 PACKAGE=eslint-config-airbnb' - - 'TEST=true ESLINT=5 REACT_HOOKS=1.7 PACKAGE=eslint-config-airbnb' -matrix: - fast_finish: true - include: - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=7 PACKAGE=eslint-config-airbnb-base - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=7 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=7 REACT_HOOKS=3 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=7 REACT_HOOKS=2.3 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=7 REACT_HOOKS=1.7 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=6 PACKAGE=eslint-config-airbnb-base - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=6 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=6 REACT_HOOKS=3 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=6 REACT_HOOKS=2.3 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=6 REACT_HOOKS=1.7 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=5 PACKAGE=eslint-config-airbnb-base - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=5 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=5 REACT_HOOKS=3 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=5 REACT_HOOKS=2.3 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: PREPUBLISH=true ESLINT=5 REACT_HOOKS=1.7 PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: LINT=true - - node_js: "lts/*" - env: LINT=true PACKAGE=eslint-config-airbnb - - node_js: "lts/*" - env: LINT=true PACKAGE=eslint-config-airbnb-base - - node_js: "8" - env: TEST=true ESLINT=6 PACKAGE=eslint-config-airbnb-base - - node_js: "8" - env: TEST=true ESLINT=6 PACKAGE=eslint-config-airbnb - - node_js: "8" - env: TEST=true ESLINT=6 REACT_HOOKS=3 PACKAGE=eslint-config-airbnb - - node_js: "8" - env: TEST=true ESLINT=6 REACT_HOOKS=2.3 PACKAGE=eslint-config-airbnb - - node_js: "8" - env: TEST=true ESLINT=6 REACT_HOOKS=1.7 PACKAGE=eslint-config-airbnb - - node_js: "8" - env: TEST=true ESLINT=5 PACKAGE=eslint-config-airbnb-base - - node_js: "8" - env: TEST=true ESLINT=5 PACKAGE=eslint-config-airbnb - - node_js: "8" - env: TEST=true ESLINT=5 REACT_HOOKS=3 PACKAGE=eslint-config-airbnb - - node_js: "8" - env: TEST=true ESLINT=5 REACT_HOOKS=2.3 PACKAGE=eslint-config-airbnb - - node_js: "8" - env: TEST=true ESLINT=5 REACT_HOOKS=1.7 PACKAGE=eslint-config-airbnb - - node_js: "6" - env: TEST=true ESLINT=5 PACKAGE=eslint-config-airbnb-base - - node_js: "6" - env: TEST=true ESLINT=5 PACKAGE=eslint-config-airbnb - - node_js: "6" - env: TEST=true ESLINT=5 REACT_HOOKS=3 PACKAGE=eslint-config-airbnb - - node_js: "6" - env: TEST=true ESLINT=5 REACT_HOOKS=2.3 PACKAGE=eslint-config-airbnb - - node_js: "6" - env: TEST=true ESLINT=5 REACT_HOOKS=1.7 PACKAGE=eslint-config-airbnb - exclude: - allow_failures: - - env: PREPUBLISH=true ESLINT=6 PACKAGE=eslint-config-airbnb-base - - env: PREPUBLISH=true ESLINT=6 PACKAGE=eslint-config-airbnb - - env: PREPUBLISH=true ESLINT=5 PACKAGE=eslint-config-airbnb-base - - env: PREPUBLISH=true ESLINT=5 PACKAGE=eslint-config-airbnb diff --git a/README.md b/README.md index 35ed2b0716..92917f5c72 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ **TODO:** Write description -**TODO:** What about these other guides? - Other Style Guides - [React](react/) - [CSS-in-JS](css-in-javascript/) @@ -84,7 +82,7 @@ Symbols and BigInts cannot be faithfully polyfilled, so they should not be used console.log(foo[0], bar[0]); // => 9, 9 ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## References @@ -148,7 +146,7 @@ console.log(c); // Prints 1 In the above code, you can see that referencing `a` and `b` will produce a ReferenceError, while `c` contains the number. This is because `a` and `b` are block scoped, while `c` is scoped to the containing function. -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Objects @@ -244,42 +242,8 @@ const obj = { --- -**TODO:** Further discussion required - - -[**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. - -```typescript -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. +[**3.5**](#objects--quoted-props) ‣ Only quote properties that are invalid identifiers. **Enforced by Prettier** @@ -306,7 +270,7 @@ const good = { --- -[**3.7**](#objects--rest-spread) ‣ Prefer the object spread syntax over [`Object.assign`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) to shallow-copy objects. Use the object rest operator to get a new object with certain properties omitted. +[**3.6**](#objects--rest-spread) ‣ Prefer the object spread syntax over [`Object.assign`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) to shallow-copy objects. Use the object rest operator to get a new object with certain properties omitted. [`prefer-object-spread`](https://eslint.org/docs/rules/prefer-object-spread) @@ -327,7 +291,7 @@ 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)** +**[⬆ back to top](#table-of-contents)** ## Arrays @@ -426,8 +390,6 @@ const baz = Array.from(foo, bar); --- -**TODO:** Further discussion required - [**4.7**](#arrays--callback-return) ‣ Use return statements in array method callbacks. It’s ok to omit the return if the function body consists of a single statement returning an expression without side effects, following [**8.2**](#arrows--implicit-return). @@ -459,8 +421,6 @@ inbox.filter((msg) => { const { subject, author } = msg; if (subject === 'Mockingbird') { return author === 'Harper Lee'; - } else { - return false; } }); @@ -517,7 +477,7 @@ const stringInArray = [ ]; ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Destructuring @@ -594,28 +554,28 @@ function processInput(input) { const { left, top } = processInput(input); ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Strings -**TODO:** Further discussion required - Prettier does double quotes by default, but can be configured for single quotes. - -[**6.1**](#strings--quotes) ‣ Use single quotes `''` for strings. +[**6.1**](#strings--quotes) ‣ Use double quotes `""` for strings. **Enforced by Prettier** [`quotes`](https://eslint.org/docs/rules/quotes.html) +> Why? In a JSX world, double quotes result in your code needing fewer escapes than single quotes. + ```typescript // bad -const name = "Capt. Janeway"; +const name = 'Let\'s all go to the movies'; // bad - template literals should contain interpolation or newlines -const name = `Capt. Janeway`; +const name = `Let's all go to the movies`; // good -const name = 'Capt. Janeway'; +const name = "Let's all go to the movies"; ``` --- @@ -699,7 +659,7 @@ const foo = '\'this\' is "quoted"'; const foo = `my name is '${name}'`; ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Functions @@ -982,7 +942,7 @@ console.log( ); ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Arrow Functions @@ -1172,7 +1132,7 @@ const itemHeight = (item: ItemType) => { ) ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Classes & Constructors @@ -1398,7 +1358,7 @@ class Foo { } ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Modules @@ -1554,7 +1514,7 @@ import barCss from 'bar.css'; import baz from './baz'; ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Iterators and Generators @@ -1706,7 +1666,7 @@ const foo = function* () { }; ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Properties @@ -1729,7 +1689,7 @@ const isJedi = luke.jedi; ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Variables @@ -1986,7 +1946,7 @@ const { type, ...coords } = data; // 'coords' is now the 'data' object without its 'type' property. ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Comparison Operators & Equality @@ -2199,7 +2159,7 @@ if (a || (b && c)) { const bar = a + (b / c) * d; ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Blocks @@ -2229,78 +2189,7 @@ if (test) { } ``` ---- - -**TODO:** Further discussion required - - -[**15.2**](#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. - - [`no-else-return`](https://eslint.org/docs/rules/no-else-return) - -```typescript -// 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)** +**[⬆ back to top](#table-of-contents)** ## Control Statements @@ -2365,7 +2254,12 @@ if (!isRunning) { } ``` -**[⬆ back to top](#table-of-contents)** +--- + + +[**16.3**](#control-statements--value-selection) ‣ Don't use labeled statements. Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand. + +**[⬆ back to top](#table-of-contents)** ## Comments @@ -2505,7 +2399,7 @@ class Calculator extends Abacus { } ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Whitespace @@ -3038,7 +2932,7 @@ const foo = 'bar'; ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Commas @@ -3183,7 +3077,7 @@ createHero( ); ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Semicolons @@ -3237,7 +3131,7 @@ function foo() { [Read more](https://stackoverflow.com/questions/7365172/semicolon-before-self-invoking-function/7365214#7365214). -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Type Casting & Coercion @@ -3344,7 +3238,7 @@ const hasAge = Boolean(age); const hasAge = !!age; ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Naming Conventions @@ -3419,7 +3313,7 @@ const good = new User({ [`no-underscore-dangle`](https://eslint.org/docs/rules/no-underscore-dangle.html) -> Why? JavaScript is only now, in ES2022, adding the concept of privacy in terms of properties or methods. Although a leading underscore has long been 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. +> Why? Although a leading underscore has long been 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. With the addition of private class fields in ES2022, there is a genuine way to do this, so the informal convention is obsolete. ```typescript // bad @@ -3596,7 +3490,7 @@ export const MAPPING = { }; ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Accessors @@ -3671,7 +3565,7 @@ class Jedi { } ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Events @@ -3715,7 +3609,7 @@ someElement.addEventListener( someElement.dispatchEvent(event); ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Standard Library @@ -3760,7 +3654,7 @@ Number.isFinite('2e3'); // false Number.isFinite(parseInt('2e3', 10)); // true ``` -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** ## Language Proposals @@ -3769,7 +3663,7 @@ Number.isFinite(parseInt('2e3', 10)); // true > 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)** +**[⬆ back to top](#table-of-contents)** ## Testing @@ -3792,12 +3686,12 @@ function foo() { - 100% test coverage is a good goal to strive for, even if it’s not always practical to reach it. Don't write crappy tests just to bump the number. - 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)** +**[⬆ back to top](#table-of-contents)** ## Resources **TODO:** Create list of resources we recommend - blog posts, books, YouTube videos, etc -**[⬆ back to top](#table-of-contents)** +**[⬆ back to top](#table-of-contents)** # }; diff --git a/linters/.eslintrc b/linters/.eslintrc deleted file mode 100644 index 9e203a5473..0000000000 --- a/linters/.eslintrc +++ /dev/null @@ -1,5 +0,0 @@ -// 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 deleted file mode 100644 index a7a08a349e..0000000000 --- a/linters/.jshintrc +++ /dev/null @@ -1,62 +0,0 @@ -{ - /* - * 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 deleted file mode 100644 index 951337dbc5..0000000000 --- a/linters/.markdownlint.json +++ /dev/null @@ -1,155 +0,0 @@ -{ - "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, - "start_indented": true - }, - - "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 use of dollar signs($) 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: Disallow multiple spaces after hash on atx style header.", - "no-multiple-space-atx": true, - - "comment": "MD020: No space should be 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 preceding 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": "You must 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 preceding 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 should be 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 deleted file mode 100644 index 259dbaff6a..0000000000 --- a/linters/SublimeLinter/SublimeLinter.sublime-settings +++ /dev/null @@ -1,73 +0,0 @@ -/** - * 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 77adc2e32d..d80d14b277 100644 --- a/package.json +++ b/package.json @@ -1,30 +1,21 @@ { - "name": "airbnb-style", - "version": "2.0.0", - "description": "A mostly reasonable approach to JavaScript.", + "name": "@spscommerce/code-style", + "version": "0.0.1", + "description": "SPS official style guides and lint configs for frontend development.", + "private": true, "scripts": { - "preinstall": "npm run install:config && npm run install:config:base", - "postinstall": "rm -rf node_modules/markdownlint-cli/node_modules/markdownlint", - "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" + "url": "https://github.com/SPSCommerce/javascript.git" }, "keywords": [ "style guide", "lint", "airbnb", + "SPS", + "SPS Commerce", "es6", "es2015", "es2016", @@ -33,14 +24,11 @@ "react", "jsx" ], - "author": "Harrison Shoff (https://twitter.com/hshoff)", + "author": "SPS Commerce", "license": "MIT", "bugs": { - "url": "https://github.com/airbnb/javascript/issues" + "url": "https://github.com/SPSCommerce/javascript/issues" }, - "homepage": "https://github.com/airbnb/javascript", - "devDependencies": { - "markdownlint": "^0.20.4", - "markdownlint-cli": "^0.23.2" - } + "homepage": "https://github.com/SPSCommerce/javascript", + "workspaces": ["packages/@spscommerce/*"] } diff --git a/packages/@spscommerce/code-style-typescript/index.ts b/packages/@spscommerce/code-style-typescript/index.ts new file mode 100644 index 0000000000..ef79eb0905 --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/index.ts @@ -0,0 +1,40 @@ +import { Linter } from 'eslint'; + +import { possibleErrors } from './rules/possibleErrors'; +import { bestPractices } from './rules/bestPractices'; +import { strictMode } from './rules/strictMode'; +import { variables } from './rules/variables'; +import { stylisticIssues } from './rules/stylisticIssues'; +import { es6 } from './rules/es6'; +import * as imports from './rules/imports'; + +const config: Linter.Config = { + parser: '@typescript-eslint/parser', + parserOptions: { + project: './tsconfig.json' + }, + plugins: [ + '@typescript-eslint', + 'import', + ], + settings: { + 'import/extensions': ['.ts', '.tsx'], + 'import/parsers': { + '@typescript-eslint/parser': ['.ts', '.tsx'], + }, + }, + rules: { + ...possibleErrors, + ...bestPractices, + ...strictMode, + ...variables, + ...stylisticIssues, + ...es6, + ...imports.staticAnalysis, + ...imports.helpfulWarnings, + ...imports.moduleSystems, + ...imports.styleGuide, + }, +}; + +export default config; diff --git a/packages/@spscommerce/code-style-typescript/package.json b/packages/@spscommerce/code-style-typescript/package.json new file mode 100644 index 0000000000..6e08abb18f --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/package.json @@ -0,0 +1,42 @@ +{ + "name": "@spscommerce/code-style-typescript", + "version": "0.0.1", + "description": "SPS official linter configuration for TypeScript.", + "main": "index.js", + "scripts": {}, + "repository": { + "type": "git", + "url": "https://github.com/SPSCommerce/javascript.git" + }, + "keywords": [ + "style guide", + "lint", + "airbnb", + "SPS", + "SPS Commerce", + "es6", + "es2015", + "es2016", + "es2017", + "es2018", + "react", + "jsx" + ], + "author": "SPS Commerce", + "license": "MIT", + "bugs": { + "url": "https://github.com/SPSCommerce/javascript/issues" + }, + "homepage": "https://github.com/SPSCommerce/javascript", + "peerDependencies": { + "eslint": "^7.32.0" + }, + "dependencies": { + "@typescript-eslint/eslint-plugin": "^4.31.2", + "@typescript-eslint/parser": "^4.31.2", + "eslint-plugin-import": "^2.24.2" + }, + "devDependencies": { + "@types/eslint": "^7.28.0" + } +} diff --git a/packages/@spscommerce/code-style-typescript/rules/bestPractices.ts b/packages/@spscommerce/code-style-typescript/rules/bestPractices.ts new file mode 100644 index 0000000000..c9781c45c5 --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/bestPractices.ts @@ -0,0 +1,383 @@ +import { BestPractices } from 'eslint/rules/best-practices'; + +export const bestPractices: BestPractices = { + /** enforces getter/setter pairs in objects + * https://eslint.org/docs/rules/accessor-pairs + * Off because getters and setters are forbidden */ + '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 + * https://eslint.org/docs/rules/block-scoped-var + * Off because `var` is forbidden */ + 'block-scoped-var': 'off', + + /** specify the maximum cyclomatic complexity allowed in a program + * https://eslint.org/docs/rules/complexity */ + complexity: 'off', + + /** enforce that class methods use "this" + * https://eslint.org/docs/rules/class-methods-use-this */ + 'class-methods-use-this': 'error', + + /** require return statements to either always or never specify values + * https://eslint.org/docs/rules/consistent-return */ + 'consistent-return': 'off', + + /** specify curly brace conventions for all control statements + * https://eslint.org/docs/rules/curly */ + curly: ['error', 'multi-line'], + + /** require default case in switch statements + * https://eslint.org/docs/rules/default-case */ + 'default-case': ['error', { commentPattern: '^no default$' }], + + /** Enforce default clauses in switch statements to be last + * https://eslint.org/docs/rules/default-case-last */ + 'default-case-last': 'error', + + /** enforce default parameters to be last + * https://eslint.org/docs/rules/default-param-last */ + 'default-param-last': 'error', + + /** enforces consistent newlines before or after dots + * https://eslint.org/docs/rules/dot-location */ + 'dot-location': ['error', 'property'], + + /** encourages use of dot notation whenever possible + * https://eslint.org/docs/rules/dot-notation */ + 'dot-notation': ['error', { allowKeywords: true }], + + /** require the use of === and !== + * https://eslint.org/docs/rules/eqeqeq */ + eqeqeq: 'error', + + /** Require grouped accessor pairs in object literals and classes + * https://eslint.org/docs/rules/grouped-accessor-pairs + * Off because getters and setters are forbidden */ + 'grouped-accessor-pairs': 'off', + + /** make sure for-in loops have an if statement + * https://eslint.org/docs/rules/guard-for-in + * Off because for-in is forbidden */ + 'guard-for-in': 'off', + + /** enforce a maximum number of classes per file + * https://eslint.org/docs/rules/max-classes-per-file */ + 'max-classes-per-file': ['error', 1], + + /** disallow the use of alert, confirm, and prompt + * https://eslint.org/docs/rules/no-alert */ + 'no-alert': 'error', + + /** disallow use of arguments.caller or arguments.callee + * https://eslint.org/docs/rules/no-caller */ + 'no-caller': 'error', + + /** disallow lexical declarations in case/default clauses + * https://eslint.org/docs/rules/no-case-declarations */ + 'no-case-declarations': 'error', + + /** Disallow returning value in constructor + * https://eslint.org/docs/rules/no-constructor-return */ + 'no-constructor-return': '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': 'off', + + /** disallow empty functions + * https://eslint.org/docs/rules/no-empty-function */ + 'no-empty-function': 'off', + + /** 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 + * https://eslint.org/docs/rules/no-eq-null + * Off because it's superceded by eqeqeq */ + 'no-eq-null': 'off', + + /** disallow use of eval() + * https://eslint.org/docs/rules/no-eval */ + 'no-eval': 'error', + + /** disallow adding to native types + * https://eslint.org/docs/rules/no-extend-native */ + 'no-extend-native': 'error', + + /** disallow unnecessary function binding + * https://eslint.org/docs/rules/no-extra-bind */ + 'no-extra-bind': 'error', + + /** disallow Unnecessary Labels + * https://eslint.org/docs/rules/no-extra-label */ + 'no-extra-label': 'error', + + /** disallow fallthrough of case statements + * https://eslint.org/docs/rules/no-fallthrough */ + 'no-fallthrough': 'error', + + /** disallow the use of leading or trailing decimal points in numeric literals + * https://eslint.org/docs/rules/no-floating-decimal */ + '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', + + /** disallow implicit type conversions + * https://eslint.org/docs/rules/no-implicit-coercion */ + 'no-implicit-coercion': [ + 'error', + { + boolean: false, + number: true, + string: true, + }, + ], + + /** disallow var and named functions in global scope + * https://eslint.org/docs/rules/no-implicit-globals */ + 'no-implicit-globals': 'error', + + /** disallow use of eval()-like methods + * https://eslint.org/docs/rules/no-implied-eval */ + 'no-implied-eval': 'error', + + /** disallow this keywords outside of classes or class-like objects + * https://eslint.org/docs/rules/no-invalid-this */ + 'no-invalid-this': 'off', + + /** disallow usage of __iterator__ property + * https://eslint.org/docs/rules/no-iterator */ + 'no-iterator': 'error', + + /** disallow use of labels for anything other than loops and switches + * https://eslint.org/docs/rules/no-labels */ + 'no-labels': 'error', + + /** disallow unnecessary nested blocks + * https://eslint.org/docs/rules/no-lone-blocks */ + 'no-lone-blocks': 'error', + + /** disallow creation of functions within loops + * https://eslint.org/docs/rules/no-loop-func */ + 'no-loop-func': 'error', + + /** disallow magic numbers + * https://eslint.org/docs/rules/no-magic-numbers */ + 'no-magic-numbers': ['error', { ignoreArrayIndexes: true }], + + /** disallow use of multiple spaces + * https://eslint.org/docs/rules/no-multi-spaces */ + 'no-multi-spaces': 'error', + + /** disallow use of multiline strings + * https://eslint.org/docs/rules/no-multi-str */ + 'no-multi-str': 'error', + + /** disallow use of new operator when not part of the assignment or comparison + * https://eslint.org/docs/rules/no-new */ + 'no-new': 'error', + + /** disallow use of new operator for Function object + * https://eslint.org/docs/rules/no-new-func */ + 'no-new-func': 'error', + + /** disallows creating new instances of String, Number, and Boolean + * https://eslint.org/docs/rules/no-new-wrappers */ + 'no-new-wrappers': 'error', + + /** Disallow \8 and \9 escape sequences in string literals + * https://eslint.org/docs/rules/no-nonoctal-decimal-escape */ + 'no-nonoctal-decimal-escape': 'error', + + /** disallow use of (old style) octal literals + * https://eslint.org/docs/rules/no-octal */ + 'no-octal': 'error', + + /** disallow use of octal escape sequences in string literals, such as + * https://eslint.org/docs/rules/no-octal-escape */ + 'no-octal-escape': 'error', + + /** disallow reassignment of function parameters, and + * 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 + ], + }, + ], + + /** disallow usage of __proto__ property + * https://eslint.org/docs/rules/no-proto */ + 'no-proto': 'error', + + /** disallow declaring the same variable more than once + * https://eslint.org/docs/rules/no-redeclare */ + '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.', + }, + ], + + /** disallow use of assignment in return statement + * https://eslint.org/docs/rules/no-return-assign */ + 'no-return-assign': 'error', + + /** disallow redundant `return await` + * https://eslint.org/docs/rules/no-return-await */ + 'no-return-await': 'error', + + /** disallow use of `javascript:` urls. + * https://eslint.org/docs/rules/no-script-url */ + '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 + * https://eslint.org/docs/rules/no-self-compare */ + 'no-self-compare': 'error', + + /** disallow use of comma operator + * https://eslint.org/docs/rules/no-sequences */ + 'no-sequences': 'error', + + /** restrict what can be thrown as an exception + * https://eslint.org/docs/rules/no-throw-literal */ + '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 + * https://eslint.org/docs/rules/no-unused-expressions */ + 'no-unused-expressions': ['error', { allowTaggedTemplates: false }], + + /** disallow unused labels + * https://eslint.org/docs/rules/no-unused-labels */ + 'no-unused-labels': 'error', + + /** disallow unnecessary .call() and .apply() + * https://eslint.org/docs/rules/no-useless-call */ + 'no-useless-call': 'off', + + /** Disallow unnecessary catch clauses + * https://eslint.org/docs/rules/no-useless-catch */ + 'no-useless-catch': 'error', + + /** 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 + * https://eslint.org/docs/rules/no-warning-comments */ + 'no-warning-comments': 'off', + + /** disallow use of the with statement + * https://eslint.org/docs/rules/no-with */ + '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 }], + + /** Suggest using named capture group in regular expression + * https://eslint.org/docs/rules/prefer-named-capture-group */ + 'prefer-named-capture-group': 'off', + + /** disallow use of the `RegExp` constructor in favor of regular expression literals + * https://eslint.org/docs/rules/prefer-regex-literals */ + 'prefer-regex-literals': 'error', + + /** require use of the second argument for parseInt() + * https://eslint.org/docs/rules/radix */ + 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', + + /** Enforce the use of u flag on RegExp + * https://eslint.org/docs/rules/require-unicode-regexp */ + 'require-unicode-regexp': 'off', + + /** requires to declare all vars on top of their containing scope + * https://eslint.org/docs/rules/vars-on-top + * Off because var is forbidden */ + 'vars-on-top': 'off', + + /** 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 + * https://eslint.org/docs/rules/yoda */ + yoda: 'error' +}; diff --git a/packages/@spscommerce/code-style-typescript/rules/es6.ts b/packages/@spscommerce/code-style-typescript/rules/es6.ts new file mode 100644 index 0000000000..44150d55c4 --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/es6.ts @@ -0,0 +1,147 @@ +import { ECMAScript6 } from 'eslint/rules/ecmascript-6'; + +export const es6: ECMAScript6 = { + /** enforces no braces where they can be omitted + * https://eslint.org/docs/rules/arrow-body-style */ + 'arrow-body-style': 'error', + + /** require parens in arrow function arguments + * https://eslint.org/docs/rules/arrow-parens */ + 'arrow-parens': 'error', + + /** require space before/after arrow function's arrow + * https://eslint.org/docs/rules/arrow-spacing */ + 'arrow-spacing': 'error', + + /** verify super() callings in constructors + * https://eslint.org/docs/rules/constructor-super */ + '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 + * https://eslint.org/docs/rules/no-const-assign */ + '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 + * superceded by eslint-plugin-import */ + 'no-duplicate-import': 'off', + + /** disallow symbol constructor + * https://eslint.org/docs/rules/no-new-symbol */ + 'no-new-symbol': 'error', + + /** Disallow specified names in exports + * https://eslint.org/docs/rules/no-restricted-exports */ + 'no-restricted-exports': 'off', + + /** disallow specific imports + * https://eslint.org/docs/rules/no-restricted-imports */ + 'no-restricted-imports': 'off', + + /** 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', + + /** require let or const instead of var + * https://eslint.org/docs/rules/no-var */ + 'no-var': 'error', + + /** require method and property shorthand syntax for object literals + * https://eslint.org/docs/rules/object-shorthand */ + 'object-shorthand': ['error', 'always', { avoidQuotes: true }], + + /** suggest using arrow functions as callbacks + * https://eslint.org/docs/rules/prefer-arrow-callback */ + 'prefer-arrow-callback': 'error', + + /** suggest using of const declaration for variables that are never modified after declared + * https://eslint.org/docs/rules/prefer-const */ + 'prefer-const': ['error', { 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: false, + }, + }, { + 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 syntax 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', + + /** import sorting + * https://eslint.org/docs/rules/sort-imports */ + 'sort-imports': 'off', + + /** 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', +}; diff --git a/packages/@spscommerce/code-style-typescript/rules/imports/helpfulWarnings.ts b/packages/@spscommerce/code-style-typescript/rules/imports/helpfulWarnings.ts new file mode 100644 index 0000000000..ca6c49d63c --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/imports/helpfulWarnings.ts @@ -0,0 +1,31 @@ +import { Linter } from 'eslint'; + +export const helpfulWarnings: Linter.RulesRecord = { + /** Report any invalid exports, i.e. re-export of the same name + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/export.md */ + "import/export": "warn", + + /** Report use of exported name as identifier of default export + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-as-default.md */ + "import/no-named-as-default": "warn", + + /** Report use of exported name as property of default export + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-as-default-member.md */ + "import/no-named-as-default-member": "warn", + + /** Report imported names marked with `@deprecated` documentation tag + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-deprecated.md */ + "import/no-deprecated": "warn", + + /** Forbid the use of extraneous packages + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md */ + "import/no-extraneous-dependencies": "warn", + + /** Forbid the use of mutable exports with `var` or `let`. + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-mutable-exports.md */ + "import/no-mutable-exports": "error", + + /** Report modules without exports, or exports without matching import in another module + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unused-modules.md */ + "import/no-unused-modules": "warn", +}; diff --git a/packages/@spscommerce/code-style-typescript/rules/imports/index.ts b/packages/@spscommerce/code-style-typescript/rules/imports/index.ts new file mode 100644 index 0000000000..6baada0c7c --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/imports/index.ts @@ -0,0 +1,4 @@ +export * from "./staticAnalysis"; +export * from "./helpfulWarnings"; +export * from "./moduleSystems"; +export * from "./styleGuide"; diff --git a/packages/@spscommerce/code-style-typescript/rules/imports/moduleSystems.ts b/packages/@spscommerce/code-style-typescript/rules/imports/moduleSystems.ts new file mode 100644 index 0000000000..48a82e13a7 --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/imports/moduleSystems.ts @@ -0,0 +1,23 @@ +import { Linter } from "eslint"; + +export const moduleSystems: Linter.RulesRecord = { + /** Report potentially ambiguous parse goal (`script` vs. `module`) + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/unambiguous.md */ + "import/unambiguous": "error", + + /** Report CommonJS `require` calls and `module.exports` or `exports.*`. + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-commonjs.md */ + "import/no-commonjs": "error", + + /** Report AMD `require` and `define` calls. + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-amd.md */ + "import/no-amd": "error", + + /** No Node.js builtin modules. + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-nodejs-modules.md */ + "import/no-nodejs-modules": "error", + + /** Forbid imports with CommonJS exports + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-import-module-exports.md */ + "import/no-import-module-exports": "error", +}; diff --git a/packages/@spscommerce/code-style-typescript/rules/imports/staticAnalysis.ts b/packages/@spscommerce/code-style-typescript/rules/imports/staticAnalysis.ts new file mode 100644 index 0000000000..c99554942b --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/imports/staticAnalysis.ts @@ -0,0 +1,59 @@ +import { Linter } from 'eslint'; + +export const staticAnalysis: Linter.RulesRecord = { + /** Ensure imports point to a file/module that can be resolved. + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unresolved.md */ + "import/no-unresolved": "error", + + /** Ensure named imports correspond to a named export in the remote file. + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/named.md */ + "import/named": "error", + + /** Ensure a default export is present, given a default import. + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/default.md */ + "import/default": "error", + + /** Ensure imported namespaces contain dereferenced properties as they are dereferenced. + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/namespace.md */ + "import/namespace": "error", + + /** Restrict which files can be imported in a given folder + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-restricted-paths.md */ + "import/no-restricted-paths": "error", + + /** Forbid import of modules using absolute paths + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-absolute-path.md */ + "import/no-absolute-path": "error", + + /** Forbid `require()` calls with expressions + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-dynamic-require.md */ + "import/no-dynamic-require": "error", + + /** Prevent importing the submodules of other modules + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-internal-modules.md */ + "import/no-internal-modules": "off", + + /** Forbid webpack loader syntax in imports + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-webpack-loader-syntax.md */ + "import/no-webpack-loader-syntax": "error", + + /** Forbid a module from importing itself + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-self-import.md */ + "import/no-self-import": "error", + + /** Forbid a module from importing a module with a dependency path back to itself + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md */ + "import/no-cycle": "error", + + /** Prevent unnecessary path segments in import and require statements + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-useless-path-segments.md */ + "import/no-useless-path-segments": "error", + + /** Forbid importing modules from parent directories + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-parent-imports.md */ + "import/no-relative-parent-imports": "off", + + /** Prevent importing packages through relative paths + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-packages.md */ + "import/no-relative-packages": "off", +}; diff --git a/packages/@spscommerce/code-style-typescript/rules/imports/styleGuide.ts b/packages/@spscommerce/code-style-typescript/rules/imports/styleGuide.ts new file mode 100644 index 0000000000..97eca2ade7 --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/imports/styleGuide.ts @@ -0,0 +1,69 @@ +import { Linter } from "eslint"; + +export const styleGuide: Linter.RulesRecord = { + /** Ensure all imports appear before other statements + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md */ + "import/first": "error", + + /** Ensure all exports appear after other statements + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md */ + "import/exports-last": "off", + + /** Report repeated import of the same module in multiple places + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-duplicates.md */ + "import/no-duplicates": "error", + + /** Forbid namespace (a.k.a. "wildcard" `*`) imports + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-namespace.md */ + "import/no-namespace": "off", + + /** Ensure consistent use of file extension within the import path + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md */ + "import/extensions": ["error", "never"], + + /** Enforce a convention in module import order + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md */ + "import/order": "error", + + /** Enforce a newline after import statements + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md */ + "import/newline-after-import": "error", + + /** Prefer a default export if module exports a single name + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/prefer-default-export.md */ + "import/prefer-default-export": "off", + + /** Limit the maximum number of dependencies a module can have + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/max-dependencies.md */ + "import/max-dependencies": "off", + + /** Forbid unassigned imports (e.g. `import 'foo';`) + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unassigned-import.md + * The general idea that importing a module shouldn't have side effects is valid, but + * there is an exception: many polyfill modules do this, so we can't really make it an error. */ + "import/no-unassigned-import": "off", + + /** Forbid named default exports + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-default.md */ + "import/no-named-default": "error", + + /** Forbid default exports + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md */ + "import/no-default-export": "off", + + /** Forbid named exports + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-export.md */ + "import/no-named-export": "off", + + /** Forbid anonymous values as default exports + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-anonymous-default-export.md */ + "import/no-anonymous-default-export": "error", + + /** Prefer named exports to be grouped together in a single export declaration + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/group-exports.md */ + "import/group-exports": "off", + + /** Enforce a leading comment with the webpackChunkName for dynamic imports + * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/dynamic-import-chunkname.md */ + "import/dynamic-import-chunkname": "off", +}; diff --git a/packages/@spscommerce/code-style-typescript/rules/possibleErrors.ts b/packages/@spscommerce/code-style-typescript/rules/possibleErrors.ts new file mode 100644 index 0000000000..61f988777e --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/possibleErrors.ts @@ -0,0 +1,183 @@ +import { PossibleErrors } from "eslint/rules/possible-errors"; + +export const possibleErrors: PossibleErrors = { + /** enforce “for” loop update clause moving the counter in the right direction + * https://eslint.org/docs/rules/for-direction */ + 'for-direction': 'error', + + /** enforce `return` statements in getters + * https://eslint.org/docs/rules/getter-return + * Off because getters and setters are forbidden */ + 'getter-return': 'off', + + /** disallow using an async function as a Promise executor + * https://eslint.org/docs/rules/no-async-promise-executor */ + 'no-async-promise-executor': 'error', + + /** 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 + * https://eslint.org/docs/rules/no-cond-assign + * 'always' bans all such assignments rather than just "ambiguous" ones */ + 'no-cond-assign': ['error', 'always'], + + /** disallow use of console + * https://eslint.org/docs/rules/no-console */ + 'no-console': 'warn', + + /** disallow use of constant expressions in conditions + * https://eslint.org/docs/rules/no-constant-condition */ + 'no-constant-condition': 'warn', + + /** disallow control characters in regular expressions + * https://eslint.org/docs/rules/no-control-regex */ + 'no-control-regex': 'error', + + /** disallow use of debugger + * https://eslint.org/docs/rules/no-debugger */ + 'no-debugger': 'error', + + /** disallow duplicate arguments in functions + * https://eslint.org/docs/rules/no-dupe-args */ + 'no-dupe-args': 'error', + + /** Disallow duplicate conditions in if-else-if chains + * https://eslint.org/docs/rules/no-dupe-else-if */ + 'no-dupe-else-if': 'error', + + /** disallow duplicate keys when creating object literals + * https://eslint.org/docs/rules/no-dupe-keys */ + 'no-dupe-keys': 'error', + + /** disallow a duplicate case label + * https://eslint.org/docs/rules/no-duplicate-case */ + 'no-duplicate-case': 'error', + + /** disallow empty statements + * https://eslint.org/docs/rules/no-empty */ + 'no-empty': 'error', + + /** disallow the use of empty character classes in regular expressions + * https://eslint.org/docs/rules/no-empty-character-class */ + 'no-empty-character-class': 'error', + + /** disallow assigning to the exception in a catch block + * https://eslint.org/docs/rules/no-ex-assign */ + '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', + + /** disallow unnecessary semicolons + * https://eslint.org/docs/rules/no-extra-semi */ + 'no-extra-semi': 'error', + + /** disallow overwriting functions written as function declarations + * https://eslint.org/docs/rules/no-func-assign */ + 'no-func-assign': 'error', + + /** disallow assigning to imported bindings + * https://eslint.org/docs/rules/no-import-assign */ + 'no-import-assign': 'error', + + /** disallow function or variable declarations in nested blocks + * https://eslint.org/docs/rules/no-inner-declarations */ + 'no-inner-declarations': 'error', + + /** disallow invalid regular expression strings in the RegExp constructor + * https://eslint.org/docs/rules/no-invalid-regexp */ + 'no-invalid-regexp': 'error', + + /** disallow irregular whitespace outside of strings and comments + * https://eslint.org/docs/rules/no-irregular-whitespace */ + 'no-irregular-whitespace': 'error', + + /** disallow literal numbers that lose precision + * https://eslint.org/docs/rules/no-loss-of-precision */ + 'no-loss-of-precision': 'error', + + /** disallow characters which are made with multiple code points in character class syntax + * https://eslint.org/docs/rules/no-misleading-character-class */ + 'no-misleading-character-class': 'error', + + /** disallow the use of object properties of the global object (Math and JSON) as functions + * https://eslint.org/docs/rules/no-obj-calls */ + 'no-obj-calls': 'error', + + /** disallow returning values from Promise executor functions + * https://eslint.org/docs/rules/no-promise-executor-return */ + 'no-promise-executor-return': 'error', + + /** disallow use of Object.prototypes builtins directly + * https://eslint.org/docs/rules/no-prototype-builtins */ + 'no-prototype-builtins': 'off', + + /** disallow multiple spaces in a regular expression literal + * https://eslint.org/docs/rules/no-regex-spaces */ + 'no-regex-spaces': 'error', + + /** disallow returning values from setters + * https://eslint.org/docs/rules/no-setter-return + * Off because getters and setters are forbidden */ + 'no-setter-return': 'off', + + /** disallow sparse arrays + * https://eslint.org/docs/rules/no-sparse-arrays + * only forbids sparse array literals, not `new Array(n)` */ + '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 + * https://eslint.org/docs/rules/no-unreachable */ + 'no-unreachable': 'error', + + /** disallow loops with a body that allows only one iteration + * https://eslint.org/docs/rules/no-unreachable-loop */ + 'no-unreachable-loop': '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 use of optional chaining in contexts where the undefined value is not allowed + * https://eslint.org/docs/rules/no-unsafe-optional-chaining */ + 'no-unsafe-optional-chaining': 'error', + + /** Disallow useless backreferences in regular expressions + * https://eslint.org/docs/rules/no-useless-backreference */ + 'no-useless-backreference': 'off', + + /** Disallow assignments that can lead to race conditions due to usage of await or yield + * https://eslint.org/docs/rules/require-atomic-updates */ + 'require-atomic-updates': 'error', + + /** disallow comparisons with the value NaN + * https://eslint.org/docs/rules/use-isnan */ + 'use-isnan': 'error', + + /** 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/@spscommerce/code-style-typescript/rules/strictMode.ts b/packages/@spscommerce/code-style-typescript/rules/strictMode.ts new file mode 100644 index 0000000000..4ca5ef023b --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/strictMode.ts @@ -0,0 +1,8 @@ +import { StrictMode } from 'eslint/rules/strict-mode'; + +export const strictMode: StrictMode = { + /** disallow the 'use strict' directive + * https://eslint.org/docs/rules/strict + * this is handled for you and does not need to be present in your source files */ + strict: ['error', 'never'], +}; diff --git a/packages/@spscommerce/code-style-typescript/rules/stylisticIssues.ts b/packages/@spscommerce/code-style-typescript/rules/stylisticIssues.ts new file mode 100644 index 0000000000..ecb315cfcd --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/stylisticIssues.ts @@ -0,0 +1,426 @@ +import { StylisticIssues } from 'eslint/rules/stylistic-issues'; + +export const stylisticIssues: StylisticIssues = { + /** enforce line breaks after opening and before closing array brackets + * https://eslint.org/docs/rules/array-bracket-newline */ + 'array-bracket-newline': ['error', 'consistent'], + + /** enforce line breaks between array elements + * https://eslint.org/docs/rules/array-element-newline */ + 'array-element-newline': ['error', { multiline: true, minItems: 3 }], + + /** enforce spacing inside array brackets + * https://eslint.org/docs/rules/array-bracket-spacing */ + '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 + * https://eslint.org/docs/rules/brace-style */ + 'brace-style': 'error', + + /** require camel case names + * https://eslint.org/docs/rules/camelcase */ + 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', + + /** require trailing commas in multiline object literals + * https://eslint.org/docs/rules/comma-dangle */ + 'comma-dangle': ['error', 'always-multiline'], + + /** enforce spacing before/after comma + * https://eslint.org/docs/rules/comma-spacing */ + 'comma-spacing': 'error', + + /** enforce one true comma style + * https://eslint.org/docs/rules/comma-style */ + 'comma-style': 'error', + + /** disallow padding inside computed properties + * https://eslint.org/docs/rules/computed-property-spacing */ + 'computed-property-spacing': 'error', + + /** enforces consistent naming when capturing the current execution context + * https://eslint.org/docs/rules/consistent-this + * doing this at all is forbidden */ + 'consistent-this': 'off', + + /** enforce newline at the end of file, with no multiple empty lines + * https://eslint.org/docs/rules/eol-last */ + 'eol-last': 'error', + + /** enforce spacing between functions and their invocations + * https://eslint.org/docs/rules/func-call-spacing */ + 'func-call-spacing': 'error', + + /** 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', + + /** require function expressions to have a name + * https://eslint.org/docs/rules/func-names */ + 'func-names': 'off', + + /** enforces use of function declarations or expressions + * https://eslint.org/docs/rules/func-style */ + 'func-style': ['off', 'expression'], + + /** enforce line breaks between arguments of a function call + * https://eslint.org/docs/rules/function-call-argument-newline */ + 'function-call-argument-newline': ['off', 'consistent'], + + /** 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', + + /** disallow specified identifiers + * https://eslint.org/docs/rules/id-denylist */ + 'id-denylist': 'off', + + /** this option enforces minimum and maximum identifier lengths (variable names, property names etc.) + * https://eslint.org/docs/rules/id-length */ + 'id-length': 'off', + + /** require identifiers to match the provided regular expression + * https://eslint.org/docs/rules/id-match */ + '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', + + /** this option sets a specific tab width for your code + * https://eslint.org/docs/rules/indent */ + indent: ['error', 2], + + /** specify whether double or single quotes should be used in JSX attributes + * https://eslint.org/docs/rules/jsx-quotes */ + 'jsx-quotes': 'error', + + /** enforces spacing between keys and values in object literal properties + * https://eslint.org/docs/rules/key-spacing */ + 'key-spacing': 'error', + + /** require a space before & after certain keywords + * https://eslint.org/docs/rules/keyword-spacing */ + 'keyword-spacing': 'error', + + /** enforce position of line comments + * https://eslint.org/docs/rules/line-comment-position */ + 'line-comment-position': 'error', + + /** disallow mixed 'LF' and 'CRLF' as linebreaks + * https://eslint.org/docs/rules/linebreak-style */ + 'linebreak-style': 'error', + + /** enforces empty lines around comments + * https://eslint.org/docs/rules/lines-around-comment */ + 'lines-around-comment': 'off', + + /** require or disallow an empty line between class members + * https://eslint.org/docs/rules/lines-between-class-members */ + 'lines-between-class-members': 'error', + + /** specify the maximum depth that blocks can be nested + * https://eslint.org/docs/rules/max-depth */ + 'max-depth': 'warn', + + /** specify the maximum length of a line in your program + * https://eslint.org/docs/rules/max-len */ + 'max-len': [ + 'error', + { + code: 100, + tabWidth: 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', + + /** enforce a maximum function length + * https://eslint.org/docs/rules/max-lines-per-function */ + 'max-lines-per-function': 'off', + + /** specify the maximum depth callbacks can be nested + * https://eslint.org/docs/rules/max-nested-callbacks */ + 'max-nested-callbacks': 'off', + + /** limits the number of parameters that can be used in the function declaration. + * https://eslint.org/docs/rules/max-params */ + 'max-params': 'off', + + /** specify the maximum number of statement allowed in a function + * https://eslint.org/docs/rules/max-statements */ + 'max-statements': 'off', + + /** restrict the number of statements per line + * https://eslint.org/docs/rules/max-statements-per-line */ + 'max-statements-per-line': 'off', + + /** enforce a particular style for multiline comments + * https://eslint.org/docs/rules/multiline-comment-style */ + 'multiline-comment-style': 'error', + + /** require multiline ternary + * https://eslint.org/docs/rules/multiline-ternary */ + 'multiline-ternary': 'off', + + /** require a capital letter for constructors + * https://eslint.org/docs/rules/new-cap */ + 'new-cap': 'error', + + /** disallow the omission of parentheses when invoking a constructor with no arguments + * https://eslint.org/docs/rules/new-parens */ + 'new-parens': 'error', + + /** 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', + + /** disallow use of the Array constructor + * https://eslint.org/docs/rules/no-array-constructor */ + 'no-array-constructor': 'error', + + /** disallow use of bitwise operators + * https://eslint.org/docs/rules/no-bitwise */ + 'no-bitwise': 'warn', + + /** disallow use of the continue statement + * https://eslint.org/docs/rules/no-continue */ + 'no-continue': 'error', + + /** disallow comments inline after code + * https://eslint.org/docs/rules/no-inline-comments */ + 'no-inline-comments': 'error', + + /** 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', + + /** disallow mixed spaces and tabs for indentation + * https://eslint.org/docs/rules/no-mixed-spaces-and-tabs */ + '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, only one newline at the end, and no new lines at the beginning + * https://eslint.org/docs/rules/no-multiple-empty-lines */ + 'no-multiple-empty-lines': ['error', { max: 1, maxBOF: 0, maxEOF: 0 }], + + /** disallow negated conditions + * https://eslint.org/docs/rules/no-negated-condition */ + 'no-negated-condition': 'off', + + /** disallow nested ternary expressions + * https://eslint.org/docs/rules/no-nested-ternary */ + 'no-nested-ternary': 'error', + + /** disallow use of the Object constructor + * https://eslint.org/docs/rules/no-new-object */ + '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 are disallowed. (https://github.com/SPSCommerce/javascript#iterators--no-for-in)', + }, + { + selector: 'LabeledStatement', + message: 'Labeled statements are disallowed. (https://github.com/SPSCommerce/javascript#control-statements--value-selection)', + }, + ], + + /** disallow tab characters entirely + * https://eslint.org/docs/rules/no-tabs */ + 'no-tabs': 'error', + + /** disallow the use of ternary operators + * https://eslint.org/docs/rules/no-ternary */ + 'no-ternary': 'off', + + /** disallow trailing whitespace at the end of lines + * https://eslint.org/docs/rules/no-trailing-spaces */ + 'no-trailing-spaces': 'error', + + /** disallow dangling underscores in identifiers + * https://eslint.org/docs/rules/no-underscore-dangle */ + 'no-underscore-dangle': ['error', { enforceInMethodNames: true }], + + /** 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', + + /** enforce line breaks between braces + * https://eslint.org/docs/rules/object-curly-newline */ + 'object-curly-newline': [ + 'error', + { + minProperties: 4, + multiline: true, + consistent: true, + }, + ], + + /** require padding inside curly braces + * https://eslint.org/docs/rules/object-curly-spacing */ + 'object-curly-spacing': ['error', 'always'], + + /** 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 variable declaration per function + * https://eslint.org/docs/rules/one-var + * nb: despite 'var' being in the name, does apply to let and const */ + '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', + + /** 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 + * https://eslint.org/docs/rules/padded-blocks */ + 'padded-blocks': [ + 'error', + { + blocks: 'never', + classes: 'never', + switches: 'never', + }, + { + allowSingleLineBlocks: true, + }, + ], + + /** Require or disallow padding lines between statements + * https://eslint.org/docs/rules/padding-line-between-statements */ + 'padding-line-between-statements': 'off', + + /** Disallow the use of Math.pow in favor of the ** operator + * https://eslint.org/docs/rules/prefer-exponentiation-operator */ + 'prefer-exponentiation-operator': 'off', + + /** Prefer use of an object spread over Object.assign + * https://eslint.org/docs/rules/prefer-object-spread */ + 'prefer-object-spread': 'error', + + /** require quotes around object literal property names + * https://eslint.org/docs/rules/quote-props */ + 'quote-props': ['error', 'as-needed', { keywords: false, numbers: false }], + + /** specify whether double or single quotes should be used + * https://eslint.org/docs/rules/quotes */ + quotes: ['error', 'double', { avoidEscape: true }], + + /** require or disallow use of semicolons instead of ASI + * https://eslint.org/docs/rules/ */ + semi: 'error', + + /** enforce spacing before and after semicolons + * https://eslint.org/docs/rules/semi-spacing */ + 'semi-spacing': 'error', + + /** Enforce location of semicolons + * https://eslint.org/docs/rules/semi-style */ + 'semi-style': 'error', + + /** requires object keys to be sorted + * https://eslint.org/docs/rules/sort-keys */ + 'sort-keys': 'off', + + /** sort variables within the same declaration block + * https://eslint.org/docs/rules/sort-vars */ + 'sort-vars': 'off', + + /** require or disallow space before blocks + * https://eslint.org/docs/rules/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 + * https://eslint.org/docs/rules/space-in-parens */ + 'space-in-parens': 'error', + + /** require spaces around operators + * https://eslint.org/docs/rules/space-infix-ops */ + 'space-infix-ops': 'error', + + /** Require or disallow spaces before/after unary operators + * https://eslint.org/docs/rules/space-unary-ops */ + 'space-unary-ops': 'error', + + /** require or disallow a space immediately following the // or /* in a comment + * https://eslint.org/docs/rules/spaced-comment */ + 'spaced-comment': 'error', + + /** Enforce spacing around colons of switch statements + * https://eslint.org/docs/rules/switch-colon-spacing */ + 'switch-colon-spacing': 'error', + + /** Require or disallow spacing between template tags and their literals + * https://eslint.org/docs/rules/template-tag-spacing */ + 'template-tag-spacing': 'error', + + /** require or disallow the Unicode Byte Order Mark + * https://eslint.org/docs/rules/unicode-bom */ + 'unicode-bom': 'error', + + /** require regex literals to be wrapped in parentheses + * https://eslint.org/docs/rules/wrap-regex */ + 'wrap-regex': 'off' +}; diff --git a/packages/@spscommerce/code-style-typescript/rules/variables.ts b/packages/@spscommerce/code-style-typescript/rules/variables.ts new file mode 100644 index 0000000000..74b1485fa8 --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/rules/variables.ts @@ -0,0 +1,63 @@ +import { Variables } from 'eslint/rules/variables'; + +export const variables: Variables = { + /** enforce or disallow variable initializations at definition + * https://eslint.org/docs/rules/init-declarations */ + 'init-declarations': 'off', + + /** disallow the catch clause parameter name being the same as a variable in the outer scope + * https://eslint.org/docs/rules/no-catch-shadow */ + 'no-catch-shadow': 'off', + + /** disallow deletion of variables + * https://eslint.org/docs/rules/no-delete-var */ + '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 + * https://eslint.org/docs/rules/no-restricted-globals */ + 'no-restricted-globals': [ + 'error', + { + name: 'isFinite', + message: + 'Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite', + }, + { + name: 'isNaN', + message: + 'Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan', + }, + ], + + /** disallow declaration of variables already declared in the outer scope + * https://eslint.org/docs/rules/no-shadow */ + 'no-shadow': 'error', + + /** disallow shadowing of names such as arguments + * https://eslint.org/docs/rules/no-shadow-restricted-names */ + 'no-shadow-restricted-names': 'error', + + /** disallow use of undeclared variables unless mentioned in `/*global ` comments + * https://eslint.org/docs/rules/no-undef */ + 'no-undef': 'error', + + /** disallow use of undefined when initializing variables + * https://eslint.org/docs/rules/no-undef-init */ + 'no-undef-init': 'error', + + /** disallow use of undefined variable + * https://eslint.org/docs/rules/no-undefined */ + 'no-undefined': 'off', + + /** disallow declaration of variables that are not used in the code + * https://eslint.org/docs/rules/no-unused-vars */ + 'no-unused-vars': ['error', { ignoreRestSiblings: true }], + + /** disallow use of variables before they are defined + * https://eslint.org/docs/rules/no-use-before-define */ + 'no-use-before-define': 'error', +}; diff --git a/packages/@spscommerce/code-style-typescript/tsconfig.json b/packages/@spscommerce/code-style-typescript/tsconfig.json new file mode 100644 index 0000000000..a4f67a5904 --- /dev/null +++ b/packages/@spscommerce/code-style-typescript/tsconfig.json @@ -0,0 +1,15 @@ +{ + "$schema": "https://json.schemastore.org/tsconfig", + "display": "Node 14", + + "compilerOptions": { + "lib": ["es2020"], + "module": "commonjs", + "target": "es2020", + + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true + } +} diff --git a/packages/eslint-config-airbnb-base/.babelrc b/packages/eslint-config-airbnb-base/.babelrc deleted file mode 100644 index e0aceaae1c..0000000000 --- a/packages/eslint-config-airbnb-base/.babelrc +++ /dev/null @@ -1,3 +0,0 @@ -{ - "presets": ["airbnb"] -} diff --git a/packages/eslint-config-airbnb-base/.editorconfig b/packages/eslint-config-airbnb-base/.editorconfig deleted file mode 120000 index 1b3ce07def..0000000000 --- a/packages/eslint-config-airbnb-base/.editorconfig +++ /dev/null @@ -1 +0,0 @@ -../../.editorconfig \ No newline at end of file diff --git a/packages/eslint-config-airbnb-base/.eslintrc b/packages/eslint-config-airbnb-base/.eslintrc deleted file mode 100644 index 7606a50a46..0000000000 --- a/packages/eslint-config-airbnb-base/.eslintrc +++ /dev/null @@ -1,10 +0,0 @@ -{ - "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, - - "max-len": 0, - }, -} diff --git a/packages/eslint-config-airbnb-base/.npmrc b/packages/eslint-config-airbnb-base/.npmrc deleted file mode 120000 index cba44bb384..0000000000 --- a/packages/eslint-config-airbnb-base/.npmrc +++ /dev/null @@ -1 +0,0 @@ -../../.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 deleted file mode 100644 index 5f8dddf100..0000000000 --- a/packages/eslint-config-airbnb-base/CHANGELOG.md +++ /dev/null @@ -1,355 +0,0 @@ -14.2.1 / 2020-11-06 -================== - - [base] `no-restricted-globals`: add better messages (#2320) - - [base] add new core eslint rules, set to off - - [deps] update `confusing-browser-globals`, `object.assign` - - [deps] update `eslint-plugin-import`, use valid `import/no-cycle` `maxDepth` option (#2250, #2249) - - [dev deps] update `@babel/runtime`, `eslint-find-rules`, `eslint-plugin-import` - -14.2.0 / 2020-06-10 -================== - - [new] add `eslint` `v7` - - [minor] Disallow multiple empty lines (#2238) - - [minor] Fix typo in no-multiple-empty-lines rule (#2168) - - [patch] Include 'context' exception for `no-param-reassign` (#2230) - - [patch] Allow triple-slash (///) comments (#2197) - - [patch] Disable `prefer-object-spread` for `airbnb-base/legacy` (#2198) - - [deps] update `eslint-plugin-import`, `eslint-plugin-react`, `babel-preset-airbnb`, `eslint-find-rules`, `in-publish`, `tape`, `object.entries` - -14.1.0 / 2020-03-12 -================== - - [minor] add new disabled rules, update eslint - - [minor] enable `import/no-useless-path-segments` for commonjs (#2113) - - [fix] `whitespace`: only set erroring rules to "warn" - - Fix indentation with JSX Fragments (#2157) - - [patch] `import/no-extraneous-dependencies`: Support karma config files (#2121) - - [readme] normalize multiline word according to merriam-webster (#2138) - - [deps] update `eslint`, `eslint-plugin-import`, `eslint-plugin-react`, `object.entries`, `confusing-browser-globals` - - [dev deps] update `@babel/runtime`, `babel-preset-airbnb`, `safe-publish-latest`, `tape` - - [tests] re-enable eslint rule `prefer-destructuring` internally (#2110) - -14.0.0 / 2019-08-09 -================== - - [breaking] `no-self-assign`: enable `props` option - - [breaking] enable `no-useless-catch` - - [breaking] enable `max-classes-per-file` - - [breaking] enable `no-misleading-character-class` - - [breaking] enable `no-async-promise-executor` - - [breaking] enable `prefer-object-spread` - - [breaking] `func-name-matching`: enable `considerPropertyDescriptor` option - - [breaking] `padded-blocks`: enable `allowSingleLineBlocks` option (#1255) - - [breaking] `no-multiple-empty-lines`: Restrict empty lines at beginning of file (#2042) - - [breaking] Set 'strict' to 'never' (#1962) - - [breaking] legacy: Enable 'strict' (#1962) - - [breaking] Simplifies `no-mixed-operators` (#1864) - - [breaking] Require parens for arrow function args (#1863) - - [breaking] add eslint v6, drop eslint v4 - - [patch] `camelcase`: enable ignoreDestructuring - - [patch] Add markers to spaced-comment block for Flow types (#1966) - - [patch] Do not prefer destructuring for object assignment expression (#1583) - - [deps] update `confusing-browser-globals`, `eslint-plugin-import`, `tape`, `babel-preset-airbnb` - - [dev deps] update babel-related deps to latest - - [dev deps] update `eslint-find-rules`, `eslint-plugin-import` - - [tests] only run tests in non-lint per-package travis job - - [tests] use `eclint` instead of `editorconfig-tools` - -13.2.0 / 2019-07-01 -================== - - [minor] Enforce dangling underscores in method names (#1907) - - [fix] disable `no-var` in legacy entry point - - [patch] Ignore property modifications of `staticContext` params (#2029) - - [patch] `no-extraneous-dependencies`: Add jest.setup.js to devDeps (#1998) - - [meta] add disabled `prefer-named-capture-group` rule - - [meta] add disabled `no-useless-catch` config - - [deps] Switch to confusing-browser-globals (#1961) - - [deps] update `object.entries`, `eslint-plugin-import`, `eslint-plugin-jsx-a11y`, `eslint-plugin-react`, `tape` - - [docs] correct JavaScript capitalization (#2046) - - [readme] Improve eslint config setup instructions for yarn (#2001) - - [docs] fix docs for whitespace config (#1914, #1871) - -13.1.0 / 2018-08-13 -================== - - [new] add eslint v5 support (#1834) - - [deps] update `eslint-plugin-import`, `eslint`, `babel-preset-airbnb`, `safe-publish-latest`, `eslint-find-rules` - - [docs] fix typo in readme (#1855) - - [new] update base ecmaVersion to 2018; remove deprecated experimentalObjectRestSpread option - -13.0.0 / 2018-06-21 -================== - - [breaking] order of import statements is ignored for unassigned imports (#1782) - - [breaking] enable `import/no-cycle`: warn on cyclical dependencies (#1779) - - [breaking] Change import/no-self-import from "off" to "error" (#1770) - - [breaking] Update `object-curly-newline` to match eslint 4.18.0 (#1761) - - [breaking] enable `no-useless-path-segments` (#1743) - - [breaking] Prevent line breaks before and after `=` (#1710) - - [breaking] Add .mjs extension support (#1634) - - [breaking] enable `implicit-arrow-linebreak` - - [breaking] Enables `nonblock-statement-body-position` rule and adds link to guide (#1618) - - [breaking] `no-mixed-operators`: only warn on `**` and `%` mixed with arithmetic operators; removes violation against mixing common math operators. (#1611) - - [breaking] `import/named`: enable - - [breaking] `lines-between-class-members`: set to “always” - - [breaking] `no-else-return`: disallow else-if (#1595) - - [breaking] Enables eslint rule for operator-linebreak - - [new] Adds config entry point with only whitespace rules enabled (#1749, #1751) - - [minor] only allow one newline at the end (#1794) - - [patch] Adjust imports for vue-cli (#1809) - - [patch] Allow devDependencies for `foo_spec.js` naming style (#1732) - - [patch] `function-paren-newline`: change to "consistent" - - [patch] avoid `__mocks__` `no-extraneous-dependencies` check (#1772) - - [patch] Include 'accumulator' exception for `no-param-reassign` (#1768) - - [patch] Set import/extensions to ignorePackages (#1652) - - [patch] properly ignore indentation on jsx - - [patch] `array-callback-return`: enable `allowImplicit` option (#1668) - - [deps] update `eslint`, `eslint-plugin-import` - - [dev deps] update `babel-preset-airbnb`, `tape`, `eslint-find-rules` - - [meta] add ES2015-2018 in npm package keywords (#1587) - - [meta] Add licenses to sub packages (#1746) - - [docs] add `npx` shortcut (#1694) - - [docs] Use HTTPS for links to ESLint documentation (#1628) - - [tests] ensure all entry points parse - -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 deleted file mode 100644 index 69d80c0252..0000000000 --- a/packages/eslint-config-airbnb-base/LICENSE.md +++ /dev/null @@ -1,21 +0,0 @@ -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 deleted file mode 100644 index 685e50060b..0000000000 --- a/packages/eslint-config-airbnb-base/README.md +++ /dev/null @@ -1,99 +0,0 @@ -# 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`. - -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 **yarn**, you can also use the shortcut described above if you have npm 5+ installed on your machine, as the command will detect that you are using yarn and will act accordingly. - Otherwise, 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. - - - 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 only errors 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 deleted file mode 100644 index 825456b8a4..0000000000 --- a/packages/eslint-config-airbnb-base/index.js +++ /dev/null @@ -1,17 +0,0 @@ -module.exports = { - extends: [ - './rules/best-practices', - './rules/errors', - './rules/node', - './rules/style', - './rules/variables', - './rules/es6', - './rules/imports', - './rules/strict', - ].map(require.resolve), - parserOptions: { - ecmaVersion: 2018, - sourceType: 'module', - }, - rules: {}, -}; diff --git a/packages/eslint-config-airbnb-base/legacy.js b/packages/eslint-config-airbnb-base/legacy.js deleted file mode 100644 index e5c9089c75..0000000000 --- a/packages/eslint-config-airbnb-base/legacy.js +++ /dev/null @@ -1,34 +0,0 @@ -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.', - }], - 'no-var': 'off', - 'prefer-object-spread': 'off', - strict: ['error', 'safe'], - } -}; diff --git a/packages/eslint-config-airbnb-base/package.json b/packages/eslint-config-airbnb-base/package.json deleted file mode 100644 index 4da8fcd9bc..0000000000 --- a/packages/eslint-config-airbnb-base/package.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "name": "eslint-config-airbnb-base", - "version": "14.2.1", - "description": "Airbnb's base JS ESLint config, following our styleguide", - "main": "index.js", - "scripts": { - "prelint": "eclint 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 tests-only", - "posttravis": ":" - }, - "repository": { - "type": "git", - "url": "https://github.com/airbnb/javascript" - }, - "keywords": [ - "eslint", - "eslintconfig", - "config", - "airbnb", - "javascript", - "styleguide", - "es2015", - "es2016", - "es2017", - "es2018" - ], - "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/runtime": "^7.14.6", - "babel-preset-airbnb": "^4.5.0", - "babel-tape-runner": "^3.0.0", - "eclint": "^2.8.1", - "eslint": "^5.16.0 || ^6.8.0 || ^7.2.0", - "eslint-find-rules": "^3.6.1", - "eslint-plugin-import": "^2.23.4", - "in-publish": "^2.0.1", - "safe-publish-latest": "^1.1.4", - "tape": "^5.2.2" - }, - "peerDependencies": { - "eslint": "^5.16.0 || ^6.8.0 || ^7.2.0", - "eslint-plugin-import": "^2.23.4" - }, - "engines": { - "node": ">= 6" - }, - "dependencies": { - "confusing-browser-globals": "^1.0.10", - "object.assign": "^4.1.2", - "object.entries": "^1.1.4" - } -} diff --git a/packages/eslint-config-airbnb-base/rules/best-practices.js b/packages/eslint-config-airbnb-base/rules/best-practices.js deleted file mode 100644 index deb91cfb01..0000000000 --- a/packages/eslint-config-airbnb-base/rules/best-practices.js +++ /dev/null @@ -1,412 +0,0 @@ -module.exports = { - rules: { - // enforces getter/setter pairs in objects - // https://eslint.org/docs/rules/accessor-pairs - '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 - // https://eslint.org/docs/rules/block-scoped-var - 'block-scoped-var': 'error', - - // specify the maximum cyclomatic complexity allowed in a program - // https://eslint.org/docs/rules/complexity - complexity: ['off', 20], - - // 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 - // https://eslint.org/docs/rules/consistent-return - 'consistent-return': 'error', - - // specify curly brace conventions for all control statements - // https://eslint.org/docs/rules/curly - curly: ['error', 'multi-line'], // multiline - - // require default case in switch statements - // https://eslint.org/docs/rules/default-case - 'default-case': ['error', { commentPattern: '^no default$' }], - - // Enforce default clauses in switch statements to be last - // https://eslint.org/docs/rules/default-case-last - // TODO: enable, semver-minor, when eslint v7 is required (which is a major) - 'default-case-last': 'off', - - // https://eslint.org/docs/rules/default-param-last - // TODO: enable, semver-minor, when eslint v6.4 is required (which is a major) - 'default-param-last': 'off', - - // encourages use of dot notation whenever possible - // https://eslint.org/docs/rules/dot-notation - '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' }], - - // Require grouped accessor pairs in object literals and classes - // https://eslint.org/docs/rules/grouped-accessor-pairs - // TODO: enable in next major, altho the guide forbids getters/setters anyways - 'grouped-accessor-pairs': 'off', - - // make sure for-in loops have an if statement - // https://eslint.org/docs/rules/guard-for-in - 'guard-for-in': 'error', - - // enforce a maximum number of classes per file - // https://eslint.org/docs/rules/max-classes-per-file - 'max-classes-per-file': ['error', 1], - - // disallow the use of alert, confirm, and prompt - // https://eslint.org/docs/rules/no-alert - 'no-alert': 'warn', - - // disallow use of arguments.caller or arguments.callee - // https://eslint.org/docs/rules/no-caller - 'no-caller': 'error', - - // disallow lexical declarations in case/default clauses - // https://eslint.org/docs/rules/no-case-declarations - 'no-case-declarations': 'error', - - // Disallow returning value in constructor - // https://eslint.org/docs/rules/no-constructor-return - // TODO: enable, semver-major - 'no-constructor-return': 'off', - - // 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 - // https://eslint.org/docs/rules/no-eq-null - 'no-eq-null': 'off', - - // disallow use of eval() - // https://eslint.org/docs/rules/no-eval - 'no-eval': 'error', - - // disallow adding to native types - // https://eslint.org/docs/rules/no-extend-native - 'no-extend-native': 'error', - - // disallow unnecessary function binding - // https://eslint.org/docs/rules/no-extra-bind - 'no-extra-bind': 'error', - - // disallow Unnecessary Labels - // https://eslint.org/docs/rules/no-extra-label - 'no-extra-label': 'error', - - // disallow fallthrough of case statements - // https://eslint.org/docs/rules/no-fallthrough - 'no-fallthrough': 'error', - - // disallow the use of leading or trailing decimal points in numeric literals - // https://eslint.org/docs/rules/no-floating-decimal - '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 - // https://eslint.org/docs/rules/no-native-reassign - '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 - // https://eslint.org/docs/rules/no-implied-eval - 'no-implied-eval': 'error', - - // disallow this keywords outside of classes or class-like objects - // https://eslint.org/docs/rules/no-invalid-this - 'no-invalid-this': 'off', - - // disallow usage of __iterator__ property - // https://eslint.org/docs/rules/no-iterator - 'no-iterator': 'error', - - // disallow use of labels for anything other than loops and switches - // https://eslint.org/docs/rules/no-labels - 'no-labels': ['error', { allowLoop: false, allowSwitch: false }], - - // disallow unnecessary nested blocks - // https://eslint.org/docs/rules/no-lone-blocks - 'no-lone-blocks': 'error', - - // disallow creation of functions within loops - // https://eslint.org/docs/rules/no-loop-func - '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 - // https://eslint.org/docs/rules/no-multi-spaces - 'no-multi-spaces': ['error', { - ignoreEOLComments: false, - }], - - // disallow use of multiline strings - // https://eslint.org/docs/rules/no-multi-str - 'no-multi-str': 'error', - - // disallow use of new operator when not part of the assignment or comparison - // https://eslint.org/docs/rules/no-new - 'no-new': 'error', - - // disallow use of new operator for Function object - // https://eslint.org/docs/rules/no-new-func - 'no-new-func': 'error', - - // disallows creating new instances of String, Number, and Boolean - // https://eslint.org/docs/rules/no-new-wrappers - 'no-new-wrappers': 'error', - - // Disallow \8 and \9 escape sequences in string literals - // https://eslint.org/docs/rules/no-nonoctal-decimal-escape - // todo: semver-major: enable when v7.14 is required - 'no-nonoctal-decimal-escape': 'off', - - // disallow use of (old style) octal literals - // https://eslint.org/docs/rules/no-octal - 'no-octal': 'error', - - // disallow use of octal escape sequences in string literals, such as - // var foo = 'Copyright \251'; - // https://eslint.org/docs/rules/no-octal-escape - '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 - 'context', // for Koa routing - 'req', // for Express requests - 'request', // for Express requests - 'res', // for Express responses - 'response', // for Express responses - '$scope', // for Angular 1 scopes - 'staticContext', // for ReactRouter context - ] - }], - - // disallow usage of __proto__ property - // https://eslint.org/docs/rules/no-proto - 'no-proto': 'error', - - // disallow declaring the same variable more than once - // https://eslint.org/docs/rules/no-redeclare - '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 - // https://eslint.org/docs/rules/no-return-assign - 'no-return-assign': ['error', 'always'], - - // disallow redundant `return await` - // https://eslint.org/docs/rules/no-return-await - 'no-return-await': 'error', - - // disallow use of `javascript:` urls. - // https://eslint.org/docs/rules/no-script-url - 'no-script-url': 'error', - - // disallow self assignment - // https://eslint.org/docs/rules/no-self-assign - 'no-self-assign': ['error', { - props: true, - }], - - // disallow comparisons where both sides are exactly the same - // https://eslint.org/docs/rules/no-self-compare - 'no-self-compare': 'error', - - // disallow use of comma operator - // https://eslint.org/docs/rules/no-sequences - 'no-sequences': 'error', - - // restrict what can be thrown as an exception - // https://eslint.org/docs/rules/no-throw-literal - '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 - // https://eslint.org/docs/rules/no-unused-expressions - '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() - // https://eslint.org/docs/rules/no-useless-call - 'no-useless-call': 'off', - - // Disallow unnecessary catch clauses - // https://eslint.org/docs/rules/no-useless-catch - 'no-useless-catch': 'error', - - // 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 - // https://eslint.org/docs/rules/no-warning-comments - 'no-warning-comments': ['off', { terms: ['todo', 'fixme', 'xxx'], location: 'start' }], - - // disallow use of the with statement - // https://eslint.org/docs/rules/no-with - '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 }], - - // Suggest using named capture group in regular expression - // https://eslint.org/docs/rules/prefer-named-capture-group - 'prefer-named-capture-group': 'off', - - // https://eslint.org/docs/rules/prefer-regex-literals - // TODO; enable, semver-minor, once eslint v6.4 is required (which is a major) - 'prefer-regex-literals': 'off', - - // require use of the second argument for parseInt() - // https://eslint.org/docs/rules/radix - 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', - - // Enforce the use of u flag on RegExp - // https://eslint.org/docs/rules/require-unicode-regexp - 'require-unicode-regexp': 'off', - - // requires to declare all vars on top of their containing scope - // https://eslint.org/docs/rules/vars-on-top - '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 - // https://eslint.org/docs/rules/yoda - yoda: 'error' - } -}; diff --git a/packages/eslint-config-airbnb-base/rules/errors.js b/packages/eslint-config-airbnb-base/rules/errors.js deleted file mode 100644 index 71ebcdecc6..0000000000 --- a/packages/eslint-config-airbnb-base/rules/errors.js +++ /dev/null @@ -1,182 +0,0 @@ -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 using an async function as a Promise executor - // https://eslint.org/docs/rules/no-async-promise-executor - 'no-async-promise-executor': 'error', - - // 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 conditions in if-else-if chains - // https://eslint.org/docs/rules/no-dupe-else-if - // TODO: enable, semver-major - 'no-dupe-else-if': 'off', - - // 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', - - // https://eslint.org/docs/rules/no-import-assign - // TODO: enable, semver-minor, once eslint v6.4 is required (which is a major) - 'no-import-assign': 'off', - - // 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 Number Literals That Lose Precision - // https://eslint.org/docs/rules/no-loss-of-precision - // TODO: enable, semver-minor, once eslint v7.1 is required (which is major) - 'no-loss-of-precision': 'off', - - // Disallow characters which are made with multiple code points in character class syntax - // https://eslint.org/docs/rules/no-misleading-character-class - 'no-misleading-character-class': 'error', - - // disallow the use of object properties of the global object (Math and JSON) as functions - 'no-obj-calls': 'error', - - // Disallow returning values from Promise executor functions - // https://eslint.org/docs/rules/no-promise-executor-return - // TODO: enable, semver-minor, once eslint v7.3 is required (which is major) - 'no-promise-executor-return': 'off', - - // 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 returning values from setters - // https://eslint.org/docs/rules/no-setter-return - // TODO: enable, semver-major (altho the guide forbids getters/setters already) - 'no-setter-return': 'off', - - // 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 loops with a body that allows only one iteration - // https://eslint.org/docs/rules/no-unreachable-loop - // TODO: enable, semver-minor, once eslint v7.3 is required (which is major) - 'no-unreachable-loop': ['off', { - ignore: [], // WhileStatement, DoWhileStatement, ForStatement, ForInStatement, ForOfStatement - }], - - // 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 use of optional chaining in contexts where the undefined value is not allowed - // https://eslint.org/docs/rules/no-unsafe-optional-chaining - // TODO: enable, semver-minor, once eslint v7.15 is required (which is major) - 'no-unsafe-optional-chaining': ['off', { disallowArithmeticOperators: true }], - - // Disallow useless backreferences in regular expressions - // https://eslint.org/docs/rules/no-useless-backreference - // TODO: enable, semver-minor, once eslint v7 is required (which is major) - 'no-useless-backreference': 'off', - - // disallow negation of the left operand of an in expression - // deprecated in favor of no-unsafe-negation - 'no-negated-in-lhs': 'off', - - // Disallow assignments that can lead to race conditions due to usage of await or yield - // https://eslint.org/docs/rules/require-atomic-updates - // note: not enabled because it is very buggy - 'require-atomic-updates': '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 deleted file mode 100644 index 835afdd319..0000000000 --- a/packages/eslint-config-airbnb-base/rules/es6.js +++ /dev/null @@ -1,186 +0,0 @@ -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', 'always'], - - // 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 specified names in exports - // https://eslint.org/docs/rules/no-restricted-exports - // TODO enable, semver-minor, once eslint v7 is required (which is major) - 'no-restricted-exports': ['off', { - restrictedNamedExports: [ - 'default', // use `export default` to provide a default export - 'then', // this will cause tons of confusion when your module is dynamically `import()`ed - ], - }], - - // 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: false, - }, - }, { - 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 syntax 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, - ignoreDeclarationSort: 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 deleted file mode 100644 index f3a477b4b5..0000000000 --- a/packages/eslint-config-airbnb-base/rules/imports.js +++ /dev/null @@ -1,275 +0,0 @@ -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 - '**/jest.setup.js', // jest setup - '**/vue.config.js', // vue-cli 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 - '**/karma.conf.js', // karma config - '**/.eslintrc.js' // eslint 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', - - // 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', - }], - - // ensure absolute imports are above relative imports and that unassigned imports are ignored - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md - // TODO: enforce a stricter convention in module import order? - 'import/order': ['error', { groups: [['builtin', 'external', 'internal']] }], - - // 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', - - // Prohibit named exports. this is a terrible rule, do not use it. - // https://github.com/benmosher/eslint-plugin-import/blob/1ec80fa35fa1819e2d35a70e68fb6a149fb57c5e/docs/rules/no-named-export.md - 'import/no-named-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: '∞' }], - - // 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', { commonjs: true }], - - // 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-_/.]+', - }], - - // Use this rule to prevent imports to folders in relative parent paths. - // https://github.com/benmosher/eslint-plugin-import/blob/c34f14f67f077acd5a61b3da9c0b0de298d20059/docs/rules/no-relative-parent-imports.md - 'import/no-relative-parent-imports': 'off', - - // Reports modules without any exports, or with unused exports - // https://github.com/benmosher/eslint-plugin-import/blob/f63dd261809de6883b13b6b5b960e6d7f42a7813/docs/rules/no-unused-modules.md - // TODO: enable, semver-major - 'import/no-unused-modules': ['off', { - ignoreExports: [], - missingExports: true, - unusedExports: true, - }], - - // Reports the use of import declarations with CommonJS exports in any module except for the main module. - // https://github.com/benmosher/eslint-plugin-import/blob/1012eb951767279ce3b540a4ec4f29236104bb5b/docs/rules/no-import-module-exports.md - // TODO: enable, semver-major - 'import/no-import-module-exports': ['off', { - exceptions: [], - }], - - // Use this rule to prevent importing packages through relative paths. - // https://github.com/benmosher/eslint-plugin-import/blob/1012eb951767279ce3b540a4ec4f29236104bb5b/docs/rules/no-relative-packages.md - // TODO: enable, semver-major - 'import/no-relative-packages': 'off', - }, -}; diff --git a/packages/eslint-config-airbnb-base/rules/node.js b/packages/eslint-config-airbnb-base/rules/node.js deleted file mode 100644 index b178d7f909..0000000000 --- a/packages/eslint-config-airbnb-base/rules/node.js +++ /dev/null @@ -1,43 +0,0 @@ -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 deleted file mode 100644 index 67cfd5e8a3..0000000000 --- a/packages/eslint-config-airbnb-base/rules/strict.js +++ /dev/null @@ -1,6 +0,0 @@ -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 deleted file mode 100644 index c988fe5f3a..0000000000 --- a/packages/eslint-config-airbnb-base/rules/style.js +++ /dev/null @@ -1,533 +0,0 @@ -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', ignoreDestructuring: false }], - - // 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'], - - // https://eslint.org/docs/rules/function-call-argument-newline - // TODO: enable, semver-minor, once eslint v6.2 is required (which is a major) - 'function-call-argument-newline': ['off', 'consistent'], - - // 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, - considerPropertyDescriptor: true, - }], - - // 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 - // TODO: semver-major, remove once eslint v7.4+ is required - 'id-blacklist': 'off', - - // disallow specified identifiers - // https://eslint.org/docs/rules/id-denylist - 'id-denylist': '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', 'JSXFragment', 'JSXOpeningFragment', 'JSXClosingFragment', '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 - }], - - // enforce a maximum function length - // https://eslint.org/docs/rules/max-lines-per-function - 'max-lines-per-function': ['off', { - max: 50, - skipBlankLines: true, - skipComments: true, - IIFEs: 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 arithmetic groups disallows mixing `%` and `**` - // with other arithmetic operators. - groups: [ - ['%', '**'], - ['%', '+'], - ['%', '-'], - ['%', '*'], - ['%', '/'], - ['/', '*'], - ['&', '|', '<<', '>>', '>>>'], - ['==', '!=', '===', '!=='], - ['&&', '||'], - ], - 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, only one newline at the end, and no new lines at the beginning - // https://eslint.org/docs/rules/no-multiple-empty-lines - 'no-multiple-empty-lines': ['error', { max: 1, maxBOF: 0, 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 - // https://eslint.org/docs/rules/no-underscore-dangle - 'no-underscore-dangle': ['error', { - allow: [], - allowAfterThis: false, - allowAfterSuper: false, - enforceInMethodNames: true, - }], - - // 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', - }, { - allowSingleLineBlocks: true, - }], - - // Require or disallow padding lines between statements - // https://eslint.org/docs/rules/padding-line-between-statements - 'padding-line-between-statements': 'off', - - // Disallow the use of Math.pow in favor of the ** operator - // https://eslint.org/docs/rules/prefer-exponentiation-operator - // TODO: enable, semver-major when eslint 5 is dropped - 'prefer-exponentiation-operator': 'off', - - // Prefer use of an object spread over Object.assign - // https://eslint.org/docs/rules/prefer-object-spread - 'prefer-object-spread': 'error', - - // 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, slash for TS /// comments - }, - block: { - exceptions: ['-', '+'], - markers: ['=', '!', ':', '::'], // space here to support sprockets directives and flow comment types - 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 deleted file mode 100644 index 6fb98bcfb6..0000000000 --- a/packages/eslint-config-airbnb-base/rules/variables.js +++ /dev/null @@ -1,56 +0,0 @@ -const confusingBrowserGlobals = require('confusing-browser-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', - { - name: 'isFinite', - message: - 'Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite', - }, - { - name: 'isNaN', - message: - 'Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan', - }, - ].concat(confusingBrowserGlobals), - - // 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 deleted file mode 100644 index 5808be6186..0000000000 --- a/packages/eslint-config-airbnb-base/test/.eslintrc +++ /dev/null @@ -1,8 +0,0 @@ -{ - "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 deleted file mode 100644 index 8176480fe1..0000000000 --- a/packages/eslint-config-airbnb-base/test/requires.js +++ /dev/null @@ -1,13 +0,0 @@ -/* 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 deleted file mode 100644 index 181e04f453..0000000000 --- a/packages/eslint-config-airbnb-base/test/test-base.js +++ /dev/null @@ -1,32 +0,0 @@ -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 deleted file mode 100644 index 0b7bda8f6f..0000000000 --- a/packages/eslint-config-airbnb-base/whitespace.js +++ /dev/null @@ -1,91 +0,0 @@ -const assign = require('object.assign'); -const entries = require('object.entries'); -const { CLIEngine } = require('eslint'); - -const baseConfig = require('.'); - -const severities = ['off', 'warn', 'error']; - -function getSeverity(ruleConfig) { - if (Array.isArray(ruleConfig)) { - return getSeverity(ruleConfig[0]); - } - if (typeof ruleConfig === 'number') { - return severities[ruleConfig]; - } - return ruleConfig; -} - -function onlyErrorOnRules(rulesToError, config) { - const errorsOnly = assign({}, config); - const cli = new CLIEngine({ baseConfig: config, useEslintrc: false }); - const baseRules = cli.getConfigForFile(require.resolve('./')).rules; - - entries(baseRules).forEach((rule) => { - const ruleName = rule[0]; - const ruleConfig = rule[1]; - const severity = getSeverity(ruleConfig); - - if (rulesToError.indexOf(ruleName) === -1 && severity === 'error') { - 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 deleted file mode 100644 index e0aceaae1c..0000000000 --- a/packages/eslint-config-airbnb/.babelrc +++ /dev/null @@ -1,3 +0,0 @@ -{ - "presets": ["airbnb"] -} diff --git a/packages/eslint-config-airbnb/.editorconfig b/packages/eslint-config-airbnb/.editorconfig deleted file mode 120000 index 1b3ce07def..0000000000 --- a/packages/eslint-config-airbnb/.editorconfig +++ /dev/null @@ -1 +0,0 @@ -../../.editorconfig \ No newline at end of file diff --git a/packages/eslint-config-airbnb/.eslintrc b/packages/eslint-config-airbnb/.eslintrc deleted file mode 100644 index ab2c306fd9..0000000000 --- a/packages/eslint-config-airbnb/.eslintrc +++ /dev/null @@ -1,8 +0,0 @@ -{ - "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, - }, -} diff --git a/packages/eslint-config-airbnb/.npmrc b/packages/eslint-config-airbnb/.npmrc deleted file mode 120000 index cba44bb384..0000000000 --- a/packages/eslint-config-airbnb/.npmrc +++ /dev/null @@ -1 +0,0 @@ -../../.npmrc \ No newline at end of file diff --git a/packages/eslint-config-airbnb/CHANGELOG.md b/packages/eslint-config-airbnb/CHANGELOG.md deleted file mode 100644 index 745b541d58..0000000000 --- a/packages/eslint-config-airbnb/CHANGELOG.md +++ /dev/null @@ -1,444 +0,0 @@ -18.2.1 / 2020-11-06 -================== - - [patch] remove deprecated `jsx-a11y/accessible-emoji` rule (#2322) - - [patch] Fix ignoreNonDOM typo in jsx-a11y/aria-role rule (#2318) - - [patch] Fixed `handle` and `on` ordering in `sort-comp` rule (#2287) - - [deps] update `eslint-plugin-jsx-a11y`, `eslint-plugin-react` - - [deps] update `eslint-config-airbnb-base`, `object.assign` - - [dev deps] update `@babel/runtime`, `eslint-find-rules`, `eslint-plugin-import`, `eslint-plugin-jsx-a11y`, `eslint-plugin-react` - -18.2.0 / 2020-06-18 -================== - - [new] add `eslint` `v7` (#2240) - - [minor] Allow using `eslint-plugin-react-hooks` v3 and v4 (#2235, #2207) - - [minor] Fix typo in no-multiple-empty-lines rule (#2168) - - [patch] set `explicitSpread` to ignore for `react/jsx-props-no-spreading` (#2237) - - [patch] relax `eslint-plugin-react-hooks` down to v2.3, due to a controversial change in v2.5 - - [readme] fix typo (#2194) - - [deps] update `eslint-config-airbnb-base`, `eslint-plugin-jsx-a11y`, `eslint-plugin-import`, `eslint-plugin-react`, `babel-preset-airbnb`, `eslint-find-rules`, `in-publish`, `tape`, `object.entries` - - [tests] fix for eslint 7 - -18.1.0 / 2020-03-12 -================== - - [minor] Support eslint-plugin-react-hooks@2 (#2090) - - [minor] add new disabled rules, update eslint - - [fix] `whitespace`: only set erroring rules to "warn" - - [patch] Remove duplicate `componentDidCatch` (#2108) - - [patch] Add `static-variables` to `sort-comp` rule (#2109) - - [readme] clarify hooks section in readme (#2074) - - [deps] update `eslint`, `eslint-plugin-react`, `eslint-plugin-react-hooks`, `eslint-config-airbnb-base`, `eslint-plugin-import`, `object.entries` - - [dev deps] update `@babel/runtime`, `babel-preset-airbnb`, `safe-publish-latest`, `tape` - - [tests] re-enable eslint rule `prefer-destructuring` internally (#2110) - - [tests] fix eslint errors from c66cfc3 (#2112) - -18.0.1 / 2019-08-13 -================== - - [patch] `react/state-in-constructor`: fix incorrect configuration - -18.0.0 / 2019-08-10 -================== - - [breaking] add eslint v6, drop eslint v4 - - [deps] [breaking] update `eslint-config-airbnb-base`, `eslint-plugin-react`, `eslint-find-rules`, `eslint-plugin-import` - - [breaking] Remove rules/strict from 'extends' (#1962) - - [breaking] set react version to "detect" - - [breaking] disable `label-has-for`; enable `control-has-associated-label` - - [breaking] enable `react/jsx-props-no-spreading` - - [breaking] enable `react/jsx-fragments` - - [minor] enable `react/static-property-placement` - - [minor] enable `react/state-in-constructor` - - [minor] enable `react/jsx-curly-newline` - - [react] Add missing/unsafe lifecycle methods to react/sort-comp rule (#2043) - - [react] add componentDidCatch to lifecycle for react/sort-comp (#2060) - - [react] add `react-hooks` plugin (#2022) - - [dev deps] update babel-related deps to latest - - [tests] only run tests in non-lint per-package travis job - - [tests] use `eclint` instead of `editorconfig-tools` - - [meta] add disabled config for new react and a11y rules - - -17.1.1 / 2019-07-01 -================== - - [patch] Turn off `react/no-multi-comp` (#2006) - - [patch] extend `no-underscore-dangle` to allow for redux dev tools in the main config instead (#1996) - - [meta] add disabled `jsx-fragments` rule - - [deps] update `eslint-config-airbnb-base`, `object.entries`, `eslint-plugin-import`, `eslint-plugin-react`, `eslint-plugin-jsx-a11y`, `babel-preset-airbnb`, `tape` (#2005, etc) - - [docs] correct JavaScript capitalization (#2046) - - [docs] fix docs for whitespace config (#1914, #1871) - - [readme] Improve eslint config setup instructions for yarn (#2001) - -17.1.0 / 2018-08-13 -================== -- [new] add eslint v5 support -- [minor] enable `label-has-associated-control` rule -- [patch] re-enabling `jsx-one-expression-per-line` allowing single children, ignore DOM components on `jsx-no-bind` -- [deps] update `eslint`, `eslint-config-airbnb-base`, `eslint-plugin-react`, `eslint-plugin-import`, `safe-publish-latest`, `eslint-plugin-jsx-a11y`, `eslint-find-rules` -- [docs] fix readme typo (#1855) - -17.0.0 / 2018-06-21 -================== -- [breaking] update `eslint-config-airbnb-base` to v13 -- [breaking] enable `no-useless-path-segments` (#1743) -- [breaking] update `eslint-plugin-react` to `v7.6`; update rule configs (#1737) -- [breaking] bump react pragma to v16; update `class-methods-use-this`'s `exceptMethods` to include `componentDidCatch` (#1704) -- [new] Adds config entry point with only whitespace rules enabled (#1749, #1751) -- [patch] set `forbid-foreign-prop-types` to "warn" -- [patch] Add new methods introduced in react@16.3 (#1831) -- [patch] `label-has-for`: Remove redundant component (#1802) -- [patch] Add 'to' as a specialLink to the 'anchor-is-valid' a11y rule (#1648) -- [patch] disable `no-did-mount-set-state`, since it’s necessary for server-rendering. -- [deps] update `eslint`, `eslint-plugin-react`, `eslint-plugin-import`, -- [dev deps] update `babel-preset-airbnb`, `tape`, `eslint-find-rules` -- [meta] add ES2015-2018 in npm package keywords (#1587) -- [meta] Add licenses to sub packages (#1746) -- [docs] add `npx` shortcut (#1694) -- [docs] Use HTTPS for links to ESLint documentation (#1628) - -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 deleted file mode 100644 index 69d80c0252..0000000000 --- a/packages/eslint-config-airbnb/LICENSE.md +++ /dev/null @@ -1,21 +0,0 @@ -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 deleted file mode 100644 index 9cb0270467..0000000000 --- a/packages/eslint-config-airbnb/README.md +++ /dev/null @@ -1,85 +0,0 @@ -# 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`, `eslint-plugin-react-hooks`, and `eslint-plugin-jsx-a11y`. If you don't need React, see [eslint-config-airbnb-base](https://npmjs.com/eslint-config-airbnb-base). - -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 **yarn**, you can also use the shortcut described above if you have npm 5+ installed on your machine, as the command will detect that you are using yarn and will act accordingly. - Otherwise, 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. - - 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@^#.#.# eslint-plugin-react-hooks@^#.#.# - ``` - - 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@^#.#.# eslint-plugin-react-hooks@^#.#.# - ``` - -2. Add `"extends": "airbnb"` to your `.eslintrc` - -### eslint-config-airbnb/hooks - -This entry point enables the linting rules for React hooks (requires v16.8+). To use, add `"extends": ["airbnb", "airbnb/hooks"]` to your `.eslintrc` - -### eslint-config-airbnb/whitespace - -This entry point only errors 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 deleted file mode 100644 index bb1ea39118..0000000000 --- a/packages/eslint-config-airbnb/base.js +++ /dev/null @@ -1,4 +0,0 @@ -module.exports = { - extends: ['eslint-config-airbnb-base'].map(require.resolve), - rules: {}, -}; diff --git a/packages/eslint-config-airbnb/hooks.js b/packages/eslint-config-airbnb/hooks.js deleted file mode 100644 index a7f70284e3..0000000000 --- a/packages/eslint-config-airbnb/hooks.js +++ /dev/null @@ -1,6 +0,0 @@ -module.exports = { - extends: [ - './rules/react-hooks.js', - ].map(require.resolve), - rules: {} -}; diff --git a/packages/eslint-config-airbnb/index.js b/packages/eslint-config-airbnb/index.js deleted file mode 100644 index 6432e10dda..0000000000 --- a/packages/eslint-config-airbnb/index.js +++ /dev/null @@ -1,8 +0,0 @@ -module.exports = { - extends: [ - 'eslint-config-airbnb-base', - './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 deleted file mode 100644 index e88f71224a..0000000000 --- a/packages/eslint-config-airbnb/legacy.js +++ /dev/null @@ -1,4 +0,0 @@ -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 deleted file mode 100644 index 941fff4869..0000000000 --- a/packages/eslint-config-airbnb/package.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "name": "eslint-config-airbnb", - "version": "18.2.1", - "description": "Airbnb's ESLint config, following our styleguide", - "main": "index.js", - "scripts": { - "prelint": "eclint 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", - "link:eslint": "cd node_modules/eslint && npm link --production && cd -", - "pretravis": "npm run link:eslint && cd ../eslint-config-airbnb-base && npm link eslint && npm install && npm link && cd - && npm link --no-save eslint-config-airbnb-base", - "travis": "npm run --silent tests-only", - "posttravis": "npm unlink --no-save eslint-config-airbnb-base eslint >/dev/null &" - }, - "repository": { - "type": "git", - "url": "https://github.com/airbnb/javascript" - }, - "keywords": [ - "eslint", - "eslintconfig", - "config", - "airbnb", - "javascript", - "styleguide", - "es2015", - "es2016", - "es2017", - "es2018" - ], - "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": "^14.2.1", - "object.assign": "^4.1.2", - "object.entries": "^1.1.4" - }, - "devDependencies": { - "@babel/runtime": "^7.14.6", - "babel-preset-airbnb": "^4.5.0", - "babel-tape-runner": "^3.0.0", - "eclint": "^2.8.1", - "eslint": "^5.16.0 || ^6.8.0 || ^7.2.0", - "eslint-find-rules": "^3.6.1", - "eslint-plugin-import": "^2.23.4", - "eslint-plugin-jsx-a11y": "^6.4.1", - "eslint-plugin-react": "^7.24.0", - "eslint-plugin-react-hooks": "^4.0.1 || ^3 || ^2.3.0 || ^1.7.0", - "in-publish": "^2.0.1", - "react": ">= 0.13.0", - "safe-publish-latest": "^1.1.4", - "tape": "^5.2.2" - }, - "peerDependencies": { - "eslint": "^5.16.0 || ^6.8.0 || ^7.2.0", - "eslint-plugin-import": "^2.22.1", - "eslint-plugin-jsx-a11y": "^6.4.1", - "eslint-plugin-react": "^7.23.1", - "eslint-plugin-react-hooks": "^4.0.1 || ^3 || ^2.3.0 || ^1.7.0" - }, - "engines": { - "node": ">= 6" - } -} diff --git a/packages/eslint-config-airbnb/rules/react-a11y.js b/packages/eslint-config-airbnb/rules/react-a11y.js deleted file mode 100644 index f7bf7c79e6..0000000000 --- a/packages/eslint-config-airbnb/rules/react-a11y.js +++ /dev/null @@ -1,251 +0,0 @@ -module.exports = { - plugins: [ - 'jsx-a11y', - 'react' - ], - - parserOptions: { - ecmaFeatures: { - jsx: true, - }, - }, - - rules: { - // ensure emoji are accessible - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/accessible-emoji.md - // disabled; rule is deprecated - 'jsx-a11y/accessible-emoji': 'off', - - // 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"]': [], - }], - - // 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: [] }], - - // 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'], - }], - - // 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', - - // 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', - - // 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 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', - - // Ensure the autocomplete attribute is correct and suitable for the form field it is used with - // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/29c68596b15c4ff0a40daae6d4a2670e36e37d35/docs/rules/autocomplete-valid.md - 'jsx-a11y/autocomplete-valid': ['off', { - inputComponents: [], - }], - - // 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 a control (an interactive element) has a text label. - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/control-has-associated-label.md - 'jsx-a11y/control-has-associated-label': ['error', { - labelAttributes: ['label'], - controlComponents: [], - ignoreElements: [ - 'audio', - 'canvas', - 'embed', - 'input', - 'textarea', - 'tr', - 'video', - ], - ignoreRoles: [ - 'grid', - 'listbox', - 'menu', - 'menubar', - 'radiogroup', - 'row', - 'tablist', - 'toolbar', - 'tree', - 'treegrid', - ], - depth: 5, - }], - - // 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', - - // 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', - - // 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', - - // 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 a label tag has a text label and an associated control. - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/b800f40a2a69ad48015ae9226fbe879f946757ed/docs/rules/label-has-associated-control.md - 'jsx-a11y/label-has-associated-control': ['error', { - labelComponents: [], - labelAttributes: [], - controlComponents: [], - assert: 'both', - depth: 25 - }], - - // 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', - - // 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: [], - }], - - // 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', - - // 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 }], - - // 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'], - }], - - // 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'], - }], - - // 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', - ] - }], - - // 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'], - }], - - // 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', - - // 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', - - // 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', - ] - }], - - // 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', - - // 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', - - // 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', - - // ---------------------------------------------------- - // Rules that no longer exist in eslint-plugin-jsx-a11y - // ---------------------------------------------------- - - // require that JSX labels use "htmlFor" - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/label-has-for.md - // deprecated: replaced by `label-has-associated-control` rule - 'jsx-a11y/label-has-for': ['off', { - components: [], - required: { - every: ['nesting', 'id'], - }, - allowChildren: false, - }], - }, -}; diff --git a/packages/eslint-config-airbnb/rules/react-hooks.js b/packages/eslint-config-airbnb/rules/react-hooks.js deleted file mode 100644 index be17c9a571..0000000000 --- a/packages/eslint-config-airbnb/rules/react-hooks.js +++ /dev/null @@ -1,21 +0,0 @@ -module.exports = { - plugins: [ - 'react-hooks', - ], - - parserOptions: { - ecmaFeatures: { - jsx: true, - }, - }, - - rules: { - // Enforce Rules of Hooks - // https://github.com/facebook/react/blob/c11015ff4f610ac2924d1fc6d569a17657a404fd/packages/eslint-plugin-react-hooks/src/RulesOfHooks.js - 'react-hooks/rules-of-hooks': 'error', - - // Verify the list of the dependencies for Hooks like useEffect and similar - // https://github.com/facebook/react/blob/1204c789776cb01fbaf3e9f032e7e2ba85a44137/packages/eslint-plugin-react-hooks/src/ExhaustiveDeps.js - 'react-hooks/exhaustive-deps': 'error', - }, -}; diff --git a/packages/eslint-config-airbnb/rules/react.js b/packages/eslint-config-airbnb/rules/react.js deleted file mode 100644 index a077e4c113..0000000000 --- a/packages/eslint-config-airbnb/rules/react.js +++ /dev/null @@ -1,566 +0,0 @@ -const assign = require('object.assign'); -const baseStyleRules = require('eslint-config-airbnb-base/rules/style').rules; - -const dangleRules = baseStyleRules['no-underscore-dangle']; - -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: { - 'no-underscore-dangle': [dangleRules[0], assign({}, dangleRules[1], { - allow: dangleRules[1].allow.concat(['__REDUX_DEVTOOLS_EXTENSION_COMPOSE__']), - })], - - // 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', - 'UNSAFE_componentWillMount', - 'componentDidMount', - 'componentWillReceiveProps', - 'UNSAFE_componentWillReceiveProps', - 'shouldComponentUpdate', - 'componentWillUpdate', - 'UNSAFE_componentWillUpdate', - 'componentDidUpdate', - 'componentWillUnmount', - 'componentDidCatch', - 'getSnapshotBeforeUpdate' - ], - }], - - // 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, - allowFunctions: false, - allowBind: false, - ignoreDOMComponents: true, - }], - - // 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': 'off', - - // 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-variables', - 'static-methods', - 'instance-variables', - 'lifecycle', - '/^handle.+$/', - '/^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', - 'getDerivedStateFromProps', - 'componentWillMount', - 'UNSAFE_componentWillMount', - 'componentDidMount', - 'componentWillReceiveProps', - 'UNSAFE_componentWillReceiveProps', - 'shouldComponentUpdate', - 'componentWillUpdate', - 'UNSAFE_componentWillUpdate', - 'getSnapshotBeforeUpdate', - 'componentDidUpdate', - 'componentDidCatch', - '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 - // this is intentionally set to "warn". it would be "error", - // but it's only critical if you're stripping propTypes in production. - 'react/forbid-foreign-prop-types': ['warn', { 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', { allow: 'single-child' }], - - // 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', - - // Prevent usage of UNSAFE_ methods - // https://github.com/yannickcr/eslint-plugin-react/blob/157cc932be2cfaa56b3f5b45df6f6d4322a2f660/docs/rules/no-unsafe.md - 'react/no-unsafe': 'off', - - // Enforce shorthand or standard form for React fragments - // https://github.com/yannickcr/eslint-plugin-react/blob/bc976b837abeab1dffd90ac6168b746a83fc83cc/docs/rules/jsx-fragments.md - 'react/jsx-fragments': ['error', 'syntax'], - - // Enforce linebreaks in curly braces in JSX attributes and expressions. - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-curly-newline.md - 'react/jsx-curly-newline': ['error', { - multiline: 'consistent', - singleline: 'consistent', - }], - - // Enforce state initialization style - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/state-in-constructor.md - // TODO: set to "never" once babel-preset-airbnb supports public class fields - 'react/state-in-constructor': ['error', 'always'], - - // Enforces where React component static properties should be positioned - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/static-property-placement.md - // TODO: set to "static public field" once babel-preset-airbnb supports public class fields - 'react/static-property-placement': ['error', 'property assignment'], - - // Disallow JSX props spreading - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-props-no-spreading.md - 'react/jsx-props-no-spreading': ['error', { - html: 'enforce', - custom: 'enforce', - explicitSpread: 'ignore', - exceptions: [], - }], - - // Enforce that props are read-only - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-read-only-props.md - 'react/prefer-read-only-props': 'off', - - // Prevent usage of `javascript:` URLs - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-script-url.md - // TODO: enable, semver-major - 'react/jsx-no-script-url': ['off', [ - { - name: 'Link', - props: ['to'], - }, - ]], - - // Disallow unnecessary fragments - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-useless-fragment.md - // TODO: enable, semver-major - 'react/jsx-no-useless-fragment': 'off', - - // Prevent adjacent inline elements not separated by whitespace - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-adjacent-inline-elements.md - // TODO: enable? semver-major - 'react/no-adjacent-inline-elements': 'off', - - // Enforce a specific function type for function components - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/function-component-definition.md - // TODO: enable! semver-minor, but do it in a major to be safe - // TODO: investigate if setting namedComponents to expression vs declaration is problematic - 'react/function-component-definition': ['off', { - namedComponents: 'function-expression', - unnamedComponents: 'function-expression', - }], - - // Enforce a new line after jsx elements and expressions - // https://github.com/yannickcr/eslint-plugin-react/blob/e2eaadae316f9506d163812a09424eb42698470a/docs/rules/jsx-newline.md - 'react/jsx-newline': 'off', - - // Prevent react contexts from taking non-stable values - // https://github.com/yannickcr/eslint-plugin-react/blob/e2eaadae316f9506d163812a09424eb42698470a/docs/rules/jsx-no-constructed-context-values.md - // TODO: enable, semver-minor - 'react/jsx-no-constructed-context-values': 'off', - - // Prevent creating unstable components inside components - // https://github.com/yannickcr/eslint-plugin-react/blob/c2a790a3472eea0f6de984bdc3ee2a62197417fb/docs/rules/no-unstable-nested-components.md - // TODO: enable, semver-major - 'react/no-unstable-nested-components': 'off', - }, - - settings: { - 'import/resolver': { - node: { - extensions: ['.js', '.jsx', '.json'] - } - }, - react: { - pragma: 'React', - version: 'detect', - }, - 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 deleted file mode 100644 index 9c23197fab..0000000000 --- a/packages/eslint-config-airbnb/test/.eslintrc +++ /dev/null @@ -1,9 +0,0 @@ -{ - "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 deleted file mode 100644 index 72f4ab8078..0000000000 --- a/packages/eslint-config-airbnb/test/requires.js +++ /dev/null @@ -1,15 +0,0 @@ -/* 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.doesNotThrow(() => require('../hooks'), 'hooks 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 deleted file mode 100644 index c283c3410c..0000000000 --- a/packages/eslint-config-airbnb/test/test-base.js +++ /dev/null @@ -1,34 +0,0 @@ -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 deleted file mode 100644 index a394fe1c3c..0000000000 --- a/packages/eslint-config-airbnb/test/test-react-order.js +++ /dev/null @@ -1,136 +0,0 @@ -import test from 'tape'; -import { CLIEngine, ESLint } from 'eslint'; -import eslintrc from '..'; -import reactRules from '../rules/react'; -import reactA11yRules from '../rules/react-a11y'; - -const cli = new (CLIEngine || ESLint)({ - 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 = CLIEngine ? cli.executeOnText(text) : cli.lintText(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 methods 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(` - componentDidMount() {} - handleSubmit() {} - onButtonAClick() {} - setFoo() {} - getFoo() {} - setBar() {} - someMethod() {} - renderDogs() {} - render() { return
; } -`)); - - t.notOk(result.warningCount, 'no warnings'); - t.deepEquals(result.messages, [], 'no messages in results'); - t.notOk(result.errorCount, 'no errors'); - }); - - t.test('order: when random method is first', (t) => { - t.plan(2); - const result = lint(wrapComponent(` - someMethod() {} - componentDidMount() {} - setFoo() {} - getFoo() {} - setBar() {} - renderDogs() {} - render() { return
; } -`)); - - t.ok(result.errorCount, 'fails'); - t.deepEqual(result.messages.map((msg) => msg.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(` - componentDidMount() {} - someMethod() {} - setFoo() {} - getFoo() {} - setBar() {} - renderDogs() {} - render() { return
; } -`)); - - t.ok(result.errorCount, 'fails'); - t.deepEqual(result.messages.map((msg) => msg.ruleId), ['react/sort-comp'], 'fails due to sort'); - }); - - t.test('order: when handler method with `handle` prefix after method with `on` prefix', (t) => { - t.plan(2); - const result = lint(wrapComponent(` - componentDidMount() {} - onButtonAClick() {} - handleSubmit() {} - setFoo() {} - getFoo() {} - render() { return
; } -`)); - - t.ok(result.errorCount, 'fails'); - t.deepEqual(result.messages.map((msg) => msg.ruleId), ['react/sort-comp'], 'fails due to sort'); - }); - - t.test('order: when lifecycle methods after event handler methods', (t) => { - t.plan(2); - const result = lint(wrapComponent(` - handleSubmit() {} - componentDidMount() {} - setFoo() {} - getFoo() {} - render() { return
; } -`)); - - t.ok(result.errorCount, 'fails'); - t.deepEqual(result.messages.map((msg) => msg.ruleId), ['react/sort-comp'], 'fails due to sort'); - }); - - t.test('order: when event handler methods after getters and setters', (t) => { - t.plan(2); - const result = lint(wrapComponent(` - componentDidMount() {} - setFoo() {} - getFoo() {} - handleSubmit() {} - render() { return
; } -`)); - - t.ok(result.errorCount, 'fails'); - t.deepEqual(result.messages.map((msg) => msg.ruleId), ['react/sort-comp'], 'fails due to sort'); - }); -}); diff --git a/packages/eslint-config-airbnb/whitespace.js b/packages/eslint-config-airbnb/whitespace.js deleted file mode 100644 index 48445ada24..0000000000 --- a/packages/eslint-config-airbnb/whitespace.js +++ /dev/null @@ -1,105 +0,0 @@ -const assign = require('object.assign'); -const entries = require('object.entries'); -const { CLIEngine } = require('eslint'); - -const baseConfig = require('.'); - -const severities = ['off', 'warn', 'error']; - -function getSeverity(ruleConfig) { - if (Array.isArray(ruleConfig)) { - return getSeverity(ruleConfig[0]); - } - if (typeof ruleConfig === 'number') { - return severities[ruleConfig]; - } - return ruleConfig; -} - -function onlyErrorOnRules(rulesToError, config) { - const errorsOnly = assign({}, config); - const cli = new CLIEngine({ baseConfig: config, useEslintrc: false }); - const baseRules = cli.getConfigForFile(require.resolve('./')).rules; - - entries(baseRules).forEach((rule) => { - const ruleName = rule[0]; - const ruleConfig = rule[1]; - const severity = getSeverity(ruleConfig); - - if (rulesToError.indexOf(ruleName) === -1 && severity === 'error') { - 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); From ebb30fbccdb3d56dcc4052cffc6f17bfe94f3811 Mon Sep 17 00:00:00 2001 From: Chris Nordhougen Date: Mon, 27 Sep 2021 14:00:41 -0500 Subject: [PATCH 06/29] lint can run w/config pkg, need to do ts rules --- package.json | 12 ++++++++---- .../code-style-typescript/tsconfig.json | 15 --------------- .../eslint-config-typescript/.gitignore | 2 ++ .../eslint-config-typescript/.npmignore | 1 + .../index.ts | 2 +- .../package.json | 6 ++++-- .../rules/bestPractices.ts | 0 .../rules/es6.ts | 0 .../rules/imports/helpfulWarnings.ts | 0 .../rules/imports/index.ts | 0 .../rules/imports/moduleSystems.ts | 0 .../rules/imports/staticAnalysis.ts | 0 .../rules/imports/styleGuide.ts | 0 .../rules/possibleErrors.ts | 0 .../rules/strictMode.ts | 0 .../rules/stylisticIssues.ts | 0 .../rules/variables.ts | 0 .../eslint-config-typescript/tsconfig.json | 8 ++++++++ tsconfig.json | 13 +++++++++++++ 19 files changed, 37 insertions(+), 22 deletions(-) delete mode 100644 packages/@spscommerce/code-style-typescript/tsconfig.json create mode 100644 packages/@spscommerce/eslint-config-typescript/.gitignore create mode 100644 packages/@spscommerce/eslint-config-typescript/.npmignore rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/index.ts (97%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/package.json (90%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/bestPractices.ts (100%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/es6.ts (100%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/imports/helpfulWarnings.ts (100%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/imports/index.ts (100%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/imports/moduleSystems.ts (100%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/imports/staticAnalysis.ts (100%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/imports/styleGuide.ts (100%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/possibleErrors.ts (100%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/strictMode.ts (100%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/stylisticIssues.ts (100%) rename packages/@spscommerce/{code-style-typescript => eslint-config-typescript}/rules/variables.ts (100%) create mode 100644 packages/@spscommerce/eslint-config-typescript/tsconfig.json create mode 100644 tsconfig.json diff --git a/package.json b/package.json index d80d14b277..c571a3b04d 100644 --- a/package.json +++ b/package.json @@ -3,9 +3,7 @@ "version": "0.0.1", "description": "SPS official style guides and lint configs for frontend development.", "private": true, - "scripts": { - - }, + "scripts": {}, "repository": { "type": "git", "url": "https://github.com/SPSCommerce/javascript.git" @@ -30,5 +28,11 @@ "url": "https://github.com/SPSCommerce/javascript/issues" }, "homepage": "https://github.com/SPSCommerce/javascript", - "workspaces": ["packages/@spscommerce/*"] + "workspaces": [ + "packages/@spscommerce/*" + ], + "devDependencies": { + "eslint": "^7.32.0", + "typescript": "^4.4.3" + } } diff --git a/packages/@spscommerce/code-style-typescript/tsconfig.json b/packages/@spscommerce/code-style-typescript/tsconfig.json deleted file mode 100644 index a4f67a5904..0000000000 --- a/packages/@spscommerce/code-style-typescript/tsconfig.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "$schema": "https://json.schemastore.org/tsconfig", - "display": "Node 14", - - "compilerOptions": { - "lib": ["es2020"], - "module": "commonjs", - "target": "es2020", - - "strict": true, - "esModuleInterop": true, - "skipLibCheck": true, - "forceConsistentCasingInFileNames": true - } -} diff --git a/packages/@spscommerce/eslint-config-typescript/.gitignore b/packages/@spscommerce/eslint-config-typescript/.gitignore new file mode 100644 index 0000000000..23a608b6ad --- /dev/null +++ b/packages/@spscommerce/eslint-config-typescript/.gitignore @@ -0,0 +1,2 @@ +node_modules +*.js diff --git a/packages/@spscommerce/eslint-config-typescript/.npmignore b/packages/@spscommerce/eslint-config-typescript/.npmignore new file mode 100644 index 0000000000..6461deecd1 --- /dev/null +++ b/packages/@spscommerce/eslint-config-typescript/.npmignore @@ -0,0 +1 @@ +*.ts diff --git a/packages/@spscommerce/code-style-typescript/index.ts b/packages/@spscommerce/eslint-config-typescript/index.ts similarity index 97% rename from packages/@spscommerce/code-style-typescript/index.ts rename to packages/@spscommerce/eslint-config-typescript/index.ts index ef79eb0905..0e55c3074b 100644 --- a/packages/@spscommerce/code-style-typescript/index.ts +++ b/packages/@spscommerce/eslint-config-typescript/index.ts @@ -37,4 +37,4 @@ const config: Linter.Config = { }, }; -export default config; +export = config; diff --git a/packages/@spscommerce/code-style-typescript/package.json b/packages/@spscommerce/eslint-config-typescript/package.json similarity index 90% rename from packages/@spscommerce/code-style-typescript/package.json rename to packages/@spscommerce/eslint-config-typescript/package.json index 6e08abb18f..4262333bb3 100644 --- a/packages/@spscommerce/code-style-typescript/package.json +++ b/packages/@spscommerce/eslint-config-typescript/package.json @@ -1,9 +1,11 @@ { - "name": "@spscommerce/code-style-typescript", + "name": "@spscommerce/eslint-config-typescript", "version": "0.0.1", "description": "SPS official linter configuration for TypeScript.", "main": "index.js", - "scripts": {}, + "scripts": { + "build": "tsc ." + }, "repository": { "type": "git", "url": "https://github.com/SPSCommerce/javascript.git" diff --git a/packages/@spscommerce/code-style-typescript/rules/bestPractices.ts b/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/bestPractices.ts rename to packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts diff --git a/packages/@spscommerce/code-style-typescript/rules/es6.ts b/packages/@spscommerce/eslint-config-typescript/rules/es6.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/es6.ts rename to packages/@spscommerce/eslint-config-typescript/rules/es6.ts diff --git a/packages/@spscommerce/code-style-typescript/rules/imports/helpfulWarnings.ts b/packages/@spscommerce/eslint-config-typescript/rules/imports/helpfulWarnings.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/imports/helpfulWarnings.ts rename to packages/@spscommerce/eslint-config-typescript/rules/imports/helpfulWarnings.ts diff --git a/packages/@spscommerce/code-style-typescript/rules/imports/index.ts b/packages/@spscommerce/eslint-config-typescript/rules/imports/index.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/imports/index.ts rename to packages/@spscommerce/eslint-config-typescript/rules/imports/index.ts diff --git a/packages/@spscommerce/code-style-typescript/rules/imports/moduleSystems.ts b/packages/@spscommerce/eslint-config-typescript/rules/imports/moduleSystems.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/imports/moduleSystems.ts rename to packages/@spscommerce/eslint-config-typescript/rules/imports/moduleSystems.ts diff --git a/packages/@spscommerce/code-style-typescript/rules/imports/staticAnalysis.ts b/packages/@spscommerce/eslint-config-typescript/rules/imports/staticAnalysis.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/imports/staticAnalysis.ts rename to packages/@spscommerce/eslint-config-typescript/rules/imports/staticAnalysis.ts diff --git a/packages/@spscommerce/code-style-typescript/rules/imports/styleGuide.ts b/packages/@spscommerce/eslint-config-typescript/rules/imports/styleGuide.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/imports/styleGuide.ts rename to packages/@spscommerce/eslint-config-typescript/rules/imports/styleGuide.ts diff --git a/packages/@spscommerce/code-style-typescript/rules/possibleErrors.ts b/packages/@spscommerce/eslint-config-typescript/rules/possibleErrors.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/possibleErrors.ts rename to packages/@spscommerce/eslint-config-typescript/rules/possibleErrors.ts diff --git a/packages/@spscommerce/code-style-typescript/rules/strictMode.ts b/packages/@spscommerce/eslint-config-typescript/rules/strictMode.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/strictMode.ts rename to packages/@spscommerce/eslint-config-typescript/rules/strictMode.ts diff --git a/packages/@spscommerce/code-style-typescript/rules/stylisticIssues.ts b/packages/@spscommerce/eslint-config-typescript/rules/stylisticIssues.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/stylisticIssues.ts rename to packages/@spscommerce/eslint-config-typescript/rules/stylisticIssues.ts diff --git a/packages/@spscommerce/code-style-typescript/rules/variables.ts b/packages/@spscommerce/eslint-config-typescript/rules/variables.ts similarity index 100% rename from packages/@spscommerce/code-style-typescript/rules/variables.ts rename to packages/@spscommerce/eslint-config-typescript/rules/variables.ts diff --git a/packages/@spscommerce/eslint-config-typescript/tsconfig.json b/packages/@spscommerce/eslint-config-typescript/tsconfig.json new file mode 100644 index 0000000000..a54d95c9c0 --- /dev/null +++ b/packages/@spscommerce/eslint-config-typescript/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "module": "commonjs" + }, + "include": ["./**/*.ts"], + "exclude": ["node_modules"] +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000000..21cf3dbf83 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,13 @@ +{ + "compilerOptions": { + "lib": ["ES2021"], + "target": "ES2021", + "module": "ES2020", + "strict": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + "moduleResolution": "node" + }, + "include": [], + "exclude": ["node_modules"] +} From eaa08ac7d649237a0a6886725d908664712cd492 Mon Sep 17 00:00:00 2001 From: Chris Nordhougen Date: Thu, 30 Sep 2021 12:49:40 -0500 Subject: [PATCH 07/29] config package is working --- .../eslint-config-typescript/package.json | 2 +- .../rules/bestPractices.ts | 66 ++++++++++----- .../eslint-config-typescript/rules/es6.ts | 19 +++-- .../rules/possibleErrors.ts | 16 ++-- .../rules/stylisticIssues.ts | 82 +++++++++++++------ .../rules/variables.ts | 22 +++-- 6 files changed, 141 insertions(+), 66 deletions(-) diff --git a/packages/@spscommerce/eslint-config-typescript/package.json b/packages/@spscommerce/eslint-config-typescript/package.json index 4262333bb3..50f324ecec 100644 --- a/packages/@spscommerce/eslint-config-typescript/package.json +++ b/packages/@spscommerce/eslint-config-typescript/package.json @@ -4,7 +4,7 @@ "description": "SPS official linter configuration for TypeScript.", "main": "index.js", "scripts": { - "build": "tsc ." + "build": "tsc -p tsconfig.json" }, "repository": { "type": "git", diff --git a/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts b/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts index c9781c45c5..5222646505 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts @@ -40,16 +40,20 @@ export const bestPractices: BestPractices = { 'default-case-last': 'error', /** enforce default parameters to be last - * https://eslint.org/docs/rules/default-param-last */ - 'default-param-last': 'error', + * https://eslint.org/docs/rules/default-param-last + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/default-param-last.md */ + 'default-param-last': 'off', + '@typescript-eslint/default-param-last': 'error', /** enforces consistent newlines before or after dots * https://eslint.org/docs/rules/dot-location */ 'dot-location': ['error', 'property'], /** encourages use of dot notation whenever possible - * https://eslint.org/docs/rules/dot-notation */ - 'dot-notation': ['error', { allowKeywords: true }], + * https://eslint.org/docs/rules/dot-notation + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/dot-notation.md */ + 'dot-notation': 'off', + '@typescript-eslint/dot-notation': ['error', { allowKeywords: true }], /** require the use of === and !== * https://eslint.org/docs/rules/eqeqeq */ @@ -94,8 +98,10 @@ export const bestPractices: BestPractices = { 'no-else-return': 'off', /** disallow empty functions - * https://eslint.org/docs/rules/no-empty-function */ + * https://eslint.org/docs/rules/no-empty-function + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-empty-function.md */ 'no-empty-function': 'off', + '@typescript-eslint/no-empty-function': 'off', /** disallow empty destructuring patterns * https://eslint.org/docs/rules/no-empty-pattern */ @@ -150,12 +156,16 @@ export const bestPractices: BestPractices = { 'no-implicit-globals': 'error', /** disallow use of eval()-like methods - * https://eslint.org/docs/rules/no-implied-eval */ - 'no-implied-eval': 'error', + * https://eslint.org/docs/rules/no-implied-eval + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-implied-eval.md */ + 'no-implied-eval': 'off', + '@typescript-eslint/no-implied-eval': 'error', /** disallow this keywords outside of classes or class-like objects - * https://eslint.org/docs/rules/no-invalid-this */ + * https://eslint.org/docs/rules/no-invalid-this + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-invalid-this.md */ 'no-invalid-this': 'off', + '@typescript-eslint/no-invalid-this': 'off', /** disallow usage of __iterator__ property * https://eslint.org/docs/rules/no-iterator */ @@ -170,12 +180,16 @@ export const bestPractices: BestPractices = { 'no-lone-blocks': 'error', /** disallow creation of functions within loops - * https://eslint.org/docs/rules/no-loop-func */ - 'no-loop-func': 'error', + * https://eslint.org/docs/rules/no-loop-func + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-loop-func.md */ + 'no-loop-func': 'off', + '@typescript-eslint/no-loop-func': 'error', /** disallow magic numbers - * https://eslint.org/docs/rules/no-magic-numbers */ - 'no-magic-numbers': ['error', { ignoreArrayIndexes: true }], + * https://eslint.org/docs/rules/no-magic-numbers + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-magic-numbers.md */ + 'no-magic-numbers': 'off', + '@typescript-eslint/no-magic-numbers': ['error', { ignoreArrayIndexes: true }], /** disallow use of multiple spaces * https://eslint.org/docs/rules/no-multi-spaces */ @@ -228,8 +242,10 @@ export const bestPractices: BestPractices = { 'no-proto': 'error', /** disallow declaring the same variable more than once - * https://eslint.org/docs/rules/no-redeclare */ - 'no-redeclare': 'error', + * https://eslint.org/docs/rules/no-redeclare + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-redeclare.md */ + 'no-redeclare': 'off', + '@typescript-eslint/no-redeclare': 'error', /** disallow certain object properties * https://eslint.org/docs/rules/no-restricted-properties */ @@ -277,8 +293,10 @@ export const bestPractices: BestPractices = { 'no-return-assign': 'error', /** disallow redundant `return await` - * https://eslint.org/docs/rules/no-return-await */ - 'no-return-await': 'error', + * https://eslint.org/docs/rules/no-return-await + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/return-await.md */ + 'no-return-await': 'off', + '@typescript-eslint/return-await': 'error', /** disallow use of `javascript:` urls. * https://eslint.org/docs/rules/no-script-url */ @@ -297,16 +315,20 @@ export const bestPractices: BestPractices = { 'no-sequences': 'error', /** restrict what can be thrown as an exception - * https://eslint.org/docs/rules/no-throw-literal */ - 'no-throw-literal': 'error', + * https://eslint.org/docs/rules/no-throw-literal + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-throw-literal.md */ + 'no-throw-literal': 'off', + '@typescript-eslint/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 - * https://eslint.org/docs/rules/no-unused-expressions */ - 'no-unused-expressions': ['error', { allowTaggedTemplates: false }], + * https://eslint.org/docs/rules/no-unused-expressions + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unused-expressions.md */ + 'no-unused-expressions': 'off', + '@typescript-eslint/no-unused-expressions': ['error', { allowTaggedTemplates: false }], /** disallow unused labels * https://eslint.org/docs/rules/no-unused-labels */ @@ -361,8 +383,10 @@ export const bestPractices: BestPractices = { 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 */ + * https://eslint.org/docs/rules/require-await + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/require-await.md */ 'require-await': 'off', + '@typescript-eslint/require-await': 'off', /** Enforce the use of u flag on RegExp * https://eslint.org/docs/rules/require-unicode-regexp */ diff --git a/packages/@spscommerce/eslint-config-typescript/rules/es6.ts b/packages/@spscommerce/eslint-config-typescript/rules/es6.ts index 44150d55c4..7617d32868 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/es6.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/es6.ts @@ -34,13 +34,18 @@ export const es6: ECMAScript6 = { 'no-const-assign': 'error', /** disallow duplicate class members - * https://eslint.org/docs/rules/no-dupe-class-members */ - 'no-dupe-class-members': 'error', + * https://eslint.org/docs/rules/no-dupe-class-members + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-dupe-class-members.md */ + 'no-dupe-class-members': 'off', + '@typescript-eslint/no-dupe-class-members': 'error', /** disallow importing from the same path more than once * https://eslint.org/docs/rules/no-duplicate-imports + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-duplicate-imports.md * superceded by eslint-plugin-import */ 'no-duplicate-import': 'off', + 'no-duplicate-imports': 'off', + '@typescript-eslint/no-duplicate-imports': 'off', /** disallow symbol constructor * https://eslint.org/docs/rules/no-new-symbol */ @@ -51,8 +56,10 @@ export const es6: ECMAScript6 = { 'no-restricted-exports': 'off', /** disallow specific imports - * https://eslint.org/docs/rules/no-restricted-imports */ + * https://eslint.org/docs/rules/no-restricted-imports + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-restricted-imports.md */ 'no-restricted-imports': 'off', + '@typescript-eslint/no-restricted-imports': 'off', /** disallow to use this/super before super() calling in constructors. * https://eslint.org/docs/rules/no-this-before-super */ @@ -63,8 +70,10 @@ export const es6: ECMAScript6 = { 'no-useless-computed-key': 'error', /** disallow unnecessary constructor - * https://eslint.org/docs/rules/no-useless-constructor */ - 'no-useless-constructor': 'error', + * https://eslint.org/docs/rules/no-useless-constructor + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-useless-constructor.md */ + 'no-useless-constructor': 'off', + '@typescript-eslint/no-useless-constructor': 'error', /** disallow renaming import, export, and destructured assignments to the same name * https://eslint.org/docs/rules/no-useless-rename */ diff --git a/packages/@spscommerce/eslint-config-typescript/rules/possibleErrors.ts b/packages/@spscommerce/eslint-config-typescript/rules/possibleErrors.ts index 61f988777e..d66af096bb 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/possibleErrors.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/possibleErrors.ts @@ -76,12 +76,16 @@ export const possibleErrors: PossibleErrors = { 'no-extra-boolean-cast': 'error', /** disallow unnecessary parentheses - * https://eslint.org/docs/rules/no-extra-parens */ + * https://eslint.org/docs/rules/no-extra-parens + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-extra-parens.md */ 'no-extra-parens': 'off', + '@typescript-eslint/no-extra-parens': 'off', /** disallow unnecessary semicolons - * https://eslint.org/docs/rules/no-extra-semi */ - 'no-extra-semi': 'error', + * https://eslint.org/docs/rules/no-extra-semi + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-extra-semi.md */ + 'no-extra-semi': 'off', + '@typescript-eslint/no-extra-semi': 'error', /** disallow overwriting functions written as function declarations * https://eslint.org/docs/rules/no-func-assign */ @@ -104,8 +108,10 @@ export const possibleErrors: PossibleErrors = { 'no-irregular-whitespace': 'error', /** disallow literal numbers that lose precision - * https://eslint.org/docs/rules/no-loss-of-precision */ - 'no-loss-of-precision': 'error', + * https://eslint.org/docs/rules/no-loss-of-precision + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-loss-of-precision.md */ + 'no-loss-of-precision': 'off', + '@typescript-eslint/no-loss-of-precision': 'error', /** disallow characters which are made with multiple code points in character class syntax * https://eslint.org/docs/rules/no-misleading-character-class */ diff --git a/packages/@spscommerce/eslint-config-typescript/rules/stylisticIssues.ts b/packages/@spscommerce/eslint-config-typescript/rules/stylisticIssues.ts index ecb315cfcd..718561fbf0 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/stylisticIssues.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/stylisticIssues.ts @@ -18,8 +18,10 @@ export const stylisticIssues: StylisticIssues = { 'block-spacing': ['error', 'always'], /** enforce one true brace style - * https://eslint.org/docs/rules/brace-style */ - 'brace-style': 'error', + * https://eslint.org/docs/rules/brace-style + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/brace-style.md */ + 'brace-style': 'off', + '@typescript-eslint/brace-style': 'error', /** require camel case names * https://eslint.org/docs/rules/camelcase */ @@ -30,12 +32,16 @@ export const stylisticIssues: StylisticIssues = { 'capitalized-comments': 'off', /** require trailing commas in multiline object literals - * https://eslint.org/docs/rules/comma-dangle */ - 'comma-dangle': ['error', 'always-multiline'], + * https://eslint.org/docs/rules/comma-dangle + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/comma-dangle.md */ + 'comma-dangle': 'off', + '@typescript-eslint/comma-dangle': ['error', 'always-multiline'], /** enforce spacing before/after comma - * https://eslint.org/docs/rules/comma-spacing */ - 'comma-spacing': 'error', + * https://eslint.org/docs/rules/comma-spacing + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/comma-spacing.md */ + 'comma-spacing': 'off', + '@typescript-eslint/comma-spacing': 'error', /** enforce one true comma style * https://eslint.org/docs/rules/comma-style */ @@ -55,8 +61,10 @@ export const stylisticIssues: StylisticIssues = { 'eol-last': 'error', /** enforce spacing between functions and their invocations - * https://eslint.org/docs/rules/func-call-spacing */ - 'func-call-spacing': 'error', + * https://eslint.org/docs/rules/func-call-spacing + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/func-call-spacing.md */ + 'func-call-spacing': 'off', + '@typescript-eslint/func-call-spacing': 'error', /** 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 */ @@ -99,8 +107,10 @@ export const stylisticIssues: StylisticIssues = { 'implicit-arrow-linebreak': 'error', /** this option sets a specific tab width for your code - * https://eslint.org/docs/rules/indent */ - indent: ['error', 2], + * https://eslint.org/docs/rules/indent + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/indent.md */ + indent: 'off', + '@typescript-eslint/indent': ['error', 2], /** specify whether double or single quotes should be used in JSX attributes * https://eslint.org/docs/rules/jsx-quotes */ @@ -111,8 +121,10 @@ export const stylisticIssues: StylisticIssues = { 'key-spacing': 'error', /** require a space before & after certain keywords - * https://eslint.org/docs/rules/keyword-spacing */ - 'keyword-spacing': 'error', + * https://eslint.org/docs/rules/keyword-spacing + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/keyword-spacing.md */ + 'keyword-spacing': 'off', + '@typescript-eslint/keyword-spacing': 'error', /** enforce position of line comments * https://eslint.org/docs/rules/line-comment-position */ @@ -127,8 +139,10 @@ export const stylisticIssues: StylisticIssues = { 'lines-around-comment': 'off', /** require or disallow an empty line between class members - * https://eslint.org/docs/rules/lines-between-class-members */ - 'lines-between-class-members': 'error', + * https://eslint.org/docs/rules/lines-between-class-members + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/lines-between-class-members.md */ + 'lines-between-class-members': 'off', + '@typescript-eslint/lines-between-class-members': 'error', /** specify the maximum depth that blocks can be nested * https://eslint.org/docs/rules/max-depth */ @@ -194,8 +208,10 @@ export const stylisticIssues: StylisticIssues = { 'newline-per-chained-call': 'error', /** disallow use of the Array constructor - * https://eslint.org/docs/rules/no-array-constructor */ - 'no-array-constructor': 'error', + * https://eslint.org/docs/rules/no-array-constructor + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-array-constructor.md */ + 'no-array-constructor': 'off', + '@typescript-eslint/no-array-constructor': 'error', /** disallow use of bitwise operators * https://eslint.org/docs/rules/no-bitwise */ @@ -299,8 +315,10 @@ export const stylisticIssues: StylisticIssues = { ], /** require padding inside curly braces - * https://eslint.org/docs/rules/object-curly-spacing */ - 'object-curly-spacing': ['error', 'always'], + * https://eslint.org/docs/rules/object-curly-spacing + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/object-curly-spacing.md */ + 'object-curly-spacing': 'off', + '@typescript-eslint/object-curly-spacing': ['error', 'always'], /** enforce "same line" or "multiple line" on object properties. * https://eslint.org/docs/rules/object-property-newline */ @@ -338,8 +356,10 @@ export const stylisticIssues: StylisticIssues = { ], /** Require or disallow padding lines between statements - * https://eslint.org/docs/rules/padding-line-between-statements */ + * https://eslint.org/docs/rules/padding-line-between-statements + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/padding-line-between-statements.md */ 'padding-line-between-statements': 'off', + '@typescript-eslint/padding-line-between-statements': 'off', /** Disallow the use of Math.pow in favor of the ** operator * https://eslint.org/docs/rules/prefer-exponentiation-operator */ @@ -354,12 +374,16 @@ export const stylisticIssues: StylisticIssues = { 'quote-props': ['error', 'as-needed', { keywords: false, numbers: false }], /** specify whether double or single quotes should be used - * https://eslint.org/docs/rules/quotes */ - quotes: ['error', 'double', { avoidEscape: true }], + * https://eslint.org/docs/rules/quotes + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/quotes.md */ + quotes: 'off', + '@typescript-eslint/quotes': ['error', 'double', { avoidEscape: true }], /** require or disallow use of semicolons instead of ASI - * https://eslint.org/docs/rules/ */ - semi: 'error', + * https://eslint.org/docs/rules/ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/semi.md */ + semi: 'off', + '@typescript-eslint/semi': 'error', /** enforce spacing before and after semicolons * https://eslint.org/docs/rules/semi-spacing */ @@ -382,8 +406,10 @@ export const stylisticIssues: StylisticIssues = { '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': [ + * https://eslint.org/docs/rules/space-before-function-paren + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/space-before-function-paren.md */ + 'space-before-function-paren': 'off', + '@typescript-eslint/space-before-function-paren': [ 'error', { anonymous: 'always', @@ -397,8 +423,10 @@ export const stylisticIssues: StylisticIssues = { 'space-in-parens': 'error', /** require spaces around operators - * https://eslint.org/docs/rules/space-infix-ops */ - 'space-infix-ops': 'error', + * https://eslint.org/docs/rules/space-infix-ops + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/space-infix-ops.md */ + 'space-infix-ops': 'off', + '@typescript-eslint/space-infix-ops': 'error', /** Require or disallow spaces before/after unary operators * https://eslint.org/docs/rules/space-unary-ops */ diff --git a/packages/@spscommerce/eslint-config-typescript/rules/variables.ts b/packages/@spscommerce/eslint-config-typescript/rules/variables.ts index 74b1485fa8..12a152481e 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/variables.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/variables.ts @@ -2,8 +2,10 @@ import { Variables } from 'eslint/rules/variables'; export const variables: Variables = { /** enforce or disallow variable initializations at definition - * https://eslint.org/docs/rules/init-declarations */ + * https://eslint.org/docs/rules/init-declarations + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/init-declarations.md */ 'init-declarations': 'off', + '@typescript-eslint/init-declarations': 'off', /** disallow the catch clause parameter name being the same as a variable in the outer scope * https://eslint.org/docs/rules/no-catch-shadow */ @@ -34,8 +36,10 @@ export const variables: Variables = { ], /** disallow declaration of variables already declared in the outer scope - * https://eslint.org/docs/rules/no-shadow */ - 'no-shadow': 'error', + * https://eslint.org/docs/rules/no-shadow + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-shadow.md */ + 'no-shadow': 'off', + '@typescript-eslint/no-shadow': 'error', /** disallow shadowing of names such as arguments * https://eslint.org/docs/rules/no-shadow-restricted-names */ @@ -54,10 +58,14 @@ export const variables: Variables = { 'no-undefined': 'off', /** disallow declaration of variables that are not used in the code - * https://eslint.org/docs/rules/no-unused-vars */ - 'no-unused-vars': ['error', { ignoreRestSiblings: true }], + * https://eslint.org/docs/rules/no-unused-vars + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unused-vars.md */ + 'no-unused-vars': 'off', + '@typescript-eslint/no-unused-vars': ['error', { ignoreRestSiblings: true }], /** disallow use of variables before they are defined - * https://eslint.org/docs/rules/no-use-before-define */ - 'no-use-before-define': 'error', + * https://eslint.org/docs/rules/no-use-before-define + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-use-before-define.md */ + 'no-use-before-define': 'off', + '@typescript-eslint/no-use-before-define': 'error', }; From cc39cbf5d4783e2317549a15a08fc88701a66a71 Mon Sep 17 00:00:00 2001 From: Chris Nordhougen Date: Mon, 11 Oct 2021 07:31:23 -0500 Subject: [PATCH 08/29] base config is working --- .eslintrc | 0 .../eslint-config-react/.gitignore | 2 + .../eslint-config-react/.npmignore | 2 + .../@spscommerce/eslint-config-react/index.ts | 22 ++ .../eslint-config-react/package.json | 45 +++ .../eslint-config-react/rules/base.ts | 96 +++++ .../rules/classComponents.ts | 86 +++++ .../eslint-config-react/rules/props.ts | 56 +++ .../eslint-config-react/tsconfig.json | 9 + .../eslint-config-typescript/.gitignore | 2 +- .../eslint-config-typescript/.npmignore | 2 + .../eslint-config-typescript/index.ts | 9 + .../eslint-config-typescript/package.json | 18 +- .../rules/bestPractices.ts | 5 +- .../rules/typescript.ts | 337 ++++++++++++++++++ .../eslint-config-typescript/tsconfig.json | 3 +- 16 files changed, 684 insertions(+), 10 deletions(-) create mode 100644 .eslintrc create mode 100644 packages/@spscommerce/eslint-config-react/.gitignore create mode 100644 packages/@spscommerce/eslint-config-react/.npmignore create mode 100644 packages/@spscommerce/eslint-config-react/index.ts create mode 100644 packages/@spscommerce/eslint-config-react/package.json create mode 100644 packages/@spscommerce/eslint-config-react/rules/base.ts create mode 100644 packages/@spscommerce/eslint-config-react/rules/classComponents.ts create mode 100644 packages/@spscommerce/eslint-config-react/rules/props.ts create mode 100644 packages/@spscommerce/eslint-config-react/tsconfig.json create mode 100644 packages/@spscommerce/eslint-config-typescript/rules/typescript.ts diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/@spscommerce/eslint-config-react/.gitignore b/packages/@spscommerce/eslint-config-react/.gitignore new file mode 100644 index 0000000000..491fc35975 --- /dev/null +++ b/packages/@spscommerce/eslint-config-react/.gitignore @@ -0,0 +1,2 @@ +node_modules +lib diff --git a/packages/@spscommerce/eslint-config-react/.npmignore b/packages/@spscommerce/eslint-config-react/.npmignore new file mode 100644 index 0000000000..c314862cef --- /dev/null +++ b/packages/@spscommerce/eslint-config-react/.npmignore @@ -0,0 +1,2 @@ +rules +*.ts diff --git a/packages/@spscommerce/eslint-config-react/index.ts b/packages/@spscommerce/eslint-config-react/index.ts new file mode 100644 index 0000000000..4d4365b094 --- /dev/null +++ b/packages/@spscommerce/eslint-config-react/index.ts @@ -0,0 +1,22 @@ +import { Linter } from 'eslint'; + +import { base } from "./rules/base"; +// Included for completeness, but all these rules are off because class components are forbidden +import { classComponents } from './rules/classComponents'; +import { props } from './rules/props'; + +const config: Linter.Config = { + plugins: [ + 'react', + 'react-prefer-function-component', + 'react-hooks', + 'jsx-a11y', + ], + rules: { + ...base, + ...classComponents, + ...props, + }, +}; + +export = config; diff --git a/packages/@spscommerce/eslint-config-react/package.json b/packages/@spscommerce/eslint-config-react/package.json new file mode 100644 index 0000000000..b804e13a5b --- /dev/null +++ b/packages/@spscommerce/eslint-config-react/package.json @@ -0,0 +1,45 @@ +{ + "name": "@spscommerce/eslint-config-react", + "version": "0.0.1", + "description": "SPS official linter configuration for React.", + "main": "lib/index.js", + "scripts": { + "build": "tsc -p tsconfig.json" + }, + "repository": { + "type": "git", + "url": "https://github.com/SPSCommerce/javascript.git" + }, + "keywords": [ + "style guide", + "lint", + "airbnb", + "SPS", + "SPS Commerce", + "es6", + "es2015", + "es2016", + "es2017", + "es2018", + "react", + "jsx" + ], + "author": "SPS Commerce", + "license": "MIT", + "bugs": { + "url": "https://github.com/SPSCommerce/javascript/issues" + }, + "homepage": "https://github.com/SPSCommerce/javascript", + "peerDependencies": { + "eslint": "^7.32.0" + }, + "dependencies": { + "eslint-plugin-jsx-a11y": "^6.4.1", + "eslint-plugin-react": "^7.26.1", + "eslint-plugin-react-hooks": "^4.2.0", + "eslint-plugin-react-prefer-function-component": "^0.0.7" + }, + "devDependencies": { + "@types/eslint": "^7.28.0" + } +} diff --git a/packages/@spscommerce/eslint-config-react/rules/base.ts b/packages/@spscommerce/eslint-config-react/rules/base.ts new file mode 100644 index 0000000000..50ee365fc9 --- /dev/null +++ b/packages/@spscommerce/eslint-config-react/rules/base.ts @@ -0,0 +1,96 @@ +import { Linter } from "eslint"; + +// ✅ = recommended, 🔧 = fixable +export const base: Linter.RulesRecord = { + /** Forbid "button" element without an explicit "type" attribute + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/button-has-type.md */ + 'react/button-has-type': 'off', + + /** Enforce consistent usage of destructuring assignment of props, state, and context + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/destructuring-assignment.md */ + 'react/destructuring-assignment': 'off', + + /** 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': 'error', + + /** Forbid certain elements + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-elements.md */ + 'react/forbid-elements': 'off', + + /** Standardize the way function components get defined 🔧 + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/function-component-definition.md */ + 'react/function-component-definition': 'off', + + /** Prevent adjacent inline elements not separated by whitespace + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-adjacent-inline-elements.md */ + 'react/no-adjacent-inline-elements': 'off', + + /** 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': 'off', + + /** 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', + + /** Prevent usage of dangerous JSX props + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-danger.md */ + 'react/no-danger': 'off', + + /** Report when a DOM element is using both children and dangerouslySetInnerHTML ✅ + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-danger-with-children.md */ + 'react/no-danger-with-children': 'error', + + /** 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 findDOMNode ✅ + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-find-dom-node.md */ + 'react/no-find-dom-node': 'off', + + /** 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': 'off', + + /** Enforce that namespaces are not used in React elements + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-namespace.md */ + 'react/no-namespace': 'off', + + /** Report "this" being used in stateless components + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-this-in-sfc.md */ + 'react/no-this-in-sfc': 'off', + + /** Prevent common typos + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-typos.md */ + 'react/no-typos': 'off', + + /** Detect unescaped HTML entities, which might represent malformed tags ✅ + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unescaped-entities.md */ + 'react/no-unescaped-entities': 'error', + + /** Prevent creating unstable components inside components + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unstable-nested-components.md */ + 'react/no-unstable-nested-components': 'off', + + /** Enforce stateless components to be written as a pure function + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-stateless-function.md */ + 'react/prefer-stateless-function': 'off', + + /** 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': 'off', + + /** 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': 'off', + + /** Enforce style prop value is an object + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/style-prop-object.md */ + 'react/style-prop-object': 'off', + + /** Prevent passing of children to void DOM elements (e.g. `
`) + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/void-dom-elements-no-children.md */ + 'react/void-dom-elements-no-children': 'off', +}; diff --git a/packages/@spscommerce/eslint-config-react/rules/classComponents.ts b/packages/@spscommerce/eslint-config-react/rules/classComponents.ts new file mode 100644 index 0000000000..d4516e208b --- /dev/null +++ b/packages/@spscommerce/eslint-config-react/rules/classComponents.ts @@ -0,0 +1,86 @@ +import { Linter } from "eslint"; + +// Included for completeness, but all rules are disabled because class components are forbidden. + +// ✅ = recommended, 🔧 = fixable +export const classComponents: Linter.RulesRecord = { + /** Reports when this.state is accessed within setState + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-access-state-in-setstate.md */ + 'react/no-access-state-in-setstate': 'off', + + /** Lifecycle methods should be methods on the prototype, not class fields 🔧 + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-arrow-function-lifecycle.md */ + 'react/no-arrow-function-lifecycle': 'off', + + /** Prevent usage of setState in componentDidMount + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-did-mount-set-state.md */ + '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': 'off', + + /** 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': 'off', + + /** Flag shouldComponentUpdate when extending PureComponent + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-redundant-should-component-update.md */ + 'react/no-redundant-should-component-update': 'off', + + /** Prevent usage of the return value of React.render ✅ + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-render-return-value.md */ + 'react/no-render-return-value': 'off', + + /** 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 string definitions for references and prevent referencing this.refs ✅ + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-string-refs.md */ + 'react/no-string-refs': 'off', + + /** Prevent usage of unsafe lifecycle methods + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unsafe.md */ + 'react/no-unsafe': 'off', + + /** Prevent declaring unused methods of component class + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unused-class-component-methods.md */ + 'react/no-unused-class-component-methods': 'off', + + /** Prevent definition of unused state fields + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unused-state.md */ + 'react/no-unused-state': 'off', + + /** 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': 'off', + + /** Enforce ES5 or ES6 class for React Components + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-es6-class.md */ + 'react/prefer-es6-class': 'off', + + /** Enforce React components to have a shouldComponentUpdate method + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-optimization.md */ + 'react/require-optimization': 'off', + + /** Enforce ES5 or ES6 class for returning value in render function ✅ + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-render-return.md */ + 'react/require-render-return': 'off', + + /** Enforce component methods order + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md */ + 'react/sort-comp': 'off', + + /** State initialization in an ES6 class component should be in a constructor + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/state-in-constructor.md */ + 'react/state-in-constructor': 'off', + + /** Defines where React component static properties should be positioned + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/static-property-placement.md */ + 'react/static-property-placement': 'off', +}; diff --git a/packages/@spscommerce/eslint-config-react/rules/props.ts b/packages/@spscommerce/eslint-config-react/rules/props.ts new file mode 100644 index 0000000000..be71b13d49 --- /dev/null +++ b/packages/@spscommerce/eslint-config-react/rules/props.ts @@ -0,0 +1,56 @@ +import { Linter } from "eslint"; + +// ✅ = recommended, 🔧 = fixable +export const props: Linter.RulesRecord = { + /** Enforces consistent naming for boolean props + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/boolean-prop-naming.md */ + 'react/boolean-prop-naming': 'off', + + /** Enforce all defaultProps are defined and not "required" in propTypes + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/default-props-match-prop-types.md */ + 'react/default-props-match-prop-types': 'off', + + /** 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 certain props on DOM Nodes + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-dom-props.md */ + 'react/forbid-dom-props': 'off', + + /** Forbid using another component's propTypes + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-foreign-prop-types.md */ + 'react/forbid-foreign-prop-types': 'off', + + /** Forbid certain propTypes + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-prop-types.md */ + 'react/forbid-prop-types': 'off', + + /** 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', + + /** Prevent definitions of unused prop types + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unused-prop-types.md */ + 'react/no-unused-prop-types': 'off', + + /** Prefer exact proptype definitions + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-exact-props.md */ + 'react/prefer-exact-props': 'off', + + /** Require read-only props 🔧 + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-read-only-props.md */ + 'react/prefer-read-only-props': 'off', + + /** 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', + + /** Enforce a defaultProps definition for every prop that is not a required prop + * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-default-props.md */ + 'react/require-default-props': 'off', + + /** 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', +}; diff --git a/packages/@spscommerce/eslint-config-react/tsconfig.json b/packages/@spscommerce/eslint-config-react/tsconfig.json new file mode 100644 index 0000000000..2d4334cbca --- /dev/null +++ b/packages/@spscommerce/eslint-config-react/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "module": "commonjs", + "outDir": "lib" + }, + "include": ["./**/*.ts"], + "exclude": ["node_modules"] +} diff --git a/packages/@spscommerce/eslint-config-typescript/.gitignore b/packages/@spscommerce/eslint-config-typescript/.gitignore index 23a608b6ad..491fc35975 100644 --- a/packages/@spscommerce/eslint-config-typescript/.gitignore +++ b/packages/@spscommerce/eslint-config-typescript/.gitignore @@ -1,2 +1,2 @@ node_modules -*.js +lib diff --git a/packages/@spscommerce/eslint-config-typescript/.npmignore b/packages/@spscommerce/eslint-config-typescript/.npmignore index 6461deecd1..93c4ca6271 100644 --- a/packages/@spscommerce/eslint-config-typescript/.npmignore +++ b/packages/@spscommerce/eslint-config-typescript/.npmignore @@ -1 +1,3 @@ +rules +!lib/rules *.ts diff --git a/packages/@spscommerce/eslint-config-typescript/index.ts b/packages/@spscommerce/eslint-config-typescript/index.ts index 0e55c3074b..ed6523f748 100644 --- a/packages/@spscommerce/eslint-config-typescript/index.ts +++ b/packages/@spscommerce/eslint-config-typescript/index.ts @@ -7,6 +7,7 @@ import { variables } from './rules/variables'; import { stylisticIssues } from './rules/stylisticIssues'; import { es6 } from './rules/es6'; import * as imports from './rules/imports'; +import { typescript } from './rules/typescript'; const config: Linter.Config = { parser: '@typescript-eslint/parser', @@ -22,6 +23,13 @@ const config: Linter.Config = { 'import/parsers': { '@typescript-eslint/parser': ['.ts', '.tsx'], }, + "import/resolver": { + "typescript": {}, + } + }, + env: { + browser: true, + jest: true, }, rules: { ...possibleErrors, @@ -34,6 +42,7 @@ const config: Linter.Config = { ...imports.helpfulWarnings, ...imports.moduleSystems, ...imports.styleGuide, + ...typescript, }, }; diff --git a/packages/@spscommerce/eslint-config-typescript/package.json b/packages/@spscommerce/eslint-config-typescript/package.json index 50f324ecec..82ac38c6c9 100644 --- a/packages/@spscommerce/eslint-config-typescript/package.json +++ b/packages/@spscommerce/eslint-config-typescript/package.json @@ -1,8 +1,8 @@ { "name": "@spscommerce/eslint-config-typescript", - "version": "0.0.1", + "version": "0.0.2", "description": "SPS official linter configuration for TypeScript.", - "main": "index.js", + "main": "lib/index.js", "scripts": { "build": "tsc -p tsconfig.json" }, @@ -31,14 +31,20 @@ }, "homepage": "https://github.com/SPSCommerce/javascript", "peerDependencies": { - "eslint": "^7.32.0" - }, - "dependencies": { "@typescript-eslint/eslint-plugin": "^4.31.2", "@typescript-eslint/parser": "^4.31.2", + "eslint": "^7.32.0", + "eslint-import-resolver-typescript": "^2.5.0", "eslint-plugin-import": "^2.24.2" }, + "dependencies": { + }, "devDependencies": { - "@types/eslint": "^7.28.0" + "@types/eslint": "^7.28.0", + "@typescript-eslint/eslint-plugin": "^4.31.2", + "@typescript-eslint/parser": "^4.31.2", + "eslint": "^7.32.0", + "eslint-import-resolver-typescript": "^2.5.0", + "eslint-plugin-import": "^2.24.2" } } diff --git a/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts b/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts index 5222646505..92aa81fd62 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts @@ -152,8 +152,9 @@ export const bestPractices: BestPractices = { ], /** disallow var and named functions in global scope - * https://eslint.org/docs/rules/no-implicit-globals */ - 'no-implicit-globals': 'error', + * https://eslint.org/docs/rules/no-implicit-globals + * disabled because it can't distinguish between a file with no imports and a browser script */ + 'no-implicit-globals': 'off', /** disallow use of eval()-like methods * https://eslint.org/docs/rules/no-implied-eval diff --git a/packages/@spscommerce/eslint-config-typescript/rules/typescript.ts b/packages/@spscommerce/eslint-config-typescript/rules/typescript.ts new file mode 100644 index 0000000000..71e0bf6e00 --- /dev/null +++ b/packages/@spscommerce/eslint-config-typescript/rules/typescript.ts @@ -0,0 +1,337 @@ +import { Linter } from "eslint"; + +// ✅ = recommended, 🔧 = fixable, 💭 = requires type information +export const typescript: Linter.RulesRecord = { + /** Require that member overloads be consecutive ✅ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/adjacent-overload-signatures.md */ + '@typescript-eslint/adjacent-overload-signatures': 'error', + + /** Requires using either `T[]` or `Array` for arrays 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/array-type.md */ + '@typescript-eslint/array-type': ['error', { default: 'array-simple' }], + + /** Disallows awaiting a value that is not a Thenable ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/await-thenable.md */ + '@typescript-eslint/await-thenable': 'error', + + /** Bans `@ts-` comments from being used or requires descriptions after directive ✅ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-ts-comment.md */ + '@typescript-eslint/ban-ts-comment': 'error', + + /** Bans // tslint: comments from being used 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-tslint-comment.md */ + '@typescript-eslint/ban-tslint-comment': 'off', + + /** Bans specific types from being used ✅ 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md + * The default config you get if you enable this recommended rule without specifying your own should be reviewed. */ + '@typescript-eslint/ban-types': 'error', + + /** Ensures that literals on classes are exposed in a consistent style 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/class-literal-property-style.md */ + '@typescript-eslint/class-literal-property-style': ["error", "fields"], + + /** Enforce or disallow the use of the record type 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/consistent-indexed-object-style.md */ + '@typescript-eslint/consistent-indexed-object-style': ['error', 'record'], + + /** Enforces consistent usage of type assertions + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/consistent-type-assertions.md */ + '@typescript-eslint/consistent-type-assertions': ['error', { assertionStyle: 'as' }], + + /** Consistent with type definition either `interface` or `type` 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/consistent-type-definitions.md */ + '@typescript-eslint/consistent-type-definitions': ['error', 'interface'], + + /** Enforces consistent usage of type imports 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/consistent-type-imports.md */ + '@typescript-eslint/consistent-type-imports': ['error', { prefer: 'type-imports' }], + + /** Require explicit return types on functions and class methods + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-function-return-type.md */ + '@typescript-eslint/explicit-function-return-type': 'error', + + /** Require explicit accessibility modifiers on class properties and methods 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-member-accessibility.md */ + '@typescript-eslint/explicit-member-accessibility': 'off', + + /** Require explicit return and argument types on exported functions' and classes' public class methods ✅ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-module-boundary-types.md */ + '@typescript-eslint/explicit-module-boundary-types': 'error', + + /** Require a specific member delimiter style for interfaces and type literals 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/member-delimiter-style.md */ + '@typescript-eslint/member-delimiter-style': 'error', + + /** Require a consistent member declaration order + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/member-ordering.md */ + '@typescript-eslint/member-ordering': 'off', + + /** Enforces using a particular method signature syntax 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/method-signature-style.md */ + '@typescript-eslint/method-signature-style': 'off', + + /** Enforces naming conventions for everything across a codebase 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/naming-convention.md */ + '@typescript-eslint/naming-convention': 'off', + + /** Requires that `.toString()` is only called on objects which provide useful information when stringified 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-base-to-string.md */ + '@typescript-eslint/no-base-to-string': 'off', + + /** Disallow non-null assertion in locations that may be confusing 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-confusing-non-null-assertion.md */ + '@typescript-eslint/no-confusing-non-null-assertion': 'off', + + /** Requires expressions of type void to appear in statement position 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-confusing-void-expression.md */ + '@typescript-eslint/no-confusing-void-expression': 'off', + + /** Disallow the delete operator with computed key expressions 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-dynamic-delete.md */ + '@typescript-eslint/no-dynamic-delete': 'off', + + /** Disallow the declaration of empty interfaces ✅ 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-empty-interface.md */ + '@typescript-eslint/no-empty-interface': 'error', + + /** Disallow usage of the `any` type ✅ 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-explicit-any.md */ + '@typescript-eslint/no-explicit-any': 'error', + + /** Disallow extra non-null assertion ✅ 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-extra-non-null-assertion.md */ + '@typescript-eslint/no-extra-non-null-assertion': 'error', + + /** Forbids the use of classes as namespaces + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-extraneous-class.md */ + '@typescript-eslint/no-extraneous-class': 'off', + + /** Requires Promise-like values to be handled appropriately ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-floating-promises.md */ + '@typescript-eslint/no-floating-promises': 'error', + + /** Disallow iterating over an array with a for-in loop ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-for-in-array.md */ + '@typescript-eslint/no-for-in-array': 'error', + + /** Disallow usage of the implicit `any` type in catch clauses 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-implicit-any-catch.md */ + '@typescript-eslint/no-implicit-any-catch': 'off', + + /** Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean ✅ 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-inferrable-types.md */ + '@typescript-eslint/no-inferrable-types': 'error', + + /** Disallows usage of `void` type outside of generic or return types + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-invalid-void-type.md */ + '@typescript-eslint/no-invalid-void-type': 'off', + + /** Disallow the `void` operator except when used to discard a value 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-meaningless-void-operator.md */ + '@typescript-eslint/no-meaningless-void-operator': 'off', + + /** Enforce valid definition of `new` and `constructor` ✅ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-misused-new.md */ + '@typescript-eslint/no-misused-new': 'error', + + /** Avoid using promises in places not designed to handle them ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-misused-promises.md */ + '@typescript-eslint/no-misused-promises': 'error', + + /** Disallow the use of custom TypeScript modules and namespaces ✅ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-namespace.md */ + '@typescript-eslint/no-namespace': 'error', + + /** Disallows using a non-null assertion in the left operand of the nullish coalescing operator + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-non-null-asserted-nullish-coalescing.md */ + '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'off', + + /** Disallows using a non-null assertion after an optional chain expression ✅ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-non-null-asserted-optional-chain.md */ + '@typescript-eslint/no-non-null-asserted-optional-chain': 'error', + + /** Disallows non-null assertions using the `!` postfix operator ✅ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-non-null-assertion.md */ + '@typescript-eslint/no-non-null-assertion': 'error', + + /** Disallow the use of parameter properties in class constructors + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-parameter-properties.md */ + '@typescript-eslint/no-parameter-properties': 'off', + + /** Disallows invocation of `require()` + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-require-imports.md */ + '@typescript-eslint/no-require-imports': 'off', + + /** Disallow aliasing `this` ✅ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-this-alias.md */ + '@typescript-eslint/no-this-alias': 'error', + + /** Disallow the use of type aliases + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-type-alias.md */ + '@typescript-eslint/no-type-alias': 'off', + + /** Flags unnecessary equality comparisons against boolean literals 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unnecessary-boolean-literal-compare.md */ + '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'off', + + /** Prevents conditionals where the type is always truthy or always falsy 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unnecessary-condition.md */ + '@typescript-eslint/no-unnecessary-condition': 'off', + + /** Warns when a namespace qualifier is unnecessary 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unnecessary-qualifier.md */ + '@typescript-eslint/no-unnecessary-qualifier': 'off', + + /** Enforces that type arguments will not be used if not required 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unnecessary-type-arguments.md */ + '@typescript-eslint/no-unnecessary-type-arguments': 'off', + + /** Warns if a type assertion does not change the type of an expression ✅ 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unnecessary-type-assertion.md */ + '@typescript-eslint/no-unnecessary-type-assertion': 'error', + + /** Disallows unnecessary constraints on generic types 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unnecessary-type-constraint.md */ + '@typescript-eslint/no-unnecessary-type-constraint': 'off', + + /** Disallows calling an function with an `any` type value 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unsafe-argument.md */ + '@typescript-eslint/no-unsafe-argument': 'off', + + /** Disallows assigning `any` to variables and properties ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unsafe-assignment.md */ + '@typescript-eslint/no-unsafe-assignment': 'error', + + /** Disallows calling an `any` type value ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unsafe-call.md */ + '@typescript-eslint/no-unsafe-call': 'error', + + /** Disallows member access on `any` typed variables ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unsafe-member-access.md */ + '@typescript-eslint/no-unsafe-member-access': 'error', + + /** Disallows returning any from a function ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unsafe-return.md */ + '@typescript-eslint/no-unsafe-return': 'error', + + /** Disallows the use of require statements except in import statements ✅ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-var-requires.md */ + '@typescript-eslint/no-var-requires': 'error', + + /** Prefers a non-null assertion over explicit type cast when possible 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/non-nullable-type-assertion-style.md */ + '@typescript-eslint/non-nullable-type-assertion-style': 'off', + + /** Prefer usage of as const over literal type ✅ 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-as-const.md */ + '@typescript-eslint/prefer-as-const': 'error', + + /** Prefer initializing each enums member value + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-enum-initializers.md */ + '@typescript-eslint/prefer-enum-initializers': 'off', + + /** Prefer a ‘for-of’ loop over a standard ‘for’ loop if the index is only used to access the array being iterated + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-for-of.md */ + '@typescript-eslint/prefer-for-of': 'off', + + /** Use function types instead of interfaces with call signatures 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-function-type.md */ + '@typescript-eslint/prefer-function-type': 'off', + + /** Enforce includes method over indexOf method 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-includes.md */ + '@typescript-eslint/prefer-includes': 'off', + + /** Require that all enum members be literal values to prevent unintended enum member name shadow issues + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-literal-enum-member.md */ + '@typescript-eslint/prefer-literal-enum-member': 'off', + + /** Require the use of the `namespace` keyword instead of the `module` keyword to declare custom TypeScript modules ✅ 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-namespace-keyword.md */ + '@typescript-eslint/prefer-namespace-keyword': 'error', + + /** Enforce the usage of the nullish coalescing operator instead of logical chaining 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-nullish-coalescing.md */ + '@typescript-eslint/prefer-nullish-coalescing': 'off', + + /** Prefer using concise optional chain expressions instead of chained logical ands + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-optional-chain.md */ + '@typescript-eslint/prefer-optional-chain': 'off', + + /** Requires that private members are marked as `readonly` if they're never modified outside of the constructor 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-readonly.md */ + '@typescript-eslint/prefer-readonly': 'off', + + /** Requires that function parameters are typed as `readonly` to prevent accidental mutation of inputs 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-readonly-parameter-types.md */ + '@typescript-eslint/prefer-readonly-parameter-types': 'off', + + /** Prefer using type parameter when calling `Array#reduce` instead of casting 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-reduce-type-parameter.md */ + '@typescript-eslint/prefer-reduce-type-parameter': 'off', + + /** Enforce that `RegExp#exec` is used instead of `String#match` if no global flag is provided ✅ 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-regexp-exec.md */ + '@typescript-eslint/prefer-regexp-exec': 'error', + + /** Enforce that `this` is used when only `this` type is returned 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-return-this-type.md */ + '@typescript-eslint/prefer-return-this-type': 'off', + + /** Enforce the use of `String#startsWith` and `String#endsWith` instead of other equivalent methods of checking substrings 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-string-starts-ends-with.md */ + '@typescript-eslint/prefer-string-starts-ends-with': 'off', + + /** Recommends using `@ts-expect-error` over `@ts-ignore` 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-ts-expect-error.md */ + '@typescript-eslint/prefer-ts-expect-error': 'off', + + /** Requires any function or method that returns a Promise to be marked async 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/promise-function-async.md */ + '@typescript-eslint/promise-function-async': 'off', + + /** Requires `Array#sort` calls to always provide a `compareFunction` 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/require-array-sort-compare.md */ + '@typescript-eslint/require-array-sort-compare': 'off', + + /** When adding two variables, operands must both be of type number or of type string ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/restrict-plus-operands.md */ + '@typescript-eslint/restrict-plus-operands': 'error', + + /** Enforce template literal expressions to be of string type ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/restrict-template-expressions.md */ + '@typescript-eslint/restrict-template-expressions': 'error', + + /** Enforces that members of a type union/intersection are sorted alphabetically 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/sort-type-union-intersection-members.md */ + '@typescript-eslint/sort-type-union-intersection-members': 'off', + + /** Restricts the types allowed in boolean expressions 🔧 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/strict-boolean-expressions.md */ + '@typescript-eslint/strict-boolean-expressions': 'off', + + /** Exhaustiveness checking in switch with union type 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.md */ + '@typescript-eslint/switch-exhaustiveness-check': 'off', + + /** Sets preference level for triple slash directives versus ES6-style import declarations ✅ + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/triple-slash-reference.md */ + '@typescript-eslint/triple-slash-reference': 'error', + + /** Require consistent spacing around type annotations 🔧 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/type-annotation-spacing.md */ + '@typescript-eslint/type-annotation-spacing': 'off', + + /** Requires type annotations to exist + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/typedef.md */ + '@typescript-eslint/typedef': 'off', + + /** Enforces unbound methods are called with their expected scope ✅ 💭 + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/unbound-method.md */ + '@typescript-eslint/unbound-method': 'off', + + /** Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter + * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/unified-signatures.md */ + '@typescript-eslint/unified-signatures': 'off', +}; diff --git a/packages/@spscommerce/eslint-config-typescript/tsconfig.json b/packages/@spscommerce/eslint-config-typescript/tsconfig.json index a54d95c9c0..2d4334cbca 100644 --- a/packages/@spscommerce/eslint-config-typescript/tsconfig.json +++ b/packages/@spscommerce/eslint-config-typescript/tsconfig.json @@ -1,7 +1,8 @@ { "extends": "../../../tsconfig.json", "compilerOptions": { - "module": "commonjs" + "module": "commonjs", + "outDir": "lib" }, "include": ["./**/*.ts"], "exclude": ["node_modules"] From 5fc931aaa086f5f0ee1e79e7c2091535caeba2b1 Mon Sep 17 00:00:00 2001 From: Chris Nordhougen Date: Mon, 11 Oct 2021 09:17:33 -0500 Subject: [PATCH 09/29] annotate recommended/fixable for base rules --- README.md | 4 +- .../rules/bestPractices.ts | 49 +++---- .../eslint-config-typescript/rules/es6.ts | 51 +++---- .../rules/possibleErrors.ts | 77 +++++------ .../rules/strictMode.ts | 3 +- .../rules/stylisticIssues.ts | 127 +++++++++--------- .../rules/variables.ts | 11 +- 7 files changed, 164 insertions(+), 158 deletions(-) diff --git a/README.md b/README.md index 92917f5c72..18faed8402 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ **TODO:** Write description -Other Style Guides + ## Table of Contents diff --git a/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts b/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts index 92aa81fd62..71048ccfbd 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/bestPractices.ts @@ -1,5 +1,6 @@ import { BestPractices } from 'eslint/rules/best-practices'; +// ✅ = recommended, 🔧 = fixable export const bestPractices: BestPractices = { /** enforces getter/setter pairs in objects * https://eslint.org/docs/rules/accessor-pairs @@ -27,7 +28,7 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/consistent-return */ 'consistent-return': 'off', - /** specify curly brace conventions for all control statements + /** specify curly brace conventions for all control statements 🔧 * https://eslint.org/docs/rules/curly */ curly: ['error', 'multi-line'], @@ -49,13 +50,13 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/dot-location */ 'dot-location': ['error', 'property'], - /** encourages use of dot notation whenever possible + /** encourages use of dot notation whenever possible 🔧 * https://eslint.org/docs/rules/dot-notation * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/dot-notation.md */ 'dot-notation': 'off', '@typescript-eslint/dot-notation': ['error', { allowKeywords: true }], - /** require the use of === and !== + /** require the use of === and !== 🔧 * https://eslint.org/docs/rules/eqeqeq */ eqeqeq: 'error', @@ -81,7 +82,7 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/no-caller */ 'no-caller': 'error', - /** disallow lexical declarations in case/default clauses + /** disallow lexical declarations in case/default clauses ✅ * https://eslint.org/docs/rules/no-case-declarations */ 'no-case-declarations': 'error', @@ -89,11 +90,11 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/no-constructor-return */ 'no-constructor-return': 'error', - /** disallow division operators explicitly at beginning of regular expression + /** 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 + /** disallow else after a return in an if 🔧 * https://eslint.org/docs/rules/no-else-return */ 'no-else-return': 'off', @@ -103,7 +104,7 @@ export const bestPractices: BestPractices = { 'no-empty-function': 'off', '@typescript-eslint/no-empty-function': 'off', - /** disallow empty destructuring patterns + /** disallow empty destructuring patterns ✅ * https://eslint.org/docs/rules/no-empty-pattern */ 'no-empty-pattern': 'error', @@ -120,27 +121,27 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/no-extend-native */ 'no-extend-native': 'error', - /** disallow unnecessary function binding + /** disallow unnecessary function binding 🔧 * https://eslint.org/docs/rules/no-extra-bind */ 'no-extra-bind': 'error', - /** disallow Unnecessary Labels + /** disallow Unnecessary Labels 🔧 * https://eslint.org/docs/rules/no-extra-label */ 'no-extra-label': 'error', - /** disallow fallthrough of case statements + /** disallow fallthrough of case statements ✅ * https://eslint.org/docs/rules/no-fallthrough */ 'no-fallthrough': 'error', - /** disallow the use of leading or trailing decimal points in numeric literals + /** disallow the use of leading or trailing decimal points in numeric literals 🔧 * https://eslint.org/docs/rules/no-floating-decimal */ 'no-floating-decimal': 'error', - /** disallow reassignments of native objects or read-only globals + /** disallow reassignments of native objects or read-only globals ✅ * https://eslint.org/docs/rules/no-global-assign */ 'no-global-assign': 'error', - /** disallow implicit type conversions + /** disallow implicit type conversions 🔧 * https://eslint.org/docs/rules/no-implicit-coercion */ 'no-implicit-coercion': [ 'error', @@ -192,7 +193,7 @@ export const bestPractices: BestPractices = { 'no-magic-numbers': 'off', '@typescript-eslint/no-magic-numbers': ['error', { ignoreArrayIndexes: true }], - /** disallow use of multiple spaces + /** disallow use of multiple spaces 🔧 * https://eslint.org/docs/rules/no-multi-spaces */ 'no-multi-spaces': 'error', @@ -212,11 +213,11 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/no-new-wrappers */ 'no-new-wrappers': 'error', - /** Disallow \8 and \9 escape sequences in string literals + /** Disallow \8 and \9 escape sequences in string literals ✅ * https://eslint.org/docs/rules/no-nonoctal-decimal-escape */ 'no-nonoctal-decimal-escape': 'error', - /** disallow use of (old style) octal literals + /** disallow use of (old style) octal literals ✅ * https://eslint.org/docs/rules/no-octal */ 'no-octal': 'error', @@ -242,7 +243,7 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/no-proto */ 'no-proto': 'error', - /** disallow declaring the same variable more than once + /** disallow declaring the same variable more than once ✅ * https://eslint.org/docs/rules/no-redeclare * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-redeclare.md */ 'no-redeclare': 'off', @@ -303,7 +304,7 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/no-script-url */ 'no-script-url': 'error', - /** disallow self assignment + /** disallow self assignment ✅ * https://eslint.org/docs/rules/no-self-assign */ 'no-self-assign': 'error', @@ -331,7 +332,7 @@ export const bestPractices: BestPractices = { 'no-unused-expressions': 'off', '@typescript-eslint/no-unused-expressions': ['error', { allowTaggedTemplates: false }], - /** disallow unused labels + /** disallow unused labels ✅ 🔧 * https://eslint.org/docs/rules/no-unused-labels */ 'no-unused-labels': 'error', @@ -339,7 +340,7 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/no-useless-call */ 'no-useless-call': 'off', - /** Disallow unnecessary catch clauses + /** Disallow unnecessary catch clauses ✅ * https://eslint.org/docs/rules/no-useless-catch */ 'no-useless-catch': 'error', @@ -347,11 +348,11 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/no-useless-concat */ 'no-useless-concat': 'error', - /** disallow unnecessary string escaping + /** disallow unnecessary string escaping ✅ * https://eslint.org/docs/rules/no-useless-escape */ 'no-useless-escape': 'error', - /** disallow redundant return; keywords + /** disallow redundant return; keywords 🔧 * https://eslint.org/docs/rules/no-useless-return */ 'no-useless-return': 'error', @@ -363,7 +364,7 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/no-warning-comments */ 'no-warning-comments': 'off', - /** disallow use of the with statement + /** disallow use of the with statement ✅ * https://eslint.org/docs/rules/no-with */ 'no-with': 'error', @@ -402,7 +403,7 @@ export const bestPractices: BestPractices = { * https://eslint.org/docs/rules/wrap-iife.html */ 'wrap-iife': ['error', 'outside', { functionPrototypeMethods: false }], - /** require or disallow Yoda conditions + /** require or disallow Yoda conditions 🔧 * https://eslint.org/docs/rules/yoda */ yoda: 'error' }; diff --git a/packages/@spscommerce/eslint-config-typescript/rules/es6.ts b/packages/@spscommerce/eslint-config-typescript/rules/es6.ts index 7617d32868..f21a76a754 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/es6.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/es6.ts @@ -1,39 +1,40 @@ import { ECMAScript6 } from 'eslint/rules/ecmascript-6'; +// ✅ = recommended, 🔧 = fixable export const es6: ECMAScript6 = { - /** enforces no braces where they can be omitted + /** enforces no braces where they can be omitted 🔧 * https://eslint.org/docs/rules/arrow-body-style */ 'arrow-body-style': 'error', - /** require parens in arrow function arguments + /** require parens in arrow function arguments 🔧 * https://eslint.org/docs/rules/arrow-parens */ 'arrow-parens': 'error', - /** require space before/after arrow function's arrow + /** require space before/after arrow function's arrow 🔧 * https://eslint.org/docs/rules/arrow-spacing */ 'arrow-spacing': 'error', - /** verify super() callings in constructors + /** verify super() callings in constructors ✅ * https://eslint.org/docs/rules/constructor-super */ 'constructor-super': 'error', - /** enforce the spacing around the * in generator functions + /** 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 + /** 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 + /** 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 + /** disallow modifying variables that are declared using const ✅ * https://eslint.org/docs/rules/no-const-assign */ 'no-const-assign': 'error', - /** disallow duplicate class members + /** disallow duplicate class members ✅ * https://eslint.org/docs/rules/no-dupe-class-members * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-dupe-class-members.md */ 'no-dupe-class-members': 'off', @@ -47,7 +48,7 @@ export const es6: ECMAScript6 = { 'no-duplicate-imports': 'off', '@typescript-eslint/no-duplicate-imports': 'off', - /** disallow symbol constructor + /** disallow symbol constructor ✅ * https://eslint.org/docs/rules/no-new-symbol */ 'no-new-symbol': 'error', @@ -61,11 +62,11 @@ export const es6: ECMAScript6 = { 'no-restricted-imports': 'off', '@typescript-eslint/no-restricted-imports': 'off', - /** disallow to use this/super before super() calling in constructors. + /** 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 + /** disallow useless computed property keys 🔧 * https://eslint.org/docs/rules/no-useless-computed-key */ 'no-useless-computed-key': 'error', @@ -75,27 +76,27 @@ export const es6: ECMAScript6 = { 'no-useless-constructor': 'off', '@typescript-eslint/no-useless-constructor': 'error', - /** disallow renaming import, export, and destructured assignments to the same name + /** disallow renaming import, export, and destructured assignments to the same name 🔧 * https://eslint.org/docs/rules/no-useless-rename */ 'no-useless-rename': 'error', - /** require let or const instead of var + /** require let or const instead of var 🔧 * https://eslint.org/docs/rules/no-var */ 'no-var': 'error', - /** require method and property shorthand syntax for object literals + /** require method and property shorthand syntax for object literals 🔧 * https://eslint.org/docs/rules/object-shorthand */ 'object-shorthand': ['error', 'always', { avoidQuotes: true }], - /** suggest using arrow functions as callbacks + /** suggest using arrow functions as callbacks 🔧 * https://eslint.org/docs/rules/prefer-arrow-callback */ 'prefer-arrow-callback': 'error', - /** suggest using of const declaration for variables that are never modified after declared + /** suggest using of const declaration for variables that are never modified after declared 🔧 * https://eslint.org/docs/rules/prefer-const */ 'prefer-const': ['error', { ignoreReadBeforeAssign: true }], - /** Prefer destructuring from arrays and objects + /** Prefer destructuring from arrays and objects 🔧 * https://eslint.org/docs/rules/prefer-destructuring */ 'prefer-destructuring': ['error', { VariableDeclarator: { @@ -110,7 +111,7 @@ export const es6: ECMAScript6 = { enforceForRenamedProperties: false, }], - /** disallow parseInt() in favor of binary, octal, and hexadecimal literals + /** disallow parseInt() in favor of binary, octal, and hexadecimal literals 🔧 * https://eslint.org/docs/rules/prefer-numeric-literals */ 'prefer-numeric-literals': 'error', @@ -126,19 +127,19 @@ export const es6: ECMAScript6 = { * https://eslint.org/docs/rules/prefer-spread */ 'prefer-spread': 'error', - /** suggest using template literals instead of string concatenation + /** 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 + /** disallow generator functions that do not have yield ✅ * https://eslint.org/docs/rules/require-yield */ 'require-yield': 'error', - /** enforce spacing between object rest-spread + /** enforce spacing between object rest-spread 🔧 * https://eslint.org/docs/rules/rest-spread-spacing */ 'rest-spread-spacing': 'error', - /** import sorting + /** import sorting 🔧 * https://eslint.org/docs/rules/sort-imports */ 'sort-imports': 'off', @@ -146,11 +147,11 @@ export const es6: ECMAScript6 = { * https://eslint.org/docs/rules/symbol-description */ 'symbol-description': 'error', - /** enforce usage of spacing in template strings + /** 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 + /** enforce spacing around the * in yield* expressions 🔧 * https://eslint.org/docs/rules/yield-star-spacing */ 'yield-star-spacing': 'error', }; diff --git a/packages/@spscommerce/eslint-config-typescript/rules/possibleErrors.ts b/packages/@spscommerce/eslint-config-typescript/rules/possibleErrors.ts index d66af096bb..545a164450 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/possibleErrors.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/possibleErrors.ts @@ -1,16 +1,17 @@ import { PossibleErrors } from "eslint/rules/possible-errors"; +// ✅ = recommended, 🔧 = fixable export const possibleErrors: PossibleErrors = { - /** enforce “for” loop update clause moving the counter in the right direction + /** enforce “for” loop update clause moving the counter in the right direction ✅ * https://eslint.org/docs/rules/for-direction */ 'for-direction': 'error', - /** enforce `return` statements in getters + /** enforce `return` statements in getters ✅ * https://eslint.org/docs/rules/getter-return * Off because getters and setters are forbidden */ 'getter-return': 'off', - /** disallow using an async function as a Promise executor + /** disallow using an async function as a Promise executor ✅ * https://eslint.org/docs/rules/no-async-promise-executor */ 'no-async-promise-executor': 'error', @@ -18,11 +19,11 @@ export const possibleErrors: PossibleErrors = { * https://eslint.org/docs/rules/no-await-in-loop */ 'no-await-in-loop': 'error', - /** disallow comparisons to negative zero + /** disallow comparisons to negative zero ✅ * https://eslint.org/docs/rules/no-compare-neg-zero */ 'no-compare-neg-zero': 'error', - /** disallow assignment in conditional expressions + /** disallow assignment in conditional expressions ✅ * https://eslint.org/docs/rules/no-cond-assign * 'always' bans all such assignments rather than just "ambiguous" ones */ 'no-cond-assign': ['error', 'always'], @@ -31,93 +32,93 @@ export const possibleErrors: PossibleErrors = { * https://eslint.org/docs/rules/no-console */ 'no-console': 'warn', - /** disallow use of constant expressions in conditions + /** disallow use of constant expressions in conditions ✅ * https://eslint.org/docs/rules/no-constant-condition */ 'no-constant-condition': 'warn', - /** disallow control characters in regular expressions + /** disallow control characters in regular expressions ✅ * https://eslint.org/docs/rules/no-control-regex */ 'no-control-regex': 'error', - /** disallow use of debugger + /** disallow use of debugger ✅ * https://eslint.org/docs/rules/no-debugger */ 'no-debugger': 'error', - /** disallow duplicate arguments in functions + /** disallow duplicate arguments in functions ✅ * https://eslint.org/docs/rules/no-dupe-args */ 'no-dupe-args': 'error', - /** Disallow duplicate conditions in if-else-if chains + /** Disallow duplicate conditions in if-else-if chains ✅ * https://eslint.org/docs/rules/no-dupe-else-if */ 'no-dupe-else-if': 'error', - /** disallow duplicate keys when creating object literals + /** disallow duplicate keys when creating object literals ✅ * https://eslint.org/docs/rules/no-dupe-keys */ 'no-dupe-keys': 'error', - /** disallow a duplicate case label + /** disallow a duplicate case label ✅ * https://eslint.org/docs/rules/no-duplicate-case */ 'no-duplicate-case': 'error', - /** disallow empty statements + /** disallow empty statements ✅ * https://eslint.org/docs/rules/no-empty */ 'no-empty': 'error', - /** disallow the use of empty character classes in regular expressions + /** disallow the use of empty character classes in regular expressions ✅ * https://eslint.org/docs/rules/no-empty-character-class */ 'no-empty-character-class': 'error', - /** disallow assigning to the exception in a catch block + /** disallow assigning to the exception in a catch block ✅ * https://eslint.org/docs/rules/no-ex-assign */ 'no-ex-assign': 'error', - /** disallow double-negation boolean casts in a boolean context + /** 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 + /** disallow unnecessary parentheses 🔧 * https://eslint.org/docs/rules/no-extra-parens * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-extra-parens.md */ 'no-extra-parens': 'off', '@typescript-eslint/no-extra-parens': 'off', - /** disallow unnecessary semicolons + /** disallow unnecessary semicolons ✅ 🔧 * https://eslint.org/docs/rules/no-extra-semi * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-extra-semi.md */ 'no-extra-semi': 'off', '@typescript-eslint/no-extra-semi': 'error', - /** disallow overwriting functions written as function declarations + /** disallow overwriting functions written as function declarations ✅ * https://eslint.org/docs/rules/no-func-assign */ 'no-func-assign': 'error', - /** disallow assigning to imported bindings + /** disallow assigning to imported bindings ✅ * https://eslint.org/docs/rules/no-import-assign */ 'no-import-assign': 'error', - /** disallow function or variable declarations in nested blocks + /** disallow function or variable declarations in nested blocks ✅ * https://eslint.org/docs/rules/no-inner-declarations */ 'no-inner-declarations': 'error', - /** disallow invalid regular expression strings in the RegExp constructor + /** disallow invalid regular expression strings in the RegExp constructor ✅ * https://eslint.org/docs/rules/no-invalid-regexp */ 'no-invalid-regexp': 'error', - /** disallow irregular whitespace outside of strings and comments + /** disallow irregular whitespace outside of strings and comments ✅ * https://eslint.org/docs/rules/no-irregular-whitespace */ 'no-irregular-whitespace': 'error', - /** disallow literal numbers that lose precision + /** disallow literal numbers that lose precision ✅ * https://eslint.org/docs/rules/no-loss-of-precision * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-loss-of-precision.md */ 'no-loss-of-precision': 'off', '@typescript-eslint/no-loss-of-precision': 'error', - /** disallow characters which are made with multiple code points in character class syntax + /** disallow characters which are made with multiple code points in character class syntax ✅ * https://eslint.org/docs/rules/no-misleading-character-class */ 'no-misleading-character-class': 'error', - /** disallow the use of object properties of the global object (Math and JSON) as functions + /** disallow the use of object properties of the global object (Math and JSON) as functions ✅ * https://eslint.org/docs/rules/no-obj-calls */ 'no-obj-calls': 'error', @@ -125,20 +126,20 @@ export const possibleErrors: PossibleErrors = { * https://eslint.org/docs/rules/no-promise-executor-return */ 'no-promise-executor-return': 'error', - /** disallow use of Object.prototypes builtins directly + /** disallow use of Object.prototypes builtins directly ✅ * https://eslint.org/docs/rules/no-prototype-builtins */ 'no-prototype-builtins': 'off', - /** disallow multiple spaces in a regular expression literal + /** disallow multiple spaces in a regular expression literal ✅ 🔧 * https://eslint.org/docs/rules/no-regex-spaces */ 'no-regex-spaces': 'error', - /** disallow returning values from setters + /** disallow returning values from setters ✅ * https://eslint.org/docs/rules/no-setter-return * Off because getters and setters are forbidden */ 'no-setter-return': 'off', - /** disallow sparse arrays + /** disallow sparse arrays ✅ * https://eslint.org/docs/rules/no-sparse-arrays * only forbids sparse array literals, not `new Array(n)` */ 'no-sparse-arrays': 'error', @@ -147,11 +148,11 @@ export const possibleErrors: PossibleErrors = { * 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 + /** 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 + /** disallow unreachable statements after a return, throw, continue, or break statement ✅ * https://eslint.org/docs/rules/no-unreachable */ 'no-unreachable': 'error', @@ -159,19 +160,19 @@ export const possibleErrors: PossibleErrors = { * https://eslint.org/docs/rules/no-unreachable-loop */ 'no-unreachable-loop': 'error', - /** disallow return/throw/break/continue inside finally blocks + /** 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 + /** disallow negating the left operand of relational operators ✅ * https://eslint.org/docs/rules/no-unsafe-negation */ 'no-unsafe-negation': 'error', - /** disallow use of optional chaining in contexts where the undefined value is not allowed + /** disallow use of optional chaining in contexts where the undefined value is not allowed ✅ * https://eslint.org/docs/rules/no-unsafe-optional-chaining */ 'no-unsafe-optional-chaining': 'error', - /** Disallow useless backreferences in regular expressions + /** Disallow useless backreferences in regular expressions ✅ * https://eslint.org/docs/rules/no-useless-backreference */ 'no-useless-backreference': 'off', @@ -179,11 +180,11 @@ export const possibleErrors: PossibleErrors = { * https://eslint.org/docs/rules/require-atomic-updates */ 'require-atomic-updates': 'error', - /** disallow comparisons with the value NaN + /** disallow comparisons with the value NaN ✅ * https://eslint.org/docs/rules/use-isnan */ 'use-isnan': 'error', - /** ensure that the results of typeof are compared against a valid string + /** 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/@spscommerce/eslint-config-typescript/rules/strictMode.ts b/packages/@spscommerce/eslint-config-typescript/rules/strictMode.ts index 4ca5ef023b..2c525395cf 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/strictMode.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/strictMode.ts @@ -1,7 +1,8 @@ import { StrictMode } from 'eslint/rules/strict-mode'; +// ✅ = recommended, 🔧 = fixable export const strictMode: StrictMode = { - /** disallow the 'use strict' directive + /** disallow the 'use strict' directive 🔧 * https://eslint.org/docs/rules/strict * this is handled for you and does not need to be present in your source files */ strict: ['error', 'never'], diff --git a/packages/@spscommerce/eslint-config-typescript/rules/stylisticIssues.ts b/packages/@spscommerce/eslint-config-typescript/rules/stylisticIssues.ts index 718561fbf0..9592ba8a8c 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/stylisticIssues.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/stylisticIssues.ts @@ -1,23 +1,24 @@ import { StylisticIssues } from 'eslint/rules/stylistic-issues'; +// ✅ = recommended, 🔧 = fixable export const stylisticIssues: StylisticIssues = { - /** enforce line breaks after opening and before closing array brackets + /** enforce line breaks after opening and before closing array brackets 🔧 * https://eslint.org/docs/rules/array-bracket-newline */ 'array-bracket-newline': ['error', 'consistent'], - /** enforce line breaks between array elements - * https://eslint.org/docs/rules/array-element-newline */ - 'array-element-newline': ['error', { multiline: true, minItems: 3 }], - - /** enforce spacing inside array brackets + /** enforce spacing inside array brackets 🔧 * https://eslint.org/docs/rules/array-bracket-spacing */ 'array-bracket-spacing': ['error', 'never'], - /** enforce spacing inside single-line blocks + /** enforce line breaks between array elements 🔧 + * https://eslint.org/docs/rules/array-element-newline */ + 'array-element-newline': ['error', { multiline: true, minItems: 3 }], + + /** enforce spacing inside single-line blocks 🔧 * https://eslint.org/docs/rules/block-spacing */ 'block-spacing': ['error', 'always'], - /** enforce one true brace style + /** enforce one true brace style 🔧 * https://eslint.org/docs/rules/brace-style * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/brace-style.md */ 'brace-style': 'off', @@ -27,27 +28,27 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/camelcase */ camelcase: ['error', { properties: 'never' }], - /** enforce or disallow capitalization of the first letter of a comment + /** enforce or disallow capitalization of the first letter of a comment 🔧 * https://eslint.org/docs/rules/capitalized-comments */ 'capitalized-comments': 'off', - /** require trailing commas in multiline object literals + /** require trailing commas in multiline object literals 🔧 * https://eslint.org/docs/rules/comma-dangle * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/comma-dangle.md */ 'comma-dangle': 'off', '@typescript-eslint/comma-dangle': ['error', 'always-multiline'], - /** enforce spacing before/after comma + /** enforce spacing before/after comma 🔧 * https://eslint.org/docs/rules/comma-spacing * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/comma-spacing.md */ 'comma-spacing': 'off', '@typescript-eslint/comma-spacing': 'error', - /** enforce one true comma style + /** enforce one true comma style 🔧 * https://eslint.org/docs/rules/comma-style */ 'comma-style': 'error', - /** disallow padding inside computed properties + /** disallow padding inside computed properties 🔧 * https://eslint.org/docs/rules/computed-property-spacing */ 'computed-property-spacing': 'error', @@ -56,11 +57,11 @@ export const stylisticIssues: StylisticIssues = { * doing this at all is forbidden */ 'consistent-this': 'off', - /** enforce newline at the end of file, with no multiple empty lines + /** enforce newline at the end of file, with no multiple empty lines 🔧 * https://eslint.org/docs/rules/eol-last */ 'eol-last': 'error', - /** enforce spacing between functions and their invocations + /** enforce spacing between functions and their invocations 🔧 * https://eslint.org/docs/rules/func-call-spacing * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/func-call-spacing.md */ 'func-call-spacing': 'off', @@ -78,11 +79,11 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/func-style */ 'func-style': ['off', 'expression'], - /** enforce line breaks between arguments of a function call + /** enforce line breaks between arguments of a function call 🔧 * https://eslint.org/docs/rules/function-call-argument-newline */ 'function-call-argument-newline': ['off', 'consistent'], - /** enforce consistent line breaks inside function parentheses + /** enforce consistent line breaks inside function parentheses 🔧 * https://eslint.org/docs/rules/function-paren-newline */ 'function-paren-newline': ['error', 'consistent'], @@ -102,25 +103,25 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/id-match */ 'id-match': 'off', - /** Enforce the location of arrow function bodies with implicit returns + /** Enforce the location of arrow function bodies with implicit returns 🔧 * https://eslint.org/docs/rules/implicit-arrow-linebreak */ 'implicit-arrow-linebreak': 'error', - /** this option sets a specific tab width for your code + /** this option sets a specific tab width for your code 🔧 * https://eslint.org/docs/rules/indent * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/indent.md */ indent: 'off', '@typescript-eslint/indent': ['error', 2], - /** specify whether double or single quotes should be used in JSX attributes + /** specify whether double or single quotes should be used in JSX attributes 🔧 * https://eslint.org/docs/rules/jsx-quotes */ 'jsx-quotes': 'error', - /** enforces spacing between keys and values in object literal properties + /** enforces spacing between keys and values in object literal properties 🔧 * https://eslint.org/docs/rules/key-spacing */ 'key-spacing': 'error', - /** require a space before & after certain keywords + /** require a space before & after certain keywords 🔧 * https://eslint.org/docs/rules/keyword-spacing * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/keyword-spacing.md */ 'keyword-spacing': 'off', @@ -130,15 +131,15 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/line-comment-position */ 'line-comment-position': 'error', - /** disallow mixed 'LF' and 'CRLF' as linebreaks + /** disallow mixed 'LF' and 'CRLF' as linebreaks 🔧 * https://eslint.org/docs/rules/linebreak-style */ 'linebreak-style': 'error', - /** enforces empty lines around comments + /** enforces empty lines around comments 🔧 * https://eslint.org/docs/rules/lines-around-comment */ 'lines-around-comment': 'off', - /** require or disallow an empty line between class members + /** require or disallow an empty line between class members 🔧 * https://eslint.org/docs/rules/lines-between-class-members * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/lines-between-class-members.md */ 'lines-between-class-members': 'off', @@ -187,11 +188,11 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/max-statements-per-line */ 'max-statements-per-line': 'off', - /** enforce a particular style for multiline comments + /** enforce a particular style for multiline comments 🔧 * https://eslint.org/docs/rules/multiline-comment-style */ 'multiline-comment-style': 'error', - /** require multiline ternary + /** require multiline ternary 🔧 * https://eslint.org/docs/rules/multiline-ternary */ 'multiline-ternary': 'off', @@ -199,11 +200,11 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/new-cap */ 'new-cap': 'error', - /** disallow the omission of parentheses when invoking a constructor with no arguments + /** disallow the omission of parentheses when invoking a constructor with no arguments 🔧 * https://eslint.org/docs/rules/new-parens */ 'new-parens': 'error', - /** enforces new line after each method call in the chain to make it more readable and easy to maintain + /** 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', @@ -225,7 +226,7 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/no-inline-comments */ 'no-inline-comments': 'error', - /** disallow if as the only statement in an else block + /** disallow if as the only statement in an else block 🔧 * https://eslint.org/docs/rules/no-lonely-if */ 'no-lonely-if': 'error', @@ -233,7 +234,7 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/no-mixed-operators */ 'no-mixed-operators': 'error', - /** disallow mixed spaces and tabs for indentation + /** disallow mixed spaces and tabs for indentation ✅ * https://eslint.org/docs/rules/no-mixed-spaces-and-tabs */ 'no-mixed-spaces-and-tabs': 'error', @@ -241,7 +242,7 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/no-multi-assign */ 'no-multi-assign': 'error', - /** disallow multiple empty lines, only one newline at the end, and no new lines at the beginning + /** disallow multiple empty lines, only one newline at the end, and no new lines at the beginning 🔧 * https://eslint.org/docs/rules/no-multiple-empty-lines */ 'no-multiple-empty-lines': ['error', { max: 1, maxBOF: 0, maxEOF: 0 }], @@ -283,7 +284,7 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/no-ternary */ 'no-ternary': 'off', - /** disallow trailing whitespace at the end of lines + /** disallow trailing whitespace at the end of lines 🔧 * https://eslint.org/docs/rules/no-trailing-spaces */ 'no-trailing-spaces': 'error', @@ -291,19 +292,19 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/no-underscore-dangle */ 'no-underscore-dangle': ['error', { enforceInMethodNames: true }], - /** prefer `a || b` over `a ? a : b` + /** 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 + /** 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 + /** enforce the location of single-line statements 🔧 * https://eslint.org/docs/rules/nonblock-statement-body-position */ 'nonblock-statement-body-position': 'error', - /** enforce line breaks between braces + /** enforce line breaks between braces 🔧 * https://eslint.org/docs/rules/object-curly-newline */ 'object-curly-newline': [ 'error', @@ -314,34 +315,34 @@ export const stylisticIssues: StylisticIssues = { }, ], - /** require padding inside curly braces + /** require padding inside curly braces 🔧 * https://eslint.org/docs/rules/object-curly-spacing * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/object-curly-spacing.md */ 'object-curly-spacing': 'off', '@typescript-eslint/object-curly-spacing': ['error', 'always'], - /** enforce "same line" or "multiple line" on object properties. + /** 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 variable declaration per function + /** allow just one variable declaration per function 🔧 * https://eslint.org/docs/rules/one-var * nb: despite 'var' being in the name, does apply to let and const */ 'one-var': ['error', 'never'], - /** require a newline around variable declaration + /** 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 + /** require assignment operator shorthand where possible or prohibit it entirely 🔧 * https://eslint.org/docs/rules/operator-assignment */ 'operator-assignment': 'error', - /** Requires operator at the beginning of the line in multiline statements + /** 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 + /** disallow padding within blocks 🔧 * https://eslint.org/docs/rules/padded-blocks */ 'padded-blocks': [ 'error', @@ -355,41 +356,41 @@ export const stylisticIssues: StylisticIssues = { }, ], - /** Require or disallow padding lines between statements + /** Require or disallow padding lines between statements 🔧 * https://eslint.org/docs/rules/padding-line-between-statements * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/padding-line-between-statements.md */ 'padding-line-between-statements': 'off', '@typescript-eslint/padding-line-between-statements': 'off', - /** Disallow the use of Math.pow in favor of the ** operator + /** Disallow the use of Math.pow in favor of the ** operator 🔧 * https://eslint.org/docs/rules/prefer-exponentiation-operator */ 'prefer-exponentiation-operator': 'off', - /** Prefer use of an object spread over Object.assign + /** Prefer use of an object spread over Object.assign 🔧 * https://eslint.org/docs/rules/prefer-object-spread */ 'prefer-object-spread': 'error', - /** require quotes around object literal property names + /** require quotes around object literal property names 🔧 * https://eslint.org/docs/rules/quote-props */ 'quote-props': ['error', 'as-needed', { keywords: false, numbers: false }], - /** specify whether double or single quotes should be used + /** specify whether double or single quotes should be used 🔧 * https://eslint.org/docs/rules/quotes * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/quotes.md */ quotes: 'off', '@typescript-eslint/quotes': ['error', 'double', { avoidEscape: true }], - /** require or disallow use of semicolons instead of ASI + /** require or disallow use of semicolons instead of ASI 🔧 * https://eslint.org/docs/rules/ * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/semi.md */ semi: 'off', '@typescript-eslint/semi': 'error', - /** enforce spacing before and after semicolons + /** enforce spacing before and after semicolons 🔧 * https://eslint.org/docs/rules/semi-spacing */ 'semi-spacing': 'error', - /** Enforce location of semicolons + /** Enforce location of semicolons 🔧 * https://eslint.org/docs/rules/semi-style */ 'semi-style': 'error', @@ -397,15 +398,15 @@ export const stylisticIssues: StylisticIssues = { * https://eslint.org/docs/rules/sort-keys */ 'sort-keys': 'off', - /** sort variables within the same declaration block + /** sort variables within the same declaration block 🔧 * https://eslint.org/docs/rules/sort-vars */ 'sort-vars': 'off', - /** require or disallow space before blocks + /** require or disallow space before blocks 🔧 * https://eslint.org/docs/rules/space-before-blocks */ 'space-before-blocks': 'error', - /** require or disallow space before function opening parenthesis + /** require or disallow space before function opening parenthesis 🔧 * https://eslint.org/docs/rules/space-before-function-paren * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/space-before-function-paren.md */ 'space-before-function-paren': 'off', @@ -418,37 +419,37 @@ export const stylisticIssues: StylisticIssues = { }, ], - /** require or disallow spaces inside parentheses + /** require or disallow spaces inside parentheses 🔧 * https://eslint.org/docs/rules/space-in-parens */ 'space-in-parens': 'error', - /** require spaces around operators + /** require spaces around operators 🔧 * https://eslint.org/docs/rules/space-infix-ops * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/space-infix-ops.md */ 'space-infix-ops': 'off', '@typescript-eslint/space-infix-ops': 'error', - /** Require or disallow spaces before/after unary operators + /** Require or disallow spaces before/after unary operators 🔧 * https://eslint.org/docs/rules/space-unary-ops */ 'space-unary-ops': 'error', - /** require or disallow a space immediately following the // or /* in a comment + /** require or disallow a space immediately following the // or /* in a comment 🔧 * https://eslint.org/docs/rules/spaced-comment */ 'spaced-comment': 'error', - /** Enforce spacing around colons of switch statements + /** Enforce spacing around colons of switch statements 🔧 * https://eslint.org/docs/rules/switch-colon-spacing */ 'switch-colon-spacing': 'error', - /** Require or disallow spacing between template tags and their literals + /** Require or disallow spacing between template tags and their literals 🔧 * https://eslint.org/docs/rules/template-tag-spacing */ 'template-tag-spacing': 'error', - /** require or disallow the Unicode Byte Order Mark + /** require or disallow the Unicode Byte Order Mark 🔧 * https://eslint.org/docs/rules/unicode-bom */ 'unicode-bom': 'error', - /** require regex literals to be wrapped in parentheses + /** require regex literals to be wrapped in parentheses 🔧 * https://eslint.org/docs/rules/wrap-regex */ 'wrap-regex': 'off' }; diff --git a/packages/@spscommerce/eslint-config-typescript/rules/variables.ts b/packages/@spscommerce/eslint-config-typescript/rules/variables.ts index 12a152481e..823e089b8c 100644 --- a/packages/@spscommerce/eslint-config-typescript/rules/variables.ts +++ b/packages/@spscommerce/eslint-config-typescript/rules/variables.ts @@ -1,5 +1,6 @@ import { Variables } from 'eslint/rules/variables'; +// ✅ = recommended, 🔧 = fixable export const variables: Variables = { /** enforce or disallow variable initializations at definition * https://eslint.org/docs/rules/init-declarations @@ -11,7 +12,7 @@ export const variables: Variables = { * https://eslint.org/docs/rules/no-catch-shadow */ 'no-catch-shadow': 'off', - /** disallow deletion of variables + /** disallow deletion of variables ✅ * https://eslint.org/docs/rules/no-delete-var */ 'no-delete-var': 'error', @@ -41,15 +42,15 @@ export const variables: Variables = { 'no-shadow': 'off', '@typescript-eslint/no-shadow': 'error', - /** disallow shadowing of names such as arguments + /** disallow shadowing of names such as arguments ✅ * https://eslint.org/docs/rules/no-shadow-restricted-names */ 'no-shadow-restricted-names': 'error', - /** disallow use of undeclared variables unless mentioned in `/*global ` comments + /** disallow use of undeclared variables unless mentioned in `/*global ` comments ✅ * https://eslint.org/docs/rules/no-undef */ 'no-undef': 'error', - /** disallow use of undefined when initializing variables + /** disallow use of undefined when initializing variables 🔧 * https://eslint.org/docs/rules/no-undef-init */ 'no-undef-init': 'error', @@ -57,7 +58,7 @@ export const variables: Variables = { * https://eslint.org/docs/rules/no-undefined */ 'no-undefined': 'off', - /** disallow declaration of variables that are not used in the code + /** disallow declaration of variables that are not used in the code ✅ * https://eslint.org/docs/rules/no-unused-vars * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unused-vars.md */ 'no-unused-vars': 'off', From 68a0d9616ed29e6dddab497ed02c689b9745af8d Mon Sep 17 00:00:00 2001 From: Chris Nordhougen Date: Mon, 11 Oct 2021 13:02:01 -0500 Subject: [PATCH 10/29] finish setting up rules for react pkg --- .../@spscommerce/eslint-config-react/index.ts | 6 + .../eslint-config-react/rules/a11y.ts | 195 ++++++++++++++++++ .../eslint-config-react/rules/hooks.ts | 11 + .../rules/preferFunctionComponent.ts | 12 ++ 4 files changed, 224 insertions(+) create mode 100644 packages/@spscommerce/eslint-config-react/rules/a11y.ts create mode 100644 packages/@spscommerce/eslint-config-react/rules/hooks.ts create mode 100644 packages/@spscommerce/eslint-config-react/rules/preferFunctionComponent.ts diff --git a/packages/@spscommerce/eslint-config-react/index.ts b/packages/@spscommerce/eslint-config-react/index.ts index 4d4365b094..520d2f326d 100644 --- a/packages/@spscommerce/eslint-config-react/index.ts +++ b/packages/@spscommerce/eslint-config-react/index.ts @@ -4,6 +4,9 @@ import { base } from "./rules/base"; // Included for completeness, but all these rules are off because class components are forbidden import { classComponents } from './rules/classComponents'; import { props } from './rules/props'; +import { preferFunctionComponent } from './rules/preferFunctionComponent'; +import { hooks } from './rules/hooks'; +import { a11y } from './rules/a11y'; const config: Linter.Config = { plugins: [ @@ -16,6 +19,9 @@ const config: Linter.Config = { ...base, ...classComponents, ...props, + ...preferFunctionComponent, + ...hooks, + ...a11y, }, }; diff --git a/packages/@spscommerce/eslint-config-react/rules/a11y.ts b/packages/@spscommerce/eslint-config-react/rules/a11y.ts new file mode 100644 index 0000000000..fb47e03a64 --- /dev/null +++ b/packages/@spscommerce/eslint-config-react/rules/a11y.ts @@ -0,0 +1,195 @@ +import { Linter } from "eslint"; + +export const a11y: Linter.RulesRecord = { + /** Enforce all elements that require alternative text have meaningful information to relay back to end user. + * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/alt-text.md */ + 'jsx-a11y/alt-text': 'error', + + /** Enforce all anchors to contain accessible content. + * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/anchor-has-content.md */ + 'jsx-a11y/anchor-has-content': 'error', + + /** Enforce all anchors are valid, navigable elements. + * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/anchor-is-valid.md */ + 'jsx-a11y/anchor-is-valid': 'error', + + /** Enforce elements with aria-activedescendant are tabbable. + * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-activedescendant-has-tabindex.md */ + 'jsx-a11y/aria-activedescendant-has-tabindex': 'error', + + /** Enforce all `aria-*` props are valid. + * https://github.com/jsx-eslint/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/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-proptypes.md */ + 'jsx-a11y/aria-proptypes': 'error', + + /** Enforce that elements with ARIA roles must use a valid, non-abstract ARIA role. + * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-role.md */ + 'jsx-a11y/aria-role': 'error', + + /** Enforce that elements that do not support ARIA roles, states, and properties do not have those attributes. + * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-unsupported-elements.md */ + 'jsx-a11y/aria-unsupported-elements': 'error', + + /** Enforce that autocomplete attributes are used correctly. + * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/autocomplete-valid.md */ + 'jsx-a11y/autocomplete-valid': 'error', + + /** Enforce a clickable non-interactive element has at least one keyboard event listener. + * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/click-events-have-key-events.md */ + 'jsx-a11y/click-events-have-key-events': 'error', + + /** Enforce heading (`h1`, `h2`, etc) elements contain accessible content. + * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/heading-has-content.md */ + 'jsx-a11y/heading-has-content': 'error', + + /** Enforce `` element has `lang` prop. + * https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/html-has-lang.md */ + 'jsx-a11y/html-has-lang': 'error', + + /** Enforce `