feat(bin): Improve output (#42)

* fix(rules): Sort rule names alphabetically * feat(bin): Improve output Improve output of rules by rendering them in a tabular structure, like ls on *nixes. Closes #9 * refactor(sort-rules): Rename function to be more concise
sarbbottam · Apr 15, 2016 · 715db46 · 715db46
1 parent e421ab1
commit 715db46
Show file tree

Hide file tree

Showing 7 changed files with 103 additions and 19 deletions.
diff --git a/package.json b/package.json
@@ -28,7 +28,9 @@
   ],
   "license": "MIT",
   "dependencies": {
+    "cliui": "^3.2.0",
     "path-is-absolute": "1.0.0",
+    "window-size": "^0.2.0",
     "yargs": "^4.4.0"
   },
   "devDependencies": {

diff --git a/src/bin/diff.js b/src/bin/diff.js
@@ -2,16 +2,45 @@
 
 'use strict'
 
+var size = require('window-size')
+var availableWidth = size.width || /* istanbul ignore next */ 80
+var ui = require('cliui')({width: availableWidth})
+
 var getRuleFinder = require('../lib/rule-finder')
 var difference = require('../lib/array-diff')
+var getSortedRules = require('../lib/sort-rules')
 
-var rules = difference(
-  getRuleFinder(process.argv[2]).getCurrentRules(),
-  getRuleFinder(process.argv[3]).getCurrentRules()
+var rules = getSortedRules(
+  difference(
+    getRuleFinder(process.argv[2]).getCurrentRules(),
+    getRuleFinder(process.argv[3]).getCurrentRules()
+  )
 )
 
+var outputRules, outputRuleCellMapper
+var outputPadding = ' '
+var outputMaxWidth = 0
+var outputMaxCols = 0
+
 /* istanbul ignore next */
 if (rules.length) {
   console.log('\n diff rules\n') // eslint-disable-line no-console
-  console.log(rules.join(', ')) // eslint-disable-line no-console
+  rules = rules.map(function columnSpecification(rule) {
+    rule = rule + outputPadding
+    outputMaxWidth = Math.max(rule.length, outputMaxWidth)
+    return rule
+  })
+  outputMaxCols = Math.floor(availableWidth / outputMaxWidth)
+  outputRuleCellMapper = getOutputRuleCellMapper(Math.floor(availableWidth / outputMaxCols))
+  while (rules.length) {
+    outputRules = rules.splice(0, outputMaxCols).map(outputRuleCellMapper)
+    ui.div.apply(ui, outputRules)
+  }
+  console.log(ui.toString()) // eslint-disable-line no-console
+}
+
+function getOutputRuleCellMapper(width) {
+  return function curriedOutputRuleCellMapper(rule) {
+    return {text: rule, width: width}
+  }
 }
diff --git a/src/bin/find.js b/src/bin/find.js
@@ -15,20 +15,38 @@ var argv = require('yargs')
   .alias(options)
   .argv
 
+var size = require('window-size')
+var availableWidth = size.width || /* istanbul ignore next */ 80
+var ui = require('cliui')({width: availableWidth})
+
 var processExitCode = argv.u && !argv.n ? 1 : 0
 var getRuleFinder = require('../lib/rule-finder')
 var specifiedFile = argv._[0]
 
 var ruleFinder = getRuleFinder(specifiedFile)
 Object.keys(options).forEach(function findRules(option) {
-  var rules
+  var rules, outputRules, outputRuleCellMapper
+  var outputPadding = ' '
+  var outputMaxWidth = 0
+  var outputMaxCols = 0
   var ruleFinderMethod = ruleFinder[option]
   if (argv[option] && ruleFinderMethod) {
     rules = ruleFinderMethod()
     /* istanbul ignore next */
     if (rules.length) {
       console.log('\n' + options[option][0], 'rules\n') // eslint-disable-line no-console
-      console.log(rules.join(', ')) // eslint-disable-line no-console
+      rules = rules.map(function columnSpecification(rule) {
+        rule = rule + outputPadding
+        outputMaxWidth = Math.max(rule.length, outputMaxWidth)
+        return rule
+      })
+      outputMaxCols = Math.floor(availableWidth / outputMaxWidth)
+      outputRuleCellMapper = getOutputRuleCellMapper(Math.floor(availableWidth / outputMaxCols))
+      while (rules.length) {
+        outputRules = rules.splice(0, outputMaxCols).map(outputRuleCellMapper)
+        ui.div.apply(ui, outputRules)
+      }
+      console.log(ui.toString()) // eslint-disable-line no-console
     } else if (option === 'getUnusedRules') {
       processExitCode = 0
     }
@@ -38,3 +56,9 @@ Object.keys(options).forEach(function findRules(option) {
 if (processExitCode) {
   process.exit(processExitCode)
 }
+
+function getOutputRuleCellMapper(width) {
+  return function curriedOutputRuleCellMapper(rule) {
+    return {text: rule, width: width}
+  }
+}
diff --git a/src/lib/rule-finder.js b/src/lib/rule-finder.js
@@ -4,6 +4,7 @@ var fs = require('fs')
 var eslint = require('eslint')
 var isAbsolute = require('path-is-absolute')
 var difference = require('./array-diff')
+var getSortedRules = require('./sort-rules')
 
 function _getConfigFile(specifiedFile) {
   if (specifiedFile) {
@@ -71,21 +72,21 @@ function RuleFinder(specifiedFile) {
 
   // get all the current rules instead of referring the extended files or documentation
   this.getCurrentRules = function getCurrentRules() {
-    return currentRules
+    return getSortedRules(currentRules)
   }
 
   // get all the plugin rules instead of referring the extended files or documentation
   this.getPluginRules = function getPluginRules() {
-    return pluginRules
+    return getSortedRules(pluginRules)
   }
 
   // get all the available rules instead of referring eslint and plugin packages or documentation
   this.getAllAvailableRules = function getAllAvailableRules() {
-    return allRules
+    return getSortedRules(allRules)
   }
 
   this.getUnusedRules = function getUnusedRules() {
-    return unusedRules
+    return getSortedRules(unusedRules)
   }
 
 }

diff --git a/src/lib/sort-rules.js b/src/lib/sort-rules.js
@@ -0,0 +1,9 @@
+'use strict'
+
+function getSortedRules(rules) {
+  return rules.sort(function sort(a, b) {
+    return a > b ? 1 : -1
+  })
+}
+
+module.exports = getSortedRules
diff --git a/test/lib/rule-finder.js b/test/lib/rule-finder.js
@@ -63,52 +63,52 @@ describe('rule-finder', function() {
       return noSpecifiedFile
     }
     ruleFinder = getRuleFinder()
-    assert.deepEqual(ruleFinder.getAllAvailableRules(), ['foo-rule', 'bar-rule', 'baz-rule'])
+    assert.deepEqual(ruleFinder.getAllAvailableRules(), ['bar-rule', 'baz-rule', 'foo-rule'])
   })
 
   it('specifiedFile (relative path) is passed to the constructor', function() {
     var ruleFinder = getRuleFinder(specifiedFileRelative)
-    assert.deepEqual(ruleFinder.getUnusedRules(), ['baz-rule', 'react/foo-rule', 'react/bar-rule', 'react/baz-rule'])
+    assert.deepEqual(ruleFinder.getUnusedRules(), ['baz-rule', 'react/bar-rule', 'react/baz-rule', 'react/foo-rule'])
   })
 
   it('specifiedFile (relative path) - curent rules', function() {
     var ruleFinder = getRuleFinder(specifiedFileRelative)
-    assert.deepEqual(ruleFinder.getCurrentRules(), ['foo-rule', 'bar-rule'])
+    assert.deepEqual(ruleFinder.getCurrentRules(), ['bar-rule', 'foo-rule'])
   })
 
   it('specifiedFile (relative path) - plugin rules', function() {
     var ruleFinder = getRuleFinder(specifiedFileRelative)
-    assert.deepEqual(ruleFinder.getPluginRules(), ['react/foo-rule', 'react/bar-rule', 'react/baz-rule'])
+    assert.deepEqual(ruleFinder.getPluginRules(), ['react/bar-rule', 'react/baz-rule', 'react/foo-rule'])
   })
 
   it('specifiedFile (relative path) - all available rules', function() {
     var ruleFinder = getRuleFinder(specifiedFileRelative)
     assert.deepEqual(
       ruleFinder.getAllAvailableRules(),
-      ['foo-rule', 'bar-rule', 'baz-rule', 'react/foo-rule', 'react/bar-rule', 'react/baz-rule']
+      ['bar-rule', 'baz-rule', 'foo-rule', 'react/bar-rule', 'react/baz-rule', 'react/foo-rule']
     )
   })
 
   it('specifiedFile (absolut path) is passed to the constructor', function() {
     var ruleFinder = getRuleFinder(specifiedFileAbsolute)
-    assert.deepEqual(ruleFinder.getUnusedRules(), ['baz-rule', 'react/foo-rule', 'react/bar-rule', 'react/baz-rule'])
+    assert.deepEqual(ruleFinder.getUnusedRules(), ['baz-rule', 'react/bar-rule', 'react/baz-rule', 'react/foo-rule'])
   })
 
   it('specifiedFile (absolut path) - curent rules', function() {
     var ruleFinder = getRuleFinder(specifiedFileAbsolute)
-    assert.deepEqual(ruleFinder.getCurrentRules(), ['foo-rule', 'bar-rule'])
+    assert.deepEqual(ruleFinder.getCurrentRules(), ['bar-rule', 'foo-rule'])
   })
 
   it('specifiedFile (absolut path) - plugin rules', function() {
     var ruleFinder = getRuleFinder(specifiedFileAbsolute)
-    assert.deepEqual(ruleFinder.getPluginRules(), ['react/foo-rule', 'react/bar-rule', 'react/baz-rule'])
+    assert.deepEqual(ruleFinder.getPluginRules(), ['react/bar-rule', 'react/baz-rule', 'react/foo-rule'])
   })
 
   it('specifiedFile (absolut path) - all available rules', function() {
     var ruleFinder = getRuleFinder(specifiedFileAbsolute)
     assert.deepEqual(
       ruleFinder.getAllAvailableRules(),
-      ['foo-rule', 'bar-rule', 'baz-rule', 'react/foo-rule', 'react/bar-rule', 'react/baz-rule']
+      ['bar-rule', 'baz-rule', 'foo-rule', 'react/bar-rule', 'react/baz-rule', 'react/foo-rule']
     )
   })
 })
diff --git a/test/lib/sort-rules.js b/test/lib/sort-rules.js
@@ -0,0 +1,19 @@
+var assert = require('assert')
+var sortRules = require('../../src/lib/sort-rules')
+
+describe('sort-rules', function() {
+  it('should return sorted rules', function() {
+    assert.deepEqual(
+      sortRules(['a', 'b', 'c']),
+      ['a', 'b', 'c']
+    )
+    assert.deepEqual(
+      sortRules(['c', 'b', 'a']),
+      ['a', 'b', 'c']
+    )
+    assert.deepEqual(
+      sortRules(['aa', 'a', 'ab', 'b', 'c']),
+      ['a', 'aa', 'ab', 'b', 'c']
+    )
+  })
+})