feat(reports): add line colorMetric option

Makes the report highlight the lines according to the chosen metric.
istanbuljs · May 13, 2021 · 029594c · 029594c
1 parent c155900
commit 029594c
Show file tree

Hide file tree

Showing 3 changed files with 334 additions and 3 deletions.
diff --git a/packages/istanbul-reports/lib/html/index.js b/packages/istanbul-reports/lib/html/index.js
@@ -154,7 +154,7 @@ const summaryTableHeader = [
 ].join('\n');
 
 function summaryLineTemplate(details) {
-    const { reportClasses, metrics, file, output } = details;
+    const { reportClasses, metrics, colorMetric, file, output } = details;
     const percentGraph = pct => {
         if (!isFinite(pct)) {
             return '';
@@ -193,7 +193,7 @@ function summaryLineTemplate(details) {
         .concat(
             '<tr>',
             `<td class="file ${
-                reportClasses.statements
+                reportClasses[colorMetric ? colorMetric : 'statements']
             }" data-value="${html.escape(file)}"><a href="${html.escape(
                 output
             )}">${html.escape(file)}</a></td>`,
@@ -259,6 +259,7 @@ class HtmlReport extends ReportBase {
         this.subdir = opts.subdir || '';
         this.date = Date();
         this.skipEmpty = opts.skipEmpty;
+        this.colorMetric = opts.colorMetric;
     }
 
     getBreadcrumbHtml(node) {
@@ -354,6 +355,7 @@ class HtmlReport extends ReportBase {
         const templateData = this.getTemplateData();
         const children = node.getChildren();
         const skipEmpty = this.skipEmpty;
+        const colorMetric = this.colorMetric;
 
         this.fillTemplate(node, templateData, context);
         const cw = this.getWriter(context).writeFile(linkMapper.getPath(node));
@@ -388,6 +390,7 @@ class HtmlReport extends ReportBase {
             const data = {
                 metrics: isEmpty ? fixPct(metrics) : metrics,
                 reportClasses,
+                colorMetric,
                 file: child.getRelativeName(),
                 output: linkMapper.relativePath(node, child)
             };

diff --git a/packages/istanbul-reports/lib/text/index.js b/packages/istanbul-reports/lib/text/index.js
@@ -181,6 +181,7 @@ function tableRow(
     level,
     skipEmpty,
     skipFull,
+    colorMetric,
     missingWidth
 ) {
     const name = nodeName(node);
@@ -208,7 +209,12 @@ function tableRow(
           };
     const elements = [];
 
-    elements.push(colorize(formatName(name, maxNameCols, level), 'statements'));
+    elements.push(
+        colorize(
+            formatName(name, maxNameCols, level),
+            colorMetric ? colorMetric : 'statements'
+        )
+    );
     elements.push(colorize(formatPct(mm.statements), 'statements'));
     elements.push(colorize(formatPct(mm.branches, PCT_COLS + 1), 'branches'));
     elements.push(colorize(formatPct(mm.functions), 'functions'));
@@ -235,6 +241,7 @@ class TextReport extends ReportBase {
         this.cw = null;
         this.skipEmpty = opts.skipEmpty;
         this.skipFull = opts.skipFull;
+        this.colorMetric = opts.colorMetric;
     }
 
     onStart(root, context) {
@@ -278,6 +285,7 @@ class TextReport extends ReportBase {
             nodeDepth,
             this.skipEmpty,
             this.skipFull,
+            this.colorMetric,
             this.missingWidth
         );
         if (row) {