monocart-coverage-reports 2.8.6 → 2.9.0

package/lib/platform/share.js

@@ -205,13 +205,7 @@ const Util = {
         }
 
         // rangeList should be sorted by startKey, but seems useless here
-
-        const listStart = rangeList.filter((it) => startPos >= it[startKey]);
-        if (!listStart.length) {
-            return;
-        }
-
-        const list = listStart.filter((it) => endPos <= it[endKey]);
+        const list = rangeList.filter((it) => startPos >= it[startKey] && endPos <= it[endKey]);
         if (!list.length) {
             return;
         }

package/lib/utils/markdown.js

@@ -0,0 +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;

package/lib/utils/snapshot.js

@@ -3,56 +3,6 @@ const EC = require('eight-colors');
 
 const Util = require('./util.js');
 
-const getUncoveredLines = (file) => {
-    const lines = [];
-
-    const dataLines = file.data.lines;
-
-    let startLine;
-    let endLine;
-
-    const addLines = () => {
-        if (!startLine) {
-            return;
-        }
-        if (endLine) {
-            // range
-            lines.push(`${startLine.line}-${endLine.line}`);
-            startLine = null;
-            endLine = null;
-        } else {
-            // only start
-            lines.push(startLine.line);
-            startLine = null;
-        }
-    };
-
-    const setLines = (line) => {
-        if (startLine) {
-            endLine = {
-                line
-            };
-            return;
-        }
-        startLine = {
-            line
-        };
-    };
-
-    Object.keys(dataLines).forEach((line) => {
-        const count = dataLines[line];
-        if (count === 0 || typeof count === 'string') {
-            setLines(line);
-            return;
-        }
-        // count >= 1
-        addLines();
-    });
-    addLines();
-
-    return lines.join(',');
-};
-
 const mergeSingleSubGroups = (item) => {
 
     if (!item.subs) {
@@ -97,7 +47,7 @@ const getGroupedRows = (flatRows) => {
 
         let filename = lastName;
         if (file.nameStatus) {
-            filename = Util.getColorStrByStatus(lastName, file.nameStatus);
+            filename = Util.getColorStrByStatus(lastName, file.nameStatus, 'ansicode');
         }
         file.name = filename;
         subs.push(file);
@@ -248,7 +198,10 @@ const getSnapshot = (reportData) => {
     addPercent(snapshot.summary, summary);
 
     files.sort((a, b) => {
-        return a.sourcePath - b.sourcePath;
+        if (a.sourcePath > b.sourcePath) {
+            return 1;
+        }
+        return -1;
     });
     files.forEach((file) => {
         // do NOT add debug file
@@ -257,7 +210,14 @@ const getSnapshot = (reportData) => {
         }
         const fileSummary = {};
         addPercent(fileSummary, file.summary);
-        fileSummary.uncoveredLines = getUncoveredLines(file);
+        fileSummary.uncoveredLines = Util.getUncoveredLines(file.data.lines);
+
+        // no extras for istanbul
+        const extras = file.data.extras;
+        fileSummary.extras = Object.keys(extras).map((k) => {
+            return k + extras[k];
+        }).join(',');
+
         snapshot.files[file.sourcePath] = fileSummary;
     });
 

package/lib/utils/util.js

@@ -501,19 +501,178 @@ 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);
+    normalizeColorType: (color) => {
+        return `${color}`.trim().toLowerCase();
+    },
+
+    getColorStrByStatus: (str, status, color = '') => {
+
+        const colorHandlers = {
+            'ansicode': () => {
+                if (status === 'low') {
+                    return EC.red(str);
+                }
+                if (status === 'medium') {
+                    return EC.yellow(str);
+                }
+                if (status === 'high') {
+                    return EC.green(str);
+                }
+                return str;
+            },
+            'unicode': () => {
+                if (status === 'low') {
+                    return `🔴 ${str}`;
+                }
+                if (status === 'medium') {
+                    return `🟡 ${str}`;
+                }
+                if (status === 'high') {
+                    return `🟢 ${str}`;
+                }
+                return str;
+            },
+            'html': () => {
+                if (status === 'low') {
+                    return `<font color="red">${str}</font>`;
+                }
+                if (status === 'medium') {
+                    return `<font color="orange">${str}</font>`;
+                }
+                if (status === 'high') {
+                    return `<font color="green">${str}</font>`;
+                }
+                return str;
+            },
+            'tex': () => {
+                const texStr = str.replace('%', '\\\\%');
+                if (status === 'low') {
+                    return `$\\color{red}{\\textsf{${texStr}}}$`;
+                }
+                if (status === 'medium') {
+                    return `$\\color{orange}{\\textsf{${texStr}}}$`;
+                }
+                if (status === 'high') {
+                    return `$\\color{green}{\\textsf{${texStr}}}$`;
+                }
+                return str;
+            }
+        };
+
+        const handler = colorHandlers[color];
+        if (handler) {
+            return handler();
         }
+        // no color
         return str;
     },
 
+    getUncoveredLines: (dataLines, color = '') => {
+
+        const lines = [];
+
+        let startLine;
+        let endLine;
+
+        const getHtmlColor = (c) => {
+            return c === 'yellow' ? 'orange' : c;
+        };
+
+        const getAnsiLink = () => {
+            if (startLine.value !== 'red' && endLine.value !== 'red' && endLine.line - startLine.line === 1) {
+                return EC.yellow('-');
+            }
+            return EC.red('-');
+        };
+
+        const getHtmlLink = () => {
+            if (startLine.value !== 'red' && endLine.value !== 'red' && endLine.line - startLine.line === 1) {
+                return '<font color="orange">-</font>';
+            }
+            return '<font color="red">-</font>';
+        };
+
+        const addRangeItem = () => {
+            if (color === 'ansicode') {
+                lines.push(EC[startLine.value](startLine.line) + getAnsiLink() + EC[endLine.value](endLine.line));
+                return;
+            }
+
+            if (color === 'html') {
+                lines.push(`<font color="${getHtmlColor(startLine.value)}">${startLine.line}</font>${getHtmlLink()}<font color="${getHtmlColor(endLine.value)}">${endLine.line}</font>`);
+                return;
+            }
+
+            // no color
+            lines.push(`${startLine.line}-${endLine.line}`);
+
+        };
+
+        const addStartItem = () => {
+            if (color === 'ansicode') {
+                lines.push(EC[startLine.value](startLine.line));
+                return;
+            }
+
+            if (color === 'html') {
+                lines.push(`<font color="${getHtmlColor(startLine.value)}">${startLine.line}</font>`);
+                return;
+            }
+
+            // no color
+            lines.push(startLine.line);
+
+        };
+
+        const addLines = () => {
+            if (!startLine) {
+                return;
+            }
+            if (endLine) {
+                // range
+                addRangeItem();
+                startLine = null;
+                endLine = null;
+            } else {
+                // only start
+                addStartItem();
+                startLine = null;
+            }
+        };
+
+        const setLines = (line, value) => {
+            if (startLine) {
+                endLine = {
+                    line,
+                    value
+                };
+                return;
+            }
+            startLine = {
+                line,
+                value
+            };
+        };
+
+        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(',');
+    },
+
     cmpVersion: (v1, v2) => {
         const [strMajor1, strMinor1, strPatch1] = `${v1}`.split('.');
         const [strMajor2, strMinor2, strPatch2] = `${v2}`.split('.');
@@ -611,7 +770,15 @@ const Util = {
         }
         const duration = Date.now() - time_start;
         const durationH = Util.TF(duration);
-        const ls = [`[MCR] ${message}`, ' ('];
+        const ls = [`[MCR] ${message}`];
+
+        // memory
+        const { heapUsed } = process.memoryUsage();
+        const memory = parseFloat((heapUsed / 1024 ** 2).toFixed(1));
+        ls.push(` (memory: ${memory}MB)`);
+
+        // time
+        ls.push(' (');
         if (duration <= 100) {
             ls.push(EC.green(durationH));
         } else if (duration < 500) {
@@ -620,6 +787,7 @@ const Util = {
             ls.push(EC.red(durationH));
         }
         ls.push(')');
+
         console.log(ls.join(''));
     }
 

package/package.json

@@ -1,104 +1,104 @@
-{
-    "name": "monocart-coverage-reports",
-    "version": "2.8.6",
-    "description": "A code coverage tool to generate native V8 reports or Istanbul reports.",
-    "main": "./lib/index.js",
-    "bin": {
-        "mcr": "./lib/cli.js"
-    },
-    "exports": {
-        ".": {
-            "types": "./lib/index.d.ts",
-            "import": "./lib/index.mjs",
-            "require": "./lib/index.js",
-            "default": "./lib/index.js"
-        },
-        "./register": {
-            "import": "./lib/register/register.mjs",
-            "require": "./lib/register/register.js",
-            "default": "./lib/register/register.js"
-        },
-        "./converter": "./lib/converter/converter.js",
-        "./util": "./lib/utils/util.js",
-        "./package.json": "./package.json"
-    },
-    "types": "./lib/index.d.ts",
-    "scripts": {
-        "build-test": "node ./test/build/build-test.js",
-        "build": "npx sf lint && npx sf b -p && npm run build-test",
-        "test-unit": "mocha --parallel test/unit/*.test.js",
-        "test-node-env": "cross-env NODE_V8_COVERAGE=.temp/v8-coverage-env node ./test/test-node-env.js && node ./test/generate-report.js",
-        "test-node-api": "cross-env NODE_V8_COVERAGE=.temp/v8-coverage-api node ./test/test-node-api.js",
-        "test-node-ins": "node ./test/test-node-ins.js",
-        "test-node-cdp": "node --inspect=9229 ./test/test-node-cdp.js",
-        "test-node-vm": "node ./test/test-node-vm.js",
-        "test-node-koa": "node ./test/test-node-koa.js",
-        "test-node-fgc": "node ./test/test-node-fgc.js",
-        "test-node": "node ./test/test.js --node",
-        "test-istanbul": "node ./test/test-istanbul.js",
-        "test-v8": "node ./test/test-v8.js",
-        "test-puppeteer": "node ./test/test-puppeteer.js",
-        "test-anonymous": "node ./test/test-anonymous.js",
-        "test-css": "node ./test/test-css.js",
-        "test-minify": "node ./test/test-minify.js",
-        "test-esbuild": "node ./test/test-esbuild.js",
-        "test-rollup": "node ./test/test-rollup.js",
-        "test-swc": "node ./test/test-swc.js",
-        "test-v8-and-istanbul": "node ./test/test-v8-and-istanbul.js",
-        "test-browser": "node ./test/test.js --browser",
-        "test-cli": "npx mcr node ./test/specs/node.test.js -c test/mcr.config.cli.js",
-        "test-tsx": "npx mcr tsx ./test/specs/tsx.test.ts -c test/mcr.config.tsx.js",
-        "test-demo": "node ./test/test-demo.js",
-        "test-merge": "node ./test/test-merge.js",
-        "test-merge-istanbul": "node ./test/test-merge-istanbul.js",
-        "test-client": "node ./test/test-client.js",
-        "test-all": "node ./test/test.js && node ./scripts/docs.js",
-        "test": "npm run test-unit && npx mcr npm run test-all -c test/mcr.config.mcr.js",
-        "test:snap": "cross-env TEST_SNAPSHOT=true npm run test",
-        "dev": "npx sf d app",
-        "open": "node ./scripts/open.js",
-        "eol": "git rm -rf --cached . && git reset --hard HEAD",
-        "patch": "npm run build && npm run test && npx sf publish patch -r"
-    },
-    "workspaces": [
-        "packages/*",
-        "test"
-    ],
-    "files": [
-        "lib",
-        "README.zh-Hans.md"
-    ],
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/cenfun/monocart-coverage-reports.git"
-    },
-    "dependencies": {
-        "console-grid": "^2.2.2",
-        "eight-colors": "^1.3.0",
-        "istanbul-lib-coverage": "^3.2.2",
-        "istanbul-lib-report": "^3.0.1",
-        "istanbul-reports": "^3.1.7",
-        "lz-utils": "^2.0.2",
-        "monocart-code-viewer": "^1.1.4",
-        "monocart-formatter": "^3.0.0",
-        "monocart-locator": "^1.0.0",
-        "turbogrid": "^3.2.0"
-    },
-    "devDependencies": {
-        "commander": "^12.1.0",
-        "esbuild": "^0.21.5",
-        "eslint": "~9.6.0",
-        "eslint-config-plus": "^2.0.2",
-        "eslint-plugin-html": "^8.1.1",
-        "eslint-plugin-vue": "^9.26.0",
-        "find-up": "^7.0.0",
-        "minimatch": "^9.0.5",
-        "starfall-cli": "^2.0.19",
-        "stylelint": "^16.6.1",
-        "stylelint-config-plus": "^1.1.2",
-        "supports-color": "^9.4.0",
-        "tsx": "^4.16.0",
-        "ws": "^8.17.1"
-    }
-}
+{
+    "name": "monocart-coverage-reports",
+    "version": "2.9.0",
+    "description": "A code coverage tool to generate native V8 reports or Istanbul reports.",
+    "main": "./lib/index.js",
+    "bin": {
+        "mcr": "./lib/cli.js"
+    },
+    "exports": {
+        ".": {
+            "types": "./lib/index.d.ts",
+            "import": "./lib/index.mjs",
+            "require": "./lib/index.js",
+            "default": "./lib/index.js"
+        },
+        "./register": {
+            "import": "./lib/register/register.mjs",
+            "require": "./lib/register/register.js",
+            "default": "./lib/register/register.js"
+        },
+        "./converter": "./lib/converter/converter.js",
+        "./util": "./lib/utils/util.js",
+        "./package.json": "./package.json"
+    },
+    "types": "./lib/index.d.ts",
+    "scripts": {
+        "build-test": "node ./test/build/build-test.js",
+        "build": "npx sf lint && npx sf b -p && npm run build-test",
+        "test-unit": "mocha --parallel test/unit/*.test.js",
+        "test-node-env": "cross-env NODE_V8_COVERAGE=.temp/v8-coverage-env node ./test/test-node-env.js && node ./test/generate-report.js",
+        "test-node-api": "cross-env NODE_V8_COVERAGE=.temp/v8-coverage-api node ./test/test-node-api.js",
+        "test-node-ins": "node ./test/test-node-ins.js",
+        "test-node-cdp": "node --inspect=9229 ./test/test-node-cdp.js",
+        "test-node-vm": "node ./test/test-node-vm.js",
+        "test-node-koa": "node ./test/test-node-koa.js",
+        "test-node-fgc": "node ./test/test-node-fgc.js",
+        "test-node": "node ./test/test.js --node",
+        "test-istanbul": "node ./test/test-istanbul.js",
+        "test-v8": "node ./test/test-v8.js",
+        "test-puppeteer": "node ./test/test-puppeteer.js",
+        "test-anonymous": "node ./test/test-anonymous.js",
+        "test-css": "node ./test/test-css.js",
+        "test-minify": "node ./test/test-minify.js",
+        "test-esbuild": "node ./test/test-esbuild.js",
+        "test-rollup": "node ./test/test-rollup.js",
+        "test-swc": "node ./test/test-swc.js",
+        "test-v8-and-istanbul": "node ./test/test-v8-and-istanbul.js",
+        "test-browser": "node ./test/test.js --browser",
+        "test-cli": "npx mcr node ./test/specs/node.test.js -c test/mcr.config.cli.js",
+        "test-tsx": "npx mcr tsx ./test/specs/tsx.test.ts -c test/mcr.config.tsx.js",
+        "test-demo": "node ./test/test-demo.js",
+        "test-merge": "node ./test/test-merge.js",
+        "test-merge-istanbul": "node ./test/test-merge-istanbul.js",
+        "test-client": "node ./test/test-client.js",
+        "test-all": "node ./test/test.js && node ./scripts/docs.js",
+        "test": "npm run test-unit && npx mcr npm run test-all -c test/mcr.config.mcr.js",
+        "test:snap": "cross-env TEST_SNAPSHOT=true npm run test",
+        "dev": "npx sf d app",
+        "open": "node ./scripts/open.js",
+        "eol": "git rm -rf --cached . && git reset --hard HEAD",
+        "patch": "npm run build && npm run test && npx sf publish patch -r"
+    },
+    "workspaces": [
+        "packages/*",
+        "test"
+    ],
+    "files": [
+        "lib",
+        "README.zh-Hans.md"
+    ],
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/cenfun/monocart-coverage-reports.git"
+    },
+    "dependencies": {
+        "console-grid": "^2.2.2",
+        "eight-colors": "^1.3.0",
+        "istanbul-lib-coverage": "^3.2.2",
+        "istanbul-lib-report": "^3.0.1",
+        "istanbul-reports": "^3.1.7",
+        "lz-utils": "^2.0.2",
+        "monocart-code-viewer": "^1.1.4",
+        "monocart-formatter": "^3.0.0",
+        "monocart-locator": "^1.0.2",
+        "turbogrid": "^3.2.0"
+    },
+    "devDependencies": {
+        "commander": "^12.1.0",
+        "esbuild": "^0.23.0",
+        "eslint": "~9.6.0",
+        "eslint-config-plus": "^2.0.2",
+        "eslint-plugin-html": "^8.1.1",
+        "eslint-plugin-vue": "^9.27.0",
+        "find-up": "^7.0.0",
+        "minimatch": "^9.0.5",
+        "starfall-cli": "^2.0.19",
+        "stylelint": "^16.6.1",
+        "stylelint-config-plus": "^1.1.2",
+        "supports-color": "^9.4.0",
+        "tsx": "^4.16.2",
+        "ws": "^8.17.1"
+    }
+}