Blame view
node_modules/eslint/lib/rules/one-var.js
11.2 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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
/** * @fileoverview A rule to control the use of single variable declarations. * @author Ian Christian Myers * @copyright 2015 Ian VanSchooten. All rights reserved. * @copyright 2015 Joey Baker. All rights reserved. * @copyright 2015 Danny Fritz. All rights reserved. * @copyright 2013 Ian Christian Myers. All rights reserved. */ "use strict"; //------------------------------------------------------------------------------ // Rule Definition //------------------------------------------------------------------------------ module.exports = function(context) { var MODE_ALWAYS = "always", MODE_NEVER = "never"; var mode = context.options[0] || MODE_ALWAYS; var options = { }; if (typeof mode === "string") { // simple options configuration with just a string options.var = { uninitialized: mode, initialized: mode}; options.let = { uninitialized: mode, initialized: mode}; options.const = { uninitialized: mode, initialized: mode}; } else if (typeof mode === "object") { // options configuration is an object if (mode.hasOwnProperty("var") && typeof mode.var === "string") { options.var = { uninitialized: mode.var, initialized: mode.var}; } if (mode.hasOwnProperty("let") && typeof mode.let === "string") { options.let = { uninitialized: mode.let, initialized: mode.let}; } if (mode.hasOwnProperty("const") && typeof mode.const === "string") { options.const = { uninitialized: mode.const, initialized: mode.const}; } if (mode.hasOwnProperty("uninitialized")) { if (!options.var) { options.var = {}; } if (!options.let) { options.let = {}; } if (!options.const) { options.const = {}; } options.var.uninitialized = mode.uninitialized; options.let.uninitialized = mode.uninitialized; options.const.uninitialized = mode.uninitialized; } if (mode.hasOwnProperty("initialized")) { if (!options.var) { options.var = {}; } if (!options.let) { options.let = {}; } if (!options.const) { options.const = {}; } options.var.initialized = mode.initialized; options.let.initialized = mode.initialized; options.const.initialized = mode.initialized; } } //-------------------------------------------------------------------------- // Helpers //-------------------------------------------------------------------------- var functionStack = []; var blockStack = []; /** * Increments the blockStack counter. * @returns {void} * @private */ function startBlock() { blockStack.push({ let: {initialized: false, uninitialized: false}, const: {initialized: false, uninitialized: false} }); } /** * Increments the functionStack counter. * @returns {void} * @private */ function startFunction() { functionStack.push({initialized: false, uninitialized: false}); startBlock(); } /** * Decrements the blockStack counter. * @returns {void} * @private */ function endBlock() { blockStack.pop(); } /** * Decrements the functionStack counter. * @returns {void} * @private */ function endFunction() { functionStack.pop(); endBlock(); } /** * Records whether initialized or uninitialized variables are defined in current scope. * @param {string} statementType node.kind, one of: "var", "let", or "const" * @param {ASTNode[]} declarations List of declarations * @param {Object} currentScope The scope being investigated * @returns {void} * @private */ function recordTypes(statementType, declarations, currentScope) { for (var i = 0; i < declarations.length; i++) { if (declarations[i].init === null) { if (options[statementType] && options[statementType].uninitialized === MODE_ALWAYS) { currentScope.uninitialized = true; } } else { if (options[statementType] && options[statementType].initialized === MODE_ALWAYS) { currentScope.initialized = true; } } } } /** * Determines the current scope (function or block) * @param {string} statementType node.kind, one of: "var", "let", or "const" * @returns {Object} The scope associated with statementType */ function getCurrentScope(statementType) { var currentScope; if (statementType === "var") { currentScope = functionStack[functionStack.length - 1]; } else if (statementType === "let") { currentScope = blockStack[blockStack.length - 1].let; } else if (statementType === "const") { currentScope = blockStack[blockStack.length - 1].const; } return currentScope; } /** * Counts the number of initialized and uninitialized declarations in a list of declarations * @param {ASTNode[]} declarations List of declarations * @returns {Object} Counts of 'uninitialized' and 'initialized' declarations * @private */ function countDeclarations(declarations) { var counts = { uninitialized: 0, initialized: 0 }; for (var i = 0; i < declarations.length; i++) { if (declarations[i].init === null) { counts.uninitialized++; } else { counts.initialized++; } } return counts; } /** * Determines if there is more than one var statement in the current scope. * @param {string} statementType node.kind, one of: "var", "let", or "const" * @param {ASTNode[]} declarations List of declarations * @returns {boolean} Returns true if it is the first var declaration, false if not. * @private */ function hasOnlyOneStatement(statementType, declarations) { var declarationCounts = countDeclarations(declarations); var currentOptions = options[statementType] || {}; var currentScope = getCurrentScope(statementType); if (currentOptions.uninitialized === MODE_ALWAYS && currentOptions.initialized === MODE_ALWAYS) { if (currentScope.uninitialized || currentScope.initialized) { return false; } } if (declarationCounts.uninitialized > 0) { if (currentOptions.uninitialized === MODE_ALWAYS && currentScope.uninitialized) { return false; } } if (declarationCounts.initialized > 0) { if (currentOptions.initialized === MODE_ALWAYS && currentScope.initialized) { return false; } } recordTypes(statementType, declarations, currentScope); return true; } //-------------------------------------------------------------------------- // Public API //-------------------------------------------------------------------------- return { "Program": startFunction, "FunctionDeclaration": startFunction, "FunctionExpression": startFunction, "ArrowFunctionExpression": startFunction, "BlockStatement": startBlock, "ForStatement": startBlock, "ForInStatement": startBlock, "ForOfStatement": startBlock, "SwitchStatement": startBlock, "VariableDeclaration": function(node) { var parent = node.parent, type, declarations, declarationCounts; type = node.kind; if (!options[type]) { return; } declarations = node.declarations; declarationCounts = countDeclarations(declarations); // always if (!hasOnlyOneStatement(type, declarations)) { if (options[type].initialized === MODE_ALWAYS && options[type].uninitialized === MODE_ALWAYS) { context.report(node, "Combine this with the previous '" + type + "' statement."); } else { if (options[type].initialized === MODE_ALWAYS) { context.report(node, "Combine this with the previous '" + type + "' statement with initialized variables."); } if (options[type].uninitialized === MODE_ALWAYS) { context.report(node, "Combine this with the previous '" + type + "' statement with uninitialized variables."); } } } // never if (parent.type !== "ForStatement" || parent.init !== node) { var totalDeclarations = declarationCounts.uninitialized + declarationCounts.initialized; if (totalDeclarations > 1) { // both initialized and uninitialized if (options[type].initialized === MODE_NEVER && options[type].uninitialized === MODE_NEVER) { context.report(node, "Split '" + type + "' declarations into multiple statements."); // initialized } else if (options[type].initialized === MODE_NEVER && declarationCounts.initialized > 0) { context.report(node, "Split initialized '" + type + "' declarations into multiple statements."); // uninitialized } else if (options[type].uninitialized === MODE_NEVER && declarationCounts.uninitialized > 0) { context.report(node, "Split uninitialized '" + type + "' declarations into multiple statements."); } } } }, "ForStatement:exit": endBlock, "ForOfStatement:exit": endBlock, "ForInStatement:exit": endBlock, "SwitchStatement:exit": endBlock, "BlockStatement:exit": endBlock, "Program:exit": endFunction, "FunctionDeclaration:exit": endFunction, "FunctionExpression:exit": endFunction, "ArrowFunctionExpression:exit": endFunction }; }; module.exports.schema = [ { "oneOf": [ { "enum": ["always", "never"] }, { "type": "object", "properties": { "var": { "enum": ["always", "never"] }, "let": { "enum": ["always", "never"] }, "const": { "enum": ["always", "never"] } }, "additionalProperties": false }, { "type": "object", "properties": { "initialized": { "enum": ["always", "never"] }, "uninitialized": { "enum": ["always", "never"] } }, "additionalProperties": false } ] } ]; |