eslint 8.0.0-beta.0 → 8.0.0

package/lib/linter/linter.js

@@ -50,8 +50,8 @@ const parserSymbol = Symbol.for("eslint.RuleTester.parser");
 // Typedefs
 //------------------------------------------------------------------------------
 
-/** @typedef {InstanceType<import("../cli-engine/config-array")["ConfigArray"]>} ConfigArray */
-/** @typedef {InstanceType<import("../cli-engine/config-array")["ExtractedConfig"]>} ExtractedConfig */
+/** @typedef {InstanceType<import("../cli-engine/config-array").ConfigArray>} ConfigArray */
+/** @typedef {InstanceType<import("../cli-engine/config-array").ExtractedConfig>} ExtractedConfig */
 /** @typedef {import("../shared/types").ConfigData} ConfigData */
 /** @typedef {import("../shared/types").Environment} Environment */
 /** @typedef {import("../shared/types").GlobalConf} GlobalConf */
@@ -60,17 +60,19 @@ const parserSymbol = Symbol.for("eslint.RuleTester.parser");
 /** @typedef {import("../shared/types").Processor} Processor */
 /** @typedef {import("../shared/types").Rule} Rule */
 
+/* eslint-disable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */
 /**
  * @template T
  * @typedef {{ [P in keyof T]-?: T[P] }} Required
  */
+/* eslint-enable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */
 
 /**
  * @typedef {Object} DisableDirective
- * @property {("disable"|"enable"|"disable-line"|"disable-next-line")} type
- * @property {number} line
- * @property {number} column
- * @property {(string|null)} ruleId
+ * @property {("disable"|"enable"|"disable-line"|"disable-next-line")} type Type of directive
+ * @property {number} line The line number
+ * @property {number} column The column number
+ * @property {(string|null)} ruleId The rule ID
  */
 
 /**
@@ -98,12 +100,12 @@ const parserSymbol = Symbol.for("eslint.RuleTester.parser");
  * @typedef {Object} ProcessorOptions
  * @property {(filename:string, text:string) => boolean} [filterCodeBlock] the
  *      predicate function that selects adopt code blocks.
- * @property {Processor["postprocess"]} [postprocess] postprocessor for report
+ * @property {Processor.postprocess} [postprocess] postprocessor for report
  *      messages. If provided, this should accept an array of the message lists
  *      for each code block returned from the preprocessor, apply a mapping to
  *      the messages as appropriate, and return a one-dimensional array of
  *      messages.
- * @property {Processor["preprocess"]} [preprocess] preprocessor for source text.
+ * @property {Processor.preprocess} [preprocess] preprocessor for source text.
  *      If provided, this should accept a string of source text, and return an
  *      array of code blocks to lint.
  */
@@ -313,7 +315,11 @@ function getDirectiveComments(filename, ast, ruleMapper, warnInlineConfig) {
             return;
         }
         const directiveText = match[1];
