Add prettyPrintSummary()

package.json

@@ -68,7 +68,8 @@
     "remark-preset-lint-recommended": "^2.0.0",
     "stylelint": "^7.9.0",
     "stylelint-config-standard": "^16.0.0",
-    "w3cjs": "^0.3.0"
+    "w3cjs": "^0.3.0",
+    "wordwrap": "^1.0.0"
   },
   "files": [
     "bin/",

src/cli.js

@@ -5,10 +5,11 @@
 const fs = require("fs");
 
 const Bluebird = require("bluebird");
+const R = require("ramda");
 
 const lints = require("./lints");
 const report = require("./report");
-const prettyPrintWarnings = require("./pretty-print-warnings");
+const prettyPrintReport = require("./pretty-print-report");
 
 Bluebird.promisifyAll(fs);
 
@@ -22,10 +23,11 @@ module.exports = function cli({
         .then(JSON.parse)
         .then((config) => lints(config, lintersDirectory))
         .then(report)
-        .then(prettyPrintWarnings)
-        .tap(log)
-        .then(function setAndReturnExitCode(output) {
-            process.exitCode = Number(output.length > 0);
+        .tap(
+            R.pipe(prettyPrintReport, log)
+        )
+        .then(function setAndReturnExitCode({numbers}) {
+            process.exitCode = Number(numbers.totalWarnings > 0);
 
             return process.exitCode;
         })

src/pretty-print-report.js

@@ -0,0 +1,18 @@
+/*jslint node, es6, maxlen: 80 */
+
+"use strict";
+
+const R = require("ramda");
+
+const prettyPrintWarnings = require("./pretty-print-warnings");
+const prettyPrintSummary = require("./pretty-print-summary");
+
+module.exports = function prettyPrintReport(report) {
+    return R.pipe(
+        R.reject(R.isEmpty),
+        R.join("\n")
+    )([
+        prettyPrintWarnings(report),
+        prettyPrintSummary(report)
+    ]);
+};

src/pretty-print-summary.js

@@ -0,0 +1,21 @@
+/*jslint node, es6, maxlen: 80 */
+
+"use strict";
+
+const wordwrap = require("wordwrap");
+
+const maxLineLength = 80;
+
+const wrapTo80 = wordwrap(maxLineLength);
+
+module.exports = function prettyPrintSummary({numbers, usedLinters}) {
+    return usedLinters.length > 0
+        ? wrapTo80(`Used linters: ${usedLinters.join(", ")}
+
+Total files checked: ${numbers.totalFiles}
+Files with warnings: ${numbers.filesWithWarnings}
+
+Total warnings: ${numbers.totalWarnings}
+`)
+        : "Nothing to check\n";
+};

test/cli.js

@@ -16,8 +16,15 @@ test("cli()", function (t) {
             `test/stubs/bad.js (JSLint)
     line 0 column 11
         Expected ';' and instead saw '(end)'. (expected_a_b)
+
+Used linters: JSLint
+
+Total files checked: 1
+Files with warnings: 1
+
+Total warnings: 1
 `,
-            "should log warnings"
+            "should log warnings and summary"
         );
     }
 
@@ -54,3 +61,26 @@ test("cli()", function (t) {
             process.exitCode = 0;
         });
 });
+
+test("cli()", function (t) {
+    t.plan(3);
+
+    function log(result) {
+        return t.strictSame(
+            result,
+            "Nothing to check\n",
+            "should log summary"
+        );
+    }
+
+    return cli({
+        rcFile: "test/stubs/.lints-nothing-to-check.json",
+        log,
+        lintersDirectory: "./linters/"
+    })
+        // eslint-disable-next-line promise/always-return
+        .then(function (exitCode) {
+            t.strictSame(exitCode, 0);
+            t.strictSame(process.exitCode, 0);
+        });
+});

test/pretty-print-summary.js

@@ -0,0 +1,82 @@
+/*jslint node, es6, maxlen: 80 */
+/*eslint "func-names": "off" */
+
+"use strict";
+
+const {test} = require("tap");
+
+const prettyPrintSummary = require("../src/pretty-print-summary");
+
+test("prettyPrintSummary()", function (t) {
+    const result = prettyPrintSummary({
+        numbers: {
+            totalFiles: 15,
+            filesWithWarnings: 4,
+            totalWarnings: 8
+        },
+        usedLinters: ["linterA", "linterB"]
+    });
+
+    t.strictSame(
+        result,
+        `Used linters: linterA, linterB
+
+Total files checked: 15
+Files with warnings: 4
+
+Total warnings: 8
+`,
+        "should pretty print summary"
+    );
+
+    t.end();
+});
+
+test("prettyPrintSummary()", function (t) {
+    const resultWithoutFiles = prettyPrintSummary({usedLinters: []});
+
+    t.strictSame(
+        resultWithoutFiles,
+        "Nothing to check\n",
+        "should pretty print if there were no used linters"
+    );
+
+    t.end();
+});
+
+test("prettyPrintSummary()", function (t) {
+    const result = prettyPrintSummary({
+        numbers: {
+            totalFiles: 15,
+            filesWithWarnings: 4,
+            totalWarnings: 8
+        },
+        usedLinters: [
+            "linterNameA",
+            "linterNameB",
+            "linterNameC",
+            "longLinterNameD",
+            "linterNameE",
+            "linterNameF",
+            "linterNameG",
+            "linterNameH",
+            "linterNameI",
+            "linterNameJ"
+        ]
+    });
+
+    t.strictSame(
+        result,
+        `Used linters: linterNameA, linterNameB, linterNameC, longLinterNameD,
+linterNameE, linterNameF, linterNameG, linterNameH, linterNameI, linterNameJ
+
+Total files checked: 15
+Files with warnings: 4
+
+Total warnings: 8
+`,
+        "should wrap lines to 80 characters"
+    );
+
+    t.end();
+});

test/stubs/.lints-nothing-to-check.json

@@ -0,0 +1,7 @@
+{
+    "jslint": {
+        "files": [
+            "nonexistent"
+        ]
+    }
+}