noBitwiseOperators

JavaScript (and super languages)

Summary

Rule available since: v2.0.0
Diagnostic Category: lint/suspicious/noBitwiseOperators
This rule doesn’t have a fix.
The default severity of this rule is information.
Sources:
- Same as no-bitwise

How to configure

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

Description

Disallow bitwise operators.

The use of bitwise operators in JavaScript is very rare and often & or | is simply a mistyped && or ||, which will lead to unexpected behavior.

Examples

Invalid

1
let x = y | z;

code-block.js:1:9 lint/suspicious/noBitwiseOperators ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected use of ’|‘.
  
  > 1 │ let x = y | z;
      │         ^^^^^
    2 │ 
  
  ℹ Did you mean || instead? If you want to use the bitwise operator, consider suppressing this diagnostic.

1
x |= y;

code-block.js:1:1 lint/suspicious/noBitwiseOperators ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected use of ’|=‘.
  
  > 1 │ x |= y;
      │ ^^^^^^
    2 │ 
  
  ℹ Bitwise operators are prohibited because their use can be confusing or unintended. If you did want to use the bitwise operator, consider suppressing this diagnostic.

Valid

1
let x = y || z;

1
let x = y && z;

Options

The rule provides the options described below.

allow

Allows a list of bitwise operators to be used as exceptions.

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "noBitwiseOperators": {
6
          "options": {
7
            "allow": [
8
              "&",
9
              "|",
10
              "^",
11
              "~",
12
              "<<",
13
              ">>",
14
              ">>>"
15
            ]
16
          }
17
        }
18
      }
19
    }
20
  }
21
}