summaryrefslogtreecommitdiffstats
path: root/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/prefer-boolean-length-check.js
blob: 0e2685ec28df7c7ecd61800468a9ac292cb96c52 (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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/**
 * @fileoverview Prefer boolean length check
 *
 * 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";

function funcForBooleanLength(context, node, conditionCheck) {
  let newText = "";
  const sourceCode = context.getSourceCode();
  switch (node.operator) {
    case ">":
      if (node.right.value == 0) {
        if (conditionCheck) {
          newText = sourceCode.getText(node.left);
        } else {
          newText = "!!" + sourceCode.getText(node.left);
        }
      } else {
        newText = "!" + sourceCode.getText(node.right);
      }
      break;
    case "<":
      if (node.right.value == 0) {
        newText = "!" + sourceCode.getText(node.left);
      } else if (conditionCheck) {
        newText = sourceCode.getText(node.right);
      } else {
        newText = "!!" + sourceCode.getText(node.right);
      }
      break;
    case "==":
      if (node.right.value == 0) {
        newText = "!" + sourceCode.getText(node.left);
      } else {
        newText = "!" + sourceCode.getText(node.right);
      }
      break;
    case "!=":
      if (node.right.value == 0) {
        if (conditionCheck) {
          newText = sourceCode.getText(node.left);
        } else {
          newText = "!!" + sourceCode.getText(node.left);
        }
      } else if (conditionCheck) {
        newText = sourceCode.getText(node.right);
      } else {
        newText = "!!" + sourceCode.getText(node.right);
      }
      break;
  }
  return newText;
}

module.exports = {
  meta: {
    docs: {
      url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/prefer-boolean-length-check.html",
    },
    fixable: "code",
    messages: {
      preferBooleanCheck: "Prefer boolean length check",
    },
    schema: [],
    type: "suggestion",
  },

  create(context) {
    const conditionStatement = [
      "IfStatement",
      "WhileStatement",
      "DoWhileStatement",
      "ForStatement",
      "ForInStatement",
      "ConditionalExpression",
    ];

    return {
      BinaryExpression(node) {
        if (
          ["==", "!=", ">", "<"].includes(node.operator) &&
          ((node.right.type == "Literal" &&
            node.right.value == 0 &&
            node.left.property?.name == "length") ||
            (node.left.type == "Literal" &&
              node.left.value == 0 &&
              node.right.property?.name == "length"))
        ) {
          if (
            conditionStatement.includes(node.parent.type) ||
            (node.parent.type == "LogicalExpression" &&
              conditionStatement.includes(node.parent.parent.type))
          ) {
            context.report({
              node,
              fix: fixer => {
                let generateExpression = funcForBooleanLength(
                  context,
                  node,
                  true
                );

                return fixer.replaceText(node, generateExpression);
              },
              messageId: "preferBooleanCheck",
            });
          } else {
            context.report({
              node,
              fix: fixer => {
                let generateExpression = funcForBooleanLength(
                  context,
                  node,
                  false
                );
                return fixer.replaceText(node, generateExpression);
              },
              messageId: "preferBooleanCheck",
            });
          }
        }
      },
    };
  },
};