cleanup/refactor

- add eslint + standardjs formatting
- split out tests into separate suites
- use json for test output comparison

Author: Marcello Bastéa-Forte

.eslintignore

@@ -0,0 +1 @@
+node_modules

.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": [ "standard" ]
+}

bin/licensecheck

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('../cli.js')
+require('../cli.js')

cli.js

@@ -1,14 +1,13 @@
 // Based on code shamelessly lifted from https://github.com/shtylman/node-weaklink (with permission)
 
-var colors = require('colors')
 var treeify = require('treeify')
 var fs = require('fs')
 var stripJsonComments = require('strip-json-comments')
 
 var licensecheck = require('./index.js')
 
 var path = '.'
-var overridesPath = "./licenses.json"
+var overridesPath = './licenses.json'
 var missingOnly = false
 var flat = false
 var format = 'color'
@@ -20,175 +19,171 @@ var once = false
 var seen = {}
 var hidelist = [] // list of licenses to omit from output
 
-function isOmittedLicense(license) {
+function isOmittedLicense (license) {
   for (var i = 0; i < hidelist.length; i++) {
-    if (license.split(' ')[0] === hidelist[i])
+    if (license.split(' ')[0] === hidelist[i]) {
       return true
+    }
   }
   return false
 }
 
 for (var i = 2; i < process.argv.length; i++) {
-    var arg = process.argv[i]
-    switch (arg) {
-        case '--dev':
-            includeDevDependencies = true
-            break
-        case '--opt':
-            includeOptDependencies = true
-            break
-        case '-m':
-        case '--missing-only':
-            missingOnly = true
-            break
-        case '-h':
-        case '--highlight':
-            highlight = new RegExp(process.argv[++i], 'i')
-            break
-        case '-f':
-        case '--flat':
-            flat = true
-            break
-        case '--tsv':
-            format = 'tsv'
-            flat = true
-            break
-        case '-o':
-        case '--once':
-            once = true
-            break
-        case '--hide':
-            i++
-            hidelist = ( process.argv[i] || "" ).split(",")
-            break
-        default:
-            path = arg
-            break
-    }
+  var arg = process.argv[i]
+  switch (arg) {
+    case '--dev':
+      includeDevDependencies = true
+      break
+    case '--opt':
+      includeOptDependencies = true
+      break
+    case '-m':
+    case '--missing-only':
+      missingOnly = true
+      break
+    case '-h':
+    case '--highlight':
+      highlight = new RegExp(process.argv[++i], 'i')
+      break
+    case '-f':
+    case '--flat':
+      flat = true
+      break
+    case '--tsv':
+      format = 'tsv'
+      flat = true
+      break
+    case '-o':
+    case '--once':
+      once = true
+      break
+    case '--hide':
+      i++
+      hidelist = (process.argv[i] || '').split(',')
+      break
+    default:
+      path = arg
+      break
+  }
 }
 
 var overrides = fs.existsSync(overridesPath) &&
-    JSON.parse(stripJsonComments(fs.readFileSync(overridesPath, "utf8"))) || {}
+    JSON.parse(stripJsonComments(fs.readFileSync(overridesPath, 'utf8'))) || {}
 
-var licenses = licensecheck(".", path, overrides, includeDevDependencies, includeOptDependencies)
+var licenses = licensecheck('.', path, overrides, includeDevDependencies, includeOptDependencies)
 if (flat) {
-    var dependencies = makeFlatDependencyMap(licenses)
-    Object.keys(dependencies).sort().forEach(function (key) {
-        console.log(dependencies[key])
-    })
+  var dependencies = makeFlatDependencyMap(licenses)
+  Object.keys(dependencies).sort().forEach(function (key) {
+    console.log(dependencies[key])
+  })
 } else {
-    treeify.asLines(makeDependencyTree(licenses), false, console.log)
+  treeify.asLines(makeDependencyTree(licenses), false, console.log)
 }
 
-
-function isMissing(info) {
-    return !info.licenseFile || info.license === 'nomatch'
+function isMissing (info) {
+  return !info.licenseFile || info.license === 'nomatch'
 }
 
-function simplifyFile(file) {
-    return file.replace(/\/node_modules\//g, ' ~ ')
+function simplifyFile (file) {
+  return file.replace(/\/node_modules\//g, ' ~ ')
 }
 
-function getDescription(info) {
-    var key
-    var sep
-    var file
-    if (format === 'color') {
-        sep = ' ── '
-        key = info.name + (" (" + info.version + ")").grey
-        if (info.depLevel) {
-            key = key + (" [" + info.depLevel + "]").bold.yellow
-        }
-
-        key = key + sep
-
-        file = info.licenseFile
-        if (file) {
-            file = simplifyFile(file)
-            if (info.license.startsWith('unknown')) {
-                key += info.license.yellow
-            } else if (info.license === 'nomatch') {
-                key += ('unmatched license file: ' + file).yellow
-            } else if (highlight && highlight.test(info.license)) {
-                key += info.license.magenta + sep + file.grey
-            } else {
-                key += info.license.green + sep + file.grey
-            }
-        } else {
-            key += "no license found".red
-        }
-    } else if (format === 'tsv') {
-        sep = '\t'
-        key = info.name + " (" + info.version + ")" + sep
-
-        file = info.licenseFile
-        if (file) {
-            if (info.license.startsWith('unknown')) {
-                key += info.license.yellow
-            } else if (info.license === 'nomatch') {
-                key += 'unmatched: ' + file + sep
-            } else {
-                key += info.license + sep + file
-            }
-        } else {
-            key += "MISSING" + sep
-        }
+function getDescription (info) {
+  var key
+  var sep
+  var file
+  if (format === 'color') {
+    sep = ' ── '
+    key = info.name + (' (' + info.version + ')').grey
+    if (info.depLevel) {
+      key = key + (' [' + info.depLevel + ']').bold.yellow
+    }
+
+    key = key + sep
+
+    file = info.licenseFile
+    if (file) {
+      file = simplifyFile(file)
+      if (info.license.startsWith('unknown')) {
+        key += info.license.yellow
+      } else if (info.license === 'nomatch') {
+        key += ('unmatched license file: ' + file).yellow
+      } else if (highlight && highlight.test(info.license)) {
+        key += info.license.magenta + sep + file.grey
+      } else {
+        key += info.license.green + sep + file.grey
+      }
+    } else {
+      key += 'no license found'.red
+    }
+  } else if (format === 'tsv') {
+    sep = '\t'
+    key = info.name + ' (' + info.version + ')' + sep
+
+    file = info.licenseFile
+    if (file) {
+      if (info.license.startsWith('unknown')) {
+        key += info.license.yellow
+      } else if (info.license === 'nomatch') {
+        key += 'unmatched: ' + file + sep
+      } else {
+        key += info.license + sep + file
+      }
     } else {
-        throw Error("invalid format: " + format)
+      key += 'MISSING' + sep
     }
-    return key;
+  } else {
+    throw Error('invalid format: ' + format)
+  }
+  return key
 }
 
-
-function makeDependencyTree(info) {
-    if (missingOnly && !isMissing(info) && !info.deps.some(isMissing)) {
-        return {}
-    }
-    var key = getDescription(info);
-    var tree = {}
-    var dependencies = tree[key] = {}
-    info.deps.map(makeDependencyTree).forEach(function (dependency) {
-        Object.keys(dependency).forEach(function (key) {
-            dependencies[key] = dependency[key]
-        })
+function makeDependencyTree (info) {
+  if (missingOnly && !isMissing(info) && !info.deps.some(isMissing)) {
+    return {}
+  }
+  var key = getDescription(info)
+  var tree = {}
+  var dependencies = tree[key] = {}
+  info.deps.map(makeDependencyTree).forEach(function (dependency) {
+    Object.keys(dependency).forEach(function (key) {
+      dependencies[key] = dependency[key]
     })
+  })
 
-    // Check if the license of the package is to be hidden
-    if (isOmittedLicense(info.license)) {
-
-      // Omit the package if it has no dependancies with non hidden license
-      if (Object.keys(tree[key]).length == 0)
-        return {}
-
-      // Otherwise include only the name and version of the package with its dependancies
-      else {
-        var dependencies = tree[key]
-        var key = info.name + (" (" + info.version + ")").grey
-        var tree = {}
-        tree[key] = dependencies
-        return tree
-      }
+  // Check if the license of the package is to be hidden
+  if (isOmittedLicense(info.license)) {
+    // Omit the package if it has no dependancies with non hidden license
+    if (Object.keys(tree[key]).length === 0) {
+      return {}
     }
-
+    // Otherwise include only the name and version of the package with its dependancies
+    dependencies = tree[key]
+    key = info.name + (' (' + info.version + ')').grey
+    tree = {}
+    tree[key] = dependencies
     return tree
+  }
+
+  return tree
 }
 
-function makeFlatDependencyMap(info) {
-    var map = {}
-    if ((!missingOnly || isMissing(info)) && (!isOmittedLicense(info.license))) {
-        map[info.name + '@' + info.version] = getDescription(info)
-    }
-    if (once && seen[info.name + '@' + info.version]) {
-        return {}
-    }
-    seen[info.name + '@' + info.version] = true
-    info.deps.forEach(function (dep) {
-        var subMap = makeFlatDependencyMap(dep)
-        Object.keys(subMap).forEach(function (key) {
-            if (!map[key]) {
-                map[key] = subMap[key]
-            }
-        })
+function makeFlatDependencyMap (info) {
+  var map = {}
+  if ((!missingOnly || isMissing(info)) && (!isOmittedLicense(info.license))) {
+    map[info.name + '@' + info.version] = getDescription(info)
+  }
+  if (once && seen[info.name + '@' + info.version]) {
+    return {}
+  }
+  seen[info.name + '@' + info.version] = true
+  info.deps.forEach(function (dep) {
+    var subMap = makeFlatDependencyMap(dep)
+    Object.keys(subMap).forEach(function (key) {
+      if (!map[key]) {
+        map[key] = subMap[key]
+      }
     })
-    return map
+  })
+  return map
 }