noReturnAssign

JavaScript (and super languages)

Summary

Rule available since: v2.3.11
Diagnostic Category: lint/suspicious/noReturnAssign
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is error.
Sources:
- Same as no-return-assign

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "noReturnAssign": "error"
6
      }
7
    }
8
  }
9
}

Description

Disallow assignments in return statements.

In return statements, it is common to mistype a comparison operator (such as ==) as an assignment operator (such as =). Moreover, the use of assignments in a return statement is confusing. Return statements are often considered side-effect free.

Examples

Invalid

1
function f(a) {
2
    return a = 1;
3
}

code-block.js:2:12 lint/suspicious/noReturnAssign ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Return statements should not contain assignments.
  
    1 │ function f(a) {
  > 2 │     return a = 1;
      │            ^^^^^
    3 │ }
    4 │ 
  
  ℹ Assignments inside return statements are easy to mistake for comparison operators (`==`), and add unexpected side effects to normally-pure code.
    If the assignment is intentional, move it outside of the return statement.

Valid

1
function f(a) {
2
    a = 1;
3
    return a;
4
}

1
function f(a) {
2
    return a == 1;
3
}