eslint 4.12.1 → 4.15.0

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

@@ -27,7 +27,8 @@ module.exports = {
         docs: {
             description: "require or disallow spacing around embedded expressions of template strings",
             category: "ECMAScript 6",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/template-curly-spacing"
         },
 
         fixable: "whitespace",

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

@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "require or disallow spacing between template tags and their literals",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/template-tag-spacing"
         },
 
         fixable: "whitespace",

package/lib/rules/unicode-bom.js

@@ -13,7 +13,8 @@ module.exports = {
         docs: {
             description: "require or disallow Unicode byte order mark (BOM)",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/unicode-bom"
         },
 
         fixable: "whitespace",

package/lib/rules/use-isnan.js

@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "require calls to `isNaN()` when checking for `NaN`",
             category: "Possible Errors",
-            recommended: true
+            recommended: true,
+            url: "https://eslint.org/docs/rules/use-isnan"
         },
 
         schema: []

package/lib/rules/valid-jsdoc.js

@@ -19,7 +19,8 @@ module.exports = {
         docs: {
             description: "enforce valid JSDoc comments",
             category: "Possible Errors",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/valid-jsdoc"
         },
 
         schema: [

package/lib/rules/valid-typeof.js

@@ -13,7 +13,8 @@ module.exports = {
         docs: {
             description: "enforce comparing `typeof` expressions against valid strings",
             category: "Possible Errors",
-            recommended: true
+            recommended: true,
+            url: "https://eslint.org/docs/rules/valid-typeof"
         },
 
         schema: [

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

@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "require `var` declarations be placed at the top of their containing scope",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/vars-on-top"
         },
 
         schema: []

package/lib/rules/wrap-iife.js

@@ -20,7 +20,8 @@ module.exports = {
         docs: {
             description: "require parentheses around immediate `function` invocations",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/wrap-iife"
         },
 
         schema: [

package/lib/rules/wrap-regex.js

@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "require parenthesis around regex literals",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/wrap-regex"
         },
 
         schema: [],

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

@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "require or disallow spacing around the `*` in `yield*` expressions",
             category: "ECMAScript 6",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/yield-star-spacing"
         },
 
         fixable: "whitespace",

package/lib/rules/yoda.js

@@ -155,7 +155,8 @@ module.exports = {
         docs: {
             description: "require or disallow \"Yoda\" conditions",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/yoda"
         },
 
         schema: [

package/lib/testers/rule-tester.js

@@ -47,7 +47,8 @@ const lodash = require("lodash"),
     ajv = require("../util/ajv"),
     Linter = require("../linter"),
     Environments = require("../config/environments"),
-    SourceCodeFixer = require("../util/source-code-fixer");
+    SourceCodeFixer = require("../util/source-code-fixer"),
+    interpolate = require("../util/interpolate");
 
 //------------------------------------------------------------------------------
 // Private Members
@@ -131,13 +132,31 @@ const DESCRIBE = Symbol("describe");
 const IT = Symbol("it");
 
 /**
- * This is `it` or `describe` if those don't exist.
+ * This is `it` default handler if `it` don't exist.
  * @this {Mocha}
  * @param {string} text - The description of the test case.
  * @param {Function} method - The logic of the test case.
  * @returns {any} Returned value of `method`.
  */
-function defaultHandler(text, method) {
+function itDefaultHandler(text, method) {
+    try {
+        return method.apply(this);
+    } catch (err) {
+        if (err instanceof assert.AssertionError) {
+            err.message += ` (${util.inspect(err.actual)} ${err.operator} ${util.inspect(err.expected)})`;
+        }
+        throw err;
+    }
+}
+
+/**
+ * This is `describe` default handler if `describe` don't exist.
+ * @this {Mocha}
+ * @param {string} text - The description of the test case.
+ * @param {Function} method - The logic of the test case.
+ * @returns {any} Returned value of `method`.
+ */
+function describeDefaultHandler(text, method) {
     return method.apply(this);
 }
 
@@ -212,7 +231,7 @@ class RuleTester {
     static get describe() {
         return (
             this[DESCRIBE] ||
-            (typeof describe === "function" ? describe : defaultHandler)
+            (typeof describe === "function" ? describe : describeDefaultHandler)
         );
     }
 
@@ -223,7 +242,7 @@ class RuleTester {
     static get it() {
         return (
             this[IT] ||
-            (typeof it === "function" ? it : defaultHandler)
+            (typeof it === "function" ? it : itDefaultHandler)
         );
     }
 
@@ -454,59 +473,73 @@ class RuleTester {
                 const hasMessageOfThisRule = messages.some(m => m.ruleId === ruleName);
 
                 for (let i = 0, l = item.errors.length; i < l; i++) {
-                    assert(!messages[i].fatal, `A fatal parsing error occurred: ${messages[i].message}`);
+                    const error = item.errors[i];
+                    const message = messages[i];
+
+                    assert(!message.fatal, `A fatal parsing error occurred: ${message.message}`);
                     assert(hasMessageOfThisRule, "Error rule name should be the same as the name of the rule being tested");
 
-                    if (typeof item.errors[i] === "string" || item.errors[i] instanceof RegExp) {
+                    if (typeof error === "string" || error instanceof RegExp) {
 
                         // Just an error message.
-                        assertMessageMatches(messages[i].message, item.errors[i]);
-                    } else if (typeof item.errors[i] === "object") {
+                        assertMessageMatches(message.message, error);
+                    } else if (typeof error === "object") {
 
                         /*
                          * Error object.
                          * This may have a message, node type, line, and/or
                          * column.
                          */
-                        if (item.errors[i].message) {
-                            assertMessageMatches(messages[i].message, item.errors[i].message);
+                        if (error.message) {
+                            assertMessageMatches(message.message, error.message);
                         }
 
-                        // The following checks use loose equality assertions for backwards compatibility.
+                        if (error.messageId) {
+                            const hOP = Object.hasOwnProperty.call.bind(Object.hasOwnProperty);
 
-                        if (item.errors[i].type) {
+                            // verify that `error.message` is `undefined`
+                            assert.strictEqual(error.message, void 0, "Error should not specify both a message and a messageId.");
+                            if (!hOP(rule, "meta") || !hOP(rule.meta, "messages")) {
+                                assert.fail("Rule must specify a messages hash in `meta`");
+                            }
+                            if (!hOP(rule.meta.messages, error.messageId)) {
+                                const friendlyIDList = `[${Object.keys(rule.meta.messages).map(key => `'${key}'`).join(", ")}]`;
 
-                            // eslint-disable-next-line no-restricted-properties
-                            assert.equal(messages[i].nodeType, item.errors[i].type, `Error type should be ${item.errors[i].type}, found ${messages[i].nodeType}`);
-                        }
+                                assert.fail(`Invalid messageId '${error.messageId}'. Expected one of ${friendlyIDList}.`);
+                            }
 
-                        if (item.errors[i].hasOwnProperty("line")) {
+                            let expectedMessage = rule.meta.messages[error.messageId];
 
-                            // eslint-disable-next-line no-restricted-properties
-                            assert.equal(messages[i].line, item.errors[i].line, `Error line should be ${item.errors[i].line}`);
-                        }
+                            if (error.data) {
+                                expectedMessage = interpolate(expectedMessage, error.data);
+                            }
 
-                        if (item.errors[i].hasOwnProperty("column")) {
+                            assertMessageMatches(message.message, expectedMessage);
+                        }
 
-                            // eslint-disable-next-line no-restricted-properties
-                            assert.equal(messages[i].column, item.errors[i].column, `Error column should be ${item.errors[i].column}`);
+                        if (error.type) {
+                            assert.strictEqual(message.nodeType, error.type, `Error type should be ${error.type}, found ${message.nodeType}`);
                         }
 
-                        if (item.errors[i].hasOwnProperty("endLine")) {
+                        if (error.hasOwnProperty("line")) {
+                            assert.strictEqual(message.line, error.line, `Error line should be ${error.line}`);
+                        }
 
-                            // eslint-disable-next-line no-restricted-properties
-                            assert.equal(messages[i].endLine, item.errors[i].endLine, `Error endLine should be ${item.errors[i].endLine}`);
+                        if (error.hasOwnProperty("column")) {
+                            assert.strictEqual(message.column, error.column, `Error column should be ${error.column}`);
                         }
 
-                        if (item.errors[i].hasOwnProperty("endColumn")) {
+                        if (error.hasOwnProperty("endLine")) {
+                            assert.strictEqual(message.endLine, error.endLine, `Error endLine should be ${error.endLine}`);
+                        }
 
-                            // eslint-disable-next-line no-restricted-properties
-                            assert.equal(messages[i].endColumn, item.errors[i].endColumn, `Error endColumn should be ${item.errors[i].endColumn}`);
+                        if (error.hasOwnProperty("endColumn")) {
+                            assert.strictEqual(message.endColumn, error.endColumn, `Error endColumn should be ${error.endColumn}`);
                         }
                     } else {
 
                         // Message was an unexpected type
-                        assert.fail(messages[i], null, "Error should be a string, object, or RegExp.");
+                        assert.fail(message, null, "Error should be a string, object, or RegExp.");
                     }
                 }
             }

package/lib/util/interpolate.js

@@ -0,0 +1,24 @@
+/**
+ * @fileoverview Interpolate keys from an object into a string with {{ }} markers.
+ * @author Jed Fox
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Public Interface
+//------------------------------------------------------------------------------
+
+module.exports = (text, data) => {
+    if (!data) {
+        return text;
+    }
+    return text.replace(/\{\{\s*([^{}]+?)\s*\}\}/g, (fullMatch, term) => {
+        if (term in data) {
+            return data[term];
+        }
+
+        // Preserve old behavior: If parameter name not provided, don't replace it.
+        return fullMatch;
+    });
+};

package/lib/util/source-code.js

@@ -84,13 +84,30 @@ class SourceCode extends TokenStore {
 
     /**
      * Represents parsed source code.
-     * @param {string} text - The source code text.
-     * @param {ASTNode} ast - The Program node of the AST representing the code. This AST should be created from the text that BOM was stripped.
+     * @param {string|Object} textOrConfig - The source code text or config object.
+     * @param {string} textOrConfig.text - The source code text.
+     * @param {ASTNode} textOrConfig.ast - The Program node of the AST representing the code. This AST should be created from the text that BOM was stripped.
+     * @param {Object|null} textOrConfig.parserServices - The parser srevices.
+     * @param {ScopeManager|null} textOrConfig.scopeManager - The scope of this source code.
+     * @param {Object|null} textOrConfig.visitorKeys - The visitor keys to traverse AST.
+     * @param {ASTNode} [ast] - The Program node of the AST representing the code. This AST should be created from the text that BOM was stripped.
      * @constructor
      */
-    constructor(text, ast) {
-        validate(ast);
+    constructor(textOrConfig, ast) {
+        let text, parserServices, scopeManager, visitorKeys;
+
+        // Process overloading.
+        if (typeof textOrConfig === "string") {
+            text = textOrConfig;
+        } else if (typeof textOrConfig === "object" && textOrConfig !== null) {
+            text = textOrConfig.text;
+            ast = textOrConfig.ast;
+            parserServices = textOrConfig.parserServices;
+            scopeManager = textOrConfig.scopeManager;
+            visitorKeys = textOrConfig.visitorKeys;
+        }
 
+        validate(ast);
         super(ast.tokens, ast.comments);
 
         /**
@@ -112,6 +129,24 @@ class SourceCode extends TokenStore {
          */
         this.ast = ast;
 
+        /**
+         * The parser services of this source code.
+         * @type {Object}
+         */
+        this.parserServices = parserServices || {};
+
+        /**
+         * The scope of this source code.
+         * @type {ScopeManager|null}
+         */
+        this.scopeManager = scopeManager || null;
+
+        /**
+         * The visitor keys to traverse AST.
+         * @type {Object}
+         */
+        this.visitorKeys = visitorKeys || Traverser.DEFAULT_VISITOR_KEYS;
+
         // Check the source text for the presence of a shebang since it is parsed as a standard line comment.
         const shebangMatched = this.text.match(astUtils.SHEBANG_MATCHER);
         const hasShebang = shebangMatched && ast.comments.length && ast.comments[0].value === shebangMatched[1];
@@ -353,9 +388,9 @@ class SourceCode extends TokenStore {
     getNodeByRangeIndex(index) {
         let result = null,
             resultParent = null;
-        const traverser = new Traverser();
 
-        traverser.traverse(this.ast, {
+        Traverser.traverse(this.ast, {
+            visitorKeys: this.visitorKeys,
             enter(node, parent) {
                 if (node.range[0] <= index && index < node.range[1]) {
                     result = node;

package/lib/util/traverser.js

@@ -1,6 +1,7 @@
 /**
- * @fileoverview Wrapper around estraverse
+ * @fileoverview Traverser to traverse AST trees.
  * @author Nicholas C. Zakas
+ * @author Toru Nagashima
  */
 "use strict";
 
@@ -8,27 +9,153 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const estraverse = require("estraverse");
+const vk = require("eslint-visitor-keys");
+const debug = require("debug")("eslint:traverser");
 
 //------------------------------------------------------------------------------
 // Helpers
 //------------------------------------------------------------------------------
 
-const KEY_BLACKLIST = new Set([
-    "parent",
-    "leadingComments",
-    "trailingComments"
-]);
+/**
+ * Do nothing.
+ * @returns {void}
+ */
+function noop() {
+
+    // do nothing.
+}
+
+/**
+ * Check whether the given value is an ASTNode or not.
+ * @param {any} x The value to check.
+ * @returns {boolean} `true` if the value is an ASTNode.
+ */
+function isNode(x) {
+    return x !== null && typeof x === "object" && typeof x.type === "string";
+}
 
 /**
- * Wrapper around an estraverse controller that ensures the correct keys
- * are visited.
- * @constructor
+ * Get the visitor keys of a given node.
+ * @param {Object} visitorKeys The map of visitor keys.
+ * @param {ASTNode} node The node to get their visitor keys.
+ * @returns {string[]} The visitor keys of the node.
  */
-class Traverser extends estraverse.Controller {
-    traverse(node, visitor) {
-        visitor.fallback = Traverser.getKeys;
-        return super.traverse(node, visitor);
+function getVisitorKeys(visitorKeys, node) {
+    let keys = visitorKeys[node.type];
+
+    if (!keys) {
+        keys = vk.getKeys(node);
+        debug("Unknown node type \"%s\": Estimated visitor keys %j", node.type, keys);
+    }
+
+    return keys;
+}
+
+/**
+ * The traverser class to traverse AST trees.
+ */
+class Traverser {
+    constructor() {
+        this._current = null;
+        this._parents = [];
+        this._skipped = false;
+        this._broken = false;
+        this._visitorKeys = null;
+        this._enter = null;
+        this._leave = null;
+    }
+
+    /**
+     * @returns {ASTNode} The current node.
+     */
+    current() {
+        return this._current;
+    }
+
+    /**
+     * @returns {ASTNode[]} The ancestor nodes.
+     */
+    parents() {
+        return this._parents.slice(0);
+    }
+
+    /**
+     * Break the current traversal.
+     * @returns {void}
+     */
+    break() {
+        this._broken = true;
+    }
+
+    /**
+     * Skip child nodes for the current traversal.
+     * @returns {void}
+     */
+    skip() {
+        this._skipped = true;
+    }
+
+    /**
+     * Traverse the given AST tree.
+     * @param {ASTNode} node The root node to traverse.
+     * @param {Object} options The option object.
+     * @param {Object} [options.visitorKeys=DEFAULT_VISITOR_KEYS] The keys of each node types to traverse child nodes. Default is `./default-visitor-keys.json`.
+     * @param {Function} [options.enter=noop] The callback function which is called on entering each node.
+     * @param {Function} [options.leave=noop] The callback function which is called on leaving each node.
+     * @returns {void}
+     */
+    traverse(node, options) {
+        this._current = null;
+        this._parents = [];
+        this._skipped = false;
+        this._broken = false;
+        this._visitorKeys = options.visitorKeys || vk.KEYS;
+        this._enter = options.enter || noop;
+        this._leave = options.leave || noop;
+        this._traverse(node, null);
+    }
+
+    /**
+     * Traverse the given AST tree recursively.
+     * @param {ASTNode} node The current node.
+     * @param {ASTNode|null} parent The parent node.
+     * @returns {void}
+     * @private
+     */
+    _traverse(node, parent) {
+        if (!isNode(node)) {
+            return;
+        }
+
+        this._current = node;
+        this._skipped = false;
+        this._enter(node, parent);
+
+        if (!this._skipped && !this._broken) {
+            const keys = getVisitorKeys(this._visitorKeys, node);
+
+            if (keys.length >= 1) {
+                this._parents.push(node);
+                for (let i = 0; i < keys.length && !this._broken; ++i) {
+                    const child = node[keys[i]];
+
+                    if (Array.isArray(child)) {
+                        for (let j = 0; j < child.length && !this._broken; ++j) {
+                            this._traverse(child[j], node);
+                        }
+                    } else {
+                        this._traverse(child, node);
+                    }
+                }
+                this._parents.pop();
+            }
+        }
+
+        if (!this._broken) {
+            this._leave(node, parent);
+        }
+
+        this._current = parent;
     }
 
     /**
@@ -38,7 +165,28 @@ class Traverser extends estraverse.Controller {
      * @private
      */
     static getKeys(node) {
-        return Object.keys(node).filter(key => !KEY_BLACKLIST.has(key));
+        return vk.getKeys(node);
+    }
+
+    /**
+     * Traverse the given AST tree.
+     * @param {ASTNode} node The root node to traverse.
+     * @param {Object} options The option object.
+     * @param {Object} [options.visitorKeys=DEFAULT_VISITOR_KEYS] The keys of each node types to traverse child nodes. Default is `./default-visitor-keys.json`.
+     * @param {Function} [options.enter=noop] The callback function which is called on entering each node.
+     * @param {Function} [options.leave=noop] The callback function which is called on leaving each node.
+     * @returns {void}
+     */
+    static traverse(node, options) {
+        new Traverser().traverse(node, options);
+    }
+
+    /**
+     * The default visitor keys.
+     * @type {Object}
+     */
+    static get DEFAULT_VISITOR_KEYS() {
+        return vk.KEYS;
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint",
-  "version": "4.12.1",
+  "version": "4.15.0",
   "author": "Nicholas C. Zakas <nicholas+npm@nczconsulting.com>",
   "description": "An AST-based pattern checker for JavaScript.",
   "bin": {
@@ -39,12 +39,12 @@
     "chalk": "^2.1.0",
     "concat-stream": "^1.6.0",
     "cross-spawn": "^5.1.0",
-    "debug": "^3.0.1",
+    "debug": "^3.1.0",
     "doctrine": "^2.0.2",
     "eslint-scope": "^3.7.1",
+    "eslint-visitor-keys": "^1.0.0",
     "espree": "^3.5.2",
     "esquery": "^1.0.0",
-    "estraverse": "^4.2.0",
     "esutils": "^2.0.2",
     "file-entry-cache": "^2.0.0",
     "functional-red-black-tree": "^1.0.1",