monocart-coverage-reports 2.0.5 → 2.0.7

package/README.md

@@ -6,12 +6,9 @@
 
 > Code coverage tool to generate native [V8](https://v8.dev/blog/javascript-code-coverage) reports or [Istanbul](https://istanbul.js.org/) reports.
 
-* [Preview Reports](#preview-reports)
 * [Usage](#usage)
 * [Default Options](#default-options)
-* [Multiple Reports](#multiple-reports)
-    - [V8 reports](#v8-reports)
-    - [Istanbul reports](#istanbul-reports)
+* [Available Reports](#available-reports)
 * [Multiprocessing Support](#multiprocessing-support)
 * [Compare Reports](#compare-reports)
 * [Compare Workflows](#compare-workflows)
@@ -26,14 +23,6 @@
 * [Istanbul Introduction](#istanbul-introduction)
 * [Thanks](#thanks)
 
-## Preview Reports
-- [V8](https://cenfun.github.io/monocart-coverage-reports/v8) - Example for browser, build with webpack, and also [Rollup](https://cenfun.github.io/monocart-coverage-reports/v8-rollup) and [Esbuild](https://cenfun.github.io/monocart-coverage-reports/v8-esbuild)
-- [V8 Node](https://cenfun.github.io/monocart-coverage-reports/v8-node-env) - Example for Node.js using env, and also [V8 API](https://cenfun.github.io/monocart-coverage-reports/v8-node-api), [Inspector](https://cenfun.github.io/monocart-coverage-reports/v8-node-ins) and [CDP](https://cenfun.github.io/monocart-coverage-reports/v8-node-cdp)
-- [V8 Minify](https://cenfun.github.io/monocart-coverage-reports/v8-minify)
-- [V8 to Istanbul](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/istanbul)
-- [Istanbul](https://cenfun.github.io/monocart-coverage-reports/istanbul/)
-- [Integration with Monocart Reporter](https://cenfun.github.io/monocart-reporter/) - Playwright test report
-
 ## Usage
 ```js
 const CoverageReport = require('monocart-coverage-reports');
@@ -53,30 +42,46 @@ console.log(coverageResults.summary);
 ## Default Options
 - [lib/default/options.js](https://github.com/cenfun/monocart-coverage-reports/blob/main/lib/default/options.js)
 
-## Multiple Reports
-### V8 reports
-- v8 (html)
-- v8-json
-### [Istanbul reports](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-reports/lib)
-- clover
-- cobertura
-- html
-- html-spa
-- json
-- json-summary
-- lcov
-- lcovonly
-- none
-- teamcity
-- text
-- text-lcov
-- text-summary
+## Available Reports
+- `v8` (V8 data only)
+    - [V8 html](https://cenfun.github.io/monocart-coverage-reports/v8) - Example for browser, build with webpack, and also [Rollup](https://cenfun.github.io/monocart-coverage-reports/v8-rollup) and [Esbuild](https://cenfun.github.io/monocart-coverage-reports/v8-esbuild)
+    - [V8 Node](https://cenfun.github.io/monocart-coverage-reports/v8-node-env) - Example for Node.js using env, and also [V8 API](https://cenfun.github.io/monocart-coverage-reports/v8-node-api), [Inspector](https://cenfun.github.io/monocart-coverage-reports/v8-node-ins) and [CDP](https://cenfun.github.io/monocart-coverage-reports/v8-node-cdp)
+    - [V8 Minify](https://cenfun.github.io/monocart-coverage-reports/v8-minify)
+
+![](test/v8.gif)
+
+- `v8-json` (V8 data only)
+    - [V8 coverage-report.json](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/coverage-report.json)
+- `console-summary` shows coverage summary in console
+    
+    ![](test/console-summary.png)
+
+> Following are [istanbul reports](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-reports/lib)
+- `clover`
+- `cobertura`
+- `html`
+    - [Istanbul html](https://cenfun.github.io/monocart-coverage-reports/istanbul/) 
+    - [V8 to Istanbul](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/istanbul)
+- `html-spa`
+    - [Istanbul html-spa](https://cenfun.github.io/monocart-coverage-reports/istanbul/html-spa/)
+- `json`
+- `json-summary`
+- `lcov`
+- `lcovonly`
+    - [V8 lcov.info](https://cenfun.github.io/monocart-coverage-reports/v8/lcov.info)
+    - [Istanbul lcov.info](https://cenfun.github.io/monocart-coverage-reports/istanbul/lcov.info)
+- `none`
+- `teamcity`
+- `text`
+- `text-lcov`
+- `text-summary`
 
 ```js
 const CoverageReport = require('monocart-coverage-reports');
 const options = {
     outputDir: './coverage-reports',
     reports: [
+        ['console-summary'],
         ['v8'],
         ['html', {
             subdir: 'istanbul'
@@ -90,6 +95,11 @@ const options = {
 const coverageReport = new CoverageReport(options);
 ```
 
+## Integration
+- [monocart-reporter](https://cenfun.github.io/monocart-reporter/) - Test reporter for [Playwright](https://github.com/microsoft/playwright)
+- [vitest-monocart-coverage](https://github.com/cenfun/vitest-monocart-coverage) - Integration with [Vitest](https://github.com/vitest-dev/vitest) coverage
+
+
 ## Multiprocessing Support
 The data will be added to `[outputDir]/.cache`, and the cache will be removed after reports generated.
 - sub process 1

package/lib/converter/converter.js

@@ -184,38 +184,9 @@ const collectFileCoverage = (item, coverageInfo, state) => {
 
 // ========================================================================================================
 
-// https://github.com/demurgos/v8-coverage
-/**
- * @ranges is always non-empty. The first range is called the "root range".
- * @isBlockCoverage indicates if the function has block coverage information
- *   @false means that there is a single range and its count is the number of times the function was called.
- *   @true means that the ranges form a tree of blocks representing how many times each statement or expression inside was executed.
- *        It detects skipped or repeated statements. The root range counts the number of function calls.
- *
- * @functionName can be an empty string. This is common for the FunctionCov representing the whole module.
- */
-// if you have a line of code that says `var x= 10; console.log(x);` that's one line and 2 statements.
-
-const addJsLineCoverage = (state, range) => {
-
-    const { locator, coverageInfo } = state;
-
-    const { data, lineMap } = coverageInfo;
-
-    const {
-        startOffset, endOffset, count
-    } = range;
-
-    // add bytes range
-    data.bytes.push({
-        // index,
-        start: startOffset,
-        end: endOffset,
-        count
-    });
-
-    const sLoc = locator.offsetToLocation(startOffset);
-    const eLoc = locator.offsetToLocation(endOffset);
+const updateLineCoverage = (start, end, count, lineMap, locator) => {
+    const sLoc = locator.offsetToLocation(start);
+    const eLoc = locator.offsetToLocation(end);
 
     // update lines coverage
     const lines = Util.getRangeLines(sLoc, eLoc);
@@ -251,6 +222,39 @@ const addJsLineCoverage = (state, range) => {
     //     console.log('===========================================', state.sourcePath);
     //     console.log(coverageInfo.lines);
     // }
+};
+
+// https://github.com/demurgos/v8-coverage
+/**
+ * @ranges is always non-empty. The first range is called the "root range".
+ * @isBlockCoverage indicates if the function has block coverage information
+ *   @false means that there is a single range and its count is the number of times the function was called.
+ *   @true means that the ranges form a tree of blocks representing how many times each statement or expression inside was executed.
+ *        It detects skipped or repeated statements. The root range counts the number of function calls.
+ *
+ * @functionName can be an empty string. This is common for the FunctionCov representing the whole module.
+ */
+// if you have a line of code that says `var x= 10; console.log(x);` that's one line and 2 statements.
+
+const addJsLineCoverage = (state, range) => {
+
+    const { locator, coverageInfo } = state;
+
+    const { data, lineMap } = coverageInfo;
+
+    const {
+        startOffset, endOffset, count
+    } = range;
+
+    // add bytes range
+    data.bytes.push({
+        // index,
+        start: startOffset,
+        end: endOffset,
+        count
+    });
+
+    updateLineCoverage(startOffset, endOffset, count, lineMap, locator);
 
 };
 
@@ -264,28 +268,11 @@ const addCssLineCoverage = (state, range) => {
         start, end, count
     } = range;
 
-    if (count > 0) {
-        const sLoc = locator.offsetToLocation(start);
-        const eLoc = locator.offsetToLocation(end);
-
-        // covered css lines
-        const lines = Util.getRangeLines(sLoc, eLoc);
-        lines.forEach((it) => {
-            if (!it.entire) {
-                return;
-            }
-            const line = lineMap.get(it.line);
-            if (line) {
-            // default is uncovered
-            // count always 1, covered is certain
-                line.covered = true;
-            }
-        });
-    }
-
     // add bytes range
     data.bytes.push(range);
 
+    updateLineCoverage(start, end, count, lineMap, locator);
+
 };
 
 // ========================================================================================================
@@ -406,9 +393,7 @@ const handleBranchesCoverage = (state) => {
 
 const handleLinesCoverage = (state) => {
 
-    const {
-        js, locator, coverageInfo
-    } = state;
+    const { locator, coverageInfo } = state;
 
     const lines = coverageInfo.lines;
     const lineMap = coverageInfo.lineMap;
@@ -417,10 +402,6 @@ const handleLinesCoverage = (state) => {
     let blankCount = 0;
     let commentCount = 0;
 
-    // js: 1 (functions include all uncovered)
-    // css: 0 (ranges include all covered)
-    const baseLineCount = js ? 1 : 0;
-
     locator.lines.forEach((it) => {
         // exclude blank and comment
         if (it.blank) {
@@ -433,7 +414,8 @@ const handleLinesCoverage = (state) => {
         }
         // line 1-base
         const line = it.line + 1;
-        const lineInfo = new InfoLine(line, it.length, baseLineCount);
+        // default count to 1, both js and css
+        const lineInfo = new InfoLine(line, it.length, 1);
         lineMap.set(line, lineInfo);
         lines.push(lineInfo);
     });

package/lib/generate.js

@@ -1,6 +1,7 @@
 const fs = require('fs');
 const path = require('path');
-
+const CG = require('console-grid');
+const EC = require('eight-colors');
 const Util = require('./utils/util.js');
 const {
     initIstanbulData, mergeIstanbulCoverage, saveIstanbulReports
@@ -72,6 +73,9 @@ const getReportGroup = (reports, lcov, dataType) => {
         'v8',
         'v8-json',
 
+        // both
+        'console-summary',
+
         // istanbul
         'clover',
         'cobertura',
@@ -95,6 +99,7 @@ const getReportGroup = (reports, lcov, dataType) => {
             return;
         }
 
+        // v8
         if (k.startsWith('v8')) {
             // v8
             if (!reportGroup.v8) {
@@ -104,6 +109,12 @@ const getReportGroup = (reports, lcov, dataType) => {
             return;
         }
 
+        // both
+        if (k === 'console-summary') {
+            reportGroup[k] = reportMap[k];
+            return;
+        }
+
         // istanbul
         if (!reportGroup.istanbul) {
             reportGroup.istanbul = {};
@@ -114,6 +125,8 @@ const getReportGroup = (reports, lcov, dataType) => {
     return reportGroup;
 };
 
+// ========================================================================================================
+
 
 const generateCoverageReports = async (dataList, options) => {
 
@@ -144,6 +157,8 @@ const generateCoverageReports = async (dataList, options) => {
 
 };
 
+// ========================================================================================================
+
 
 const getCoverageDataList = async (cacheDir) => {
     const files = fs.readdirSync(cacheDir).filter((f) => f.startsWith('coverage-'));
@@ -164,8 +179,114 @@ const getCoverageDataList = async (cacheDir) => {
     }
 };
 
+// ========================================================================================================
+
+const capitalizeFirstLetter = (string) => {
+    return string.charAt(0).toUpperCase() + string.slice(1);
+};
+
+const pFormatter = (v, row, column) => {
+    if (typeof v === 'number') {
+        const p = Util.PSF(v, 100, 2);
+        if (row.status === 'low') {
+            return EC.red(p);
+        }
+        if (row.status === 'medium') {
+            return EC.yellow(p);
+        }
+        if (row.status === 'high') {
+            return EC.green(p);
+        }
+    }
+    return v;
+};
+
+const nFormatter = (v) => {
+    if (typeof v === 'number') {
+        return Util.NF(v);
+    }
+    return v;
+};
+
+const showConsoleSummary = (coverageResults, options) => {
+
+    const reportGroup = options.reportGroup;
+    const consoleOptions = reportGroup['console-summary'];
+    if (!consoleOptions) {
+        return;
+    }
+
+    const { metrics } = consoleOptions;
+
+    const {
+        summary, name, type
+    } = coverageResults;
+    if (name) {
+        EC.logCyan(name);
+    }
+
+    const allMetrics = {
+        v8: ['bytes', 'functions', 'branches', 'lines'],
+        istanbul: ['statements', 'functions', 'branches', 'lines']
+    };
+
+    let list = allMetrics[type];
+    if (Util.isList(metrics)) {
+        const newList = list.filter((k) => metrics.includes(k));
+        if (newList.length) {
+            list = newList;
+        }
+    }
+
+    const rows = list.map((k) => {
+        return {
+            ... summary[k],
+            name: capitalizeFirstLetter(k)
+        };
+    });
+
+    const columns = [{
+        id: 'name',
+        name: 'Name'
+    }, {
+        id: 'pct',
+        name: 'Coverage %',
+        align: 'right',
+        formatter: pFormatter
+    }, {
+        id: 'covered',
+        name: 'Covered',
+        align: 'right',
+        formatter: nFormatter
+    }, {
+        id: 'uncovered',
+        name: 'Uncovered',
+        align: 'right',
+        formatter: nFormatter
+    }, {
+        id: 'total',
+        name: 'Total',
+        align: 'right',
+        formatter: nFormatter
+    }];
+
+    if (type === 'istanbul') {
+        columns.splice(4, 0, {
+            id: 'skipped',
+            name: 'Skipped',
+            align: 'right',
+            formatter: nFormatter
+        });
+    }
+
+    CG({
+        columns,
+        rows
+    });
+};
 
 module.exports = {
     getCoverageDataList,
-    generateCoverageReports
+    generateCoverageReports,
+    showConsoleSummary
 };

package/lib/index.d.ts

@@ -23,11 +23,15 @@ export type ReportDescription =
     ['v8'] | ["v8", {
         outputFile?: string,
         inline?: boolean,
-        assetsPath?: string
+        assetsPath?: string,
+        metrics?: Array<"bytes" | "functions" | "branches" | "lines">
     }] |
     ['v8-json'] | ["v8-json", {
         outputFile?: string
     }] |
+    ['console-summary'] | ['console-summary', {
+        metrics?: Array<"bytes" | "functions" | "branches" | "lines" | "statements">
+    }] |
     ['clover'] | ['clover', {
         file?: string
     }] |

package/lib/index.js

@@ -4,7 +4,9 @@ const defaultOptions = require('./default/options.js');
 const Util = require('./utils/util.js');
 
 const { initV8ListAndSourcemap } = require('./v8/v8.js');
-const { getCoverageDataList, generateCoverageReports } = require('./generate.js');
+const {
+    getCoverageDataList, generateCoverageReports, showConsoleSummary
+} = require('./generate.js');
 
 class CoverageReport {
 
@@ -107,6 +109,8 @@ class CoverageReport {
             Util.rmSync(cacheDir);
         }
 
+        showConsoleSummary(coverageResults, this.options);
+
         const onEnd = this.options.onEnd;
         if (typeof onEnd === 'function') {
             await onEnd(coverageResults);

package/lib/istanbul/istanbul-summary.js

@@ -37,6 +37,19 @@ class IstanbulSummary extends ReportBase {
     }
 
     getReport() {
+
+        // remove branchesTrue
+        delete this.summary.branchesTrue;
+
+        // add uncovered
+        Object.keys(this.summary).forEach((id) => {
+            const item = this.summary[id];
+            // NOTE: skipped
+            item.uncovered = item.total - item.covered - item.skipped;
+        });
+
+        // console.log(this.summary);
+
         return {
             summary: this.summary,
             files: this.files