Fix: quote-props false positive on certain keys (fixes #5532)

This patch ensures the "tokenized" version of the key is an exact match to avoid any false positives when the key includes spaces around of it or has "comment blocks" in it such as `//..` or `/*..*/`
eslint · Mar 13, 2016 · 689cb7d · 689cb7d
1 parent fce1917
commit 689cb7d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/lib/rules/quote-props.js b/lib/rules/quote-props.js
@@ -41,13 +41,14 @@ module.exports = function(context) {
 
     /**
      * Checks if an espree-tokenized key has redundant quotes (i.e. whether quotes are unnecessary)
+     * @param   {string} rawKey The raw key value from the source
      * @param   {espreeTokens} tokens The espree-tokenized node key
      * @param   {boolean} [skipNumberLiterals=false] Indicates whether number literals should be checked
      * @returns {boolean} Whether or not a key has redundant quotes.
      * @private
      */
-    function areQuotesRedundant(tokens, skipNumberLiterals) {
-        return tokens.length === 1 &&
+    function areQuotesRedundant(rawKey, tokens, skipNumberLiterals) {
+        return tokens.length === 1 && tokens[0].start === 0 && tokens[0].end === rawKey.length &&
             (["Identifier", "Keyword", "Null", "Boolean"].indexOf(tokens[0].type) >= 0 ||
             (tokens[0].type === "Numeric" && !skipNumberLiterals && "" + +tokens[0].value === tokens[0].value));
     }
@@ -83,7 +84,7 @@ module.exports = function(context) {
                 return;
             }
 
-            if (CHECK_UNNECESSARY && areQuotesRedundant(tokens, NUMBERS)) {
+            if (CHECK_UNNECESSARY && areQuotesRedundant(key.value, tokens, NUMBERS)) {
                 context.report(node, MESSAGE_UNNECESSARY, {property: key.value});
             }
         } else if (KEYWORDS && key.type === "Identifier" && isKeyword(key.name)) {
@@ -139,7 +140,7 @@ module.exports = function(context) {
                         return;
                     }
 
-                    necessaryQuotes = necessaryQuotes || !areQuotesRedundant(tokens) || KEYWORDS && isKeyword(tokens[0].value);
+                    necessaryQuotes = necessaryQuotes || !areQuotesRedundant(key.value, tokens) || KEYWORDS && isKeyword(tokens[0].value);
                 }
             } else if (KEYWORDS && checkQuotesRedundancy && key.type === "Identifier" && isKeyword(key.name)) {
                 necessaryQuotes = true;

diff --git a/tests/lib/rules/quote-props.js b/tests/lib/rules/quote-props.js
@@ -44,6 +44,11 @@ ruleTester.run("quote-props", rule, {
         { code: "({ a: 0, '@': 0 })", options: ["as-needed"] },
         { code: "({ a: 0, 0: 0 })", options: ["as-needed"] },
         { code: "({ a: 0, '0x0': 0 })", options: ["as-needed"] },
+        { code: "({ ' 0': 0, '0x0': 0 })", options: ["as-needed"] },
+        { code: "({ '0 ': 0 })", options: ["as-needed"] },
+        { code: "({ 'hey//meh': 0 })", options: ["as-needed"] },
+        { code: "({ 'hey/*meh': 0 })", options: ["as-needed"] },
+        { code: "({ 'hey/*meh*/': 0 })", options: ["as-needed"] },
         { code: "({ 'a': 0, '-b': 0 })", options: ["consistent"] },
         { code: "({ 'true': 0, 'b': 0 })", options: ["consistent"] },
         { code: "({ null: 0, a: 0 })", options: ["consistent"] },