Blame view
node_modules/eslint/lib/rules/new-cap.js
7.7 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 |
/** * @fileoverview Rule to flag use of constructors without capital letters * @author Nicholas C. Zakas * @copyright 2014 Jordan Harband. All rights reserved. * @copyright 2013-2014 Nicholas C. Zakas. All rights reserved. */ "use strict"; //------------------------------------------------------------------------------ // Requirements //------------------------------------------------------------------------------ var assign = require("object-assign"); //------------------------------------------------------------------------------ // Helpers //------------------------------------------------------------------------------ var CAPS_ALLOWED = [ "Array", "Boolean", "Date", "Error", "Function", "Number", "Object", "RegExp", "String", "Symbol" ]; /** * Ensure that if the key is provided, it must be an array. * @param {Object} obj Object to check with `key`. * @param {string} key Object key to check on `obj`. * @param {*} fallback If obj[key] is not present, this will be returned. * @returns {string[]} Returns obj[key] if it's an Array, otherwise `fallback` */ function checkArray(obj, key, fallback) { /* istanbul ignore if */ if (Object.prototype.hasOwnProperty.call(obj, key) && !Array.isArray(obj[key])) { throw new TypeError(key + ", if provided, must be an Array"); } return obj[key] || fallback; } /** * A reducer function to invert an array to an Object mapping the string form of the key, to `true`. * @param {Object} map Accumulator object for the reduce. * @param {string} key Object key to set to `true`. * @returns {Object} Returns the updated Object for further reduction. */ function invert(map, key) { map[key] = true; return map; } /** * Creates an object with the cap is new exceptions as its keys and true as their values. * @param {Object} config Rule configuration * @returns {Object} Object with cap is new exceptions. */ function calculateCapIsNewExceptions(config) { var capIsNewExceptions = checkArray(config, "capIsNewExceptions", CAPS_ALLOWED); if (capIsNewExceptions !== CAPS_ALLOWED) { capIsNewExceptions = capIsNewExceptions.concat(CAPS_ALLOWED); } return capIsNewExceptions.reduce(invert, {}); } //------------------------------------------------------------------------------ // Rule Definition //------------------------------------------------------------------------------ module.exports = function(context) { var config = context.options[0] ? assign({}, context.options[0]) : {}; config.newIsCap = config.newIsCap !== false; config.capIsNew = config.capIsNew !== false; var skipProperties = config.properties === false; var newIsCapExceptions = checkArray(config, "newIsCapExceptions", []).reduce(invert, {}); var capIsNewExceptions = calculateCapIsNewExceptions(config); var listeners = {}; //-------------------------------------------------------------------------- // Helpers //-------------------------------------------------------------------------- /** * Get exact callee name from expression * @param {ASTNode} node CallExpression or NewExpression node * @returns {string} name */ function extractNameFromExpression(node) { var name = "", property; if (node.callee.type === "MemberExpression") { property = node.callee.property; if (property.type === "Literal" && (typeof property.value === "string")) { name = property.value; } else if (property.type === "Identifier" && !node.callee.computed) { name = property.name; } } else { name = node.callee.name; } return name; } /** * Returns the capitalization state of the string - * Whether the first character is uppercase, lowercase, or non-alphabetic * @param {string} str String * @returns {string} capitalization state: "non-alpha", "lower", or "upper" */ function getCap(str) { var firstChar = str.charAt(0); var firstCharLower = firstChar.toLowerCase(); var firstCharUpper = firstChar.toUpperCase(); if (firstCharLower === firstCharUpper) { // char has no uppercase variant, so it's non-alphabetic return "non-alpha"; } else if (firstChar === firstCharLower) { return "lower"; } else { return "upper"; } } /** * Check if capitalization is allowed for a CallExpression * @param {Object} allowedMap Object mapping calleeName to a Boolean * @param {ASTNode} node CallExpression node * @param {string} calleeName Capitalized callee name from a CallExpression * @returns {Boolean} Returns true if the callee may be capitalized */ function isCapAllowed(allowedMap, node, calleeName) { if (allowedMap[calleeName] || allowedMap[context.getSource(node.callee)]) { return true; } if (calleeName === "UTC" && node.callee.type === "MemberExpression") { // allow if callee is Date.UTC return node.callee.object.type === "Identifier" && node.callee.object.name === "Date"; } return skipProperties && node.callee.type === "MemberExpression"; } /** * Reports the given message for the given node. The location will be the start of the property or the callee. * @param {ASTNode} node CallExpression or NewExpression node. * @param {string} message The message to report. * @returns {void} */ function report(node, message) { var callee = node.callee; if (callee.type === "MemberExpression") { callee = callee.property; } context.report(node, callee.loc.start, message); } //-------------------------------------------------------------------------- // Public //-------------------------------------------------------------------------- if (config.newIsCap) { listeners.NewExpression = function(node) { var constructorName = extractNameFromExpression(node); if (constructorName) { var capitalization = getCap(constructorName); var isAllowed = capitalization !== "lower" || isCapAllowed(newIsCapExceptions, node, constructorName); if (!isAllowed) { report(node, "A constructor name should not start with a lowercase letter."); } } }; } if (config.capIsNew) { listeners.CallExpression = function(node) { var calleeName = extractNameFromExpression(node); if (calleeName) { var capitalization = getCap(calleeName); var isAllowed = capitalization !== "upper" || isCapAllowed(capIsNewExceptions, node, calleeName); if (!isAllowed) { report(node, "A function with a name starting with an uppercase letter should only be used as a constructor."); } } }; } return listeners; }; module.exports.schema = [ { "type": "object", "properties": { "newIsCap": { "type": "boolean" }, "capIsNew": { "type": "boolean" }, "newIsCapExceptions": { "type": "array", "items": { "type": "string" } }, "capIsNewExceptions": { "type": "array", "items": { "type": "string" } }, "properties": { "type": "boolean" } }, "additionalProperties": false } ]; |