Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Update no-confusing-arrow with the new default option #11886

Merged
merged 2 commits into from Jun 24, 2019
Merged

Docs: Update no-confusing-arrow with the new default option #11886

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e0e472
Docs: Update examples with the new default option (refs #11503)
zypA13510 Jun 24, 2019
3781b86
Docs: Fix examples
zypA13510 Jun 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/rules/no-confusing-arrow.md
View file
Open in desktop
@@ -1,6 +1,6 @@
# Disallow arrow functions where they could be confused with comparisons (no-confusing-arrow)

Arrow functions (`=>`) are similar in syntax to some comparison operators (`>`, `<`, `<=`, and `>=`). This rule warns against using the arrow function syntax in places where it could be confused with a comparison operator. Even if the arguments of the arrow function are wrapped with parens, this rule still warns about it unless `allowParens` is set to `true`.
Arrow functions (`=>`) are similar in syntax to some comparison operators (`>`, `<`, `<=`, and `>=`). This rule warns against using the arrow function syntax in places where it could be confused with a comparison operator.

Here's an example where the usage of `=>` could be confusing:

Expand All @@ -22,8 +22,6 @@ Examples of **incorrect** code for this rule:
/*eslint-env es6*/

var x = a => 1 ? 2 : 3;
var x = (a) => 1 ? 2 : 3;
var x = (a) => (1 ? 2 : 3);
```

Examples of **correct** code for this rule:
Expand All @@ -32,6 +30,8 @@ Examples of **correct** code for this rule:
/*eslint no-confusing-arrow: "error"*/
/*eslint-env es6*/

var x = (a) => 1 ? 2 : 3;
zypA13510 marked this conversation as resolved.
Show resolved Hide resolved
var x = (a) => (1 ? 2 : 3);
var x = a => { return 1 ? 2 : 3; };
var x = (a) => { return 1 ? 2 : 3; };
```
Expand All @@ -43,7 +43,7 @@ This rule accepts a single options argument with the following defaults:
```json
{
"rules": {
"no-confusing-arrow": ["error", {"allowParens": false}]
"no-confusing-arrow": ["error", {"allowParens": true}]
}
}
```
Expand All @@ -53,10 +53,10 @@ This rule accepts a single options argument with the following defaults:
1. `true` relaxes the rule and accepts parenthesis as a valid "confusion-preventing" syntax.
2. `false` warns even if the expression is wrapped in parenthesis

Examples of **correct** code for this rule with the `{"allowParens": true}` option:
Examples of **incorrect** code for this rule with the `{"allowParens": false}` option:

```js
/*eslint no-confusing-arrow: ["error", {"allowParens": true}]*/
/*eslint no-confusing-arrow: ["error", {"allowParens": false}]*/
/*eslint-env es6*/
var x = a => (1 ? 2 : 3);
var x = (a) => (1 ? 2 : 3);
Expand Down