Blame view
node_modules/eslint/lib/rules/no-mixed-operators.js
6.64 KB
f7563de62
|
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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
/** * @fileoverview Rule to disallow mixed binary operators. * @author Toru Nagashima */ "use strict"; //------------------------------------------------------------------------------ // Requirements //------------------------------------------------------------------------------ const astUtils = require("../ast-utils.js"); //------------------------------------------------------------------------------ // Helpers //------------------------------------------------------------------------------ const ARITHMETIC_OPERATORS = ["+", "-", "*", "/", "%", "**"]; const BITWISE_OPERATORS = ["&", "|", "^", "~", "<<", ">>", ">>>"]; const COMPARISON_OPERATORS = ["==", "!=", "===", "!==", ">", ">=", "<", "<="]; const LOGICAL_OPERATORS = ["&&", "||"]; const RELATIONAL_OPERATORS = ["in", "instanceof"]; const ALL_OPERATORS = [].concat( ARITHMETIC_OPERATORS, BITWISE_OPERATORS, COMPARISON_OPERATORS, LOGICAL_OPERATORS, RELATIONAL_OPERATORS ); const DEFAULT_GROUPS = [ ARITHMETIC_OPERATORS, BITWISE_OPERATORS, COMPARISON_OPERATORS, LOGICAL_OPERATORS, RELATIONAL_OPERATORS ]; const TARGET_NODE_TYPE = /^(?:Binary|Logical)Expression$/; /** * Normalizes options. * * @param {Object|undefined} options - A options object to normalize. * @returns {Object} Normalized option object. */ function normalizeOptions(options) { const hasGroups = (options && options.groups && options.groups.length > 0); const groups = hasGroups ? options.groups : DEFAULT_GROUPS; const allowSamePrecedence = (options && options.allowSamePrecedence) !== false; return { groups, allowSamePrecedence }; } /** * Checks whether any group which includes both given operator exists or not. * * @param {Array.<string[]>} groups - A list of groups to check. * @param {string} left - An operator. * @param {string} right - Another operator. * @returns {boolean} `true` if such group existed. */ function includesBothInAGroup(groups, left, right) { return groups.some(group => group.indexOf(left) !== -1 && group.indexOf(right) !== -1); } //------------------------------------------------------------------------------ // Rule Definition //------------------------------------------------------------------------------ module.exports = { meta: { docs: { description: "disallow mixed binary operators", category: "Stylistic Issues", recommended: false }, schema: [ { type: "object", properties: { groups: { type: "array", items: { type: "array", items: { enum: ALL_OPERATORS }, minItems: 2, uniqueItems: true }, uniqueItems: true }, allowSamePrecedence: { type: "boolean" } }, additionalProperties: false } ] }, create(context) { const sourceCode = context.getSourceCode(); const options = normalizeOptions(context.options[0]); /** * Checks whether a given node should be ignored by options or not. * * @param {ASTNode} node - A node to check. This is a BinaryExpression * node or a LogicalExpression node. This parent node is one of * them, too. * @returns {boolean} `true` if the node should be ignored. */ function shouldIgnore(node) { const a = node; const b = node.parent; return ( !includesBothInAGroup(options.groups, a.operator, b.operator) || ( options.allowSamePrecedence && astUtils.getPrecedence(a) === astUtils.getPrecedence(b) ) ); } /** * Checks whether the operator of a given node is mixed with parent * node's operator or not. * * @param {ASTNode} node - A node to check. This is a BinaryExpression * node or a LogicalExpression node. This parent node is one of * them, too. * @returns {boolean} `true` if the node was mixed. */ function isMixedWithParent(node) { return ( node.operator !== node.parent.operator && !astUtils.isParenthesised(sourceCode, node) ); } /** * Gets the operator token of a given node. * * @param {ASTNode} node - A node to check. This is a BinaryExpression * node or a LogicalExpression node. * @returns {Token} The operator token of the node. */ function getOperatorToken(node) { return sourceCode.getTokenAfter(node.left, astUtils.isNotClosingParenToken); } /** * Reports both the operator of a given node and the operator of the * parent node. * * @param {ASTNode} node - A node to check. This is a BinaryExpression * node or a LogicalExpression node. This parent node is one of * them, too. * @returns {void} */ function reportBothOperators(node) { const parent = node.parent; const left = (parent.left === node) ? node : parent; const right = (parent.left !== node) ? node : parent; const message = "Unexpected mix of '{{leftOperator}}' and '{{rightOperator}}'."; const data = { leftOperator: left.operator, rightOperator: right.operator }; context.report({ node: left, loc: getOperatorToken(left).loc.start, message, data }); context.report({ node: right, loc: getOperatorToken(right).loc.start, message, data }); } /** * Checks between the operator of this node and the operator of the * parent node. * * @param {ASTNode} node - A node to check. * @returns {void} */ function check(node) { if (TARGET_NODE_TYPE.test(node.parent.type) && isMixedWithParent(node) && !shouldIgnore(node) ) { reportBothOperators(node); } } return { BinaryExpression: check, LogicalExpression: check }; } }; |