Customize markdown formatter

compat/eslint-formatter-markdown/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sven Piller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

compat/eslint-formatter-markdown/index.js

@@ -0,0 +1,2 @@
+'use strict';
+module.exports = require('path').join(__dirname, 'markdown.js');

compat/eslint-formatter-markdown/markdown.js

@@ -0,0 +1,301 @@
+/**
+ * @fileoverview Markdown reporter (based on HTML reporter by Julian Laval)
+ * @author Sven Piller
+ */
+'use strict';
+
+/* eslint no-sync: 0, func-names:0 */
+var lodash = require('lodash');
+var fs = require('fs');
+var path = require('path');
+
+var files = {
+  tmplPage: 'templates/md-template-page.md',
+  tmplResult: 'templates/md-template-result.md',
+  tmplTH: 'templates/md-template-message.table-header.md',
+  tmplTR: 'templates/md-template-message.table-row.md',
+  tmplStats: 'templates/md-template-stats.md',
+  tmplStatsRow: 'templates/md-template-stats-row.md'
+};
+
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+var pageTemplate = lodash.template(fs.readFileSync(path.join(__dirname, files.tmplPage), 'utf-8'));
+var resultTemplate = lodash.template(fs.readFileSync(path.join(__dirname, files.tmplResult), 'utf-8'));
+var tableHeaderTemplate = lodash.template(fs.readFileSync(path.join(__dirname, files.tmplTH), 'utf-8'));
+var tableRowTemplate = lodash.template(fs.readFileSync(path.join(__dirname, files.tmplTR), 'utf-8'));
+var statsTemplate = lodash.template(fs.readFileSync(path.join(__dirname, files.tmplStats), 'utf-8'));
+var statsRowTemplate = lodash.template(fs.readFileSync(path.join(__dirname, files.tmplStatsRow), 'utf-8'));
+
+/**
+ * Given a word and a count, append an s if count is not one.
+ * @param {string} word A word in its singular form.
+ * @param {int} count A number controlling whether word should be pluralized.
+ * @returns {string} The original word with an s on the end if count is not one.
+ */
+function pluralize(word, count) {
+  return (count === 1 ? word : word + 's');
+}
+
+/**
+ * Renders text along the template of x problems (x errors, x warnings)
+ * @param {string} totalErrors Total errors
+ * @param {string} totalWarnings Total warnings
+ * @returns {string} The formatted string, pluralized where necessary
+ */
+function renderSummary(totalErrors, totalWarnings) {
+  var totalProblems = totalErrors + totalWarnings;
+  var renderedText = totalProblems + ' ' + pluralize('problem', totalProblems);
+
+  if (totalProblems !== 0) {
+    renderedText += ' (' + totalErrors + ' ' + pluralize('error', totalErrors) + ', ' + totalWarnings + ' ' + pluralize('warning', totalWarnings) + ')';
+  }
+  return renderedText;
+}
+
+/**
+ * Renders MARKDOWN for stats
+ * @param {Object} stats the rules and their stats
+ * @returns {string} The formatted string, pluralized where necessary
+ */
+function renderStats(stats) {
+
+  /**
+   * Creates table Header if necessary
+   * @param {string} type error or warning
+   * @returns {string} The formatted string
+   */
+  function injectHeader(type) {
+    return (stats[type]) ? '| SWC | count | visual |\n| --- | --- | --- |\n' : '';
+  }
+
+  /**
+   * renders templates for each rule
+   * @param {string} type error or warning
+   * @returns {string} The formatted string, pluralized where necessary
+   */
+  function output(type) {
+    var statstype = stats[type];
+    return injectHeader(type) + lodash.map(statstype, function (ruleStats, ruleId) {
+      return statsRowTemplate({
+        ruleId: ruleId,
+        ruleCount: ruleStats,
+        visual: lodash.repeat('X', lodash.min([ruleStats, 20]))
+      });
+    }, '').join('');
+  }
+
+  /**
+   * render template for severity
+   * @param {string} type severity
+   * @returns {string} template
+   */
+  function renderTemplate(type) {
+    var lcType = lodash.lowerCase(type);
+    if (lodash.size(stats[lcType])) {
+      return statsTemplate({
+        title: '### ' + type,
+        items: output(lcType)
+      });
+    } else {
+      return '';
+    }
+  }
+
+  return renderTemplate('Errors') + renderTemplate('Warnings');
+}
+
+/**
+ * Get the color based on whether there are errors/warnings...
+ * @param {string} totalErrors Total errors
+ * @param {string} totalWarnings Total warnings
+ * @returns {string} The color code (0 = green, 1 = yellow, 2 = red)
+ */
+function renderColor(totalErrors, totalWarnings) {
+  if (totalErrors !== 0) {
+    return 2;
+  } else if (totalWarnings !== 0) {
+    return 1;
+  }
+  return 0;
+}
+
+
+var SEVERTITY_NAME = ['OK', 'Warning', 'Error'];
+
+/**
+ * Get the color based on whether there are errors/warnings...
+ * @param {string} totalErrors Total errors
+ * @param {string} totalWarnings Total warnings
+ * @returns {string} The color code ('' = green, 'Warning' = yellow, 'Error' = red)
+ */
+function renderSummaryColor(totalErrors, totalWarnings) {
+  return SEVERTITY_NAME[renderColor(totalErrors, totalWarnings)];
+}
+
+/**
+ * Get table header for the message table.
+ * @param {Array} messages Messages.
+ * @returns {string} markdown (table header)
+ */
+function renderHeaders(messages) {
+  return (messages.length) ? tableHeaderTemplate() : '';
+}
+
+/**
+ * Sorts the result files after severity in following order:
+ *
+ *   - Error
+ *   - Warning
+ *
+ * @param {Array}   messages  Messages.
+ * @returns {Array}           Sorted messages.
+ */
+function sortMessages(messages) {
+  var fileArray = {
+    error: [],
+    warning: []
+  };
+
+  messages.forEach(function (message) {
+    if (message.severity === 1) {
+      fileArray.warning.push(message);
+    } else {
+      fileArray.error.push(message);
+    }
+  });
+
+  return lodash.concat(fileArray.error, fileArray.warning);
+}
+
+
+/**
+ * Get MARKDOWN (table rows) describing the messages.
+ * @param {Array} messages Messages.
+ * @param {int} parentIndex Index of the parent MARKDOWN row.
+ * @returns {string} MARKDOWN (table rows) describing the messages.
+ */
+function renderMessages(messages, parentIndex) {
+  messages = sortMessages(messages);
+
+  /**
+   * Get MARKDOWN (table row) describing a message.
+   * @param {Object} message Message.
+   * @returns {string} MARKDOWN (table row) describing a message.
+   */
+  return lodash.map(messages, function (message) {
+    var lineNumber = message.line || 0;
+    var columnNumber = message.column || 0;
+
+    return tableRowTemplate({
+      parentIndex: parentIndex,
+      lineNumber: lineNumber,
+      columnNumber: columnNumber,
+      severityNumber: message.severity,
+      severityName: message.severity === 1 ? 'Warning' : 'Error',
+      message: message.message,
+      ruleId: message.ruleId
+    });
+  }).join('\n');
+}
+
+/**
+ * @param {Array} results Test results.
+ * @returns {string} MARKDOWN string describing the results.
+ */
+function renderResults(results) {
+  return lodash.map(results, function (result, index) {
+    return resultTemplate({
+      index: index,
+      color: renderColor(result.errorCount, result.warningCount),
+      filePath: result.filePath,
+      summary: renderSummary(result.errorCount, result.warningCount)
+
+    }) + renderHeaders(result.messages) + renderMessages(result.messages, index);
+  }).join('\n');
+}
+
+/**
+ * Sorts the result files after severity in following order:
+ *
+ *   - Error
+ *   - Warning
+ *   - Clean
+ *
+ * @param {Array}    results  results
+ * @returns {Array}           sorted results
+ */
+function sortResults(results) {
+  var fileArray = {
+    error: [],
+    warning: [],
+    clean: []
+  };
+  results.forEach(function (result) {
+    if (result.errorCount > 0) {
+      fileArray.error.push(result);
+    } else if (result.warningCount > 0) {
+      fileArray.warning.push(result);
+    } else {
+      fileArray.clean.push(result);
+    }
+  });
+  return lodash.concat(fileArray.error, fileArray.warning, fileArray.clean);
+}
+
+/**
+ * Calculate stats
+ * @param {Array}    results  results
+ * @returns {Object} stats
+ */
+function getStats(results) {
+
+  /**
+   * calculate stats for each severity
+   * @param {string} type  severity
+   * @returns {Object} stats
+   */
+  function filterMessages(type) {
+    return lodash(results)
+      .map('messages')
+      .flatten()
+      .filter(function (message) { return message.severity === type; })
+      .groupBy('ruleId')
+      .mapValues(function (ruleMessages) {
+        return ruleMessages.length;
+      })
+      .value();
+  }
+  return {
+    errors: filterMessages(2),
+    warnings: filterMessages(1)
+  };
+}
+
+//------------------------------------------------------------------------------
+// Public Interface
+//------------------------------------------------------------------------------
+
+module.exports = function (results) {
+  var totalErrors = 0;
+  var totalWarnings = 0;
+  var stats = getStats(results);
+
+  // Iterate over results to get totals
+  results.forEach(function (result) {
+    totalErrors += result.errorCount;
+    totalWarnings += result.warningCount;
+  });
+  results = sortResults(results);
+
+  return pageTemplate({
+    date: new Date(),
+    reportColor: renderSummaryColor(totalErrors, totalWarnings),
+    reportSummary: renderSummary(totalErrors, totalWarnings),
+    results: renderResults(results),
+    stats: renderStats(stats)
+  });
+};

