feat(api): expose current rules detailed config

sarbbottam · Apr 17, 2016 · 4c7c83c · 4c7c83c
1 parent 7593487
commit 4c7c83c
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -94,6 +94,8 @@ var ruleFinder = getRuleFinder('path/to/eslint-config')
 
 ruleFinder.getCurrentRules()
 
+ruleFinder.getCurrentRulesDetailed()
+
 ruleFinder.getPluginRules()
 
 ruleFinder.getAllAvailableRules()

diff --git a/src/lib/rule-finder.js b/src/lib/rule-finder.js
@@ -75,6 +75,11 @@ function RuleFinder(specifiedFile) {
     return getSortedRules(currentRules)
   }
 
+  // get all the current rules' particular configuration
+  this.getCurrentRulesDetailed = function getCurrentRulesDetailed() {
+    return config.rules
+  }
+
   // get all the plugin rules instead of referring the extended files or documentation
   this.getPluginRules = function getPluginRules() {
     return getSortedRules(pluginRules)

diff --git a/test/lib/rule-finder.js b/test/lib/rule-finder.js
@@ -48,6 +48,15 @@ describe('rule-finder', function() {
     assert.deepEqual(ruleFinder.getCurrentRules(), ['foo-rule'])
   })
 
+  it('no specifiedFile - current rule config', function() {
+    var ruleFinder
+    process.cwd = function() {
+      return noSpecifiedFile
+    }
+    ruleFinder = getRuleFinder()
+    assert.deepEqual(ruleFinder.getCurrentRulesDetailed(), {'foo-rule': [2]})
+  })
+
   it('no specifiedFile - plugin rules', function() {
     var ruleFinder
     process.cwd = function() {
@@ -76,6 +85,11 @@ describe('rule-finder', function() {
     assert.deepEqual(ruleFinder.getCurrentRules(), ['bar-rule', 'foo-rule'])
   })
 
+  it('specifiedFile (relative path) - current rule config', function() {
+    var ruleFinder = getRuleFinder(specifiedFileRelative)
+    assert.deepEqual(ruleFinder.getCurrentRulesDetailed(), {'bar-rule': [2], 'foo-rule': [2]})
+  })
+
   it('specifiedFile (relative path) - plugin rules', function() {
     var ruleFinder = getRuleFinder(specifiedFileRelative)
     assert.deepEqual(ruleFinder.getPluginRules(), ['react/bar-rule', 'react/baz-rule', 'react/foo-rule'])
@@ -99,6 +113,11 @@ describe('rule-finder', function() {
     assert.deepEqual(ruleFinder.getCurrentRules(), ['bar-rule', 'foo-rule'])
   })
 
+  it('specifiedFile (absolut path) - current rule config', function() {
+    var ruleFinder = getRuleFinder(specifiedFileAbsolute)
+    assert.deepEqual(ruleFinder.getCurrentRulesDetailed(), {'foo-rule': [2], 'bar-rule': [2]})
+  })
+
   it('specifiedFile (absolut path) - plugin rules', function() {
     var ruleFinder = getRuleFinder(specifiedFileAbsolute)
     assert.deepEqual(ruleFinder.getPluginRules(), ['react/bar-rule', 'react/baz-rule', 'react/foo-rule'])