Add markdown output

Author: kriskbx

gtt-report.js

@@ -9,7 +9,8 @@ const Report = require('./models/report');
 
 const Output = {
     table: require('./output/table'),
-    csv: require('./output/csv')
+    csv: require('./output/csv'),
+    markdown: require('./output/markdown')
 };
 
 // this collects options

output/markdown.js

@@ -0,0 +1,65 @@
+const _ = require('underscore');
+
+const Table = require('markdown-table');
+const Base = require('./base');
+
+const format = {
+    headline: h => `\n### ${h}\n`,
+    warning: w => `> ${w}`
+};
+
+/**
+ * stdout table output
+ */
+class table extends Base {
+    constructor(config, report) {
+        super(config, report);
+        this.format = format;
+    }
+
+    makeStats() {
+        this.headline('TIME STATS');
+
+        let stats = '';
+
+        _.each(this.stats, (time, name) => stats += `\n* **${name}**: ${time}`);
+        _.each(this.users, (time, name) => stats += `\n* **${name}**: ${time}`);
+
+        this.write(stats.substr(1));
+    }
+
+    makeIssues() {
+        this.headline('ISSUES');
+
+        if (this.report.issues.length === 0)
+            return this.warning('No issues found');
+
+        let issues = [this.config.get('issueColumns')];
+        this.report.issues.forEach(issue => issues.push(this.prepare(issue, this.config.get('issueColumns'))));
+
+        this.write(Table(issues));
+    }
+
+    makeMergeRequests() {
+        this.headline('MERGE REQUESTS');
+
+        if (this.report.mergeRequests.length === 0)
+            return this.warning('No merge requests found');
+
+        let mergeRequests = [this.config.get('mergeRequestColumns')];
+        this.report.mergeRequests.forEach(mergeRequest => mergeRequests.push(this.prepare(mergeRequest, this.config.get('mergeRequestColumns'))));
+
+        this.write(Table(mergeRequests));
+    }
+
+    makeRecords() {
+        this.headline('TIME RECORDS');
+
+        let times = [this.config.get('recordColumns')];
+        this.times.forEach(time => times.push(this.prepare(time, this.config.get('recordColumns'))));
+
+        this.write(Table(times));
+    }
+}
+
+module.exports = table;

package.json

@@ -20,6 +20,7 @@
     "find-in-files": "^0.4.0",
     "got": "^6.7.1",
     "hashids": "^1.1.1",
+    "markdown-table": "^1.1.0",
     "moment": "^2.18.1",
     "node-spinner": "^0.0.4",
     "open": "^0.0.5",

readme.md

@@ -172,7 +172,7 @@ gtt report --exclude_labels=bug --exclude_labels=feature
 # include issues and merge requests in the report hat have no time records
 gtt report --show_without_times
 
-# choose a different output than a stdout table (json coming soon)
+# choose a different output than a stdout table
 gtt report --output=markdown --file=filename.md
 gtt report --output=csv --file=filename.csv
 ```
@@ -257,7 +257,7 @@ dateFormat: DD.MM.YYYY HH:mm:ss
 # -> use a comma instead of a dot for those float values
 timeFormat: "[%sign][%days>d ][%hours>h ][%minutes>m ][%seconds>s]"
 
-# default output
+# default output, available: csv, table, markdown
 output: markdown
 
 # exclude issues and merge requests that have the following labels

yarn.lock

@@ -213,6 +213,10 @@ lowercase-keys@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-1.0.0.tgz#4e3366b39e7f5457e35f1324bdf6f88d0bfc7306"
 
+markdown-table@^1.1.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-1.1.0.tgz#1f5ae61659ced8808d882554c32e8b3f38dd1143"
+
 mimic-fn@^1.0.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-1.1.0.tgz#e667783d92e89dbd342818b5230b9d62a672ad18"