Merge pull request #27 from sarbbottam/refactor

Refactor

Author: ta2edchimp

README.md

@@ -27,7 +27,7 @@ The intended usage is as an npm script:
 {
   ...
   "scripts": {
-    "find-new-rules": "eslint-find-new-rules eslint-config-yourConfigName"
+    "find-new-rules": "eslint-find-new-rules path/to/eslint-config"
   }
   ...
 }
@@ -65,6 +65,27 @@ It will also default to the `main` in your `package.json`, so you can omit the a
 eslint-find-new-rules
 ```
 
+### As a `require`d module
+
+```
+var getRuleFinder = require('./eslint-find-new-rules')
+var ruleFinder = getRuleFinder('path/to/eslint-config')
+
+// default to the `main` in your `package.json`
+// var ruleFinder = getRuleFinder()
+
+// get all the current, plugin, available and unused rules
+// without referring the extended files or documentation
+
+ruleFinder.getCurrentRules()
+
+ruleFinder.getPluginRules()
+
+ruleFinder.getAllAvailableRules()
+
+ruleFinder.getUnusedRules()
+```
+
 ## Contributors
 
 Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

bin-utils.js

@@ -2,7 +2,7 @@
   "name": "eslint-find-new-rules",
   "version": "0.0.0-semantically-released",
   "description": "Find built-in ESLint rules you don't have in your custom config.",
-  "main": "index.js",
+  "main": "src/rule-finder.js",
   "scripts": {
     "cover": "nyc --reporter=lcov --reporter=text ava",
     "test": "ava",
@@ -16,7 +16,7 @@
     "report-coverage": "cat ./coverage/lcov.info | node_modules/.bin/codecov"
   },
   "bin": {
-    "eslint-find-new-rules": "bin.js"
+    "eslint-find-new-rules": "src/bin.js"
   },
   "keywords": [],
   "author": "Michał Gołębiowski <[email protected]>",
@@ -78,4 +78,4 @@
     "url": "https://github.com/kentcdodds/eslint-find-new-rules/issues"
   },
   "homepage": "https://github.com/kentcdodds/eslint-find-new-rules#readme"
-}
+}

index.js

@@ -4,14 +4,11 @@
 
 // Prints rules recognized by ESLint that don't appear in the given config
 // preset. It helps with upgrading the preset when new ESLint gets released.
-var binUtils = require('./bin-utils')
-var findNewRules = require('./index')
+var getRuleFinder = require('./rule-finder')
+var specifiedFile = process.argv[2]
+var ruleFinder = getRuleFinder(specifiedFile)
 
-var config = binUtils.getConfig(process.argv[2])
-var currentRules = binUtils.getCurrentRules(config)
-var pluginRules = binUtils.getPluginRules(config)
-
-var newRules = findNewRules(currentRules, pluginRules)
+var newRules = ruleFinder.getUnusedRules()
 
 if (newRules.length) {
   console.log('New rules to add to the config: ' + newRules.join(', ') + '.') // eslint-disable-line no-console

package.json

@@ -0,0 +1,95 @@
+var path = require('path')
+var fs = require('fs')
+
+var eslint = require('eslint')
+var isAbsolute = require('path-is-absolute')
+var difference = require('lodash.difference')
+
+function _getConfigFile(specifiedFile) {
+  if (specifiedFile) {
+    if (isAbsolute(specifiedFile)) {
+      return specifiedFile
+    } else {
+      return path.join(process.cwd(), specifiedFile)
+    }
+  } else {
+    // this is not being called with an arg. Use the package.json `main`
+    return require(path.join(process.cwd(), 'package.json')).main
+  }
+}
+
+function _getConfig(configFile) {
+  var cliEngine = new eslint.CLIEngine({
+    // ignore any config applicable depending on the location on the filesystem
+    useEslintrc: false,
+    // point to the particular config
+    configFile: configFile, // eslint-disable-line object-shorthand
+  })
+  return cliEngine.getConfigForFile()
+}
+
+function _getCurrentRules(config) {
+  return Object.keys(config.rules)
+}
+
+function _getPluginRules(config) {
+  var pluginRules = []
+  var plugins = config.plugins
+  if (plugins) {
+    plugins.forEach(function getPluginRule(plugin) {
+      var pluginConfig = require('eslint-plugin-' + plugin)
+      var rules = pluginConfig.rules
+      pluginRules = pluginRules.concat(
+        Object.keys(rules).map(function normalizePluginRule(rule) {
+          return plugin + '/' + rule
+        })
+      )
+    })
+  }
+  return pluginRules
+}
+
+function _getAllAvailableRules(pluginRules) {
+  var allRules = fs
+    .readdirSync('./node_modules/eslint/lib/rules')
+    .map(function removeJsFromFilename(filename) {
+      return filename.replace(/\.js$/, '')
+    })
+
+  allRules = allRules.concat(pluginRules)
+
+  return allRules
+}
+
+function RuleFinder(specifiedFile) {
+  var configFile = _getConfigFile(specifiedFile)
+  var config = _getConfig(configFile)
+  var currentRules = _getCurrentRules(config)
+  var pluginRules = _getPluginRules(config)
+  var allRules = _getAllAvailableRules(pluginRules)
+  var unusedRules = difference(allRules, currentRules)
+
+  // get all the current rules instead of referring the extended files or documentation
+  this.getCurrentRules = function getCurrentRules() {
+    return currentRules
+  }
+
+  // get all the plugin rules instead of referring the extended files or documentation
+  this.getPluginRules = function getPluginRules() {
+    return pluginRules
+  }
+
+  // get all the availale rules instead of referring eslint and pluging packages or documentation
+  this.getAllAvailableRules = function getAllAvailableRules() {
+    return allRules
+  }
+
+  this.getUnusedRules = function getUnusedRules() {
+    return unusedRules
+  }
+
+}
+
+module.exports = function getRuleFinder(specifiedFile) {
+  return new RuleFinder(specifiedFile)
+}

bin.js renamed to src/bin.js

@@ -0,0 +1,6 @@
+{
+  "extends": "./eslint.yml",
+  "plugins": [
+    "react"
+  ]
+}