Update: enforceForLogicalOperands no-extra-boolean-cast (fixes #12137) (

#12734)

* Working rule, updated documentation

* New: Added enforceForLogicalOperands option to no-extra-boolean-cast
(fixes #12137)

* Add default for schema option; renamed functions for clarity; pass fewer parameters to functions; check precedence in fixer

* Removed extra variable from function; fixed function name; fixed precedence check; added additional example

* Updated documentation

* Removed outdated legacy code method

* Added additional tests

* Renamed function

* Added additional test; updated documentation

* Switched docs examples order; fixed comments in rule; added test for inserting space

* Fixed accidentally edited lines

docs/rules/no-extra-boolean-cast.md

@@ -68,3 +68,57 @@ function foo() {
 
 var foo = bar ? !!baz : !!bat;
 ```
+
+## Options
+
+This rule has an object option:
+
+* `"enforceForLogicalOperands"` when set to `true`, in addition to checking default contexts, checks whether the extra boolean cast is contained within a logical expression. Default is `false`, meaning that this rule by default does not warn about extra booleans cast inside logical expression.
+
+### enforceForLogicalOperands
+
+Examples of **incorrect** code for this rule with `"enforceForLogicalOperands"` option set to `true`:
+
+```js
+/*eslint no-extra-boolean-cast: ["error", {"enforceForLogicalOperands": true}]*/
+
+if (!!foo || bar) {
+    //...
+}
+
+while (!!foo && bar) {
+    //...
+}
+
+if ((!!foo || bar) && baz) {
+    //...
+}
+
+foo && Boolean(bar) ? baz : bat
+
+var foo = new Boolean(!!bar || baz)
+```
+
+Examples of **correct** code for this rule with `"enforceForLogicalOperands"` option set to `true`:
+
+```js
+/*eslint no-extra-boolean-cast: ["error", {"enforceForLogicalOperands": true}]*/
+
+if (foo || bar) {
+    //...
+}
+
+while (foo && bar) {
+    //...
+}
+
+if ((foo || bar) && baz) {
+    //...
+}
+
+foo && bar ? baz : bat
+
+var foo = new Boolean(bar || baz)
+
+var foo = !!bar || baz;
+```

lib/rules/no-extra-boolean-cast.js

@@ -26,7 +26,16 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-extra-boolean-cast"
         },
 
-        schema: [],
+        schema: [{
+            type: "object",
+            properties: {
+                enforceForLogicalOperands: {
+                    type: "boolean",
+                    default: false
+                }
+            },
+            additionalProperties: false
+        }],
         fixable: "code",
 
         messages: {
@@ -47,23 +56,67 @@ module.exports = {
             "ForStatement"
         ];
 
+        /**
+         * Check if a node is a Boolean function or constructor.
+         * @param {ASTNode} node the node
+         * @returns {boolean} If the node is Boolean function or constructor
+         */
+        function isBooleanFunctionOrConstructorCall(node) {
+
+            // Boolean(<bool>) and new Boolean(<bool>)
+            return (node.type === "CallExpression" || node.type === "NewExpression") &&
+                    node.callee.type === "Identifier" &&
+                        node.callee.name === "Boolean";
+        }
+
+        /**
+         * Checks whether the node is a logical expression and that the option is enabled
+         * @param {ASTNode} node the node
+         * @returns {boolean} if the node is a logical expression and option is enabled
+         */
+        function isLogicalContext(node) {
+            return node.type === "LogicalExpression" &&
+            (node.operator === "||" || node.operator === "&&") &&
+            (context.options.length && context.options[0].enforceForLogicalOperands === true);
+
+        }
+
+
         /**
          * Check if a node is in a context where its value would be coerced to a boolean at runtime.
          * @param {ASTNode} node The node
-         * @param {ASTNode} parent Its parent
          * @returns {boolean} If it is in a boolean context
          */
-        function isInBooleanContext(node, parent) {
+        function isInBooleanContext(node) {
             return (
-                (BOOLEAN_NODE_TYPES.indexOf(parent.type) !== -1 &&
-                    node === parent.test) ||
+                (isBooleanFunctionOrConstructorCall(node.parent) &&
+                node === node.parent.arguments[0]) ||
+
+                (BOOLEAN_NODE_TYPES.indexOf(node.parent.type) !== -1 &&
+                    node === node.parent.test) ||
 
                 // !<bool>
-                (parent.type === "UnaryExpression" &&
-                    parent.operator === "!")
+                (node.parent.type === "UnaryExpression" &&
+                    node.parent.operator === "!")
+            );
+        }
+
+        /**
+         * Checks whether the node is a context that should report an error
+         * Acts recursively if it is in a logical context
+         * @param {ASTNode} node the node
+         * @returns {boolean} If the node is in one of the flagged contexts
+         */
+        function isInFlaggedContext(node) {
+            return isInBooleanContext(node) ||
+            (isLogicalContext(node.parent) &&
+
+            // For nested logical statements
+            isInFlaggedContext(node.parent)
             );
         }
 
+
         /**
          * Check if a node has comments inside.
          * @param {ASTNode} node The node to check.
@@ -75,24 +128,18 @@ module.exports = {
 
         return {
             UnaryExpression(node) {
-                const ancestors = context.getAncestors(),
-                    parent = ancestors.pop(),
-                    grandparent = ancestors.pop();
+                const parent = node.parent;
+
 
                 // Exit early if it's guaranteed not to match
                 if (node.operator !== "!" ||
-                        parent.type !== "UnaryExpression" ||
-                        parent.operator !== "!") {
+                          parent.type !== "UnaryExpression" ||
+                          parent.operator !== "!") {
                     return;
                 }
 
-                if (isInBooleanContext(parent, grandparent) ||
 
-                    // Boolean(<bool>) and new Boolean(<bool>)
-                    ((grandparent.type === "CallExpression" || grandparent.type === "NewExpression") &&
-                        grandparent.callee.type === "Identifier" &&
-                        grandparent.callee.name === "Boolean")
-                ) {
+                if (isInFlaggedContext(parent)) {
                     context.report({
                         node: parent,
                         messageId: "unexpectedNegation",
@@ -110,6 +157,10 @@ module.exports = {
                                 prefix = " ";
                             }
 
+                            if (astUtils.getPrecedence(node.argument) < astUtils.getPrecedence(parent.parent)) {
+                                return fixer.replaceText(parent, `(${sourceCode.getText(node.argument)})`);
+                            }
+
                             return fixer.replaceText(parent, prefix + sourceCode.getText(node.argument));
                         }
                     });
@@ -122,7 +173,7 @@ module.exports = {
                     return;
                 }
 
-                if (isInBooleanContext(node, parent)) {
+                if (isInFlaggedContext(node)) {
                     context.report({
                         node,
                         messageId: "unexpectedCall",