-        const mustBeOnSingleLine = /^eslint-disable-(next-)?line$/u.test(directiveText);
+        const lineCommentSupported = /^eslint-disable-(next-)?line$/u.test(directiveText);
+
+        if (comment.type === "Line" && !lineCommentSupported) {
+            return;
+        }
 
         if (warnInlineConfig) {
             const kind = comment.type === "Block" ? `/*${directiveText}*/` : `//${directiveText}`;
@@ -327,7 +333,7 @@ function getDirectiveComments(filename, ast, ruleMapper, warnInlineConfig) {
             return;
         }
 
-        if (mustBeOnSingleLine && comment.loc.start.line !== comment.loc.end.line) {
+        if (lineCommentSupported && comment.loc.start.line !== comment.loc.end.line) {
             const message = `${directiveText} comment should not span multiple lines.`;
 
             problems.push(createLintingProblem({
@@ -454,10 +460,7 @@ function normalizeEcmaVersion(parser, ecmaVersion) {
     return ecmaVersion >= 2015 ? ecmaVersion - 2009 : ecmaVersion;
 }
 
-const eslintEnvPatterns = [
-    /\/\*\s*eslint-env\s(.+?)\*\//gsu, // block comments
-    /\/\/[^\S\r\n\u2028\u2029]*eslint-env[^\S\r\n\u2028\u2029](.+)/gu // line comments
-];
+const eslintEnvPattern = /\/\*\s*eslint-env\s(.+?)(?:\*\/|$)/gsu;
 
 /**
  * Checks whether or not there is a comment which has "eslint-env *" in a given text.
@@ -467,16 +470,17 @@ const eslintEnvPatterns = [
 function findEslintEnv(text) {
     let match, retv;
 
-    for (const eslintEnvPattern of eslintEnvPatterns) {
-        eslintEnvPattern.lastIndex = 0;
+    eslintEnvPattern.lastIndex = 0;
 
-        while ((match = eslintEnvPattern.exec(text)) !== null) {
+    while ((match = eslintEnvPattern.exec(text)) !== null) {
+        if (match[0].endsWith("*/")) {
             retv = Object.assign(
                 retv || {},
                 commentParser.parseListConfig(stripDirectiveComment(match[1]))
             );
         }
     }
+
     return retv;
 }
 
@@ -764,6 +768,7 @@ function markVariableAsUsed(scopeManager, currentNode, parserOptions, name) {
  * Runs a rule, and gets its listeners
  * @param {Rule} rule A normalized rule with a `create` method
  * @param {Context} ruleContext The context that should be passed to the rule
+ * @throws {any} Any error during the rule's `create`
  * @returns {Object} A map of selector listeners provided by the rule
  */
 function createRuleListeners(rule, ruleContext) {
@@ -950,13 +955,31 @@ function runRules(sourceCode, configuredRules, ruleMapper, parserOptions, parser
 
         const ruleListeners = createRuleListeners(rule, ruleContext);
 
+        /**
+         * Include `ruleId` in error logs
+         * @param {Function} ruleListener A rule method that listens for a node.
+         * @returns {Function} ruleListener wrapped in error handler
+         */
+        function addRuleErrorHandler(ruleListener) {
+            return function ruleErrorHandler(...listenerArgs) {
+                try {
+                    return ruleListener(...listenerArgs);
+                } catch (e) {
+                    e.ruleId = ruleId;
+                    throw e;
+                }
+            };
+        }
+
         // add all the selectors from the rule as listeners
         Object.keys(ruleListeners).forEach(selector => {
+            const ruleListener = timing.enabled
+                ? timing.time(ruleId, ruleListeners[selector])
+                : ruleListeners[selector];
+
             emitter.on(
                 selector,
-                timing.enabled
-                    ? timing.time(ruleId, ruleListeners[selector])
-                    : ruleListeners[selector]
+                addRuleErrorHandler(ruleListener)
             );
         });
     });
@@ -1041,7 +1064,7 @@ function normalizeCwd(cwd) {
     }
 
     // It's more explicit to assign the undefined
-    // eslint-disable-next-line no-undefined
+    // eslint-disable-next-line no-undefined -- Consistently returning a value
     return undefined;
 }
 
@@ -1064,7 +1087,7 @@ class Linter {
     /**
      * Initialize the Linter.
      * @param {Object} [config] the config object
-     * @param {string} [config.cwd]  path to a directory that should be considered as the current working directory, can be undefined.
+     * @param {string} [config.cwd] path to a directory that should be considered as the current working directory, can be undefined.
      */
     constructor({ cwd } = {}) {
         internalSlotsMap.set(this, {
@@ -1092,6 +1115,7 @@ class Linter {
      * @param {string|SourceCode} textOrSourceCode The text to parse or a SourceCode object.
      * @param {ConfigData} providedConfig An ESLintConfig instance to configure everything.
      * @param {VerifyOptions} [providedOptions] The optional filename of the file being checked.
+     * @throws {Error} If during rule execution.
      * @returns {LintMessage[]} The results as an array of messages or an empty array if no messages.
      */
     _verifyWithoutProcessors(textOrSourceCode, providedConfig, providedOptions) {
@@ -1217,6 +1241,11 @@ class Linter {
             debug("Parser Options:", parserOptions);
             debug("Parser Path:", parserName);
             debug("Settings:", settings);
+
+            if (err.ruleId) {
+                err.message += `\nRule: "${err.ruleId}"`;
+            }
+
             throw err;
         }
 

package/lib/linter/node-event-generator.js

@@ -237,7 +237,6 @@ function parseSelector(rawSelector) {
  */
 class NodeEventGenerator {
 
-    // eslint-disable-next-line jsdoc/require-description
     /**
      * @param {SafeEmitter} emitter
      * An SafeEmitter which is the destination of events. This emitter must already

package/lib/linter/report-translator.js

@@ -32,18 +32,18 @@ const interpolate = require("./interpolate");
 /**
  * Information about the report
  * @typedef {Object} ReportInfo
- * @property {string} ruleId
- * @property {(0|1|2)} severity
- * @property {(string|undefined)} message
- * @property {(string|undefined)} [messageId]
- * @property {number} line
- * @property {number} column
- * @property {(number|undefined)} [endLine]
- * @property {(number|undefined)} [endColumn]
- * @property {(string|null)} nodeType
- * @property {string} source
- * @property {({text: string, range: (number[]|null)}|null)} [fix]
- * @property {Array<{text: string, range: (number[]|null)}|null>} [suggestions]
+ * @property {string} ruleId The rule ID
+ * @property {(0|1|2)} severity Severity of the error
+ * @property {(string|undefined)} message The message
+ * @property {(string|undefined)} [messageId] The message ID
+ * @property {number} line The line number
+ * @property {number} column The column number
+ * @property {(number|undefined)} [endLine] The ending line number
+ * @property {(number|undefined)} [endColumn] The ending column number
+ * @property {(string|null)} nodeType Type of node
+ * @property {string} source Source text
+ * @property {({text: string, range: (number[]|null)}|null)} [fix] The fix object
+ * @property {Array<{text: string, range: (number[]|null)}|null>} [suggestions] Suggestion info
  */
 
 //------------------------------------------------------------------------------

package/lib/linter/rules.js

@@ -30,6 +30,9 @@ function normalizeRule(rule) {
 // Public Interface
 //------------------------------------------------------------------------------
 
+/**
+ * A storage for rules.
+ */
 class Rules {
     constructor() {
         this._rules = Object.create(null);

package/lib/linter/safe-emitter.js

@@ -12,8 +12,8 @@
 /**
  * An event emitter
  * @typedef {Object} SafeEmitter
- * @property {function(eventName: string, listenerFunc: Function): void} on Adds a listener for a given event name
- * @property {function(eventName: string, arg1?: any, arg2?: any, arg3?: any)} emit Emits an event with a given name.
+ * @property {(eventName: string, listenerFunc: Function) => void} on Adds a listener for a given event name
+ * @property {(eventName: string, arg1?: any, arg2?: any, arg3?: any) => void} emit Emits an event with a given name.
  * This calls all the listeners that were listening for that name, with `arg1`, `arg2`, and `arg3` as arguments.
  * @property {function(): string[]} eventNames Gets the list of event names that have registered listeners.
  */

package/lib/linter/source-code-fixer.js

@@ -80,8 +80,8 @@ SourceCodeFixer.applyFixes = function(sourceText, messages, shouldFix) {
 
     /**
      * Try to use the 'fix' from a problem.
-     * @param   {Message} problem The message object to apply fixes from
-     * @returns {boolean}         Whether fix was successfully applied
+     * @param {Message} problem The message object to apply fixes from
+     * @returns {boolean} Whether fix was successfully applied
      */
     function attemptFix(problem) {
         const fix = problem.fix;

package/lib/linter/timing.js

@@ -116,7 +116,7 @@ function display(data) {
         return ALIGN[index](":", width + extraAlignment, "-");
     }).join("|"));
 
-    console.log(table.join("\n")); // eslint-disable-line no-console
+    console.log(table.join("\n")); // eslint-disable-line no-console -- Debugging function
 }
 
 /* istanbul ignore next */
@@ -126,7 +126,7 @@ module.exports = (function() {
 
     /**
      * Time the run
-     * @param {*} key key from the data object
+     * @param {any} key key from the data object
      * @param {Function} fn function to be called
      * @returns {Function} function to be executed
      * @private

package/lib/rule-tester/rule-tester.js

@@ -4,7 +4,7 @@
  */
 "use strict";
 
-/* global describe, it */
+/* eslint-env mocha -- Mocha wrapper */
 
 /*
  * This is a wrapper around mocha to allow for DRY unittests for eslint
@@ -63,6 +63,7 @@ const { SourceCode } = require("../source-code");
 
 /** @typedef {import("../shared/types").Parser} Parser */
 
+/* eslint-disable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */
 /**
  * A test case that is expected to pass lint.
  * @typedef {Object} ValidTestCase
@@ -105,6 +106,7 @@ const { SourceCode } = require("../source-code");
  * @property {number} [endLine] The 1-based line number of the reported end location.
  * @property {number} [endColumn] The 1-based column number of the reported end location.
  */
+/* eslint-enable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */
 
 //------------------------------------------------------------------------------
 // Private Members
@@ -212,7 +214,7 @@ function freezeDeeply(x) {
  */
 function sanitize(text) {
     return text.replace(
-        /[\u0000-\u0009\u000b-\u001a]/gu, // eslint-disable-line no-control-regex
+        /[\u0000-\u0009\u000b-\u001a]/gu, // eslint-disable-line no-control-regex -- Escaping controls
         c => `\\u${c.codePointAt(0).toString(16).padStart(4, "0")}`
     );
 }
@@ -311,6 +313,7 @@ const IT_ONLY = Symbol("itOnly");
  * @this {Mocha}
  * @param {string} text The description of the test case.
  * @param {Function} method The logic of the test case.
+ * @throws {Error} Any error upon execution of `method`.
  * @returns {any} Returned value of `method`.
  */
 function itDefaultHandler(text, method) {
@@ -335,6 +338,9 @@ function describeDefaultHandler(text, method) {
     return method.call(this);
 }
 
+/**
+ * Mocha test wrapper.
+ */
 class RuleTester {
 
     /**
@@ -366,6 +372,7 @@ class RuleTester {
     /**
      * Set the configuration to use for all future tests
      * @param {Object} config the configuration to use.
+     * @throws {TypeError} If non-object config.
      * @returns {void}
      */
     static setDefaultConfig(config) {
@@ -481,6 +488,8 @@ class RuleTester {
      *   valid: (ValidTestCase | string)[],
      *   invalid: InvalidTestCase[]
      * }} test The collection of tests to run.
+     * @throws {TypeError|Error} If non-object `test`, or if a required
+     * scenario of the given type is missing.
      * @returns {void}
      */
     run(ruleName, rule, test) {
@@ -524,6 +533,7 @@ class RuleTester {
         /**
          * Run the rule for the given item
          * @param {string|Object} item Item to run the rule against
+         * @throws {Error} If an invalid schema.
          * @returns {Object} Eslint run result
          * @private
          */

package/lib/rules/accessor-pairs.js

@@ -140,7 +140,6 @@ module.exports = {
 
         docs: {
             description: "enforce getter and setter pairs in objects and classes",
-            category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/accessor-pairs"
         },

package/lib/rules/array-bracket-newline.js

@@ -17,7 +17,6 @@ module.exports = {
 
         docs: {
             description: "enforce linebreaks after opening and before closing array brackets",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/array-bracket-newline"
         },

package/lib/rules/array-bracket-spacing.js

@@ -16,7 +16,6 @@ module.exports = {
 
         docs: {
             description: "enforce consistent spacing inside array brackets",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/array-bracket-spacing"
         },

package/lib/rules/array-callback-return.js

@@ -139,7 +139,6 @@ module.exports = {
 
         docs: {
             description: "enforce `return` statements in callbacks of array methods",
-            category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/array-callback-return"
         },

package/lib/rules/array-element-newline.js

@@ -17,7 +17,6 @@ module.exports = {
 
         docs: {
             description: "enforce line breaks after each array element",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/array-element-newline"
         },

package/lib/rules/arrow-body-style.js

@@ -20,7 +20,6 @@ module.exports = {
 
         docs: {
             description: "require braces around arrow function bodies",
-            category: "ECMAScript 6",
             recommended: false,
             url: "https://eslint.org/docs/rules/arrow-body-style"
         },

package/lib/rules/arrow-parens.js

@@ -33,7 +33,6 @@ module.exports = {
 
         docs: {
             description: "require parentheses around arrow function arguments",
-            category: "ECMAScript 6",
             recommended: false,
             url: "https://eslint.org/docs/rules/arrow-parens"
         },

package/lib/rules/arrow-spacing.js

@@ -20,7 +20,6 @@ module.exports = {
 
         docs: {
             description: "enforce consistent spacing before and after the arrow in arrow functions",
-            category: "ECMAScript 6",
             recommended: false,
             url: "https://eslint.org/docs/rules/arrow-spacing"
         },

package/lib/rules/block-scoped-var.js

@@ -14,7 +14,6 @@ module.exports = {
 
         docs: {
             description: "enforce the use of variables within the scope they are defined",
-            category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/block-scoped-var"
         },

package/lib/rules/block-spacing.js

@@ -17,7 +17,6 @@ module.exports = {
 
         docs: {
             description: "disallow or enforce spaces inside of blocks after opening block and before closing block",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/block-spacing"
         },

package/lib/rules/brace-style.js

@@ -17,7 +17,6 @@ module.exports = {
 
         docs: {
             description: "enforce consistent brace style for blocks",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/brace-style"
         },

package/lib/rules/callback-return.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Enforce return after a callback.
  * @author Jamund Ferguson
+ * @deprecated in ESLint v7.0.0
  */
 "use strict";
 
@@ -18,7 +19,6 @@ module.exports = {
 
         docs: {
             description: "require `return` statements after callbacks",
-            category: "Node.js and CommonJS",
             recommended: false,
             url: "https://eslint.org/docs/rules/callback-return"
         },

package/lib/rules/camelcase.js

@@ -15,7 +15,6 @@ module.exports = {
 
         docs: {
             description: "enforce camelcase naming convention",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/camelcase"
         },
@@ -240,27 +239,26 @@ module.exports = {
 
             // Report camelcase of global variable references ------------------
             Program() {
-                if (ignoreGlobals) {
-                    return;
-                }
-
                 const scope = context.getScope();
 
-                // Defined globals in config files or directive comments.
-                for (const variable of scope.variables) {
-                    if (
-                        variable.identifiers.length > 0 ||
-                        isGoodName(variable.name)
-                    ) {
-                        continue;
-                    }
-                    for (const reference of variable.references) {
+                if (!ignoreGlobals) {
 
-                        /*
-                         * For backward compatibility, this rule reports read-only
-                         * references as well.
-                         */
-                        reportReferenceId(reference.identifier);
+                    // Defined globals in config files or directive comments.
+                    for (const variable of scope.variables) {
+                        if (
+                            variable.identifiers.length > 0 ||
+                            isGoodName(variable.name)
+                        ) {
+                            continue;
+                        }
+                        for (const reference of variable.references) {
+
+                            /*
+                             * For backward compatibility, this rule reports read-only
+                             * references as well.
+                             */
+                            reportReferenceId(reference.identifier);
+                        }
                     }
                 }
 

package/lib/rules/capitalized-comments.js

@@ -105,7 +105,6 @@ module.exports = {
 
         docs: {
             description: "enforce or disallow capitalization of the first letter of a comment",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/capitalized-comments"
         },

package/lib/rules/class-methods-use-this.js

@@ -21,7 +21,6 @@ module.exports = {
 
         docs: {
             description: "enforce that class methods utilize `this`",
-            category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/class-methods-use-this"
         },
@@ -34,6 +33,10 @@ module.exports = {
                     items: {
                         type: "string"
                     }
+                },
+                enforceForClassFields: {
+                    type: "boolean",
+                    default: true
                 }
             },
             additionalProperties: false
@@ -45,10 +48,27 @@ module.exports = {
     },
     create(context) {
         const config = Object.assign({}, context.options[0]);
+        const enforceForClassFields = config.enforceForClassFields !== false;
         const exceptMethods = new Set(config.exceptMethods || []);
 
         const stack = [];
 
+        /**
+         * Push `this` used flag initialized with `false` onto the stack.
+         * @returns {void}
+         */
+        function pushContext() {
+            stack.push(false);
+        }
+
+        /**
+         * Pop `this` used flag from the stack.
+         * @returns {boolean | undefined} `this` used flag
+         */
+        function popContext() {
+            return stack.pop();
+        }
+
         /**
          * Initializes the current context to false and pushes it onto the stack.
          * These booleans represent whether 'this' has been used in the context.
@@ -56,7 +76,7 @@ module.exports = {
          * @private
          */
         function enterFunction() {
-            stack.push(false);
+            pushContext();
         }
 
         /**
@@ -70,7 +90,7 @@ module.exports = {
                 case "MethodDefinition":
                     return !node.static && node.kind !== "constructor";
                 case "PropertyDefinition":
-                    return !node.static;
+                    return !node.static && enforceForClassFields;
                 default:
                     return false;
             }
@@ -83,8 +103,19 @@ module.exports = {
          * @private
          */
         function isIncludedInstanceMethod(node) {
-            return isInstanceMethod(node) &&
-                (node.computed || !exceptMethods.has(node.key.name));
+            if (isInstanceMethod(node)) {
+                if (node.computed) {
+                    return true;
+                }
+
+                const hashIfNeeded = node.key.type === "PrivateIdentifier" ? "#" : "";
+                const name = node.key.type === "Literal"
+                    ? astUtils.getStaticStringValue(node.key)
+                    : (node.key.name || "");
+
+                return !exceptMethods.has(hashIfNeeded + name);
+            }
+            return false;
         }
 
         /**
@@ -96,7 +127,7 @@ module.exports = {
          * @private
          */
         function exitFunction(node) {
-            const methodUsesThis = stack.pop();
+            const methodUsesThis = popContext();
 
             if (isIncludedInstanceMethod(node.parent) && !methodUsesThis) {
                 context.report({
@@ -126,10 +157,21 @@ module.exports = {
             "FunctionDeclaration:exit": exitFunction,
             FunctionExpression: enterFunction,
             "FunctionExpression:exit": exitFunction,
-            "PropertyDefinition > ArrowFunctionExpression.value": enterFunction,
-            "PropertyDefinition > ArrowFunctionExpression.value:exit": exitFunction,
+
+            /*
+             * Class field value are implicit functions.
+             */
+            "PropertyDefinition:exit": popContext,
+            "PropertyDefinition > *.key:exit": pushContext,
+
             ThisExpression: markThisUsed,
-            Super: markThisUsed
+            Super: markThisUsed,
+            ...(
+                enforceForClassFields && {
+                    "PropertyDefinition > ArrowFunctionExpression.value": enterFunction,
+                    "PropertyDefinition > ArrowFunctionExpression.value:exit": exitFunction
+                }
+            )
         };
     }
 };

package/lib/rules/comma-dangle.js

@@ -76,7 +76,6 @@ module.exports = {
 
         docs: {
             description: "require or disallow trailing commas",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/comma-dangle"
         },