monocart-coverage-reports 2.9.2 → 2.10.0

package/lib/utils/markdown.js

@@ -1,132 +1,132 @@
-const os = require('os');
-
-const renderLine = (ls, padding) => {
-    const spacing = ''.padEnd(padding, ' ');
-    const line = ls.join(`${spacing}|${spacing}`);
-    return `|${spacing}${line}${spacing}|`;
-};
-
-const renderCell = (cellValue, column) => {
-
-    // To include a pipe | as content within your cell, use a \ before the pipe:
-    cellValue = cellValue.split(/\\?\|/g).join('\\|');
-    const valueWidth = cellValue.length;
-    const width = column.width;
-
-    if (width <= valueWidth) {
-        return cellValue;
-    }
-
-    const spacingWidth = width - valueWidth;
-    const spacing = ''.padEnd(spacingWidth, ' ');
-
-    const align = column.align;
-
-    if (align === 'right') {
-        return spacing + cellValue;
-    }
-
-    if (align === 'center') {
-        const l = Math.round(spacingWidth * 0.5);
-        const r = spacingWidth - l;
-        const spacingL = ''.padEnd(l, ' ');
-        const spacingR = ''.padEnd(r, ' ');
-        return spacingL + cellValue + spacingR;
-
-    }
-
-    return cellValue + spacing;
-};
-
-const renderHyphen = (column) => {
-    const width = column.width;
-    const align = column.align;
-    if (align === 'right') {
-        return ':'.padStart(width, '-');
-    }
-    if (align === 'center') {
-        const hyphen = ''.padEnd(width - 2, '-');
-        return `:${hyphen}:`;
-    }
-    // default to left
-    return ':'.padEnd(width, '-');
-};
-
-const generateMarkdownGrid = (data) => {
-
-    const options = {
-        name: '',
-        padding: 1,
-        nullPlaceholder: '',
-        ... data.options
-    };
-
-    const padding = options.padding;
-
-    // console.log(data, options);
-
-    const lines = [];
-
-    if (options.name) {
-        lines.push(`## ${options.name}`);
-    }
-
-    // init columns
-    const columns = data.columns.map((item) => {
-        if (typeof item === 'string') {
-            item = {
-                name: item
-            };
-        }
-        const column = {
-            ... item
-        };
-        column.name = `${column.name}`;
-        if (typeof column.width !== 'number') {
-            column.width = column.name.length;
-        }
-        column.width = Math.max(column.width, 3);
-        return column;
-    });
-
-    // header
-    const headers = [];
-    columns.forEach((column) => {
-        headers.push(renderCell(column.name, column));
-    });
-    lines.push(renderLine(headers, padding));
-
-    const hyphens = [];
-    columns.forEach((column) => {
-        hyphens.push(renderHyphen(column));
-    });
-    lines.push(renderLine(hyphens, padding));
-
-    // rows
-    data.rows.forEach((row) => {
-        const cells = [];
-        columns.forEach((column, i) => {
-            let cellValue = '';
-            if (Array.isArray(row)) {
-                cellValue += row[i];
-            } else {
-                let v = row[column.id];
-                if (typeof v === 'undefined' || v === null) {
-                    v = options.nullPlaceholder;
-                }
-                if (column.formatter) {
-                    v = column.formatter(v, row, column);
-                }
-                cellValue += v;
-            }
-            cells.push(renderCell(cellValue, column));
-        });
-        lines.push(renderLine(cells, padding));
-    });
-
-    return lines.join(os.EOL) + os.EOL;
-
-};
-
-
-module.exports = generateMarkdownGrid;
+const os = require('os');
+
+const renderLine = (ls, padding) => {
+    const spacing = ''.padEnd(padding, ' ');
+    const line = ls.join(`${spacing}|${spacing}`);
+    return `|${spacing}${line}${spacing}|`;
+};
+
+const renderCell = (cellValue, column) => {
+
+    // To include a pipe | as content within your cell, use a \ before the pipe:
+    cellValue = cellValue.split(/\\?\|/g).join('\\|');
+    const valueWidth = cellValue.length;
+    const width = column.width;
+
+    if (width <= valueWidth) {
+        return cellValue;
+    }
+
+    const spacingWidth = width - valueWidth;
+    const spacing = ''.padEnd(spacingWidth, ' ');
+
+    const align = column.align;
+
+    if (align === 'right') {
+        return spacing + cellValue;
+    }
+
+    if (align === 'center') {
+        const l = Math.round(spacingWidth * 0.5);
+        const r = spacingWidth - l;
+        const spacingL = ''.padEnd(l, ' ');
+        const spacingR = ''.padEnd(r, ' ');
+        return spacingL + cellValue + spacingR;
+
+    }
+
+    return cellValue + spacing;
+};
+
+const renderHyphen = (column) => {
+    const width = column.width;
+    const align = column.align;
+    if (align === 'right') {
+        return ':'.padStart(width, '-');
+    }
+    if (align === 'center') {
+        const hyphen = ''.padEnd(width - 2, '-');
+        return `:${hyphen}:`;
+    }
+    // default to left
+    return ':'.padEnd(width, '-');
+};
+
+const generateMarkdownGrid = (data) => {
+
+    const options = {
+        name: '',
+        padding: 1,
+        nullPlaceholder: '',
+        ... data.options
+    };
+
+    const padding = options.padding;
+
+    // console.log(data, options);
+
+    const lines = [];
+
+    if (options.name) {
+        lines.push(`## ${options.name}`);
+    }
+
+    // init columns
+    const columns = data.columns.map((item) => {
+        if (typeof item === 'string') {
+            item = {
+                name: item
+            };
+        }
+        const column = {
+            ... item
+        };
+        column.name = `${column.name}`;
+        if (typeof column.width !== 'number') {
+            column.width = column.name.length;
+        }
+        column.width = Math.max(column.width, 3);
+        return column;
+    });
+
+    // header
+    const headers = [];
+    columns.forEach((column) => {
+        headers.push(renderCell(column.name, column));
+    });
+    lines.push(renderLine(headers, padding));
+
+    const hyphens = [];
+    columns.forEach((column) => {
+        hyphens.push(renderHyphen(column));
+    });
+    lines.push(renderLine(hyphens, padding));
+
+    // rows
+    data.rows.forEach((row) => {
+        const cells = [];
+        columns.forEach((column, i) => {
+            let cellValue = '';
+            if (Array.isArray(row)) {
+                cellValue += row[i];
+            } else {
+                let v = row[column.id];
+                if (typeof v === 'undefined' || v === null) {
+                    v = options.nullPlaceholder;
+                }
+                if (column.formatter) {
+                    v = column.formatter(v, row, column);
+                }
+                cellValue += v;
+            }
+            cells.push(renderCell(cellValue, column));
+        });
+        lines.push(renderLine(cells, padding));
+    });
+
+    return lines.join(os.EOL) + os.EOL;
+
+};
+
+
+module.exports = generateMarkdownGrid;