compat/eslint-formatter-markdown/templates/md-template-message.inline.md

@@ -0,0 +1 @@
+- ```<%= severityName %>``` <%= lineNumber %>:<%= columnNumber %> - <%- message %> - [<%= ruleId %>](https://smartcontractsecurity.github.io/SWC-registry/docs/<%= ruleId %>) 

compat/eslint-formatter-markdown/templates/md-template-message.table-header.md

@@ -0,0 +1,3 @@
+
+| Type | Line | Description | SWC |
+| --- | --- | --- | --- |

compat/eslint-formatter-markdown/templates/md-template-message.table-row.md

@@ -0,0 +1 @@
+| ```<%= severityName %>``` | <%= lineNumber %>:<%= columnNumber %> | <%- message %> | [<%= ruleId %>](https://smartcontractsecurity.github.io/SWC-registry/docs/<%= ruleId %>) |

compat/eslint-formatter-markdown/templates/md-template-page.md

@@ -0,0 +1,15 @@
+# MythX Report
+
+## Summary
+
+<%= reportSummary %>
+
+<%= stats %>
+
+## Details
+
+<%= results %>
+
+---
+
+Generated on <%= date %>

compat/eslint-formatter-markdown/templates/md-template-result.md

@@ -0,0 +1,2 @@
+
+### <%= filePath %> - <%= summary %>

compat/eslint-formatter-markdown/templates/md-template-stats-row.md

@@ -0,0 +1 @@
+| <%= ruleId %> | <%= ruleCount %> | <%= visual %> |

compat/eslint-formatter-markdown/templates/md-template-stats.md

@@ -0,0 +1,3 @@
+<%= title %>
+
+<%= items %>

helpers.js

@@ -45,7 +45,7 @@ function getFormatter(style) {
     const formatterName = style || 'stylish';
     try {
         if(formatterName == "markdown") {
-            return require('eslint-formatter-markdown/markdown')
+            return require('./compat/eslint-formatter-markdown/markdown')
         }
         return require(`eslint/lib/formatters/${formatterName}`);
     } catch (ex) {

package.json

@@ -7,10 +7,10 @@
     "armlet": "^2.6.0",
     "configstore": "^4.0.0",
     "debug": "^4.1.1",
-    "eslint-formatter-markdown": "^1.0.4",
     "find-cache-dir": "^2.1.0",
     "inquirer": "^6.2.2",
     "js-yaml": "^3.13.1",
+    "lodash": "^4.17.11",
     "mkdirp": "^0.5.1",
     "mocha": "^5.2.0",
     "multi-progress": "^2.0.0",