feat: allow including and excluding files with glob patterns

Author: saintedlama

cli.js

@@ -3,6 +3,7 @@
 const program = require('commander');
 const fs = require('fs-extra');
 const parse = require('parse-git-numstat');
+const multimatch = require('multimatch');
 
 const { table } = require('table');
 const { createObjectCsvStringifier } = require('csv-writer');
@@ -13,6 +14,8 @@ const buildBusfactors = require('./lib/build-busfactors');
 
 program.option('-g, --gitlog <gitlog>', 'path to git log with numstat', 'gitlog.txt');
 program.option('-t, --threshold <threshold>', 'report busfactor below this threshold', 3);
+program.option('-e, --exclude <glob>', 'glob pattern to exclude files', repeatable, []);
+program.option('-i, --include <glob>', 'glob pattern to include files', repeatable, []);
 program.option('-r, --report <table/csv>', 'report bus factors in csv or console table format', 'table');
 
 program.parse(process.argv);
@@ -32,7 +35,16 @@ async function buildReport(args) {
 
   const commits = markDeleted(normalizeRenames(gitlog.filter(commit => !commit.merge)));
 
-  const busfactors = buildBusfactors(commits).filter(file => file.busfactor < args.threshold);
+  const matchPattern = buildMatchPattern(args.include, args.exclude);
+
+  const busfactors = buildBusfactors(commits)
+    .filter(file => file.busfactor < args.threshold)
+    .filter(file => multimatch([file.filepath], matchPattern).length == 1);
+
+  if (busfactors.length == 0) {
+    console.log(`No files with bus factor less than threshold ${args.threshold} found`);
+    return;
+  }
 
   if (args.report == 'csv') {
     const records = busfactors.map(file => ({
@@ -68,4 +80,12 @@ async function buildReport(args) {
   }
 }
 
+function buildMatchPattern(includes, excludes) {
+  return [].concat(includes.length > 0 ? includes : '**/*.*', excludes.map(e => `!${e}`));
+}
+
+function repeatable(value, previous) {
+  return [...previous, value];
+}
+
 buildReport(program);

package-lock.json

@@ -2,7 +2,9 @@
   "name": "gitlog-busfactor",
   "version": "1.0.0",
   "description": "Calculates the bus factor from git log",
-  "bin" : { "gitlog-busfactor" : "./cli.js" },
+  "bin": {
+    "gitlog-busfactor": "./cli.js"
+  },
   "main": "lib/build-busfactors.js",
   "scripts": {
     "start": "nodemon cli.js",
@@ -32,6 +34,7 @@
     "commander": "^3.0.1",
     "csv-writer": "^1.5.0",
     "fs-extra": "^8.1.0",
+    "multimatch": "^4.0.0",
     "parse-git-numstat": "^1.0.2",
     "table": "^5.4.6"
   },