package/lib/utils/util.js

@@ -8,10 +8,8 @@ const EC = require('eight-colors');
 const CG = require('console-grid');
 const Share = require('../platform/share.js');
 const request = require('./request.js');
-const { deflateSync } = require('lz-utils');
-
+const version = require('../../package.json').version;
 const acornWalk = require('acorn-walk');
-
 const { findUpSync, supportsColor } = require('../packages/monocart-coverage-vendor.js');
 
 // https://github.com/chalk/supports-color
@@ -21,6 +19,8 @@ if (!supportsColor.stdout) {
 }
 
 const Util = {
+    version,
+
     ... Share,
 
     EC,
@@ -149,42 +149,6 @@ const Util = {
         return htmlPathHandler();
     },
 
-    resolveNodeModule: (id) => {
-
-        // for deno npm module
-        const mp = require.resolve(id);
-        if (fs.existsSync(mp)) {
-            return mp;
-        }
-
-        const p = `${it}/dist/${it}.js`;
-        // root
-        const cwd = path.resolve('node_modules', p);
-        if (fs.existsSync(cwd)) {
-            return cwd;
-        }
-
-        // sub node modules
-        const sub = path.resolve(__dirname, '../../node_modules', p);
-        if (fs.existsSync(sub)) {
-            return sub;
-        }
-
-        // same level dep
-        const dep = path.resolve(__dirname, '../../../', p);
-        if (fs.existsSync(dep)) {
-            return dep;
-        }
-
-        Util.logError(`Not found module: ${p}`);
-
-        return cwd;
-    },
-
-    resolvePackage: (p) => {
-        return path.resolve(__dirname, '../packages', p);
-    },
-
     getCacheFileInfo: (type, id, cacheDir) => {
         const cacheName = `${type}-${id}.json`;
         const cachePath = path.resolve(cacheDir, cacheName);
@@ -219,76 +183,6 @@ const Util = {
         // default config not found
     },
 
-    saveHtmlReport: async (options) => {
-
-        const {
-            inline,
-            reportData,
-            jsFiles,
-            assetsPath,
-            outputDir,
-            htmlFile,
-
-            reportDataFile
-        } = options;
-
-        //  report data
-        const reportDataCompressed = deflateSync(JSON.stringify(reportData));
-        const reportDataStr = `window.reportData = '${reportDataCompressed}';`;
-
-        // js libs
-        const jsList = [];
-        for (const jsFile of jsFiles) {
-            const jsStr = await Util.readFile(jsFile);
-            jsList.push({
-                filename: path.basename(jsFile),
-                str: jsStr
-            });
-        }
-
-        // html content
-        let htmlStr = '';
-        const EOL = Util.getEOL();
-        if (inline) {
-            htmlStr = [
-                '<script>',
-                reportDataStr,
-                ... jsList.map((it) => it.str),
-                '</script>'
-            ].join(EOL);
-        } else {
-
-            await Util.writeFile(path.resolve(outputDir, reportDataFile), reportDataStr);
-
-            const assetsDir = path.resolve(outputDir, assetsPath);
-            const relAssetsDir = Util.relativePath(assetsDir, outputDir);
-
-            for (const item of jsList) {
-                const filePath = path.resolve(assetsDir, item.filename);
-                if (!fs.existsSync(filePath)) {
-                    await Util.writeFile(filePath, item.str);
-                }
-            }
-
-            htmlStr = [
-                `<script src="${reportDataFile}"></script>`,
-                ... jsList.map((it) => `<script src="${relAssetsDir}/${it.filename}"></script>`)
-            ].join(EOL);
-        }
-
-        // html
-        const htmlPath = path.resolve(outputDir, htmlFile);
-        const template = Util.getTemplate(path.resolve(__dirname, '../default/template.html'));
-        const html = Util.replace(template, {
-            title: reportData.title,
-            content: htmlStr
-        });
-
-        await Util.writeFile(htmlPath, html);
-
-        return Util.relativePath(htmlPath);
-    },
-
     runCustomReporter: async (reportName, reportData, reportOptions, globalOptions) => {
         let CustomReporter;
         let err;
@@ -485,26 +379,16 @@ const Util = {
         }
     },
 
-    getTemplate: function(templatePath) {
-        if (!Util.templateCache) {
-            Util.templateCache = {};
-        }
-        let template = Util.templateCache[templatePath];
-        if (!template) {
-            template = Util.readFileSync(templatePath);
-            if (template) {
-                Util.templateCache[templatePath] = template;
-            } else {
-                Util.logError(`not found template: ${templatePath}`);
-            }
-        }
-        return template;
-    },
-
     normalizeColorType: (color) => {
         return `${color}`.trim().toLowerCase();
     },
 
+    normalizeMaxCols: (maxCols, min = 1) => {
+        if (Util.isNum(maxCols)) {
+            return Math.max(maxCols, min);
+        }
+    },
+
     getColorStrByStatus: (str, status, color = '') => {
 
         const colorHandlers = {
@@ -545,7 +429,7 @@ const Util = {
                 return str;
             },
             'tex': () => {
-                const texStr = str.replace('%', '\\\\%');
+                const texStr = str.replace(/%/g, '\\\\%');
                 if (status === 'low') {
                     return `$\\color{red}{\\textsf{${texStr}}}$`;
                 }

package/lib/v8/v8.js

@@ -1,8 +1,5 @@
-const path = require('path');
 const EC = require('eight-colors');
-const { minimatch } = require('minimatch');
 const { mergeScriptCovs } = require('@bcoe/v8-coverage');
-
 const Util = require('../utils/util.js');
 const { getV8Summary } = require('./v8-summary.js');
 const { dedupeFlatRanges } = require('../utils/dedupe.js');
@@ -10,7 +7,10 @@ const {
     resolveAnonymousUrl, normalizeSourcePath, getSourcePathReplacer
 } = require('../utils/source-path.js');
 const { collectSourceMaps } = require('../converter/collect-source-maps.js');
-const version = require('../../package.json').version;
+const { minimatch } = require('../packages/monocart-coverage-vendor.js');
+
+const { v8Report } = require('../reports/v8.js');
+const { v8JsonReport } = require('../reports/v8-json.js');
 
 const getWrapperSource = (offset, source) => {
     // NO \n because it break line number in mappings
@@ -313,68 +313,6 @@ const mergeV8Coverage = async (dataList, sourceCache, options) => {
 
 // ============================================================
 
-const handleV8JsonReport = async (reportData, reportOptions, options) => {
-    const v8JsonOptions = {
-        outputFile: 'coverage-report.json',
-        ... reportOptions
-    };
-
-    // console.log(mergedOptions);
-    const jsonPath = path.resolve(options.outputDir, v8JsonOptions.outputFile);
-    await Util.writeFile(jsonPath, JSON.stringify(reportData));
-    return Util.relativePath(jsonPath);
-};
-
-
-const handleV8HtmlReport = async (reportData, reportOptions, options) => {
-
-    // V8 only options, merged with root options
-    const v8HtmlOptions = {
-        outputFile: options.outputFile,
-        inline: options.inline,
-        assetsPath: options.assetsPath,
-        metrics: options.metrics,
-        ... reportOptions
-    };
-
-    // add metrics to data for UI
-    reportData.metrics = v8HtmlOptions.metrics;
-
-    const {
-        outputFile, inline, assetsPath
-    } = v8HtmlOptions;
-
-    // resolve full report path
-    const reportPath = path.resolve(options.outputDir, outputFile);
-    const outputDir = path.dirname(reportPath);
-    const htmlFile = path.basename(reportPath);
-
-    // deps
-    const jsFiles = ['monocart-code-viewer', 'monocart-formatter', 'turbogrid'].map((id) => {
-        return Util.resolveNodeModule(id);
-    });
-
-    // package app ui
-    jsFiles.push(Util.resolvePackage('monocart-coverage-app.js'));
-
-    // console.log(jsFiles);
-
-    const htmlOptions = {
-        reportData,
-        jsFiles,
-        inline,
-        assetsPath,
-        outputDir,
-        htmlFile,
-
-        reportDataFile: 'coverage-data.js'
-    };
-
-    const htmlPath = await Util.saveHtmlReport(htmlOptions);
-
-    return htmlPath;
-};
-
 const saveV8Report = async (v8list, options, istanbulReportPath) => {
 
     const defaultWatermarks = {
@@ -389,8 +327,11 @@ const saveV8Report = async (v8list, options, istanbulReportPath) => {
     const summary = getV8Summary(v8list, watermarks);
 
     const reportData = {
+        type: 'v8',
+        // override with saved file path
+        reportPath: '',
+        version: Util.version,
         name: options.name,
-        version,
         watermarks,
         summary,
         files: v8list
@@ -398,17 +339,15 @@ const saveV8Report = async (v8list, options, istanbulReportPath) => {
 
     // v8 only reports
     const buildInV8Reports = {
-        'v8': handleV8HtmlReport,
-        'v8-json': handleV8JsonReport
+        'v8': v8Report,
+        'v8-json': v8JsonReport
     };
 
     const outputs = {};
-    const v8Group = options.reportGroup.v8;
+    const v8Group = options.reportGroup.get('v8');
     // could be no v8 only reports, but have `both` data reports
     if (v8Group) {
-        const v8Reports = Object.keys(v8Group);
-        for (const reportName of v8Reports) {
-            const reportOptions = v8Group[reportName];
+        for (const [reportName, reportOptions] of v8Group) {
             const buildInHandler = buildInV8Reports[reportName];
             const t1 = Date.now();
             if (buildInHandler) {
@@ -431,7 +370,9 @@ const saveV8Report = async (v8list, options, istanbulReportPath) => {
 
     const coverageResults = {
         type: 'v8',
+        // html or json
         reportPath,
+        version: Util.version,
         name: options.name,
         watermarks,
         summary,