eslint 6.3.0 → 6.6.0

package/lib/rules/spaced-comment.js

@@ -13,7 +13,7 @@ const astUtils = require("./utils/ast-utils");
 
 /**
  * Escapes the control characters of a given string.
- * @param {string} s - A string to escape.
+ * @param {string} s A string to escape.
  * @returns {string} An escaped string.
  */
 function escape(s) {
@@ -23,7 +23,7 @@ function escape(s) {
 /**
  * Escapes the control characters of a given string.
  * And adds a repeat flag.
- * @param {string} s - A string to escape.
+ * @param {string} s A string to escape.
  * @returns {string} An escaped string.
  */
 function escapeAndRepeat(s) {
@@ -33,7 +33,7 @@ function escapeAndRepeat(s) {
 /**
  * Parses `markers` option.
  * If markers don't include `"*"`, this adds `"*"` to allow JSDoc comments.
- * @param {string[]} [markers] - A marker list.
+ * @param {string[]} [markers] A marker list.
  * @returns {string[]} A marker list.
  */
 function parseMarkersOption(markers) {
@@ -51,8 +51,7 @@ function parseMarkersOption(markers) {
  * Generated pattern:
  *
  * 1. A space or an exception pattern sequence.
- *
- * @param {string[]} exceptions - An exception pattern list.
+ * @param {string[]} exceptions An exception pattern list.
  * @returns {string} A regular expression string for exceptions.
  */
 function createExceptionsPattern(exceptions) {
@@ -97,9 +96,8 @@ function createExceptionsPattern(exceptions) {
  *
  * 1. First, a marker or nothing.
  * 2. Next, a space or an exception pattern sequence.
- *
- * @param {string[]} markers - A marker list.
- * @param {string[]} exceptions - An exception pattern list.
+ * @param {string[]} markers A marker list.
+ * @param {string[]} exceptions An exception pattern list.
  * @returns {RegExp} A RegExp object for the beginning of a comment in `always` mode.
  */
 function createAlwaysStylePattern(markers, exceptions) {
@@ -135,8 +133,7 @@ function createAlwaysStylePattern(markers, exceptions) {
  *
  * 1. First, a marker or nothing (captured).
  * 2. Next, a space or a tab.
- *
- * @param {string[]} markers - A marker list.
+ * @param {string[]} markers A marker list.
  * @returns {RegExp} A RegExp object for `never` mode.
  */
 function createNeverStylePattern(markers) {
@@ -260,10 +257,10 @@ module.exports = {
 
         /**
          * Reports a beginning spacing error with an appropriate message.
-         * @param {ASTNode} node - A comment node to check.
-         * @param {string} message - An error message to report.
-         * @param {Array} match - An array of match results for markers.
-         * @param {string} refChar - Character used for reference in the error message.
+         * @param {ASTNode} node A comment node to check.
+         * @param {string} message An error message to report.
+         * @param {Array} match An array of match results for markers.
+         * @param {string} refChar Character used for reference in the error message.
          * @returns {void}
          */
         function reportBegin(node, message, match, refChar) {
@@ -293,9 +290,9 @@ module.exports = {
 
         /**
          * Reports an ending spacing error with an appropriate message.
-         * @param {ASTNode} node - A comment node to check.
-         * @param {string} message - An error message to report.
-         * @param {string} match - An array of the matched whitespace characters.
+         * @param {ASTNode} node A comment node to check.
+         * @param {string} message An error message to report.
+         * @param {string} match An array of the matched whitespace characters.
          * @returns {void}
          */
         function reportEnd(node, message, match) {
@@ -317,7 +314,7 @@ module.exports = {
 
         /**
          * Reports a given comment if it's invalid.
-         * @param {ASTNode} node - a comment node to check.
+         * @param {ASTNode} node a comment node to check.
          * @returns {void}
          */
         function checkCommentForSpace(node) {

package/lib/rules/strict.js

@@ -43,8 +43,7 @@ function getUseStrictDirectives(statements) {
 
 /**
  * Checks whether a given parameter is a simple parameter.
- *
- * @param {ASTNode} node - A pattern node to check.
+ * @param {ASTNode} node A pattern node to check.
  * @returns {boolean} `true` if the node is an Identifier node.
  */
 function isSimpleParameter(node) {
@@ -53,8 +52,7 @@ function isSimpleParameter(node) {
 
 /**
  * Checks whether a given parameter list is a simple parameter list.
- *
- * @param {ASTNode[]} params - A parameter list to check.
+ * @param {ASTNode[]} params A parameter list to check.
  * @returns {boolean} `true` if the every parameter is an Identifier node.
  */
 function isSimpleParameterList(params) {

package/lib/rules/symbol-description.js

@@ -38,8 +38,7 @@ module.exports = {
         /**
          * Reports if node does not conform the rule in case rule is set to
          * report missing description
-         *
-         * @param {ASTNode} node - A CallExpression node to check.
+         * @param {ASTNode} node A CallExpression node to check.
          * @returns {void}
          */
         function checkArgument(node) {

package/lib/rules/template-curly-spacing.js

@@ -53,7 +53,7 @@ module.exports = {
 
         /**
          * Checks spacing before `}` of a given token.
-         * @param {Token} token - A token to check. This is a Template token.
+         * @param {Token} token A token to check. This is a Template token.
          * @returns {void}
          */
         function checkSpacingBefore(token) {
@@ -82,7 +82,7 @@ module.exports = {
 
         /**
          * Checks spacing after `${` of a given token.
-         * @param {Token} token - A token to check. This is a Template token.
+         * @param {Token} token A token to check. This is a Template token.
          * @returns {void}
          */
         function checkSpacingAfter(token) {

package/lib/rules/use-isnan.js

@@ -5,6 +5,25 @@
 
 "use strict";
 
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const astUtils = require("./utils/ast-utils");
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/**
+ * Determines if the given node is a NaN `Identifier` node.
+ * @param {ASTNode|null} node The node to check.
+ * @returns {boolean} `true` if the node is 'NaN' identifier.
+ */
+function isNaNIdentifier(node) {
+    return Boolean(node) && node.type === "Identifier" && node.name === "NaN";
+}
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -20,21 +39,100 @@ module.exports = {
             url: "https://eslint.org/docs/rules/use-isnan"
         },
 
-        schema: [],
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    enforceForSwitchCase: {
+                        type: "boolean",
+                        default: false
+                    },
+                    enforceForIndexOf: {
+                        type: "boolean",
+                        default: false
+                    }
+                },
+                additionalProperties: false
+            }
+        ],
+
         messages: {
-            useIsNaN: "Use the isNaN function to compare with NaN."
+            comparisonWithNaN: "Use the isNaN function to compare with NaN.",
+            switchNaN: "'switch(NaN)' can never match a case clause. Use Number.isNaN instead of the switch.",
+            caseNaN: "'case NaN' can never match. Use Number.isNaN before the switch.",
+            indexOfNaN: "Array prototype method '{{ methodName }}' cannot find NaN."
         }
     },
 
     create(context) {
 
-        return {
-            BinaryExpression(node) {
-                if (/^(?:[<>]|[!=]=)=?$/u.test(node.operator) && (node.left.name === "NaN" || node.right.name === "NaN")) {
-                    context.report({ node, messageId: "useIsNaN" });
+        const enforceForSwitchCase = context.options[0] && context.options[0].enforceForSwitchCase;
+        const enforceForIndexOf = context.options[0] && context.options[0].enforceForIndexOf;
+
+        /**
+         * Checks the given `BinaryExpression` node for `foo === NaN` and other comparisons.
+         * @param {ASTNode} node The node to check.
+         * @returns {void}
+         */
+        function checkBinaryExpression(node) {
+            if (
+                /^(?:[<>]|[!=]=)=?$/u.test(node.operator) &&
+                (isNaNIdentifier(node.left) || isNaNIdentifier(node.right))
+            ) {
+                context.report({ node, messageId: "comparisonWithNaN" });
+            }
+        }
+
+        /**
+         * Checks the discriminant and all case clauses of the given `SwitchStatement` node for `switch(NaN)` and `case NaN:`
+         * @param {ASTNode} node The node to check.
+         * @returns {void}
+         */
+        function checkSwitchStatement(node) {
+            if (isNaNIdentifier(node.discriminant)) {
+                context.report({ node, messageId: "switchNaN" });
+            }
+
+            for (const switchCase of node.cases) {
+                if (isNaNIdentifier(switchCase.test)) {
+                    context.report({ node: switchCase, messageId: "caseNaN" });
                 }
             }
+        }
+
+        /**
+         * Checks the the given `CallExpression` node for `.indexOf(NaN)` and `.lastIndexOf(NaN)`.
+         * @param {ASTNode} node The node to check.
+         * @returns {void}
+         */
+        function checkCallExpression(node) {
+            const callee = node.callee;
+
+            if (callee.type === "MemberExpression") {
+                const methodName = astUtils.getStaticPropertyName(callee);
+
+                if (
+                    (methodName === "indexOf" || methodName === "lastIndexOf") &&
+                    node.arguments.length === 1 &&
+                    isNaNIdentifier(node.arguments[0])
+                ) {
+                    context.report({ node, messageId: "indexOfNaN", data: { methodName } });
+                }
+            }
+        }
+
+        const listeners = {
+            BinaryExpression: checkBinaryExpression
         };
 
+        if (enforceForSwitchCase) {
+            listeners.SwitchStatement = checkSwitchStatement;
+        }
+
+        if (enforceForIndexOf) {
+            listeners.CallExpression = checkCallExpression;
+        }
+
+        return listeners;
     }
 };