eslint 4.14.0 → 4.15.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+v4.15.0 - January 6, 2018
+
+* 6ab04b5 New: Add context.report({ messageId }) (fixes #6740) (#9165) (Jed Fox)
+* fc7f404 Docs: add url to each of the rules (refs #6582) (#9788) (Patrick McElhaney)
+* fc44da9 Docs: fix sort-imports rule block language (#9805) (ferhat elmas)
+* 65f0176 New: CLIEngine#getRules() (refs #6582) (#9782) (Patrick McElhaney)
+* c64195f Update: More detailed assert message for rule-tester (#9769) (Weijia Wang)
+* 9fcfabf Fix: no-extra-parens false positive (fixes: #9755) (#9795) (Erin)
+* 61e5fa0 Docs: Add table of contents to Node.js API docs (#9785) (Patrick McElhaney)
+* 4c87f42 Fix: incorrect error messages of no-unused-vars (fixes #9774) (#9791) (akouryy)
+* bbabf34 Update: add `ignoreComments` option to `indent` rule (fixes #9018) (#9752) (Kevin Partington)
+* db431cb Docs: HTTP -> HTTPS (fixes #9768) (#9768) (Ronald Eddy Jr)
+* cbf0fb9 Docs: describe how to feature-detect scopeManager/visitorKeys support (#9764) (Teddy Katz)
+* f7dcb70 Docs: Add note about "patch release pending" label to maintainer guide (#9763) (Teddy Katz)
+
 v4.14.0 - December 23, 2017
 
 * be2f57e Update: support separate requires in one-var. (fixes #6175) (#9441) (薛定谔的猫)

package/README.md

@@ -156,7 +156,7 @@ Before filing an issue, please be sure to read the guidelines for what you're re
 
 ## Semantic Versioning Policy
 
-ESLint follows [semantic versioning](http://semver.org). However, due to the nature of ESLint as a code quality tool, it's not always clear when a minor or major version bump occurs. To help clarify this for everyone, we've defined the following semantic versioning policy for ESLint:
+ESLint follows [semantic versioning](https://semver.org). However, due to the nature of ESLint as a code quality tool, it's not always clear when a minor or major version bump occurs. To help clarify this for everyone, we've defined the following semantic versioning policy for ESLint:
 
 * Patch release (intended to not break your lint build)
     * A bug fix in a rule that results in ESLint reporting fewer errors.

package/lib/cli-engine.js

@@ -420,6 +420,10 @@ class CLIEngine {
         this.config = new Config(this.options, this.linter);
     }
 
+    getRules() {
+        return this.linter.getRules();
+    }
+
     /**
      * Returns results that only contains errors.
      * @param {LintResult[]} results The results to filter.

package/lib/linter.js

@@ -911,6 +911,7 @@ module.exports = class Linter {
             }
 
             const rule = this.rules.get(ruleId);
+            const messageIds = rule && rule.meta && rule.meta.messages;
             let reportTranslator = null;
             const ruleContext = Object.freeze(
                 Object.assign(
@@ -931,7 +932,7 @@ module.exports = class Linter {
                              * with Node 8.4.0.
                              */
                             if (reportTranslator === null) {
-                                reportTranslator = createReportTranslator({ ruleId, severity, sourceCode });
+                                reportTranslator = createReportTranslator({ ruleId, severity, sourceCode, messageIds });
                             }
                             const problem = reportTranslator.apply(null, arguments);
 

package/lib/report-translator.js

@@ -11,6 +11,7 @@
 
 const assert = require("assert");
 const ruleFixer = require("./util/rule-fixer");
+const interpolate = require("./util/interpolate");
 
 //------------------------------------------------------------------------------
 // Typedefs
@@ -41,7 +42,9 @@ function normalizeMultiArgReportCall() {
 
     // If there is one argument, it is considered to be a new-style call already.
     if (arguments.length === 1) {
-        return arguments[0];
+
+        // Shallow clone the object to avoid surprises if reusing the descriptor
+        return Object.assign({}, arguments[0]);
     }
 
     // If the second argument is a string, the arguments are interpreted as [node, message, data, fix].
@@ -100,16 +103,7 @@ function normalizeReportLoc(descriptor) {
  * @returns {string} The interpolated message for the descriptor
  */
 function normalizeMessagePlaceholders(descriptor) {
-    if (!descriptor.data) {
-        return descriptor.message;
-    }
-    return descriptor.message.replace(/\{\{\s*([^{}]+?)\s*\}\}/g, (fullMatch, term) => {
-        if (term in descriptor.data) {
-            return descriptor.data[term];
-        }
-
-        return fullMatch;
-    });
+    return interpolate(descriptor.message, descriptor.data);
 }
 
 /**
@@ -216,6 +210,14 @@ function createProblem(options) {
         source: options.sourceLines[options.loc.start.line - 1] || ""
     };
 
+    /*
+     * If this isn’t in the conditional, some of the tests fail
+     * because `messageId` is present in the problem object
+     */
+    if (options.messageId) {
+        problem.messageId = options.messageId;
+    }
+
     if (options.loc.end) {
         problem.endLine = options.loc.end.line;
         problem.endColumn = options.loc.end.column + 1;
@@ -231,12 +233,13 @@ function createProblem(options) {
 /**
  * Returns a function that converts the arguments of a `context.report` call from a rule into a reported
  * problem for the Node.js API.
- * @param {{ruleId: string, severity: number, sourceCode: SourceCode}} metadata Metadata for the reported problem
+ * @param {{ruleId: string, severity: number, sourceCode: SourceCode, messageIds: Object}} metadata Metadata for the reported problem
  * @param {SourceCode} sourceCode The `SourceCode` instance for the text being linted
  * @returns {function(...args): {
  *      ruleId: string,
  *      severity: (0|1|2),
- *      message: string,
+ *      message: (string|undefined),
+ *      messageId: (string|undefined),
  *      line: number,
  *      column: number,
  *      endLine: (number|undefined),
@@ -261,11 +264,29 @@ module.exports = function createReportTranslator(metadata) {
 
         assertValidNodeInfo(descriptor);
 
+        if (descriptor.messageId) {
+            if (!metadata.messageIds) {
+                throw new TypeError("context.report() called with a messageId, but no messages were present in the rule metadata.");
+            }
+            const id = descriptor.messageId;
+            const messages = metadata.messageIds;
+
+            if (descriptor.message) {
+                throw new TypeError("context.report() called with a message and a messageId. Please only pass one.");
+            }
+            if (!messages || !Object.prototype.hasOwnProperty.call(messages, id)) {
+                throw new TypeError(`context.report() called with a messageId of '${id}' which is not present in the 'messages' config: ${JSON.stringify(messages, null, 2)}`);
+            }
+            descriptor.message = messages[id];
+        }
+
+
         return createProblem({
             ruleId: metadata.ruleId,
             severity: metadata.severity,
             node: descriptor.node,
             message: normalizeMessagePlaceholders(descriptor),
+            messageId: descriptor.messageId,
             loc: normalizeReportLoc(descriptor),
             fix: normalizeFixes(descriptor, metadata.sourceCode),
             sourceLines: metadata.sourceCode.lines

package/lib/rules/.eslintrc.yml

@@ -1,3 +1,4 @@
 rules:
     rulesdir/no-invalid-meta: "error"
     rulesdir/consistent-docs-description: "error"
+    rulesdir/consistent-docs-url: "error"

package/lib/rules/accessor-pairs.js

@@ -75,7 +75,8 @@ module.exports = {
         docs: {
             description: "enforce getter and setter pairs in objects",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/accessor-pairs"
         },
         schema: [{
             type: "object",

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

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

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

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

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

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

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

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

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

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

package/lib/rules/arrow-parens.js

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

package/lib/rules/arrow-spacing.js

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

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

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

package/lib/rules/block-spacing.js

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

package/lib/rules/brace-style.js

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

package/lib/rules/callback-return.js

@@ -13,7 +13,8 @@ module.exports = {
         docs: {
             description: "require `return` statements after callbacks",
             category: "Node.js and CommonJS",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/callback-return"
         },
 
         schema: [{

package/lib/rules/camelcase.js

@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "enforce camelcase naming convention",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/camelcase"
         },
 
         schema: [

package/lib/rules/capitalized-comments.js

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

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

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

package/lib/rules/comma-dangle.js

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

package/lib/rules/comma-spacing.js

@@ -15,7 +15,8 @@ module.exports = {
         docs: {
             description: "enforce consistent spacing before and after commas",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/comma-spacing"
         },
 
         fixable: "whitespace",

package/lib/rules/comma-style.js

@@ -16,7 +16,8 @@ module.exports = {
         docs: {
             description: "enforce consistent comma style",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/comma-style"
         },
         fixable: "code",
         schema: [

package/lib/rules/complexity.js

@@ -23,7 +23,8 @@ module.exports = {
         docs: {
             description: "enforce a maximum cyclomatic complexity allowed in a program",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/complexity"
         },
 
         schema: [

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

@@ -15,7 +15,8 @@ module.exports = {
         docs: {
             description: "enforce consistent spacing inside computed property brackets",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/computed-property-spacing"
         },
 
         fixable: "whitespace",

package/lib/rules/consistent-return.js

@@ -56,7 +56,8 @@ module.exports = {
         docs: {
             description: "require `return` statements to either always or never specify values",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/consistent-return"
         },
 
         schema: [{

package/lib/rules/consistent-this.js

@@ -13,7 +13,8 @@ module.exports = {
         docs: {
             description: "enforce consistent naming when capturing the current execution context",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/consistent-this"
         },
 
         schema: {

package/lib/rules/constructor-super.js

@@ -95,7 +95,8 @@ module.exports = {
         docs: {
             description: "require `super()` calls in constructors",
             category: "ECMAScript 6",
-            recommended: true
+            recommended: true,
+            url: "https://eslint.org/docs/rules/constructor-super"
         },
 
         schema: []

package/lib/rules/curly.js

@@ -19,7 +19,8 @@ module.exports = {
         docs: {
             description: "enforce consistent brace style for all control statements",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/curly"
         },
 
         schema: {

package/lib/rules/default-case.js

@@ -15,7 +15,8 @@ module.exports = {
         docs: {
             description: "require `default` cases in `switch` statements",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/default-case"
         },
 
         schema: [{

package/lib/rules/dot-location.js

@@ -16,7 +16,8 @@ module.exports = {
         docs: {
             description: "enforce consistent newlines before and after dots",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/dot-location"
         },
 
         schema: [

package/lib/rules/dot-notation.js

@@ -22,7 +22,8 @@ module.exports = {
         docs: {
             description: "enforce dot notation whenever possible",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/dot-notation"
         },
 
         schema: [

package/lib/rules/eol-last.js

@@ -19,7 +19,8 @@ module.exports = {
         docs: {
             description: "require or disallow newline at the end of files",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/eol-last"
         },
         fixable: "whitespace",
         schema: [

package/lib/rules/eqeqeq.js

@@ -20,7 +20,8 @@ module.exports = {
         docs: {
             description: "require the use of `===` and `!==`",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/eqeqeq"
         },
 
         schema: {

package/lib/rules/for-direction.js

@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "enforce \"for\" loop update clause moving the counter in the right direction.",
             category: "Possible Errors",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/for-direction"
         },
         fixable: null,
         schema: []

package/lib/rules/func-call-spacing.js

@@ -20,7 +20,8 @@ module.exports = {
         docs: {
             description: "require or disallow spacing between function identifiers and their invocations",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/func-call-spacing"
         },
 
         fixable: "whitespace",

package/lib/rules/func-name-matching.js

@@ -70,7 +70,8 @@ module.exports = {
         docs: {
             description: "require function names to match the name of the variable or property to which they are assigned",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/func-name-matching"
         },
 
         schema: {

package/lib/rules/func-names.js

@@ -29,7 +29,8 @@ module.exports = {
         docs: {
             description: "require or disallow named `function` expressions",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/func-names"
         },
 
         schema: [

package/lib/rules/func-style.js

@@ -13,7 +13,8 @@ module.exports = {
         docs: {
             description: "enforce the consistent use of either `function` declarations or expressions",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/func-style"
         },
 
         schema: [

package/lib/rules/function-paren-newline.js

@@ -19,7 +19,8 @@ module.exports = {
         docs: {
             description: "enforce consistent line breaks inside function parentheses",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/function-paren-newline"
         },
         fixable: "whitespace",
         schema: [

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

@@ -30,7 +30,8 @@ module.exports = {
         docs: {
             description: "enforce consistent spacing around `*` operators in generator functions",
             category: "ECMAScript 6",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/generator-star-spacing"
         },
 
         fixable: "whitespace",

package/lib/rules/getter-return.js

@@ -47,7 +47,8 @@ module.exports = {
         docs: {
             description: "enforce `return` statements in getters",
             category: "Possible Errors",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/getter-return"
         },
         fixable: null,
         schema: [

package/lib/rules/global-require.js

@@ -51,7 +51,8 @@ module.exports = {
         docs: {
             description: "require `require()` calls to be placed at top-level module scope",
             category: "Node.js and CommonJS",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/global-require"
         },
 
         schema: []

package/lib/rules/guard-for-in.js

@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "require `for-in` loops to include an `if` statement",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/guard-for-in"
         },
 
         schema: []

package/lib/rules/handle-callback-err.js

@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "require error handling in callbacks",
             category: "Node.js and CommonJS",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/handle-callback-err"
         },
 
         schema: [

package/lib/rules/id-blacklist.js

@@ -15,7 +15,8 @@ module.exports = {
         docs: {
             description: "disallow specified identifiers",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/id-blacklist"
         },
 
         schema: {

package/lib/rules/id-length.js

@@ -15,7 +15,8 @@ module.exports = {
         docs: {
             description: "enforce minimum and maximum identifier lengths",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/id-length"
         },
 
         schema: [

package/lib/rules/id-match.js

@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "require identifiers to match a specified regular expression",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/id-match"
         },
 
         schema: [