Update: requireStringLiterals option for valid-typeof (fixes #6698)…

… (#6923)
eslint · Aug 21, 2016 · cf2242c · cf2242c
1 parent 8561389
commit cf2242c
Show file tree

Hide file tree

Showing 3 changed files with 81 additions and 4 deletions.
diff --git a/docs/rules/valid-typeof.md b/docs/rules/valid-typeof.md
@@ -6,6 +6,12 @@ For a vast majority of use cases, the result of the `typeof` operator is one of
 
 This rule enforces comparing `typeof` expressions to valid string literals.
 
+## Options
+
+This rule has an object option:
+
+* `"requireStringLiterals": true` requires `typeof` expressions to only be compared to string literals, and disallows comparisons to any other value.
+
 Examples of **incorrect** code for this rule:
 
 ```js
@@ -28,6 +34,26 @@ typeof foo === baz
 typeof bar === typeof qux
 ```
 
+Examples of **incorrect** code with the `{ "requireStringLiterals": true }` option:
+
+```js
+typeof foo === undefined
+typeof bar == Object
+typeof baz === "strnig"
+typeof qux === "some invalid type"
+typeof baz === anotherVariable
+typeof foo == 5
+typeof bar === typeof qux
+```
+
+Examples of **correct** code with the `{ "requireStringLiterals": true }` option:
+
+```js
+typeof foo === "undefined"
+typeof bar == "object"
+typeof baz === "string"
+```
+
 ## When Not To Use It
 
 You may want to turn this rule off if you will be using the `typeof` operator on host objects.
diff --git a/lib/rules/valid-typeof.js b/lib/rules/valid-typeof.js
@@ -16,7 +16,17 @@ module.exports = {
             recommended: true
         },
 
-        schema: []
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    requireStringLiterals: {
+                        type: "boolean"
+                    }
+                },
+                additionalProperties: false
+            }
+        ]
     },
 
     create(context) {
@@ -37,8 +47,12 @@ module.exports = {
                     if (parent.type === "BinaryExpression" && OPERATORS.indexOf(parent.operator) !== -1) {
                         const sibling = parent.left === node ? parent.right : parent.left;
 
-                        if (sibling.type === "Literal" && VALID_TYPES.indexOf(sibling.value) === -1) {
-                            context.report(sibling, "Invalid typeof comparison value.");
+                        if (sibling.type === "Literal") {
+                            if (VALID_TYPES.indexOf(sibling.value) === -1) {
+                                context.report(sibling, "Invalid typeof comparison value.");
+                            }
+                        } else if (context.options[0] && context.options[0].requireStringLiterals) {
+                            context.report(sibling, "Typeof comparisons should be to string literals.");
                         }
                     }
                 }

diff --git a/tests/lib/rules/valid-typeof.js b/tests/lib/rules/valid-typeof.js
@@ -43,7 +43,19 @@ ruleTester.run("valid-typeof", rule, {
         "typeof(foo) !== 'string'",
         "typeof(foo) == 'string'",
         "typeof(foo) != 'string'",
-        "var oddUse = typeof foo + 'thing'"
+        "var oddUse = typeof foo + 'thing'",
+        {
+            code: "typeof foo === 'number'",
+            options: [{ requireStringLiterals: true }],
+        },
+        {
+            code: "typeof foo === \"number\"",
+            options: [{ requireStringLiterals: true }]
+        },
+        {
+            code: "var baz = typeof foo + 'thing'",
+            options: [{ requireStringLiterals: true }]
+        }
     ],
 
     invalid: [
@@ -94,6 +106,31 @@ ruleTester.run("valid-typeof", rule, {
         {
             code: "if (typeof bar == 'umdefined') {}",
             errors: [{ message: "Invalid typeof comparison value.", type: "Literal" }]
+        },
+        {
+            code: "typeof foo == 'invalid string'",
+            options: [{ requireStringLiterals: true }],
+            errors: [{ message: "Invalid typeof comparison value.", type: "Literal" }]
+        },
+        {
+            code: "typeof foo == Object",
+            options: [{ requireStringLiterals: true }],
+            errors: [{ message: "Typeof comparisons should be to string literals.", type: "Identifier" }]
+        },
+        {
+            code: "typeof foo === undefined",
+            options: [{ requireStringLiterals: true }],
+            errors: [{ message: "Typeof comparisons should be to string literals.", type: "Identifier" }]
+        },
+        {
+            code: "undefined === typeof foo",
+            options: [{ requireStringLiterals: true }],
+            errors: [{ message: "Typeof comparisons should be to string literals.", type: "Identifier" }]
+        },
+        {
+            code: "undefined == typeof foo",
+            options: [{ requireStringLiterals: true }],
+            errors: [{ message: "Typeof comparisons should be to string literals.", type: "Identifier" }]
         }
     ]
 });