summaryrefslogtreecommitdiffstats
path: root/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/use-includes-instead-of-indexOf.js
blob: 245c89a09525fdcc20a35659c3bd037992d94a45 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/**
 * @fileoverview Use .includes instead of .indexOf
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

"use strict";

module.exports = {
  meta: {
    docs: {
      url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/rules/use-includes-instead-of-indexOf.html",
    },
    messages: {
      useIncludes: "use .includes instead of .indexOf",
    },
    schema: [],
    type: "suggestion",
  },

  create(context) {
    return {
      BinaryExpression(node) {
        if (
          node.left.type != "CallExpression" ||
          node.left.callee.type != "MemberExpression" ||
          node.left.callee.property.type != "Identifier" ||
          node.left.callee.property.name != "indexOf"
        ) {
          return;
        }

        if (
          (["!=", "!==", "==", "==="].includes(node.operator) &&
            node.right.type == "UnaryExpression" &&
            node.right.operator == "-" &&
            node.right.argument.type == "Literal" &&
            node.right.argument.value == 1) ||
          ([">=", "<"].includes(node.operator) &&
            node.right.type == "Literal" &&
            node.right.value == 0)
        ) {
          context.report({
            node,
            messageId: "useIncludes",
          });
        }
      },
    };
  },
};