Extract config finder

Author: pointlessone

lib/config_finder.js

@@ -0,0 +1,28 @@
+"use strict";
+
+const CONFIG_FILES = require("eslint/lib/config/config-file").CONFIG_FILES
+  , FileFinder = require("eslint/lib/file-finder")
+  , path = require("path");
+
+module.exports = function(configFile, analysisFiles) {
+  if (configFile) {
+    return [configFile];
+  }
+
+  const dirs = analysisFiles.map(function(fileName){
+    return path.dirname(fileName);
+  });
+  const directories = Array.from(new Set(dirs));
+
+  const localConfigFinder = new FileFinder(CONFIG_FILES, process.cwd());
+
+  const configs = new Set();
+  for (const dir of directories) {
+    const configFiles = localConfigFinder.findAllInDirectoryAndParents(dir);
+    for (const file of configFiles) {
+      configs.add(file);
+    }
+  }
+
+  return Array.from(configs);
+};

lib/config_upgrader.js

@@ -1,11 +1,11 @@
 "use strict";
 
-const Config = require("eslint/lib/config")
+const
+    Config = require("eslint/lib/config")
   , merge = require("eslint/lib/config/config-ops").merge
   , path = require("path")
   , stringify = require("json-stable-stringify")
-  , CONFIG_FILES = require("eslint/lib/config/config-file").CONFIG_FILES
-  , FileFinder = require("eslint/lib/file-finder");
+  ;
 
 var SEVERITIES = {
   0: "off",
@@ -226,34 +226,8 @@ class ConfigUpgrader {
     return [].concat(this._report);
   }
 
-  static configs(analysisFiles) {
-    const dirs = analysisFiles.map(function(fileName){
-      return path.dirname(fileName);
-    });
-    const directories = Array.from(new Set(dirs));
-
-    const localConfigFinder = new FileFinder(CONFIG_FILES, process.cwd());
-
-    const configs = new Set();
-    for (const dir of directories) {
-      const configFiles = localConfigFinder.findAllInDirectoryAndParents(dir);
-      for (const file of configFiles) {
-        configs.add(file);
-      }
-    }
-
-    return Array.from(configs);
-  }
-
-  static upgradeInstructions(configFile, analysisFiles, root) {
-    let configs;
-    if (configFile) {
-      configs = [configFile];
-    }
-    else {
-      configs = this.configs(analysisFiles);
-    }
 
+  static upgradeInstructions(configs, root) {
     const reports = configs.map(function(configFile) {
       let report = [];
 

lib/eslint.js

@@ -11,6 +11,7 @@ const checks = require("./checks");
 const validateConfig = require("./validate_config");
 const computeFingerprint = require("./compute_fingerprint");
 const ConfigUpgrader = require("./config_upgrader");
+const findConfigs = require("./config_finder");
 
 const CLIEngine = eslint.CLIEngine;
 const options = { extensions: [".js"], ignore: true, reset: false, useEslintrc: true };
@@ -230,7 +231,14 @@ function run(console, runOptions) {
   if (validateConfig(options.configFile)) {
     console.error("ESLint is running with the " + cli.getConfigForFile(null).parser + " parser.");
 
-    for (const line of ConfigUpgrader.upgradeInstructions(options.configFile, analysisFiles, process.cwd())) {
+
+    let configs = findConfigs(options.configFile, analysisFiles);
+
+    let report = [
+      ConfigUpgrader.upgradeInstructions(configs, process.cwd())
+    ].reduce(function(a, b) { return a.concat([""]).concat(b); });
+
+    for (const line of report) {
       console.error(line);
     }
 

test/config_finder_test.js

@@ -0,0 +1,67 @@
+const findConfigs = require("../lib/config_finder")
+  , expect = require("chai").expect
+  , fs = require("fs")
+  , path = require("path")
+  , temp = require('temp');
+
+describe("findConfigs", function() {
+  it("finds configs", function(done) {
+    temp.mkdir("code ", function(err, directory) {
+      if (err) { throw err; }
+
+      process.chdir(directory);
+
+      const configPath = path.join(directory, ".eslintrc");
+      fs.writeFile(configPath, "{}", function(err) {
+        if (err) { throw err; }
+
+
+        let configs = findConfigs(null, [directory + '/file.js']);
+        expect(configs).to.deep.eq([directory + '/.eslintrc']);
+        done();
+      });
+    });
+  });
+
+  it("ignores irrelevant configs", function(done) {
+    temp.mkdir("code ", function(err, directory) {
+      if (err) { throw err; }
+
+      process.chdir(directory);
+
+      const configPath = path.join(directory, ".eslintrc.json");
+      fs.writeFile(configPath, "{}", function(err) {
+        if (err) { throw err; }
+
+        fs.mkdir(path.join(directory, "lib"), function(err) {
+          if (err) { throw err; }
+
+          fs.writeFile(path.join(directory, "lib", ".eslintrc"), "{}", function(err) {
+            if (err) { throw err; }
+
+            let configs = findConfigs(null, [directory + '/file.js']);
+            expect(configs).to.deep.eq([directory + "/.eslintrc.json"]);
+            done();
+          });
+        });
+      });
+    });
+  });
+
+  it("uses specific configs", function(done) {
+    temp.mkdir("code", function(err, directory) {
+      if (err) { throw err; }
+
+      process.chdir(directory);
+
+      const configPath = path.join(directory, "codeclimate-eslint");
+      fs.writeFile(configPath, "{}", function(err) {
+        if (err) { throw err; }
+
+        let configs = findConfigs("codeclimate-eslint", [directory + '/file.js']);
+        expect(configs).to.deep.eq(["codeclimate-eslint"]);
+        done();
+      });
+    });
+  });
+});

test/config_upgrater_test.js

@@ -19,7 +19,7 @@ describe("ConfigUpgrader", function() {
 
 
           let report = ConfigUpgrader
-            .upgradeInstructions(null, [directory + '/file.js'], directory);
+            .upgradeInstructions([directory + '/.eslintrc'], directory);
           expect(report).to.deep.eq([
             ".eslintrc appears to be incompatible with ESLint 3.",
             "To upgrade it do the following:\n",
@@ -29,54 +29,6 @@ describe("ConfigUpgrader", function() {
         });
       });
     });
-
-    it("ignores irrelevant configs", function(done) {
-      temp.mkdir("code ", function(err, directory) {
-        if (err) { throw err; }
-
-        process.chdir(directory);
-
-        const configPath = path.join(directory, ".eslintrc.json");
-        fs.writeFile(configPath, "{}", function(err) {
-          if (err) { throw err; }
-
-          fs.mkdir(path.join(directory, "lib"), function(err) {
-            if (err) { throw err; }
-
-            fs.writeFile(path.join(directory, "lib", ".eslintrc"), "{}", function(err) {
-              if (err) { throw err; }
-
-              let report = ConfigUpgrader
-                .upgradeInstructions(null, [directory + '/file.js'], directory);
-              expect(report).to.deep.eq([]);
-              done();
-            });
-          });
-        });
-      });
-    });
-
-    it("uses specific configs", function(done) {
-      temp.mkdir("code", function(err, directory) {
-        if (err) { throw err; }
-
-        process.chdir(directory);
-
-        const configPath = path.join(directory, "codeclimate-eslint");
-        fs.writeFile(configPath, "{}", function(err) {
-          if (err) { throw err; }
-
-          let report = ConfigUpgrader
-            .upgradeInstructions("codeclimate-eslint", [directory + '/file.js'], directory);
-          expect(report).to.deep.eq([
-            "codeclimate-eslint appears to be incompatible with ESLint 3.",
-            "To upgrade it do the following:\n",
-            "* Add .yml or .json to the config file name. Extension-less config file names are deprecated."
-          ]);
-          done();
-        });
-      });
-    });
   });