useIncludes (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.5.0
Diagnostic Category: lint/nursery/useIncludes
This rule has an unsafe fix.
The default severity of this rule is information.
This rule belongs to the following domains:
- types
Sources:
- Inspired from @typescript-eslint/prefer-includes
- Inspired from unicorn/prefer-includes
- Inspired from e18e/prefer-includes

How to configure

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

Description

Prefer Array#includes() over Array#indexOf(), Array#lastIndexOf(), and Array#some() when checking for existence or non-existence.

Array#indexOf() and Array#lastIndexOf() return a numeric index and are commonly compared against -1 to check for the presence of an element. Array#some() is sometimes used with a strict-equality callback for the same purpose. Array#includes() is more readable and expressive, and avoids off-by-one mistakes with the comparison operator.

Examples

Invalid

1
const arr = [1, 2, 3];
2
arr.indexOf(1) !== -1;

/invalid1.ts:2:1 lint/nursery/useIncludes  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Checking the result of indexOf() against -1 to test for presence.
  
    1 │ const arr = [1, 2, 3];
  > 2 │ arr.indexOf(1) !== -1;
      │ ^^^^^^^^^^^^^^^^^^^^^
    3 │ 
  
  ℹ indexOf() returns a numeric index, not a boolean. Comparing it against -1 is error-prone and harder to read.
  
  ℹ Use includes() instead, which directly expresses the intent and returns a boolean.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Unsafe fix: Replace with .includes().
  
    1 1 │   const arr = [1, 2, 3];
    2   │ - arr.indexOf(1)·!==·-1;
      2 │ + arr.includes(1);
    3 3 │

1
const arr = [1, 2, 3];
2
arr.indexOf(1) >= 0;

/invalid2.ts:2:1 lint/nursery/useIncludes  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Checking the result of indexOf() against -1 to test for presence.
  
    1 │ const arr = [1, 2, 3];
  > 2 │ arr.indexOf(1) >= 0;
      │ ^^^^^^^^^^^^^^^^^^^
    3 │ 
  
  ℹ indexOf() returns a numeric index, not a boolean. Comparing it against -1 is error-prone and harder to read.
  
  ℹ Use includes() instead, which directly expresses the intent and returns a boolean.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Unsafe fix: Replace with .includes().
  
    1 1 │   const arr = [1, 2, 3];
    2   │ - arr.indexOf(1)·>=·0;
      2 │ + arr.includes(1);
    3 3 │

1
const arr = [1, 2, 3];
2
arr.indexOf(1) === -1;

/invalid3.ts:2:1 lint/nursery/useIncludes  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Checking the result of indexOf() against -1 to test for presence.
  
    1 │ const arr = [1, 2, 3];
  > 2 │ arr.indexOf(1) === -1;
      │ ^^^^^^^^^^^^^^^^^^^^^
    3 │ 
  
  ℹ indexOf() returns a numeric index, not a boolean. Comparing it against -1 is error-prone and harder to read.
  
  ℹ Use !...includes() instead, which directly expresses the intent and returns a boolean.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Unsafe fix: Replace with !...includes().
  
    1 1 │   const arr = [1, 2, 3];
    2   │ - arr.indexOf(1)·===·-1;
      2 │ + !
      3 │ + arr.includes(1);
    3 4 │

1
const arr = [1, 2, 3];
2
arr.lastIndexOf(1) !== -1;

/invalid4.ts:2:1 lint/nursery/useIncludes  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Checking the result of lastIndexOf() against -1 to test for presence.
  
    1 │ const arr = [1, 2, 3];
  > 2 │ arr.lastIndexOf(1) !== -1;
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^
    3 │ 
  
  ℹ lastIndexOf() returns a numeric index, not a boolean. Comparing it against -1 is error-prone and harder to read.
  
  ℹ Use includes() instead, which directly expresses the intent and returns a boolean.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Unsafe fix: Replace with .includes().
  
    1 1 │   const arr = [1, 2, 3];
    2   │ - arr.lastIndexOf(1)·!==·-1;
      2 │ + arr.includes(1);
    3 3 │

1
const arr = [1, 2, 3];
2
arr.some((item) => item === 1);

/invalid5.ts:2:1 lint/nursery/useIncludes  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Using some() with a strict-equality callback to test for presence.
  
    1 │ const arr = [1, 2, 3];
  > 2 │ arr.some((item) => item === 1);
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    3 │ 
  
  ℹ Use includes() instead, which directly expresses the intent and returns a boolean.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Unsafe fix: Replace with .includes().
  
    1 1 │   const arr = [1, 2, 3];
    2   │ - arr.some((item)·=>·item·===·1);
      2 │ + arr.includes(1);
    3 3 │

Valid

1
const arr = [1, 2, 3];
2

3
arr.includes(1);
4

5
!arr.includes(1);
6

7
// Positional use of indexOf is fine
8
const pos = arr.indexOf(1);