feat: Custom reporters

Closes: #19
d4rkr00t · Jul 26, 2018 · 8627b2f · 8627b2f
1 parent 8bed71b
commit 8627b2f
Show file tree

Hide file tree

Showing 12 changed files with 1,656 additions and 19 deletions.
diff --git a/cli.js b/cli.js
@@ -1,9 +1,11 @@
 #!/usr/bin/env node
 /* @flow */
 
+const path = require("path");
 const meow = require("meow");
 const chalk = require("chalk");
 const createProgressBar = require("./lib/console/progress-bar");
+const defaultReporter = require("./lib/reporter");
 const defaultCommand = require("./commands/default");
 const byCommand = require("./commands/by");
 const helpCommand = require("./commands/help");
@@ -18,7 +20,8 @@ const knownFlags = [
   "limit",
   "version",
   "help",
-  "ignore"
+  "ignore",
+  "reporter"
 ];
 
 const validateFlags = flags => {
@@ -56,10 +59,21 @@ if (!input || !input.length || !input[0].match(".json") || flags.help) {
 
 const updateProgressBar = createProgressBar();
 
+let reporter = defaultReporter;
+if (flags.reporter) {
+  try {
+    reporter = {
+      ...defaultReporter,
+      // $FlowFixMe
+      ...require(path.resolve(__dirname, flags.reporter))
+    };
+  } catch (e) {}
+}
+
 if (flags.by) {
-  byCommand(input[0], flags, input[1], updateProgressBar);
+  byCommand(input[0], flags, input[1], reporter, updateProgressBar);
 } else {
-  defaultCommand(input[0], flags, input[1], updateProgressBar);
+  defaultCommand(input[0], flags, input[1], reporter, updateProgressBar);
 }
 
 const timing = (Date.now() - start) / 1000;

diff --git a/commands/by.js b/commands/by.js
@@ -3,9 +3,10 @@
 /*::
 import type { UpdateProgressBar } from '../lib/console/progress-bar';
 import type { Reason, Module } from '../lib/analyze';
+import type { Reporter } from '../lib/reporter';
 */
 
-const { analyze, print, getStats } = require("../lib");
+const { analyze, getStats } = require("../lib");
 const validate = require("../lib/validate");
 const { log, invalidStatsJson } = require("../lib/console/messages");
 
@@ -40,6 +41,7 @@ module.exports = function byCommand(
   statsFilePath /*: string */,
   flags /*: { limit: number, by: string, only?: boolean, ignore?: string } */,
   pattern /*: string */,
+  reporter /*: Reporter */,
   updateProgressBar /*: UpdateProgressBar */ = () => {}
 ) {
   const stats = getStats(statsFilePath);
@@ -57,5 +59,5 @@ module.exports = function byCommand(
     : modulesFollowingDepsChain(report.modules, flags.by);
 
   const limit /*: number */ = pattern ? 0 : flags.limit >= 0 ? flags.limit : 20;
-  print(modules, report.chunks, { by: flags.by }, limit);
+  reporter.print(modules, report.chunks, { by: flags.by }, limit);
 };
diff --git a/commands/default.js b/commands/default.js
@@ -1,12 +1,13 @@
 /* @flow */
 
 const mm = require("micromatch");
-const { analyze, print, getStats } = require("../lib");
+const { analyze, getStats } = require("../lib");
 const validate = require("../lib/validate");
 const { log, invalidStatsJson } = require("../lib/console/messages");
 
 /*::
 import type { UpdateProgressBar } from '../lib/console/progress-bar';
+import type { Reporter } from '../lib/reporter';
 
 type Flags = {
   limit: number,
@@ -24,6 +25,7 @@ module.exports = function defaultCommand(
   statsFilePath /*: string */,
   flags /*: Flags */,
   pattern /*: string*/,
+  reporter /*: Reporter */,
   updateProgressBar /*: UpdateProgressBar */ = () => {}
 ) {
   const stats = getStats(statsFilePath);
@@ -54,5 +56,5 @@ module.exports = function defaultCommand(
   });
 
   const limit = pattern ? 0 : flags.limit >= 0 ? flags.limit : 20;
-  print(modules, report.chunks, flags, limit);
+  reporter.print(modules, report.chunks, flags, limit);
 };
diff --git a/lib/console/__tests__/__snapshots__/progress-bar.js.md b/lib/console/__tests__/__snapshots__/progress-bar.js.md
@@ -10,7 +10,7 @@ Generated by [AVA](https://ava.li).
 
     [
       `␍
-                                                                                                         `,
+                                                                                                          `,
       `␍
       `,
       '⸨░░░░░░░░░░░░░░░░░░░░⸩ 0% • info ',
@@ -22,14 +22,14 @@ Generated by [AVA](https://ava.li).
 
     [
       `␍
-                                                                                                         `,
+                                                                                                          `,
       `␍
       `,
       '⸨                    ⸩ 100% • info ',
       `␍
       `,
       `␍
-                                                                                                         `,
+                                                                                                          `,
     ]
 
 ## should output correct progress for {"progress":30,"title":"title","text":"text"}
@@ -38,7 +38,7 @@ Generated by [AVA](https://ava.li).
 
     [
       `␍
-                                                                                                         `,
+                                                                                                          `,
       `␍
       `,
       '⸨      ░░░░░░░░░░░░░░⸩ 30% • info title: text',
@@ -50,7 +50,7 @@ Generated by [AVA](https://ava.li).
 
     [
       `␍
-                                                                                                         `,
+                                                                                                          `,
       `␍
       `,
       '⸨          ░░░░░░░░░░⸩ 50% • info text',
@@ -62,7 +62,7 @@ Generated by [AVA](https://ava.li).
 
     [
       `␍
-                                                                                                         `,
+                                                                                                          `,
       `␍
       `,
       '⸨               ░░░░░⸩ 75% • info title: ',

diff --git a/lib/console/__tests__/__snapshots__/progress-bar.js.snap b/lib/console/__tests__/__snapshots__/progress-bar.js.snap
diff --git a/lib/console/progress-bar.js b/lib/console/progress-bar.js
@@ -12,7 +12,7 @@ function toStartOfLine(stdout /*: stream$Writable */) {
 
 function clearLine(stdout /*: stream$Writable */) {
   // $FlowFixMe: investigate process.stderr.columns flow error
-  stdout.write(`\r${" ".repeat(stdout.columns - 1)}`);
+  stdout.write(`\r${" ".repeat(stdout.columns)}`);
 }
 
 function selectPrevLine(stdout /*: stream$Writable */) {

diff --git a/lib/index.js b/lib/index.js
@@ -1,7 +1,7 @@
 /* @flow */
 
 const analyze = require("./analyze");
-const print = require("./print");
+const reporter = require("./reporter");
 const getStats = require("./get-stats");
 
-module.exports = { analyze, print, getStats };
+module.exports = { analyze, reporter, getStats };