New: Additional APIs (fixes #6256) (#7669)

* New: Additional APIs (fixes #6256)

* Fix unit test

lib/cli-engine.js

@@ -792,4 +792,6 @@ CLIEngine.prototype = {
 
 };
 
+CLIEngine.version = pkg.version;
+
 module.exports = CLIEngine;

lib/eslint.js

@@ -26,7 +26,10 @@ const assert = require("assert"),
     Traverser = require("./util/traverser"),
     RuleContext = require("./rule-context"),
     rules = require("./rules"),
-    timing = require("./timing");
+    timing = require("./timing"),
+
+    pkg = require("../package.json");
+
 
 //------------------------------------------------------------------------------
 // Typedefs
@@ -1192,6 +1195,16 @@ module.exports = (function() {
         return require("../conf/eslint.json");
     };
 
+    /**
+     * Gets an object with all loaded rules.
+     * @returns {Map} All loaded rules
+     */
+    api.getRules = function() {
+        return rules.getAllLoadedRules();
+    };
+
+    api.version = pkg.version;
+
     /**
      * Gets variables that are declared by a specified node.
      *

lib/rules.js

@@ -75,6 +75,21 @@ function getHandler(ruleId) {
     }
 }
 
+/**
+ * Get an object with all currently loaded rules
+ * @returns {Map} All loaded rules
+ */
+function getAllLoadedRules() {
+    const allRules = new Map();
+
+    Object.keys(rules).forEach(name => {
+        const rule = getHandler(name);
+
+        allRules.set(name, rule);
+    });
+    return allRules;
+}
+
 /**
  * Reset rules storage.
  * Should be used only in tests.
@@ -89,6 +104,7 @@ module.exports = {
     load,
     importPlugin,
     get: getHandler,
+    getAllLoadedRules,
     testClear,
 
     /**

tests/lib/cli-engine.js

@@ -18,7 +18,8 @@ const assert = require("chai").assert,
     Plugins = require("../../lib/config/plugins"),
     fs = require("fs"),
     os = require("os"),
-    hash = require("../../lib/util/hash");
+    hash = require("../../lib/util/hash"),
+    rules = require("../../lib/rules");
 
 require("shelljs/global");
 
@@ -82,6 +83,7 @@ describe("CLIEngine", () => {
     after(() => {
         rm("-r", fixtureDir);
         Plugins.testReset();
+        rules.testReset();
     });
 
     describe("new CLIEngine(options)", () => {
@@ -2704,4 +2706,14 @@ describe("CLIEngine", () => {
 
     });
 
+    describe("when retreiving version number", () => {
+        it("should return current version number", () => {
+            const eslintCLI = require("../../lib/cli-engine");
+            const version = eslintCLI.version;
+
+            assert.isString(version);
+            assert.isTrue(parseInt(version[0], 10) >= 3);
+        });
+    });
+
 });

tests/lib/cli.js

@@ -19,7 +19,8 @@ const assert = require("chai").assert,
     leche = require("leche"),
     fs = require("fs"),
     os = require("os"),
-    sh = require("shelljs");
+    sh = require("shelljs"),
+    rules = require("../../lib/rules");
 
 const proxyquire = require("proxyquire").noCallThru().noPreserveCache();
 
@@ -91,6 +92,7 @@ describe("cli", () => {
 
     after(() => {
         sh.rm("-r", fixtureDir);
+        rules.testReset();
     });
 
     describe("execute()", () => {

tests/lib/eslint.js

@@ -1917,13 +1917,15 @@ describe("eslint", () => {
 
     describe("when evaluating code with comments to disable and enable configurable rule as part of plugin", () => {
 
-        eslint.defineRule("test-plugin/test-rule", context => ({
-            Literal(node) {
-                if (node.value === "trigger violation") {
-                    context.report(node, "Reporting violation.");
+        before(() => {
+            eslint.defineRule("test-plugin/test-rule", context => ({
+                Literal(node) {
+                    if (node.value === "trigger violation") {
+                        context.report(node, "Reporting violation.");
+                    }
                 }
-            }
-        }));
+            }));
+        });
 
         it("should not report a violation when inline comment enables plugin rule and there's no violation", () => {
             const config = { rules: {} };
@@ -2735,6 +2737,24 @@ describe("eslint", () => {
         });
     });
 
+    describe("when calling getRules", () => {
+        it("should return all loaded rules", () => {
+            const rules = eslint.getRules();
+
+            assert.isAbove(rules.size, 230);
+            assert.isObject(rules.get("no-alert"));
+        });
+    });
+
+    describe("when calling version", () => {
+        it("should return current version number", () => {
+            const version = eslint.version;
+
+            assert.isString(version);
+            assert.isTrue(parseInt(version[0], 10) >= 3);
+        });
+    });
+
     describe("when evaluating code without comments to environment", () => {
         it("should report a violation when using typed array", () => {
             const code = "var array = new Uint8Array();";

tests/lib/rules.js

@@ -19,11 +19,7 @@ const assert = require("chai").assert,
 describe("rules", () => {
 
     beforeEach(() => {
-        rules.testClear();
-    });
-
-    afterEach(() => {
-        rules.load();
+        rules.testReset();
     });
 
     describe("when given an invalid rules directory", () => {
@@ -69,5 +65,23 @@ describe("rules", () => {
             assert.isDefined(rules.get("custom-plugin/custom-rule"));
             assert.equal(rules.get("custom-plugin/custom-rule"), customPlugin.rules["custom-rule"]);
         });
+
+        it("should return custom rules as part of getAllLoadedRules", () => {
+            rules.importPlugin(customPlugin, pluginName);
+
+            const allRules = rules.getAllLoadedRules();
+
+            assert.equal(allRules.get("custom-plugin/custom-rule"), customPlugin.rules["custom-rule"]);
+        });
+    });
+
+    describe("when loading all rules", () => {
+        it("should return a map", () => {
+            const allRules = rules.getAllLoadedRules();
+
+            assert.isAbove(allRules.size, 230);
+            assert.instanceOf(allRules, Map);
+            assert.isObject(allRules.get("no-alert"));
+        });
     });
 });