monocart-coverage-reports 2.5.8 → 2.5.9

package/README.md

@@ -48,15 +48,22 @@
 ## Usage
 ```js
 const MCR = require('monocart-coverage-reports');
-const options = {
+const coverageOptions = {
+    name: 'My Coverage Report - 2024-02-28',
     outputDir: './coverage-reports',
-    reports: "v8"
+    reports: ["v8", "console-details"]
 }
-const coverageReport = MCR(options);
+const coverageReport = MCR(coverageOptions);
+coverageReport.cleanCache();
+
 await coverageReport.add(coverageData1);
 await coverageReport.add(coverageData2);
-const coverageResults = await coverageReport.generate();
-console.log(coverageResults.summary);
+
+await coverageReport.generate();
+
+// Or 
+// const { CoverageReport } = require('monocart-coverage-reports');
+// const coverageReport = new CoverageReport(coverageOptions);
 ```
 - [example v8](https://github.com/cenfun/monocart-coverage-reports/blob/main/test/test-v8.js)
 - [example istanbul](https://github.com/cenfun/monocart-coverage-reports/blob/main/test/test-istanbul.js)
@@ -134,7 +141,7 @@ console.log(coverageResults.summary);
 ### Multiple Reports:
 ```js
 const MCR = require('monocart-coverage-reports');
-const options = {
+const coverageOptions = {
     outputDir: './coverage-reports',
     reports: [
         // build-in reports
@@ -153,14 +160,15 @@ const options = {
         ["custom-reporter-1"],
         ["custom-reporter-2", {
             type: "istanbul",
-            option: "value"
+            key: "value"
         }],
         // Specify reporter name with local path
         ['/absolute/path/to/custom-reporter.js']
 
     ]
 }
-const coverageReport = MCR(options);
+const coverageReport = MCR(coverageOptions);
+coverageReport.cleanCache();
 ```
 
 ## Using `entryFilter` and `sourceFilter` to filter the results for V8 report
@@ -419,34 +427,40 @@ Possible solutions:
 > The data will be added to `[outputDir]/.cache`, After the generation of the report, this data will be removed unless debugging has been enabled or a raw report has been used, see [Debug for Coverage and Sourcemap](#debug-for-coverage-and-sourcemap)
 - Main process, before the start of testing
 ```js
-// clean previous cache before the start of testing (option)
 const MCR = require('monocart-coverage-reports');
-const options = require('path-to/same-options.js');
-MCR(options).cleanCache();
+const coverageOptions = require('path-to/same-options.js');
+const coverageReport = MCR(coverageOptions);
+// clean previous cache before the start of testing
+// unless the running environment is new and no cache
+coverageReport.cleanCache();
 ```
 
 - Sub process 1, testing stage 1
 ```js
 const MCR = require('monocart-coverage-reports');
-const options = require('path-to/same-options.js');
-await MCR(options).add(coverageData1);
+const coverageOptions = require('path-to/same-options.js');
+const coverageReport = MCR(coverageOptions);
+// do not clean cache in the stage
+await coverageReport.add(coverageData1);
 ```
 
 - Sub process 2, testing stage 2
 ```js
 const MCR = require('monocart-coverage-reports');
-const options = require('path-to/same-options.js');
-await MCR(options).add(coverageData2);
+const coverageOptions = require('path-to/same-options.js');
+const coverageReport = MCR(coverageOptions);
+// do not clean cache in the stage
+await coverageReport.add(coverageData2);
 ```
 
 - Main process, after the completion of testing
 ```js
 // generate coverage reports after the completion of testing
 const MCR = require('monocart-coverage-reports');
-const options = require('path-to/same-options.js');
-const coverageReport = MCR(options);
-const coverageResults = await coverageReport.generate();
-console.log(coverageResults.summary);
+const coverageOptions = require('path-to/same-options.js');
+const coverageReport = MCR(coverageOptions);
+// do not clean cache before generating reports
+await coverageReport.generate();
 ```
 
 ## Merge Coverage Reports
@@ -473,6 +487,7 @@ const coverageOptions = {
 ```
 Then, after all the tests are completed, generate a merged report with option `inputDir`:
 ```js
+// esm syntax
 import fs from "fs";
 import { CoverageReport } from 'monocart-coverage-reports';
 const coverageOptions = {

package/lib/converter/converter.js

@@ -697,6 +697,9 @@ const handleOriginalBytesCoverage = (state, originalStateMap) => {
         // });
     }
 
+
+    const checkList = [];
+
     // check original bytes if fully in a wrapper range
     originalStateMap.forEach((originalState) => {
         const bytes = originalState.bytes;
@@ -727,6 +730,30 @@ const handleOriginalBytesCoverage = (state, originalStateMap) => {
         // console.log('===========================================================', originalState.sourcePath);
         // console.log(originalState.source.length, endMapping);
 
+        checkList.push({
+            originalState,
+            startOffset,
+            endOffset
+        });
+
+    });
+
+    if (!checkList.length) {
+        return;
+    }
+
+    // there is no state.bytes if not in debug
+    // should using coverageList to generate bytes first
+    handleBytesCoverage(state);
+
+    checkList.forEach((it) => {
+
+        const {
+            originalState, startOffset, endOffset
+        } = it;
+
+        // console.log('=============', 'no bytes', originalState.sourcePath);
+
         // only check uncovered range
         // because a uncovered range could be in a covered wrapper
         // { start: 0, end: 12137, count: 1 }, could be { start: > 0, end: < 12137, count: 0 }
@@ -735,7 +762,8 @@ const handleOriginalBytesCoverage = (state, originalStateMap) => {
                 continue;
             }
             if (startOffset >= range.start && endOffset <= range.end) {
-                bytes.push({
+                // console.log('------------', 'added');
+                originalState.bytes.push({
                     start: 0,
                     end: originalState.source.length,
                     count: 0
@@ -746,6 +774,7 @@ const handleOriginalBytesCoverage = (state, originalStateMap) => {
 
     });
 
+
 };
 
 // ========================================================================================================

package/lib/default/options.js

@@ -72,9 +72,12 @@ module.exports = {
     // {object} { bytes:[50,80], statements:[50,80], branches:[50,80], functions:[50,80], lines:[50,80] }
     watermarks: [50, 80],
 
-    // {boolean} clean previous files in output dir before generating report. Defaults to true.
+    // {boolean} Indicates whether to clean previous files in output dir before generating report. Defaults to true.
     clean: true,
 
+    // {boolean} Indicates whether to clean previous cache in output dir before generating report. Defaults to false.
+    cleanCache: false,
+
     // {function} onEnd hook
     // onEnd: async (reportData) => {}
     onEnd: null

package/lib/index.d.ts

@@ -280,9 +280,16 @@ declare namespace MCR {
         * {object} { bytes:[50,80], statements:[50,80], branches:[50,80], functions:[50,80], lines:[50,80] } */
         watermarks?: Watermarks;
 
-        /** {boolean} clean previous files in output dir before generating report. Defaults to true. */
+        /** {boolean} Indicates whether to clean previous files in output dir before generating report. Defaults to true. */
         clean?: boolean;
 
+        /**
+         * {boolean} Indicates whether to clean previous cache in output dir before generating report. Defaults to false. 
+         * 
+         * If true, the API `cleanCache()` will execute automatically.
+        */
+        cleanCache?: boolean;
+
         /** {function} onEnd hook */
         onEnd?: (reportData: CoverageResults) => Promise<void>;
     }

package/lib/index.js

@@ -14,6 +14,13 @@ class CoverageReport {
             ... defaultOptions,
             ... options
         };
+
+        this.initOptions();
+        // If true, the API `cleanCache()` will execute automatically.
+        if (this.options.cleanCache) {
+            this.cleanCache();
+        }
+
     }
 
     initOptions() {

package/lib/utils/source-path.js

@@ -101,11 +101,22 @@ const initIstanbulSourcePath = (coverageData, fileSources, sourcePathHandler) =>
         return coverageData;
     }
 
+    // console.log(fileSources);
+
     const newCoverage = {};
     Object.keys(coverageData).forEach((sourcePath) => {
         // previous coverage and source
         const item = coverageData[sourcePath];
-        const source = fileSources[sourcePath];
+        let source = fileSources[sourcePath];
+
+        // source could be empty string ''
+        if (typeof source !== 'string') {
+            // read source with original source path first
+            source = Util.readFileSync(sourcePath);
+            if (typeof source === 'string') {
+                fileSources[sourcePath] = source;
+            }
+        }
 
         // new source path, second is source url
         const newSourcePath = sourcePathHandler(sourcePath, '');
@@ -117,11 +128,14 @@ const initIstanbulSourcePath = (coverageData, fileSources, sourcePathHandler) =>
         item.data.path = sourcePath;
         newCoverage[sourcePath] = item;
         // update source for the new path
-        if (source) {
+        if (typeof source === 'string') {
             fileSources[sourcePath] = source;
         }
     });
 
+    // console.log(Object.keys(fileSources));
+    // console.log(newCoverage);
+
     return newCoverage;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-coverage-reports",
-    "version": "2.5.8",
+    "version": "2.5.9",
     "description": "Monocart coverage reports",
     "main": "./lib/index.js",
     "bin": {
@@ -36,6 +36,7 @@
         "test-css": "node ./test/test-css.js",
         "test-cli": "npx mcr \"node ./test/test-node-env.js\" -o docs/cli -c test/cli-options.js",
         "test-merge": "node ./test/test-merge.js",
+        "test-merge-istanbul": "node ./test/test-merge-istanbul.js",
         "test-all": "npm run test-browser && npm run test-node && npm run test-cli && npm run test-merge && npm run build-docs",
         "test": "npx mcr \"npm run test-all\" -c test/mcr-options.js",
         "dev": "sf d v8",