monocart-coverage-reports 2.4.4 → 2.5.1

package/lib/platform/share.js

@@ -4,65 +4,6 @@ const Util = {
     tagPattern: /(\s*)@([^@\s]+)(\s*)/g,
     lineBreakPattern: /\r\n|[\r\n\u2028\u2029]/gu,
 
-    attachments: {
-        audit: {
-            name: 'audit',
-            contentType: 'text/html',
-            reportFile: 'audit-report.json'
-        },
-        coverage: {
-            name: 'coverage',
-            contentType: 'text/html',
-            reportFile: 'coverage-report.json'
-        },
-        network: {
-            name: 'network',
-            contentType: 'text/html',
-            reportFile: 'network-report.json'
-        },
-        // artifact will be removed finally
-        artifact: {
-            name: 'artifact',
-            contentType: 'application/json'
-        }
-    },
-
-    pageTimings: [{
-        key: 'onContentLoad',
-        name: 'Content Loaded',
-        color: '#1a1aa6'
-    }, {
-        key: 'onLoad',
-        name: 'Page Loaded',
-        color: '#c80000'
-    }],
-
-    timings: [{
-        key: 'blocked',
-        name: 'Blocking',
-        color: '#858585'
-    }, {
-        key: 'dns',
-        name: 'DNS Lookup',
-        color: '#009688'
-    }, {
-        key: 'connect',
-        name: 'Connecting',
-        color: '#b52dcd'
-    }, {
-        key: 'send',
-        name: 'Sending',
-        color: '#74979a'
-    }, {
-        key: 'wait',
-        name: 'Waiting',
-        color: '#00a846'
-    }, {
-        key: 'receive',
-        name: 'Receiving',
-        color: '#0299de'
-    }],
-
     hasOwn: function(obj, key) {
         return Object.prototype.hasOwnProperty.call(obj, key);
     },
@@ -190,6 +131,20 @@ const Util = {
 
     // =============================================================================
 
+    getMetrics: (type, metrics) => {
+        const istanbulMetrics = ['statements', 'branches', 'functions', 'lines'];
+        const v8Metrics = ['bytes'].concat(istanbulMetrics);
+        const allMetrics = type === 'v8' ? v8Metrics : istanbulMetrics;
+        let list = allMetrics;
+        if (Util.isList(metrics)) {
+            const newList = list.filter((k) => metrics.includes(k));
+            if (newList.length) {
+                list = newList;
+            }
+        }
+        return list;
+    },
+
     generatePercentChart: function(percent) {
         return `<div style="--mcr-percent:${percent}%;" class="mcr-percent-chart"></div>`;
     },
@@ -409,6 +364,10 @@ const Util = {
         return `${Util.dFixed(px)},${Util.dFixed(py)}`;
     },
 
+    capitalizeFirstLetter: (string) => {
+        return string.charAt(0).toUpperCase() + string.slice(1);
+    },
+
     // =============================================================================
     // formatter
 

package/lib/utils/util.js

@@ -409,6 +409,19 @@ const Util = {
         return template;
     },
 
+    getColorStrByStatus: (str, status) => {
+        if (status === 'low') {
+            return EC.red(str);
+        }
+        if (status === 'medium') {
+            return EC.yellow(str);
+        }
+        if (status === 'high') {
+            return EC.green(str);
+        }
+        return str;
+    },
+
     // ==========================================================================================
 
     loggingLevels: {

package/lib/v8/v8.js

@@ -1,4 +1,6 @@
 const path = require('path');
+const CG = require('console-grid');
+const EC = require('eight-colors');
 const Util = require('../utils/util.js');
 const { getV8Summary } = require('./v8-summary.js');
 const { dedupeFlatRanges } = require('../utils/dedupe.js');
@@ -233,7 +235,212 @@ const mergeV8Coverage = async (dataList, sourceCache, options) => {
 
 // ============================================================
 
-const saveCodecovReport = async (reportData, reportOptions, options) => {
+const mergeSingleSubGroups = (item) => {
+
+    if (!item.subs) {
+        return;
+    }
+    if (item.subs.length === 1) {
+        const sub = item.subs[0];
+        if (!sub.subs) {
+            return;
+        }
+        item.name = [item.name, sub.name].filter((it) => it).join('/');
+        item.subs = sub.subs;
+        mergeSingleSubGroups(item);
+        return;
+    }
+
+    item.subs.forEach((sub) => {
+        mergeSingleSubGroups(sub);
+    });
+
+};
+
+const getRowData = (rowName, summary, metrics) => {
+    const summaryRow = {};
+    let lowest = {
+        pct: 100,
+        status: 'high'
+    };
+    metrics.map((k) => {
+        const s = summary[k];
+        const percent = s.pct;
+        if (typeof percent !== 'number') {
+            return;
+        }
+        summaryRow[k] = Util.getColorStrByStatus(Util.PSF(percent, 100, 2), s.status);
+        if (percent < lowest.pct) {
+            lowest = s;
+        }
+    });
+    summaryRow.name = Util.getColorStrByStatus(rowName, lowest.status);
+    return summaryRow;
+};
+
+const getUncoveredLines = (file) => {
+    const lines = [];
+
+    const dataLines = file.data.lines;
+
+    let startLine;
+    let endLine;
+
+    const addLines = () => {
+        if (!startLine) {
+            return;
+        }
+        if (endLine) {
+            // range
+            const link = startLine.color === 'yellow' && endLine.color === 'yellow' ? EC.yellow('-') : EC.red('-');
+            lines.push(EC[startLine.color](startLine.line) + link + EC[endLine.color](endLine.line));
+            startLine = null;
+            endLine = null;
+        } else {
+            // only start
+            lines.push(EC[startLine.color](startLine.line));
+            startLine = null;
+        }
+    };
+
+    const setLines = (line, color) => {
+        if (startLine) {
+            endLine = {
+                line,
+                color
+            };
+            return;
+        }
+        startLine = {
+            line,
+            color
+        };
+    };
+
+    Object.keys(dataLines).forEach((line) => {
+        const count = dataLines[line];
+        if (count === 0) {
+            setLines(line, 'red');
+            return;
+        }
+        // 0 < count < 1
+        if (typeof count === 'string') {
+            setLines(line, 'yellow');
+            return;
+        }
+        // count >= 1
+        addLines();
+    });
+    addLines();
+
+    return lines.join(',');
+};
+
+const getGroupedRows = (files, metrics, cdOptions) => {
+
+    const skipPercent = cdOptions.skipPercent;
+    if (typeof skipPercent === 'number' && skipPercent > 0) {
+        files = files.filter((file) => {
+            const { summary } = file;
+            for (const k of metrics) {
+                const percent = summary[k].pct;
+                if (typeof percent === 'number' && percent < skipPercent) {
+                    return true;
+                }
+            }
+            return false;
+        });
+    }
+
+    let groups = [];
+
+    files.forEach((file) => {
+        const { sourcePath, summary } = file;
+        const pathList = sourcePath.split('/');
+        const lastName = pathList.pop();
+        let subs = groups;
+        pathList.forEach((key) => {
+            const item = subs.find((it) => it.name === key && it.subs);
+            if (item) {
+                subs = item.subs;
+                return;
+            }
+            const sub = {
+                name: key,
+                subs: []
+            };
+            subs.push(sub);
+            subs = sub.subs;
+        });
+        const fileRow = getRowData(lastName, summary, metrics);
+        fileRow.uncoveredLines = getUncoveredLines(file);
+        subs.push(fileRow);
+    });
+
+    const group = {
+        subs: groups
+    };
+    mergeSingleSubGroups(group);
+
+    if (group.name) {
+        groups = [group];
+    }
+
+    return groups;
+};
+
+const handleConsoleDetailsReport = (reportData, reportOptions, options) => {
+    const cdOptions = {
+        maxCols: 50,
+        skipPercent: 0,
+        metrics: [],
+        ... reportOptions
+    };
+
+    const {
+        name, summary, files
+    } = reportData;
+
+    if (name) {
+        EC.logCyan(name);
+    }
+
+    const metrics = Util.getMetrics('v8', cdOptions.metrics);
+    const rows = getGroupedRows(files, metrics, cdOptions);
+    const summaryRow = getRowData('Summary', summary, metrics);
+    // no rows if skipped all by skipPercent
+    if (rows.length) {
+        rows.push({
+            innerBorder: true
+        });
+    }
+    rows.push(summaryRow);
+
+    const columns = [{
+        id: 'name',
+        name: 'Name'
+    }, ... metrics.map((m) => {
+        return {
+            id: m,
+            name: Util.capitalizeFirstLetter(m),
+            align: 'right'
+        };
+    }), {
+        id: 'uncoveredLines',
+        name: 'Uncovered Lines'
+    }];
+
+    CG({
+        options: {
+            nullPlaceholder: '',
+            defaultMaxWidth: cdOptions.maxCols
+        },
+        columns,
+        rows
+    });
+};
+
+const handleCodecovReport = async (reportData, reportOptions, options) => {
     const codecovOptions = {
         outputFile: 'codecov.json',
         ... reportOptions
@@ -255,7 +462,7 @@ const saveCodecovReport = async (reportData, reportOptions, options) => {
     return Util.relativePath(jsonPath);
 };
 
-const saveV8JsonReport = async (reportData, reportOptions, options) => {
+const handleV8JsonReport = async (reportData, reportOptions, options) => {
     const v8JsonOptions = {
         outputFile: 'coverage-report.json',
         ... reportOptions
@@ -268,7 +475,7 @@ const saveV8JsonReport = async (reportData, reportOptions, options) => {
 };
 
 
-const saveV8HtmlReport = async (reportData, reportOptions, options) => {
+const handleV8HtmlReport = async (reportData, reportOptions, options) => {
 
     // V8 only options, merged with root options
     const v8HtmlOptions = {
@@ -340,9 +547,10 @@ const saveV8Report = async (v8list, options) => {
 
     // v8 reports
     const buildInV8Reports = {
-        'v8': saveV8HtmlReport,
-        'v8-json': saveV8JsonReport,
-        'codecov': saveCodecovReport
+        'v8': handleV8HtmlReport,
+        'v8-json': handleV8JsonReport,
+        'codecov': handleCodecovReport,
+        'console-details': handleConsoleDetailsReport
     };
 
     const outputs = {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-coverage-reports",
-    "version": "2.4.4",
+    "version": "2.5.1",
     "description": "Monocart coverage reports",
     "main": "./lib/index.js",
     "bin": {
@@ -54,7 +54,7 @@
         "url": "git+https://github.com/cenfun/monocart-coverage-reports.git"
     },
     "dependencies": {
-        "console-grid": "~2.1.0",
+        "console-grid": "~2.2.1",
         "eight-colors": "~1.2.1",
         "istanbul-lib-coverage": "~3.2.2",
         "istanbul-lib-report": "~3.0.1",