eslint 1.7.1 → 1.9.0

package/lib/testers/rule-tester.js

@@ -78,6 +78,34 @@ var RuleTesterParameters = [
 
 var validateSchema = validate(metaSchema, { verbose: true });
 
+var hasOwnProperty = Function.call.bind(Object.hasOwnProperty);
+
+/**
+ * Clones a given value deeply.
+ * Note: This ignores `parent` property.
+ *
+ * @param {any} x - A value to clone.
+ * @returns {any} A cloned value.
+ */
+function cloneDeeplyExcludesParent(x) {
+    if (typeof x === "object" && x !== null) {
+        if (Array.isArray(x)) {
+            return x.map(cloneDeeplyExcludesParent);
+        }
+
+        var retv = {};
+        for (var key in x) {
+            if (key !== "parent" && hasOwnProperty(x, key)) {
+                retv[key] = cloneDeeplyExcludesParent(x[key]);
+            }
+        }
+
+        return retv;
+    }
+
+    return x;
+}
+
 //------------------------------------------------------------------------------
 // Public Interface
 //------------------------------------------------------------------------------
@@ -178,7 +206,7 @@ RuleTester.prototype = {
          */
         function runRuleForItem(ruleName, item) {
             var config = clone(testerConfig),
-                code, filename, schema;
+                code, filename, schema, beforeAST, afterAST;
 
             if (typeof item === "string") {
                 code = item;
@@ -223,7 +251,21 @@ RuleTester.prototype = {
 
             validator.validate(config, "rule-tester");
 
-            return eslint.verify(code, config, filename);
+            // To cache AST.
+            eslint.reset();
+            eslint.on("Program", function(node) {
+                beforeAST = cloneDeeplyExcludesParent(node);
+
+                eslint.on("Program:exit", function(node) {
+                    afterAST = cloneDeeplyExcludesParent(node);
+                });
+            });
+
+            return {
+                messages: eslint.verify(code, config, filename, true),
+                beforeAST: beforeAST,
+                afterAST: afterAST
+            };
         }
 
         /**
@@ -235,10 +277,17 @@ RuleTester.prototype = {
          * @private
          */
         function testValidTemplate(ruleName, item) {
-            var messages = runRuleForItem(ruleName, item);
+            var result = runRuleForItem(ruleName, item);
+            var messages = result.messages;
 
             assert.equal(messages.length, 0, util.format("Should have no errors but had %d: %s",
                         messages.length, util.inspect(messages)));
+
+            assert.deepEqual(
+                result.beforeAST,
+                result.afterAST,
+                "Rule should not modify AST."
+            );
         }
 
         /**
@@ -250,7 +299,8 @@ RuleTester.prototype = {
          * @private
          */
         function testInvalidTemplate(ruleName, item) {
-            var messages = runRuleForItem(ruleName, item);
+            var result = runRuleForItem(ruleName, item);
+            var messages = result.messages;
 
             if (typeof item.errors === "number") {
                 assert.equal(messages.length, item.errors, util.format("Should have %d errors but had %d: %s",
@@ -261,11 +311,10 @@ RuleTester.prototype = {
                     item.errors.length, messages.length, util.inspect(messages)));
 
                 if (item.hasOwnProperty("output")) {
-                    var result = SourceCodeFixer.applyFixes(eslint.getSourceCode(), messages);
-                    assert.equal(result.output, item.output, "Output is incorrect.");
+                    var fixResult = SourceCodeFixer.applyFixes(eslint.getSourceCode(), messages);
+                    assert.equal(fixResult.output, item.output, "Output is incorrect.");
                 }
 
-
                 for (var i = 0, l = item.errors.length; i < l; i++) {
                     assert.ok(!("fatal" in messages[i]), "A fatal parsing error occurred: " + messages[i].message);
                     assert.equal(messages[i].ruleId, ruleName, "Error rule name should be the same as the name of the rule being tested");
@@ -299,6 +348,12 @@ RuleTester.prototype = {
                     }
                 }
             }
+
+            assert.deepEqual(
+                result.beforeAST,
+                result.afterAST,
+                "Rule should not modify AST."
+            );
         }
 
         // this creates a mocha test suite and pipes all supplied info

package/lib/util/estraverse.js

@@ -0,0 +1,54 @@
+/**
+ * @fileoverview Patch for estraverse
+ * @author Toru Nagashima
+ * @copyright 2015 Toru Nagashima. All rights reserved.
+ * See LICENSE file in root directory for full license.
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+var estraverse = require("estraverse"),
+    jsxKeys = require("estraverse-fb/keys");
+
+//------------------------------------------------------------------------------
+// Helers
+//------------------------------------------------------------------------------
+
+var experimentalKeys = {
+    ExperimentalRestProperty: ["argument"],
+    ExperimentalSpreadProperty: ["argument"]
+};
+
+/**
+ * Adds a given keys to Syntax and VisitorKeys of estraverse.
+ *
+ * @param {object} keys - Key definitions to add.
+ *   This is an object as map.
+ *   Keys are the node type.
+ *   Values are an array of property names to visit.
+ * @returns {void}
+ */
+function installKeys(keys) {
+    for (var key in keys) {
+        if (keys.hasOwnProperty(key)) {
+            estraverse.Syntax[key] = key;
+            if (keys[key]) {
+                estraverse.VisitorKeys[key] = keys[key];
+            }
+        }
+    }
+}
+
+// Add JSX node types.
+installKeys(jsxKeys);
+// Add Experimental node types.
+installKeys(experimentalKeys);
+
+//------------------------------------------------------------------------------
+// Public Interface
+//------------------------------------------------------------------------------
+
+module.exports = estraverse;

package/lib/util/glob-util.js

@@ -0,0 +1,149 @@
+/**
+ * @fileoverview Utilities for working with globs and the filesystem.
+ * @author Ian VanSchooten
+ * @copyright 2015 Ian VanSchooten. All rights reserved.
+ * See LICENSE in root directory for full license.
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+var debug = require("debug"),
+    fs = require("fs"),
+    glob = require("glob"),
+    shell = require("shelljs"),
+
+    IgnoredPaths = require("../ignored-paths");
+
+debug = debug("eslint:glob-util");
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/**
+ * Checks if a provided path is a directory and returns a glob string matching
+ * all files under that directory if so, the path itself otherwise.
+ *
+ * Reason for this is that `glob` needs `/**` to collect all the files under a
+ * directory where as our previous implementation without `glob` simply walked
+ * a directory that is passed. So this is to maintain backwards compatibility.
+ *
+ * Also makes sure all path separators are POSIX style for `glob` compatibility.
+ *
+ * @param {string[]} [extensions] An array of accepted extensions
+ * @returns {Function} A function that takes a pathname and returns a glob that
+ *                     matches all files with the provided extensions if
+ *                     pathname is a directory.
+ */
+function processPath(extensions) {
+    var suffix = "/**";
+
+    if (extensions) {
+        if (extensions.length === 1) {
+            suffix += "/*." + extensions[0];
+        } else {
+            suffix += "/*.{" + extensions.join(",") + "}";
+        }
+    }
+
+    /**
+     * A function that converts a directory name to a glob pattern
+     *
+     * @param {string} pathname The directory path to be modified
+     * @returns {string} The glob path or the file path itself
+     * @private
+     */
+    return function(pathname) {
+        var newPath = pathname;
+
+        if (shell.test("-d", pathname)) {
+            newPath = pathname.replace(/[\/\\]$/, "") + suffix;
+        }
+
+        return newPath.replace(/\\/g, "/").replace(/^\.\//, "");
+    };
+}
+
+//------------------------------------------------------------------------------
+// Public Interface
+//------------------------------------------------------------------------------
+
+/**
+ * Resolves the patterns into glob-based patterns for easier handling.
+ * @param   {string[]} patterns    File patterns (such as passed on the command line).
+ * @param   {string[]} extensions  List of valid file extensions.
+ * @returns {string[]} The equivalent glob patterns.
+ */
+function resolveFileGlobPatterns(patterns, extensions) {
+    extensions = extensions || [".js"];
+
+    extensions = extensions.map(function(ext) {
+        return ext.charAt(0) === "." ? ext.substr(1) : ext;
+    });
+
+    return patterns.map(processPath(extensions));
+}
+
+/**
+ * Build a list of absolute filesnames on which ESLint will act.
+ * Ignored files are excluded from the results, as are duplicates.
+ *
+ * @param   {string[]} globPatterns            Glob patterns.
+ * @param   {Object}   [options]               An options object.
+ * @param   {boolean}  [options.ignore]        False disables use of .eslintignore.
+ * @param   {string}   [options.ignorePath]    The ignore file to use instead of .eslintignore.
+ * @param   {string}   [options.ignorePattern] A pattern of files to ignore.
+ * @returns {string[]} Resolved absolute filenames.
+ */
+function listFilesToProcess(globPatterns, options) {
+    var ignoredPaths,
+        ignoredPathsList,
+        files = [],
+        added = {},
+        globOptions;
+
+    /**
+     * Executes the linter on a file defined by the `filename`. Skips
+     * unsupported file extensions and any files that are already linted.
+     * @param {string} filename The file to be processed
+     * @returns {void}
+     */
+    function addFile(filename) {
+        if (ignoredPaths.contains(filename)) {
+            return;
+        }
+        filename = fs.realpathSync(filename);
+        if (added[filename]) {
+            return;
+        }
+        files.push(filename);
+        added[filename] = true;
+    }
+
+    options = options || { ignore: true };
+    ignoredPaths = IgnoredPaths.load(options);
+    ignoredPathsList = ignoredPaths.patterns || [];
+    globOptions = {
+        nodir: true,
+        ignore: ignoredPathsList
+    };
+
+    debug("Creating list of files to process.");
+    globPatterns.forEach(function(pattern) {
+        if (shell.test("-f", pattern)) {
+            addFile(pattern);
+        } else {
+            glob.sync(pattern, globOptions).forEach(addFile);
+        }
+    });
+
+    return files;
+}
+
+module.exports = {
+    resolveFileGlobPatterns: resolveFileGlobPatterns,
+    listFilesToProcess: listFilesToProcess
+};

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

@@ -97,7 +97,7 @@ SourceCodeFixer.applyFixes = function(sourceCode, messages) {
         fixes.forEach(function(problem) {
             var fix = problem.fix;
 
-            if (fix.range[1] <= lastFixPos) {
+            if (fix.range[1] < lastFixPos) {
                 chars.splice(fix.range[0], fix.range[1] - fix.range[0], fix.text);
                 lastFixPos = fix.range[0];
             } else {

package/lib/util/source-code.js

@@ -12,7 +12,7 @@
 //------------------------------------------------------------------------------
 
 var createTokenStore = require("../token-store.js"),
-    estraverse = require("estraverse"),
+    estraverse = require("./estraverse"),
     assign = require("object-assign");
 
 //------------------------------------------------------------------------------
@@ -115,6 +115,10 @@ function SourceCode(text, ast) {
      */
     this.lines = text.split(/\r\n|\r|\n|\u2028|\u2029/g);
 
+    this.tokensAndComments = ast.tokens.concat(ast.comments).sort(function(left, right) {
+        return left.range[0] - right.range[0];
+    });
+
     // create token store methods
     var tokenStore = createTokenStore(ast.tokens);
     Object.keys(tokenStore).forEach(function(methodName) {
@@ -211,6 +215,12 @@ SourceCode.prototype = {
                 }
                 break;
 
+            case "ClassDeclaration":
+                return findJSDocComment(node.leadingComments, line);
+
+            case "ClassExpression":
+                return findJSDocComment(parent.parent.leadingComments, line);
+
             case "ArrowFunctionExpression":
             case "FunctionExpression":
 

package/lib/util.js

@@ -22,7 +22,7 @@ var PLUGIN_NAME_PREFIX = "eslint-plugin-",
  * @param {boolean} [isRule] Whether its a rule
  * @returns {Object} merged config object.
  */
-exports.mergeConfigs = function deepmerge(target, src, combine, isRule) {
+function deepmerge(target, src, combine, isRule) {
     /*
      The MIT License (MIT)
 
@@ -104,32 +104,38 @@ exports.mergeConfigs = function deepmerge(target, src, combine, isRule) {
     }
 
     return dst;
-};
+}
 
 /**
  * Removes the prefix `eslint-plugin-` from a plugin name.
  * @param {string} pluginName The name of the plugin which may have the prefix.
  * @returns {string} The name of the plugin without prefix.
  */
-exports.removePluginPrefix = function removePluginPrefix(pluginName) {
+function removePluginPrefix(pluginName) {
     return pluginName.indexOf(PLUGIN_NAME_PREFIX) === 0 ? pluginName.substring(PLUGIN_NAME_PREFIX.length) : pluginName;
-};
+}
 
 /**
  * @param {string} pluginName The name of the plugin which may have the prefix.
  * @returns {string} The name of the plugins namepace if it has one.
  */
-exports.getNamespace = function getNamespace(pluginName) {
+function getNamespace(pluginName) {
     return pluginName.match(NAMESPACE_REGEX) ? pluginName.match(NAMESPACE_REGEX)[0] : "";
-};
+}
 
 /**
  * Removes the namespace from a plugin name.
  * @param {string} pluginName The name of the plugin which may have the prefix.
  * @returns {string} The name of the plugin without the namespace.
  */
-exports.removeNameSpace = function removeNameSpace(pluginName) {
+function removeNameSpace(pluginName) {
     return pluginName.replace(NAMESPACE_REGEX, "");
-};
+}
 
-exports.PLUGIN_NAME_PREFIX = PLUGIN_NAME_PREFIX;
+module.exports = {
+    mergeConfigs: deepmerge,
+    removePluginPrefix: removePluginPrefix,
+    getNamespace: getNamespace,
+    removeNameSpace: removeNameSpace,
+    "PLUGIN_NAME_PREFIX": PLUGIN_NAME_PREFIX
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint",
-  "version": "1.7.1",
+  "version": "1.9.0",
   "author": "Nicholas C. Zakas <nicholas+npm@nczconsulting.com>",
   "description": "An AST-based pattern checker for JavaScript.",
   "bin": {
@@ -42,14 +42,14 @@
     "escape-string-regexp": "^1.0.2",
     "escope": "^3.2.0",
     "espree": "^2.2.4",
-    "estraverse": "^4.1.0",
+    "estraverse": "^4.1.1",
     "estraverse-fb": "^1.3.1",
     "esutils": "^2.0.2",
     "file-entry-cache": "^1.1.1",
     "glob": "^5.0.14",
     "globals": "^8.11.0",
     "handlebars": "^4.0.0",
-    "inquirer": "^0.9.0",
+    "inquirer": "^0.11.0",
     "is-my-json-valid": "^2.10.0",
     "is-resolvable": "^1.0.0",
     "js-yaml": "^3.2.5",
@@ -57,33 +57,33 @@
     "lodash.clonedeep": "^3.0.1",
     "lodash.merge": "^3.3.2",
     "lodash.omit": "^3.1.0",
-    "minimatch": "^2.0.1",
+    "minimatch": "^3.0.0",
     "mkdirp": "^0.5.0",
-    "object-assign": "^2.0.0",
-    "optionator": "^0.5.0",
+    "object-assign": "^4.0.1",
+    "optionator": "^0.6.0",
     "path-is-absolute": "^1.0.0",
     "path-is-inside": "^1.0.1",
-    "shelljs": "^0.3.0",
+    "shelljs": "^0.5.3",
     "strip-json-comments": "~1.0.1",
     "text-table": "~0.2.0",
-    "to-double-quotes": "^1.0.1",
-    "to-single-quotes": "^1.0.3",
-    "user-home": "^1.0.0",
+    "to-double-quotes": "^2.0.0",
+    "to-single-quotes": "^2.0.0",
+    "user-home": "^2.0.0",
     "xml-escape": "~1.0.0"
   },
   "devDependencies": {
     "beefy": "^1.0.0",
     "brfs": "0.0.9",
-    "browserify": "^8.1.3",
-    "chai": "^1.9.1",
+    "browserify": "^12.0.1",
+    "chai": "^3.4.0",
     "cheerio": "^0.19.0",
-    "coveralls": "2.11.2",
+    "coveralls": "2.11.4",
     "dateformat": "^1.0.8",
     "ejs": "^2.3.3",
     "esprima": "^2.4.1",
-    "esprima-fb": "^10001.1.0-dev-harmony-fb",
-    "gh-got": "^1.0.3",
-    "istanbul": "^0.3.5",
+    "esprima-fb": "^15001.1001.0-dev-harmony-fb",
+    "gh-got": "^2.2.0",
+    "istanbul": "^0.4.0",
     "jsdoc": "^3.3.0-beta1",
     "jsonlint": "^1.6.2",
     "leche": "^2.1.1",
@@ -91,14 +91,14 @@
     "load-perf": "^0.2.0",
     "markdownlint": "^0.0.8",
     "mocha": "^2.1.0",
-    "mocha-phantomjs": "3.6.0",
-    "npm-license": "^0.2.3",
-    "phantomjs": "1.9.7-15",
+    "mocha-phantomjs": "4.0.1",
+    "npm-license": "^0.3.1",
+    "phantomjs": "1.9.18",
     "proxyquire": "^1.0.0",
     "rewire": "^2.3.4",
-    "semver": "^4.1.0",
+    "semver": "^5.0.3",
     "shelljs-nodecli": "~0.1.0",
-    "sinon": "1.14.1",
+    "sinon": "1.17.2",
     "through": "^2.3.6"
   },
   "keywords": [