eslint 5.8.0 → 5.9.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+v5.9.0 - November 9, 2018
+
+* 9436712 Fix: Unused recursive function expressions (fixes #10982) (#11032) (Sergei Startsev)
+* c832cd5 Update: add `ignoreDestructuring` option to `id-match` rule (#10554) (一名宅。)
+* 54687a8 Fix: prefer-const autofix multiline assignment (fixes #10582) (#10987) (Scott Stern)
+* ae2b61d Update: "off" options for "space-before-blocks" (refs #10906) (#10907) (Sophie Kirschner)
+* 57f357e Docs: Update require-await docs with exception (fixes #9540) (#11063) (Nicholas C. Zakas)
+* 79a2797 Update: no-restricted-imports to check re-export (fixes #9678) (#11064) (Nicholas C. Zakas)
+* 3dd7493 Docs: update ecmaVersion to include 2019/10 values (#11059) (Vse Mozhet Byt)
+* 607635d Upgrade: eslint-plugin-node & eslint-plugin (#11067) (薛定谔的猫)
+* dcc6233 Fix: Ignore empty statements in no-unreachable (fixes #9081) (#11058) (Nicholas C. Zakas)
+* 7ad86de New: Add --fix-type option to CLI (fixes #10855) (#10912) (Nicholas C. Zakas)
+* 0800b20 Chore: fix invalid super() calls in tests (#11054) (Teddy Katz)
+* 4fe3287 Docs: Cross-reference two rules (refs #11041) (#11042) (Paul Melnikow)
+* 5525eb6 Fix: rule deprecation warnings did not consider all rules (#11044) (Teddy Katz)
+* 44d37ca Docs: Update steps for adding new TSC member (#11038) (Nicholas C. Zakas)
+* 802e926 Update: Warn for deprecation in Node output (fixes #7443) (#10953) (Colin Chang)
+
 v5.8.0 - October 26, 2018
 
 * 9152417 Fix: deprecation warning in RuleTester using Node v11 (#11009) (Teddy Katz)

package/lib/cli-engine.js

@@ -19,8 +19,10 @@ const fs = require("fs"),
     path = require("path"),
     defaultOptions = require("../conf/default-cli-options"),
     Linter = require("./linter"),
+    lodash = require("lodash"),
     IgnoredPaths = require("./ignored-paths"),
     Config = require("./config"),
+    ConfigOps = require("./config/config-ops"),
     LintResultCache = require("./util/lint-result-cache"),
     globUtils = require("./util/glob-utils"),
     validator = require("./config/config-validator"),
@@ -31,6 +33,7 @@ const fs = require("fs"),
 
 const debug = require("debug")("eslint:cli-engine");
 const resolver = new ModuleResolver();
+const validFixTypes = new Set(["problem", "suggestion", "layout"]);
 
 //------------------------------------------------------------------------------
 // Typedefs
@@ -48,6 +51,7 @@ const resolver = new ModuleResolver();
  * @property {string[]} envs An array of environments to load.
  * @property {string[]} extensions An array of file extensions to check.
  * @property {boolean|Function} fix Execute in autofix mode. If a function, should return a boolean.
+ * @property {string[]} fixTypes Array of rule types to apply fixes for.
  * @property {string[]} globals An array of global variables to declare.
  * @property {boolean} ignore False disables use of .eslintignore.
  * @property {string} ignorePath The ignore file to use instead of .eslintignore.
@@ -84,6 +88,21 @@ const resolver = new ModuleResolver();
 // Helpers
 //------------------------------------------------------------------------------
 
+/**
+ * Determines if each fix type in an array is supported by ESLint and throws
+ * an error if not.
+ * @param {string[]} fixTypes An array of fix types to check.
+ * @returns {void}
+ * @throws {Error} If an invalid fix type is found.
+ */
+function validateFixTypes(fixTypes) {
+    for (const fixType of fixTypes) {
+        if (!validFixTypes.has(fixType)) {
+            throw new Error(`Invalid fix type "${fixType}" found.`);
+        }
+    }
+}
+
 /**
  * It will calculate the error and warning count for collection of messages per file
  * @param {Object[]} messages - Collection of messages
@@ -142,7 +161,7 @@ function calculateStatsPerRun(results) {
  * @param {boolean} allowInlineConfig Allow/ignore comments that change config.
  * @param {boolean} reportUnusedDisableDirectives Allow/ignore comments that change config.
  * @param {Linter} linter Linter context
- * @returns {LintResult} The results for linting on this text.
+ * @returns {{rules: LintResult, config: Object}} The results for linting on this text and the fully-resolved config for it.
  * @private
  */
 function processText(text, configHelper, filename, fix, allowInlineConfig, reportUnusedDisableDirectives, linter) {
@@ -174,7 +193,6 @@ function processText(text, configHelper, filename, fix, allowInlineConfig, repor
     }
 
     const autofixingEnabled = typeof fix !== "undefined" && (!processor || processor.supportsAutofix);
-
     const fixedResult = linter.verifyAndFix(text, config, {
         filename: effectiveFilename,
         allowInlineConfig,
@@ -183,7 +201,6 @@ function processText(text, configHelper, filename, fix, allowInlineConfig, repor
         preprocess: processor && (rawText => processor.preprocess(rawText, effectiveFilename)),
         postprocess: processor && (problemLists => processor.postprocess(problemLists, effectiveFilename))
     });
-
     const stats = calculateStatsPerFile(fixedResult.messages);
 
     const result = {
@@ -203,7 +220,7 @@ function processText(text, configHelper, filename, fix, allowInlineConfig, repor
         result.source = text;
     }
 
-    return result;
+    return { result, config };
 }
 
 /**
@@ -213,24 +230,22 @@ function processText(text, configHelper, filename, fix, allowInlineConfig, repor
  * @param {Object} configHelper The configuration options for ESLint.
  * @param {Object} options The CLIEngine options object.
  * @param {Linter} linter Linter context
- * @returns {LintResult} The results for linting on this file.
+ * @returns {{rules: LintResult, config: Object}} The results for linting on this text and the fully-resolved config for it.
  * @private
  */
 function processFile(filename, configHelper, options, linter) {
 
-    const text = fs.readFileSync(path.resolve(filename), "utf8"),
-        result = processText(
-            text,
-            configHelper,
-            filename,
-            options.fix,
-            options.allowInlineConfig,
-            options.reportUnusedDisableDirectives,
-            linter
-        );
-
-    return result;
-
+    const text = fs.readFileSync(path.resolve(filename), "utf8");
+
+    return processText(
+        text,
+        configHelper,
+        filename,
+        options.fix,
+        options.allowInlineConfig,
+        options.reportUnusedDisableDirectives,
+        linter
+    );
 }
 
 /**
@@ -272,6 +287,33 @@ function createIgnoreResult(filePath, baseDir) {
     };
 }
 
+/**
+ * Produces rule warnings (i.e. deprecation) from configured rules
+ * @param {(Array<string>|Set<string>)} usedRules - Rules configured
+ * @param {Map} loadedRules - Map of loaded rules
+ * @returns {Array<Object>} Contains rule warnings
+ * @private
+ */
+function createRuleDeprecationWarnings(usedRules, loadedRules) {
+    const usedDeprecatedRules = [];
+
+    usedRules.forEach(name => {
+        const loadedRule = loadedRules.get(name);
+
+        if (loadedRule && loadedRule.meta && loadedRule.meta.deprecated) {
+            const deprecatedRule = { ruleId: name };
+            const replacedBy = lodash.get(loadedRule, "meta.replacedBy", []);
+
+            if (replacedBy.every(newRule => lodash.isString(newRule))) {
+                deprecatedRule.replacedBy = replacedBy;
+            }
+
+            usedDeprecatedRules.push(deprecatedRule);
+        }
+    });
+
+    return usedDeprecatedRules;
+}
 
 /**
  * Checks if the given message is an error message.
@@ -429,6 +471,33 @@ class CLIEngine {
              */
             this._lintResultCache = new LintResultCache(cacheFile, this.config);
         }
+
+        // setup special filter for fixes
+        if (this.options.fix && this.options.fixTypes && this.options.fixTypes.length > 0) {
+
+            debug(`Using fix types ${this.options.fixTypes}`);
+
+            // throw an error if any invalid fix types are found
+            validateFixTypes(this.options.fixTypes);
+
+            // convert to Set for faster lookup
+            const fixTypes = new Set(this.options.fixTypes);
+
+            // save original value of options.fix in case it's a function
+            const originalFix = (typeof this.options.fix === "function")
+                ? this.options.fix : () => this.options.fix;
+
+            // create a cache of rules (but don't populate until needed)
+            this._rulesCache = null;
+
+            this.options.fix = lintResult => {
+                const rule = this._rulesCache.get(lintResult.ruleId);
+                const matches = rule.meta && fixTypes.has(rule.meta.type);
+
+                return matches && originalFix(lintResult);
+            };
+        }
+
     }
 
     getRules() {
@@ -511,6 +580,7 @@ class CLIEngine {
 
         const startTime = Date.now();
         const fileList = globUtils.listFilesToProcess(patterns, options);
+        const allUsedRules = new Set();
         const results = fileList.map(fileInfo => {
             if (fileInfo.ignored) {
                 return createIgnoreResult(fileInfo.filename, options.cwd);
@@ -532,9 +602,20 @@ class CLIEngine {
                 }
             }
 
+            // if there's a cache, populate it
+            if ("_rulesCache" in this) {
+                this._rulesCache = this.getRules();
+            }
+
             debug(`Processing ${fileInfo.filename}`);
 
-            return processFile(fileInfo.filename, configHelper, options, this.linter);
+            const { result, config } = processFile(fileInfo.filename, configHelper, options, this.linter);
+
+            Object.keys(config.rules)
+                .filter(ruleId => ConfigOps.getRuleSeverity(config.rules[ruleId]))
+                .forEach(ruleId => allUsedRules.add(ruleId));
+
+            return result;
         });
 
         if (options.cache) {
@@ -555,6 +636,8 @@ class CLIEngine {
 
         const stats = calculateStatsPerRun(results);
 
+        const usedDeprecatedRules = createRuleDeprecationWarnings(allUsedRules, this.getRules());
+
         debug(`Linting complete in: ${Date.now() - startTime}ms`);
 
         return {
@@ -562,7 +645,8 @@ class CLIEngine {
             errorCount: stats.errorCount,
             warningCount: stats.warningCount,
             fixableErrorCount: stats.fixableErrorCount,
-            fixableWarningCount: stats.fixableWarningCount
+            fixableWarningCount: stats.fixableWarningCount,
+            usedDeprecatedRules
         };
     }
 
@@ -585,22 +669,34 @@ class CLIEngine {
         const resolvedFilename = filename && !path.isAbsolute(filename)
             ? path.resolve(options.cwd, filename)
             : filename;
+        let usedDeprecatedRules;
 
         if (resolvedFilename && ignoredPaths.contains(resolvedFilename)) {
             if (warnIgnored) {
                 results.push(createIgnoreResult(resolvedFilename, options.cwd));
             }
+            usedDeprecatedRules = [];
         } else {
-            results.push(
-                processText(
-                    text,
-                    configHelper,
-                    resolvedFilename,
-                    options.fix,
-                    options.allowInlineConfig,
-                    options.reportUnusedDisableDirectives,
-                    this.linter
-                )
+
+            // if there's a cache, populate it
+            if ("_rulesCache" in this) {
+                this._rulesCache = this.getRules();
+            }
+
+            const { result, config } = processText(
+                text,
+                configHelper,
+                resolvedFilename,
+                options.fix,
+                options.allowInlineConfig,
+                options.reportUnusedDisableDirectives,
+                this.linter
+            );
+
+            results.push(result);
+            usedDeprecatedRules = createRuleDeprecationWarnings(
+                Object.keys(config.rules).filter(rule => ConfigOps.getRuleSeverity(config.rules[rule])),
+                this.getRules()
             );
         }
 
@@ -611,7 +707,8 @@ class CLIEngine {
             errorCount: stats.errorCount,
             warningCount: stats.warningCount,
             fixableErrorCount: stats.fixableErrorCount,
-            fixableWarningCount: stats.fixableWarningCount
+            fixableWarningCount: stats.fixableWarningCount,
+            usedDeprecatedRules
         };
     }
 

package/lib/cli.js

@@ -64,6 +64,7 @@ function translateOptions(cliOptions) {
         cacheFile: cliOptions.cacheFile,
         cacheLocation: cliOptions.cacheLocation,
         fix: (cliOptions.fix || cliOptions.fixDryRun) && (cliOptions.quiet ? quietFixPredicate : true),
+        fixTypes: cliOptions.fixType,
         allowInlineConfig: cliOptions.inlineConfig,
         reportUnusedDisableDirectives: cliOptions.reportUnusedDisableDirectives
     };
@@ -187,8 +188,12 @@ const cli = {
                 return 2;
             }
 
-            const engine = new CLIEngine(translateOptions(currentOptions));
+            if (currentOptions.fixType && !currentOptions.fix && !currentOptions.fixDryRun) {
+                log.error("The --fix-type option requires either --fix or --fix-dry-run.");
+                return 2;
+            }
 
+            const engine = new CLIEngine(translateOptions(currentOptions));
             const report = useStdin ? engine.executeOnText(text, currentOptions.stdinFilename, true) : engine.executeOnFiles(files);
 
             if (currentOptions.fix) {

package/lib/options.js

@@ -97,6 +97,11 @@ module.exports = optionator({
             default: false,
             description: "Automatically fix problems without saving the changes to the file system"
         },
+        {
+            option: "fix-type",
+            type: "Array",
+            description: "Specify the types of fixes to apply (problem, suggestion, layout)"
+        },
         {
             heading: "Ignoring files"
         },

package/lib/rules/accessor-pairs.js

@@ -72,12 +72,15 @@ function isPropertyDescriptor(node) {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce getter and setter pairs in objects",
             category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/accessor-pairs"
         },
+
         schema: [{
             type: "object",
             properties: {
@@ -90,6 +93,7 @@ module.exports = {
             },
             additionalProperties: false
         }],
+
         messages: {
             getter: "Getter is not present.",
             setter: "Setter is not present."

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

@@ -13,13 +13,17 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         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"
         },
+
         fixable: "whitespace",
+
         schema: [
             {
                 oneOf: [
@@ -42,6 +46,7 @@ module.exports = {
                 ]
             }
         ],
+
         messages: {
             unexpectedOpeningLinebreak: "There should be no linebreak after '['.",
             unexpectedClosingLinebreak: "There should be no linebreak before ']'.",

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

@@ -12,13 +12,17 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing inside array brackets",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/array-bracket-spacing"
         },
+
         fixable: "whitespace",
+
         schema: [
             {
                 enum: ["always", "never"]
@@ -39,6 +43,7 @@ module.exports = {
                 additionalProperties: false
             }
         ],
+
         messages: {
             unexpectedSpaceAfter: "There should be no space after '{{tokenValue}}'.",
             unexpectedSpaceBefore: "There should be no space before '{{tokenValue}}'.",

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

@@ -141,6 +141,8 @@ function isCallbackOfArrayMethod(node) {
 
 module.exports = {
     meta: {
+        type: "problem",
+
         docs: {
             description: "enforce `return` statements in callbacks of array methods",
             category: "Best Practices",

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

@@ -13,13 +13,17 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce line breaks after each array element",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/array-element-newline"
         },
+
         fixable: "whitespace",
+
         schema: [
             {
                 oneOf: [

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

@@ -16,6 +16,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require braces around arrow function bodies",
             category: "ECMAScript 6",

package/lib/rules/arrow-parens.js

@@ -16,6 +16,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require parentheses around arrow function arguments",
             category: "ECMAScript 6",

package/lib/rules/arrow-spacing.js

@@ -16,6 +16,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing before and after the arrow in arrow functions",
             category: "ECMAScript 6",

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

@@ -10,6 +10,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce the use of variables within the scope they are defined",
             category: "Best Practices",

package/lib/rules/block-spacing.js

@@ -13,6 +13,8 @@ const util = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "disallow or enforce spaces inside of blocks after opening block and before closing block",
             category: "Stylistic Issues",

package/lib/rules/brace-style.js

@@ -13,6 +13,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent brace style for blocks",
             category: "Stylistic Issues",

package/lib/rules/callback-return.js

@@ -10,6 +10,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require `return` statements after callbacks",
             category: "Node.js and CommonJS",

package/lib/rules/camelcase.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce camelcase naming convention",
             category: "Stylistic Issues",

package/lib/rules/capitalized-comments.js

@@ -108,13 +108,17 @@ function createRegExpForIgnorePatterns(normalizedOptions) {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         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"
         },
+
         fixable: "code",
+
         schema: [
             { enum: ["always", "never"] },
             {

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

@@ -11,12 +11,15 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce that class methods utilize `this`",
             category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/class-methods-use-this"
         },
+
         schema: [{
             type: "object",
             properties: {

package/lib/rules/comma-dangle.js

@@ -76,13 +76,17 @@ function normalizeOptions(optionValue) {
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require or disallow trailing commas",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/comma-dangle"
         },
+
         fixable: "code",
+
         schema: {
             definitions: {
                 value: {

package/lib/rules/comma-spacing.js

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

package/lib/rules/comma-style.js

@@ -13,13 +13,17 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent comma style",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/comma-style"
         },
+
         fixable: "code",
+
         schema: [
             {
                 enum: ["first", "last"]
@@ -37,6 +41,7 @@ module.exports = {
                 additionalProperties: false
             }
         ],
+
         messages: {
             unexpectedLineBeforeAndAfterComma: "Bad line breaking before and after ','.",
             expectedCommaFirst: "',' should be placed first.",

package/lib/rules/complexity.js

@@ -20,6 +20,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce a maximum cyclomatic complexity allowed in a program",
             category: "Best Practices",

package/lib/rules/computed-property-spacing.js

@@ -12,6 +12,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing inside computed property brackets",
             category: "Stylistic Issues",

package/lib/rules/consistent-return.js

@@ -53,6 +53,8 @@ function isClassConstructor(node) {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require `return` statements to either always or never specify values",
             category: "Best Practices",

package/lib/rules/consistent-this.js

@@ -10,6 +10,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce consistent naming when capturing the current execution context",
             category: "Stylistic Issues",

package/lib/rules/constructor-super.js

@@ -92,6 +92,8 @@ function isPossibleConstructor(node) {
 
 module.exports = {
     meta: {
+        type: "problem",
+
         docs: {
             description: "require `super()` calls in constructors",
             category: "ECMAScript 6",