monocart-coverage-reports 2.0.6 → 2.0.7

package/README.md

@@ -43,24 +43,6 @@ console.log(coverageResults.summary);
 - [lib/default/options.js](https://github.com/cenfun/monocart-coverage-reports/blob/main/lib/default/options.js)
 
 ## Available Reports
-```js
-const CoverageReport = require('monocart-coverage-reports');
-const options = {
-    outputDir: './coverage-reports',
-    reports: [
-        ['console-summary'],
-        ['v8'],
-        ['html', {
-            subdir: 'istanbul'
-        }],
-        ['json', {
-            file: 'my-json-file.json'
-        }],
-        'lcovonly'
-    ]
-}
-const coverageReport = new CoverageReport(options);
-```
 - `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)
@@ -94,6 +76,25 @@ const coverageReport = new CoverageReport(options);
 - `text-lcov`
 - `text-summary`
 
+```js
+const CoverageReport = require('monocart-coverage-reports');
+const options = {
+    outputDir: './coverage-reports',
+    reports: [
+        ['console-summary'],
+        ['v8'],
+        ['html', {
+            subdir: 'istanbul'
+        }],
+        ['json', {
+            file: 'my-json-file.json'
+        }],
+        'lcovonly'
+    ]
+}
+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

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

@@ -216,6 +216,8 @@ const showConsoleSummary = (coverageResults, options) => {
         return;
     }
 
+    const { metrics } = consoleOptions;
+
     const {
         summary, name, type
     } = coverageResults;
@@ -223,12 +225,19 @@ const showConsoleSummary = (coverageResults, options) => {
         EC.logCyan(name);
     }
 
-    const indicators = {
+    const allMetrics = {
         v8: ['bytes', 'functions', 'branches', 'lines'],
         istanbul: ['statements', 'functions', 'branches', 'lines']
     };
 
-    const list = indicators[type] || indicators.v8;
+    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],

package/lib/index.d.ts

@@ -23,12 +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'] | ['console-summary', {
+        metrics?: Array<"bytes" | "functions" | "branches" | "lines" | "statements">
+    }] |
     ['clover'] | ['clover', {
         file?: string
     }] |