Blame view
node_modules/eslint/lib/rules/curly.js
9.84 KB
c39994410
|
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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
/** * @fileoverview Rule to flag statements without curly braces * @author Nicholas C. Zakas * @copyright 2015 Ivan Nikulin. All rights reserved. */ "use strict"; //------------------------------------------------------------------------------ // Requirements //------------------------------------------------------------------------------ var astUtils = require("../ast-utils"); //------------------------------------------------------------------------------ // Rule Definition //------------------------------------------------------------------------------ module.exports = function(context) { var multiOnly = (context.options[0] === "multi"); var multiLine = (context.options[0] === "multi-line"); var multiOrNest = (context.options[0] === "multi-or-nest"); var consistent = (context.options[1] === "consistent"); //-------------------------------------------------------------------------- // Helpers //-------------------------------------------------------------------------- /** * Determines if a given node is a one-liner that's on the same line as it's preceding code. * @param {ASTNode} node The node to check. * @returns {boolean} True if the node is a one-liner that's on the same line as it's preceding code. * @private */ function isCollapsedOneLiner(node) { var before = context.getTokenBefore(node), last = context.getLastToken(node); return before.loc.start.line === last.loc.end.line; } /** * Determines if a given node is a one-liner. * @param {ASTNode} node The node to check. * @returns {boolean} True if the node is a one-liner. * @private */ function isOneLiner(node) { var first = context.getFirstToken(node), last = context.getLastToken(node); return first.loc.start.line === last.loc.end.line; } /** * Gets the `else` keyword token of a given `IfStatement` node. * @param {ASTNode} node - A `IfStatement` node to get. * @returns {Token} The `else` keyword token. */ function getElseKeyword(node) { var sourceCode = context.getSourceCode(); var token = sourceCode.getTokenAfter(node.consequent); while (token.type !== "Keyword" || token.value !== "else") { token = sourceCode.getTokenAfter(token); } return token; } /** * Checks a given IfStatement node requires braces of the consequent chunk. * This returns `true` when below: * * 1. The given node has the `alternate` node. * 2. There is a `IfStatement` which doesn't have `alternate` node in the * trailing statement chain of the `consequent` node. * * @param {ASTNode} node - A IfStatement node to check. * @returns {boolean} `true` if the node requires braces of the consequent chunk. */ function requiresBraceOfConsequent(node) { if (node.alternate && node.consequent.type === "BlockStatement") { if (node.consequent.body.length >= 2) { return true; } node = node.consequent.body[0]; while (node) { if (node.type === "IfStatement" && !node.alternate) { return true; } node = astUtils.getTrailingStatement(node); } } return false; } /** * Reports "Expected { after ..." error * @param {ASTNode} node The node to report. * @param {string} name The name to report. * @param {string} suffix Additional string to add to the end of a report. * @returns {void} * @private */ function reportExpectedBraceError(node, name, suffix) { context.report({ node: node, loc: (name !== "else" ? node : getElseKeyword(node)).loc.start, message: "Expected { after '{{name}}'{{suffix}}.", data: { name: name, suffix: (suffix ? " " + suffix : "") } }); } /** * Reports "Unnecessary { after ..." error * @param {ASTNode} node The node to report. * @param {string} name The name to report. * @param {string} suffix Additional string to add to the end of a report. * @returns {void} * @private */ function reportUnnecessaryBraceError(node, name, suffix) { context.report({ node: node, loc: (name !== "else" ? node : getElseKeyword(node)).loc.start, message: "Unnecessary { after '{{name}}'{{suffix}}.", data: { name: name, suffix: (suffix ? " " + suffix : "") } }); } /** * Prepares to check the body of a node to see if it's a block statement. * @param {ASTNode} node The node to report if there's a problem. * @param {ASTNode} body The body node to check for blocks. * @param {string} name The name to report if there's a problem. * @param {string} suffix Additional string to add to the end of a report. * @returns {object} a prepared check object, with "actual", "expected", "check" properties. * "actual" will be `true` or `false` whether the body is already a block statement. * "expected" will be `true` or `false` if the body should be a block statement or not, or * `null` if it doesn't matter, depending on the rule options. It can be modified to change * the final behavior of "check". * "check" will be a function reporting appropriate problems depending on the other * properties. */ function prepareCheck(node, body, name, suffix) { var hasBlock = (body.type === "BlockStatement"); var expected = null; if (node.type === "IfStatement" && node.consequent === body && requiresBraceOfConsequent(node)) { expected = true; } else if (multiOnly) { if (hasBlock && body.body.length === 1) { expected = false; } } else if (multiLine) { if (!isCollapsedOneLiner(body)) { expected = true; } } else if (multiOrNest) { if (hasBlock && body.body.length === 1 && isOneLiner(body.body[0])) { expected = false; } else if (!isOneLiner(body)) { expected = true; } } else { expected = true; } return { actual: hasBlock, expected: expected, check: function() { if (this.expected !== null && this.expected !== this.actual) { if (this.expected) { reportExpectedBraceError(node, name, suffix); } else { reportUnnecessaryBraceError(node, name, suffix); } } } }; } /** * Prepares to check the bodies of a "if", "else if" and "else" chain. * @param {ASTNode} node The first IfStatement node of the chain. * @returns {object[]} prepared checks for each body of the chain. See `prepareCheck` for more * information. */ function prepareIfChecks(node) { var preparedChecks = []; do { preparedChecks.push(prepareCheck(node, node.consequent, "if", "condition")); if (node.alternate && node.alternate.type !== "IfStatement") { preparedChecks.push(prepareCheck(node, node.alternate, "else")); break; } node = node.alternate; } while (node); if (consistent) { // If any node should have or already have braces, make sure they all have braces. // If all nodes shouldn't have braces, make sure they don't. var expected = preparedChecks.some(function(preparedCheck) { if (preparedCheck.expected !== null) { return preparedCheck.expected; } return preparedCheck.actual; }); preparedChecks.forEach(function(preparedCheck) { preparedCheck.expected = expected; }); } return preparedChecks; } //-------------------------------------------------------------------------- // Public //-------------------------------------------------------------------------- return { "IfStatement": function(node) { if (node.parent.type !== "IfStatement") { prepareIfChecks(node).forEach(function(preparedCheck) { preparedCheck.check(); }); } }, "WhileStatement": function(node) { prepareCheck(node, node.body, "while", "condition").check(); }, "DoWhileStatement": function(node) { prepareCheck(node, node.body, "do").check(); }, "ForStatement": function(node) { prepareCheck(node, node.body, "for", "condition").check(); }, "ForInStatement": function(node) { prepareCheck(node, node.body, "for-in").check(); }, "ForOfStatement": function(node) { prepareCheck(node, node.body, "for-of").check(); } }; }; module.exports.schema = { "anyOf": [ { "type": "array", "items": [ { "enum": [0, 1, 2] }, { "enum": ["all"] } ], "minItems": 1, "maxItems": 2 }, { "type": "array", "items": [ { "enum": [0, 1, 2] }, { "enum": ["multi", "multi-line", "multi-or-nest"] }, { "enum": ["consistent"] } ], "minItems": 1, "maxItems": 3 } ] }; |