Blame view
node_modules/eslint/lib/rules/quotes.js
6.29 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 |
/** * @fileoverview A rule to choose between single and double quote marks * @author Matt DuVall <http://www.mattduvall.com/>, Brandon Payton * @copyright 2013 Matt DuVall. All rights reserved. * See LICENSE file in root directory for full license. */ "use strict"; //------------------------------------------------------------------------------ // Requirements //------------------------------------------------------------------------------ var astUtils = require("../ast-utils"); //------------------------------------------------------------------------------ // Constants //------------------------------------------------------------------------------ var QUOTE_SETTINGS = { "double": { quote: "\"", alternateQuote: "'", description: "doublequote" }, "single": { quote: "'", alternateQuote: "\"", description: "singlequote" }, "backtick": { quote: "`", alternateQuote: "\"", description: "backtick" } }; /** * Switches quoting of javascript string between ' " and ` * escaping and unescaping as necessary. * Only escaping of the minimal set of characters is changed. * Note: escaping of newlines when switching from backtick to other quotes is not handled. * @param {string} str - A string to convert. * @returns {string} The string with changed quotes. * @private */ QUOTE_SETTINGS.double.convert = QUOTE_SETTINGS.single.convert = QUOTE_SETTINGS.backtick.convert = function(str) { var newQuote = this.quote; var oldQuote = str[0]; if (newQuote === oldQuote) { return str; } return newQuote + str.slice(1, -1).replace(/\\(\${|\r ?| |.)|["'`]|\${|(\r ?| )/g, function(match, escaped, newline) { if (escaped === oldQuote || oldQuote === "`" && escaped === "${") { return escaped; // unescape } if (match === newQuote || newQuote === "`" && match === "${") { return "\\" + match; // escape } if (newline && oldQuote === "`") { return "\ "; // escape newlines } return match; }) + newQuote; }; var AVOID_ESCAPE = "avoid-escape", FUNCTION_TYPE = /^(?:Arrow)?Function(?:Declaration|Expression)$/; //------------------------------------------------------------------------------ // Rule Definition //------------------------------------------------------------------------------ module.exports = function(context) { /** * Determines if a given node is part of JSX syntax. * @param {ASTNode} node The node to check. * @returns {boolean} True if the node is a JSX node, false if not. * @private */ function isJSXElement(node) { return node.type.indexOf("JSX") === 0; } /** * Checks whether or not a given node is a directive. * The directive is a `ExpressionStatement` which has only a string literal. * @param {ASTNode} node - A node to check. * @returns {boolean} Whether or not the node is a directive. * @private */ function isDirective(node) { return ( node.type === "ExpressionStatement" && node.expression.type === "Literal" && typeof node.expression.value === "string" ); } /** * Checks whether or not a given node is a part of directive prologues. * See also: http://www.ecma-international.org/ecma-262/6.0/#sec-directive-prologues-and-the-use-strict-directive * @param {ASTNode} node - A node to check. * @returns {boolean} Whether or not the node is a part of directive prologues. * @private */ function isPartOfDirectivePrologue(node) { var block = node.parent.parent; if (block.type !== "Program" && (block.type !== "BlockStatement" || !FUNCTION_TYPE.test(block.parent.type))) { return false; } // Check the node is at a prologue. for (var i = 0; i < block.body.length; ++i) { var statement = block.body[i]; if (statement === node.parent) { return true; } if (!isDirective(statement)) { break; } } return false; } /** * Checks whether or not a given node is allowed as non backtick. * @param {ASTNode} node - A node to check. * @returns {boolean} Whether or not the node is allowed as non backtick. * @private */ function isAllowedAsNonBacktick(node) { var parent = node.parent; switch (parent.type) { // Directive Prologues. case "ExpressionStatement": return isPartOfDirectivePrologue(node); // LiteralPropertyName. case "Property": return parent.key === node && !parent.computed; // ModuleSpecifier. case "ImportDeclaration": case "ExportNamedDeclaration": case "ExportAllDeclaration": return parent.source === node; // Others don't allow. default: return false; } } return { "Literal": function(node) { var val = node.value, rawVal = node.raw, quoteOption = context.options[0], settings = QUOTE_SETTINGS[quoteOption || "double"], avoidEscape = context.options[1] === AVOID_ESCAPE, isValid; if (settings && typeof val === "string") { isValid = (quoteOption === "backtick" && isAllowedAsNonBacktick(node)) || isJSXElement(node.parent) || astUtils.isSurroundedBy(rawVal, settings.quote); if (!isValid && avoidEscape) { isValid = astUtils.isSurroundedBy(rawVal, settings.alternateQuote) && rawVal.indexOf(settings.quote) >= 0; } if (!isValid) { context.report({ node: node, message: "Strings must use " + settings.description + ".", fix: function(fixer) { return fixer.replaceText(node, settings.convert(node.raw)); } }); } } } }; }; module.exports.schema = [ { "enum": ["single", "double", "backtick"] }, { "enum": ["avoid-escape"] } ]; |