feat: add skip-empty option for html & text reports (#140)

packages/istanbul-lib-coverage/lib/file.js

@@ -96,6 +96,13 @@ CoverageSummary.prototype.toJSON = function () {
     return this.data;
 };
 
+/**
+ * return true if summary has no lines of code
+ */
+CoverageSummary.prototype.isEmpty = function () {
+  return this.lines.total === 0;
+};
+
 // returns a data object that represents empty coverage
 function emptyCoverage(filePath) {
     return {

packages/istanbul-lib-coverage/test/file.test.js

@@ -101,6 +101,11 @@ describe('coverage summary', function () {
         });
         assert.equal(data.branches.pct, 100);
     });
+
+    it('isEmpty() by default', function () {
+      var cs = new CoverageSummary();
+      assert.equal(cs.isEmpty(), true);
+    });
 });
 
 describe('base coverage', function () {

packages/istanbul-reports/lib/html/assets/base.css

@@ -183,6 +183,14 @@ table.coverage td span.cline-any {
 span.cline-neutral { background: #eaeaea; }
 .medium { background: #eaeaea; }
 
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
 .cover-fill, .cover-empty {
   display:inline-block;
   height: 12px;

packages/istanbul-reports/lib/html/index.js

@@ -57,7 +57,13 @@ var fs = require('fs'),
         '</tbody>',
         '</table>',
         '</div>'
-    ].join('\n');
+    ].join('\n'),
+    emptyClasses = {
+        statements: 'empty',
+        lines: 'empty',
+        functions: 'empty',
+        branches: 'empty'
+    };
 
 helpers.registerHelpers(handlebars);
 
@@ -139,6 +145,7 @@ function HtmlReport(opts) {
     this.linkMapper = opts.linkMapper || standardLinkMapper;
     this.subdir = opts.subdir || '';
     this.date = Date();
+    this.skipEmpty = opts.skipEmpty;
 }
 
 HtmlReport.prototype.getTemplateData = function () {
@@ -177,10 +184,18 @@ HtmlReport.prototype.onStart = function (root, context) {
     });
 };
 
+function fixPct(metrics) {
+    Object.keys(emptyClasses).forEach(function(key) {
+        metrics[key].pct = 0;
+    });
+    return metrics;
+}
+
 HtmlReport.prototype.onSummary = function (node, context) {
     var linkMapper = this.linkMapper,
         templateData = this.getTemplateData(),
         children = node.getChildren(),
+        skipEmpty = this.skipEmpty,
         cw;
 
     fillTemplate(node, templateData, linkMapper, context);
@@ -189,14 +204,16 @@ HtmlReport.prototype.onSummary = function (node, context) {
     cw.write(summaryTableHeader);
     children.forEach(function (child) {
         var metrics = child.getCoverageSummary(),
-            reportClasses = {
+            isEmpty = metrics.isEmpty();
+        if (skipEmpty && isEmpty) { return; }
+        var reportClasses = isEmpty ? emptyClasses : {
                 statements: context.classForPercent('statements', metrics.statements.pct),
                 lines: context.classForPercent('lines', metrics.lines.pct),
                 functions: context.classForPercent('functions', metrics.functions.pct),
                 branches: context.classForPercent('branches', metrics.branches.pct)
             },
             data = {
-                metrics: metrics,
+                metrics: isEmpty ? fixPct(metrics) : metrics,
                 reportClasses: reportClasses,
                 file: child.getRelativeName(),
                 output: linkMapper.relativePath(node, child)

packages/istanbul-reports/lib/text/index.js

@@ -127,16 +127,18 @@ function missingBranches (node, colorizer) {
     return colorizer(formatPct(missingLines.join(','), MISSING_COL), 'medium');
 }
 
-function tableRow(node, context, colorizer, maxNameCols, level) {
+function tableRow(node, context, colorizer, maxNameCols, level, skipEmpty) {
     var name = nodeName(node),
         metrics = node.getCoverageSummary(),
-        mm = {
-            statements: metrics.statements.pct,
-            branches: metrics.branches.pct,
-            functions: metrics.functions.pct,
-            lines: metrics.lines.pct,
+        isEmpty = metrics.isEmpty();
+    if (skipEmpty && isEmpty) { return ''; }
+    var mm = {
+            statements: isEmpty ? 0 : metrics.statements.pct,
+            branches: isEmpty ? 0 : metrics.branches.pct,
+            functions: isEmpty ? 0 : metrics.functions.pct,
+            lines: isEmpty ? 0 : metrics.lines.pct,
         },
-        colorize = function (str, key) {
+        colorize = isEmpty ? function(str){ return str; } : function (str, key) {
             return colorizer(str, context.classForPercent(key, mm[key]));
         },
         elements = [];
@@ -159,6 +161,7 @@ function TextReport(opts) {
     this.file = opts.file || null;
     this.maxCols = opts.maxCols || 0;
     this.cw = null;
+    this.skipEmpty = opts.skipEmpty;
 }
 
 TextReport.prototype.onStart = function (root, context) {
@@ -182,7 +185,8 @@ TextReport.prototype.onStart = function (root, context) {
 
 TextReport.prototype.onSummary = function (node, context) {
     var nodeDepth = depthFor(node);
-    this.cw.println(tableRow(node, context, this.cw.colorize.bind(this.cw),this.nameWidth, nodeDepth));
+    var row = tableRow(node, context, this.cw.colorize.bind(this.cw),this.nameWidth, nodeDepth, this.skipEmpty);
+    if (row) { this.cw.println(row); }
 };
 
 TextReport.prototype.onDetail = function (node, context) {

packages/istanbul-reports/test/fixtures/specs/empty-file-skip-empty.json

@@ -0,0 +1,18 @@
+{
+  "title": "empty file - skip empty",
+  "opts": {
+    "skipEmpty": true
+  },
+  "textReportExpected": "----------|----------|----------|----------|----------|----------------|\nFile      |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |\n----------|----------|----------|----------|----------|----------------|\n----------|----------|----------|----------|----------|----------------|\n",
+  "map": {
+    "/dev/git/istanbuljs/packages/istanbul-reports/lib/text/empty.js": {
+      "path": "/dev/git/istanbuljs/packages/istanbul-reports/lib/text/empty.js",
+      "statementMap": {},
+      "fnMap": {},
+      "branchMap": {},
+      "s": {},
+      "f": {},
+      "b": {}
+    }
+  }
+}

packages/istanbul-reports/test/fixtures/specs/empty-file.json

@@ -0,0 +1,15 @@
+{
+  "title": "empty file - show 0%",
+  "textReportExpected": "----------|----------|----------|----------|----------|----------------|\nFile      |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |\n----------|----------|----------|----------|----------|----------------|\nAll files |        0 |        0 |        0 |        0 |\u001b[31;1m               \u001b[0m |\n empty.js |        0 |        0 |        0 |        0 |\u001b[31;1m               \u001b[0m |\n----------|----------|----------|----------|----------|----------------|\n",
+  "map": {
+    "/dev/git/istanbuljs/packages/istanbul-reports/lib/text/empty.js": {
+      "path": "/dev/git/istanbuljs/packages/istanbul-reports/lib/text/empty.js",
+      "statementMap": {},
+      "fnMap": {},
+      "branchMap": {},
+      "s": {},
+      "f": {},
+      "b": {}
+    }
+  }
+}

packages/istanbul-reports/test/text/index.js

@@ -31,7 +31,7 @@ describe('TextReport', function () {
             dir: './'
           });
           var tree = fixture.map;
-          var report = new TextReport(context);
+          var report = new TextReport(fixture.opts);
           tree.visit(report, context);
           var output = FileWriter.getOutput();
           output.should.equal(fixture.textReportExpected);