eslint 5.7.0 → 5.11.0

package/lib/rules/quotes.js

@@ -76,6 +76,8 @@ const AVOID_ESCAPE = "avoid-escape";
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce the consistent use of either backticks, double, or single quotes",
             category: "Stylistic Issues",
@@ -226,6 +228,34 @@ module.exports = {
             }
         }
 
+        /**
+         * Checks whether or not a given TemplateLiteral node is actually using any of the special features provided by template literal strings.
+         * @param {ASTNode} node - A TemplateLiteral node to check.
+         * @returns {boolean} Whether or not the TemplateLiteral node is using any of the special features provided by template literal strings.
+         * @private
+         */
+        function isUsingFeatureOfTemplateLiteral(node) {
+            const hasTag = node.parent.type === "TaggedTemplateExpression" && node === node.parent.quasi;
+
+            if (hasTag) {
+                return true;
+            }
+
+            const hasStringInterpolation = node.expressions.length > 0;
+
+            if (hasStringInterpolation) {
+                return true;
+            }
+
+            const isMultilineString = node.quasis.length >= 1 && UNESCAPED_LINEBREAK_PATTERN.test(node.quasis[0].value.raw);
+
+            if (isMultilineString) {
+                return true;
+            }
+
+            return false;
+        }
+
         return {
 
             Literal(node) {
@@ -258,39 +288,34 @@ module.exports = {
 
             TemplateLiteral(node) {
 
-                // If backticks are expected or it's a tagged template, then this shouldn't throw an errors
+                // Don't throw an error if backticks are expected or a template literal feature is in use.
                 if (
                     allowTemplateLiterals ||
                     quoteOption === "backtick" ||
-                    node.parent.type === "TaggedTemplateExpression" && node === node.parent.quasi
+                    isUsingFeatureOfTemplateLiteral(node)
                 ) {
                     return;
                 }
 
-                // A warning should be produced if the template literal only has one TemplateElement, and has no unescaped newlines.
-                const shouldWarn = node.quasis.length === 1 && !UNESCAPED_LINEBREAK_PATTERN.test(node.quasis[0].value.raw);
-
-                if (shouldWarn) {
-                    context.report({
-                        node,
-                        message: "Strings must use {{description}}.",
-                        data: {
-                            description: settings.description
-                        },
-                        fix(fixer) {
-                            if (isPartOfDirectivePrologue(node)) {
-
-                                /*
-                                 * TemplateLiterals in a directive prologue aren't actually directives, but if they're
-                                 * in the directive prologue, then fixing them might turn them into directives and change
-                                 * the behavior of the code.
-                                 */
-                                return null;
-                            }
-                            return fixer.replaceText(node, settings.convert(sourceCode.getText(node)));
+                context.report({
+                    node,
+                    message: "Strings must use {{description}}.",
+                    data: {
+                        description: settings.description
+                    },
+                    fix(fixer) {
+                        if (isPartOfDirectivePrologue(node)) {
+
+                            /*
+                             * TemplateLiterals in a directive prologue aren't actually directives, but if they're
+                             * in the directive prologue, then fixing them might turn them into directives and change
+                             * the behavior of the code.
+                             */
+                            return null;
                         }
-                    });
-                }
+                        return fixer.replaceText(node, settings.convert(sourceCode.getText(node)));
+                    }
+                });
             }
         };
 

package/lib/rules/radix.js

@@ -78,6 +78,8 @@ function isDefaultRadix(radix) {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce the consistent use of the radix argument when using `parseInt()`",
             category: "Best Practices",

package/lib/rules/require-atomic-updates.js

@@ -12,14 +12,18 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "problem",
+
         docs: {
             description: "disallow assignments that can lead to race conditions due to usage of `await` or `yield`",
             category: "Possible Errors",
             recommended: false,
             url: "https://eslint.org/docs/rules/require-atomic-updates"
         },
+
         fixable: null,
         schema: [],
+
         messages: {
             nonAtomicUpdate: "Possible race condition: `{{value}}` might be reassigned based on an outdated value of `{{value}}`."
         }

package/lib/rules/require-await.js

@@ -31,12 +31,15 @@ function capitalizeFirstLetter(text) {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "disallow async functions which have no `await` expression",
             category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/require-await"
         },
+
         schema: []
     },
 

package/lib/rules/require-jsdoc.js

@@ -6,6 +6,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require JSDoc comments",
             category: "Stylistic Issues",
@@ -41,7 +43,10 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        deprecated: true,
+        replacedBy: []
     },
 
     create(context) {

package/lib/rules/require-unicode-regexp.js

@@ -22,15 +22,19 @@ const {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce the use of `u` flag on RegExp",
             category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/require-unicode-regexp"
         },
+
         messages: {
             requireUFlag: "Use the 'u' flag."
         },
+
         schema: []
     },
 

package/lib/rules/require-yield.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require generator functions to contain `yield`",
             category: "ECMAScript 6",

package/lib/rules/rest-spread-spacing.js

@@ -11,13 +11,17 @@
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce spacing between rest and spread operators and their expressions",
             category: "ECMAScript 6",
             recommended: false,
             url: "https://eslint.org/docs/rules/rest-spread-spacing"
         },
+
         fixable: "whitespace",
+
         schema: [
             {
                 enum: ["always", "never"]

package/lib/rules/semi-spacing.js

@@ -13,6 +13,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing before and after semicolons",
             category: "Stylistic Issues",

package/lib/rules/semi-style.js

@@ -65,12 +65,15 @@ function isLastChild(node) {
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce location of semicolons",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/semi-style"
         },
+
         schema: [{ enum: ["last", "first"] }],
         fixable: "whitespace"
     },

package/lib/rules/semi.js

@@ -17,6 +17,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require or disallow semicolons instead of ASI",
             category: "Stylistic Issues",

package/lib/rules/sort-imports.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce sorted import declarations within modules",
             category: "ECMAScript 6",

package/lib/rules/sort-keys.js

@@ -73,12 +73,15 @@ const isValidOrders = {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require object keys to be sorted",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/sort-keys"
         },
+
         schema: [
             {
                 enum: ["asc", "desc"]

package/lib/rules/sort-vars.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require variables within the same declaration block to be sorted",
             category: "Stylistic Issues",

package/lib/rules/space-before-blocks.js

@@ -13,6 +13,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing before blocks",
             category: "Stylistic Issues",
@@ -32,13 +34,13 @@ module.exports = {
                         type: "object",
                         properties: {
                             keywords: {
-                                enum: ["always", "never"]
+                                enum: ["always", "never", "off"]
                             },
                             functions: {
-                                enum: ["always", "never"]
+                                enum: ["always", "never", "off"]
                             },
                             classes: {
-                                enum: ["always", "never"]
+                                enum: ["always", "never", "off"]
                             }
                         },
                         additionalProperties: false
@@ -51,18 +53,27 @@ module.exports = {
     create(context) {
         const config = context.options[0],
             sourceCode = context.getSourceCode();
-        let checkFunctions = true,
-            checkKeywords = true,
-            checkClasses = true;
+        let alwaysFunctions = true,
+            alwaysKeywords = true,
+            alwaysClasses = true,
+            neverFunctions = false,
+            neverKeywords = false,
+            neverClasses = false;
 
         if (typeof config === "object") {
-            checkFunctions = config.functions !== "never";
-            checkKeywords = config.keywords !== "never";
-            checkClasses = config.classes !== "never";
+            alwaysFunctions = config.functions === "always";
+            alwaysKeywords = config.keywords === "always";
+            alwaysClasses = config.classes === "always";
+            neverFunctions = config.functions === "never";
+            neverKeywords = config.keywords === "never";
+            neverClasses = config.classes === "never";
         } else if (config === "never") {
-            checkFunctions = false;
-            checkKeywords = false;
-            checkClasses = false;
+            alwaysFunctions = false;
+            alwaysKeywords = false;
+            alwaysClasses = false;
+            neverFunctions = true;
+            neverKeywords = true;
+            neverClasses = true;
         }
 
         /**
@@ -88,35 +99,35 @@ module.exports = {
                 const hasSpace = sourceCode.isSpaceBetweenTokens(precedingToken, node);
                 const parent = context.getAncestors().pop();
                 let requireSpace;
+                let requireNoSpace;
 
                 if (parent.type === "FunctionExpression" || parent.type === "FunctionDeclaration") {
-                    requireSpace = checkFunctions;
+                    requireSpace = alwaysFunctions;
+                    requireNoSpace = neverFunctions;
                 } else if (node.type === "ClassBody") {
-                    requireSpace = checkClasses;
+                    requireSpace = alwaysClasses;
+                    requireNoSpace = neverClasses;
                 } else {
-                    requireSpace = checkKeywords;
+                    requireSpace = alwaysKeywords;
+                    requireNoSpace = neverKeywords;
                 }
 
-                if (requireSpace) {
-                    if (!hasSpace) {
-                        context.report({
-                            node,
-                            message: "Missing space before opening brace.",
-                            fix(fixer) {
-                                return fixer.insertTextBefore(node, " ");
-                            }
-                        });
-                    }
-                } else {
-                    if (hasSpace) {
-                        context.report({
-                            node,
-                            message: "Unexpected space before opening brace.",
-                            fix(fixer) {
-                                return fixer.removeRange([precedingToken.range[1], node.range[0]]);
-                            }
-                        });
-                    }
+                if (requireSpace && !hasSpace) {
+                    context.report({
+                        node,
+                        message: "Missing space before opening brace.",
+                        fix(fixer) {
+                            return fixer.insertTextBefore(node, " ");
+                        }
+                    });
+                } else if (requireNoSpace && hasSpace) {
+                    context.report({
+                        node,
+                        message: "Unexpected space before opening brace.",
+                        fix(fixer) {
+                            return fixer.removeRange([precedingToken.range[1], node.range[0]]);
+                        }
+                    });
                 }
             }
         }

package/lib/rules/space-before-function-paren.js

@@ -16,6 +16,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing before `function` definition opening parenthesis",
             category: "Stylistic Issues",

package/lib/rules/space-in-parens.js

@@ -12,6 +12,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing inside parentheses",
             category: "Stylistic Issues",
@@ -59,7 +61,6 @@ module.exports = {
 
         /**
          * Produces an object with the opener and closer exception values
-         * @param {Object} opts The exception options
          * @returns {Object} `openers` and `closers` exception values
          * @private
          */

package/lib/rules/space-infix-ops.js

@@ -10,6 +10,8 @@
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require spacing around infix operators",
             category: "Stylistic Issues",
@@ -67,7 +69,10 @@ module.exports = {
             context.report({
                 node: mainNode,
                 loc: culpritToken.loc.start,
-                message: "Infix operators must be spaced.",
+                message: "Operator '{{operator}}' must be spaced.",
+                data: {
+                    operator: culpritToken.value
+                },
                 fix(fixer) {
                     const previousToken = sourceCode.getTokenBefore(culpritToken);
                     const afterToken = sourceCode.getTokenAfter(culpritToken);

package/lib/rules/space-unary-ops.js

@@ -16,6 +16,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing before or after unary operators",
             category: "Stylistic Issues",

package/lib/rules/spaced-comment.js

@@ -151,6 +151,8 @@ function createNeverStylePattern(markers) {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce consistent spacing after the `//` or `/*` in a comment",
             category: "Stylistic Issues",

package/lib/rules/strict.js

@@ -80,6 +80,8 @@ function isSimpleParameterList(params) {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require or disallow strict mode directives",
             category: "Strict Mode",

package/lib/rules/switch-colon-spacing.js

@@ -17,12 +17,15 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce spacing around colons of switch statements",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/switch-colon-spacing"
         },
+
         schema: [
             {
                 type: "object",
@@ -33,6 +36,7 @@ module.exports = {
                 additionalProperties: false
             }
         ],
+
         fixable: "whitespace"
     },
 

package/lib/rules/symbol-description.js

@@ -18,6 +18,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require symbol descriptions",
             category: "ECMAScript 6",

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

@@ -24,6 +24,8 @@ const CLOSE_PAREN = /^\}/;
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require or disallow spacing around embedded expressions of template strings",
             category: "ECMAScript 6",

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

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require or disallow spacing between template tags and their literals",
             category: "Stylistic Issues",

package/lib/rules/unicode-bom.js

@@ -10,6 +10,8 @@
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require or disallow Unicode byte order mark (BOM)",
             category: "Stylistic Issues",

package/lib/rules/use-isnan.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "problem",
+
         docs: {
             description: "require calls to `isNaN()` when checking for `NaN`",
             category: "Possible Errors",

package/lib/rules/valid-jsdoc.js

@@ -16,6 +16,8 @@ const doctrine = require("doctrine");
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce valid JSDoc comments",
             category: "Possible Errors",
@@ -62,7 +64,10 @@ module.exports = {
             }
         ],
 
-        fixable: "code"
+        fixable: "code",
+
+        deprecated: true,
+        replacedBy: []
     },
 
     create(context) {

package/lib/rules/valid-typeof.js

@@ -10,6 +10,8 @@
 
 module.exports = {
     meta: {
+        type: "problem",
+
         docs: {
             description: "enforce comparing `typeof` expressions against valid strings",
             category: "Possible Errors",

package/lib/rules/vars-on-top.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require `var` declarations be placed at the top of their containing scope",
             category: "Best Practices",

package/lib/rules/wrap-iife.js

@@ -17,6 +17,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require parentheses around immediate `function` invocations",
             category: "Best Practices",

package/lib/rules/wrap-regex.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require parenthesis around regex literals",
             category: "Stylistic Issues",
@@ -19,8 +21,8 @@ module.exports = {
         },
 
         schema: [],
-
         fixable: "code",
+
         messages: {
             requireParens: "Wrap the regexp literal in parens to disambiguate the slash."
         }

package/lib/rules/yield-star-spacing.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require or disallow spacing around the `*` in `yield*` expressions",
             category: "ECMAScript 6",