monocart-coverage-reports 2.7.6 → 2.7.7

package/README.md

@@ -16,7 +16,7 @@
 * [Collecting V8 Coverage Data](#collecting-v8-coverage-data)
     - [Collecting V8 Coverage Data with Playwright](#collecting-v8-coverage-data-with-playwright)
     - [Collecting Raw V8 Coverage Data with Puppeteer](#collecting-raw-v8-coverage-data-with-puppeteer)
-    - [Node.js V8 Coverage Report for Server Side](#nodejs-v8-coverage-report-for-server-side)
+    - [Collecting V8 Coverage Data from Node.js](#collecting-v8-coverage-data-from-nodejs)
     - [Collecting V8 Coverage Data with `CDPClient` API](#collecting-v8-coverage-data-with-cdpclient-api)
     - [V8 Coverage Data API](#v8-coverage-data-api)
 * [Using `entryFilter` and `sourceFilter` to filter the results for V8 report](#using-entryfilter-and-sourcefilter-to-filter-the-results-for-v8-report)
@@ -42,6 +42,7 @@
     - [WebdriverIO](#webdriverio)
     - [Storybook Test Runner](#storybook-test-runner)
     - [TestCafe](#testcafe)
+    - [Selenium Webdriver](#selenium-webdriver)
     - [Mocha](#mocha)
     - [tsx](#tsx)
     - [ts-node](#ts-node)
@@ -53,30 +54,31 @@
 
 ## Usage
 > It's recommended to use [Node.js 20+](https://nodejs.org/).
-- [API](#multiprocessing-support)
+- API
 ```js
 const MCR = require('monocart-coverage-reports');
-const coverageOptions = {
+const mcr = MCR({
     name: 'My Coverage Report - 2024-02-28',
     outputDir: './coverage-reports',
-    reports: ["v8", "console-details"]
-}
-const mcr = MCR(coverageOptions);
-mcr.cleanCache();
-
-await mcr.add(coverageData1);
-await mcr.add(coverageData2);
-
+    reports: ["v8", "console-details"],
+    cleanCache: true
+});
+await mcr.add(coverageData);
 await mcr.generate();
-
-// Or 
-// const { CoverageReport } = require('monocart-coverage-reports');
-// const mcr = new CoverageReport(coverageOptions);
 ```
-- [CLI](#command-line)
+Using `import` and load options from [config file](#config-file)
+```js
+import { CoverageReport } from 'monocart-coverage-reports';
+const mcr = new CoverageReport();
+await mcr.loadConfig();
+```
+For more information, see [Multiprocessing Support](#multiprocessing-support)
+
+- CLI
 ```sh
 mcr node my-app.js -r v8,console-details
 ```
+For more information, see [Command Line](#command-line)
 
 ## Options
 - Default Options: [lib/default/options.js](./lib/default/options.js)
@@ -109,7 +111,7 @@ mcr node my-app.js -r v8,console-details
 - `v8-json`
     - [V8 coverage-report.json](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/coverage-report.json)
 
-> Istanbul build-in reports (both V8 and istanbul data):
+> Istanbul build-in reports (both V8 and Istanbul data):
 
 - `clover`
 - `cobertura`
@@ -129,7 +131,7 @@ mcr node my-app.js -r v8,console-details
 - `text-lcov`
 - `text-summary`
 
-> Other build-in reports (both V8 and istanbul data):
+> Other build-in reports (both V8 and Istanbul data):
 
 - `codecov`
     - coverage data for [Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format), see [example](https://app.codecov.io/github/cenfun/monocart-coverage-reports) 
@@ -163,9 +165,9 @@ mcr node my-app.js -r v8,console-details
         ]
     }
     ```
-    - istanbul custom reporter
+    - Istanbul custom reporter
     > example: [./test/custom-istanbul-reporter.js](./test/custom-istanbul-reporter.js), see [istanbul built-in reporters' implementation](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-reports/lib) for reference.
-    - v8 custom reporter
+    - V8 custom reporter
     > example: [./test/custom-v8-reporter.js](./test/custom-v8-reporter.js)
 
 ### Multiple Reports:
@@ -194,11 +196,9 @@ const coverageOptions = {
         }],
         // Specify reporter name with local path
         ['/absolute/path/to/custom-reporter.js']
-
     ]
 }
 const mcr = MCR(coverageOptions);
-mcr.cleanCache();
 ```
 
 ## Compare Reports
@@ -216,19 +216,20 @@ mcr.cleanCache();
 | Minified code | ❌ | ✅ | ❌ |
 
 ## Collecting Istanbul Coverage Data
-- Instrumenting source code
-    > Before collecting Istanbul coverage data, It requires your source code is instrumented with Istanbul
-    - webpack: [babel-plugin-istanbul](https://github.com/istanbuljs/babel-plugin-istanbul), example: [webpack.config-istanbul.js](./test/webpack.config-istanbul.js)
-    - rollup: [rollup-plugin-istanbul](https://github.com/artberri/rollup-plugin-istanbul)
+- Before coverage collection: Instrumenting source code with Istanbul
+    - webpack with babel loader: [babel-plugin-istanbul](https://github.com/istanbuljs/babel-plugin-istanbul), see example: [webpack.config-istanbul.js](./test/build/webpack.config-istanbul.js)
+    - CLI: [nyc instrument](https://github.com/istanbuljs/nyc/blob/master/docs/instrument.md) or API: [istanbul-lib-instrument](https://github.com/istanbuljs/istanbuljs/blob/main/packages/istanbul-lib-instrument/api.md)
     - vite: [vite-plugin-istanbul](https://github.com/ifaxity/vite-plugin-istanbul)
+    - rollup: [rollup-plugin-istanbul](https://github.com/artberri/rollup-plugin-istanbul)
+    - swc: [swc-plugin-coverage-instrument](https://github.com/kwonoj/swc-plugin-coverage-instrument)
 - Browser
     - Collecting coverage data from `window.__coverage__`, example: [test-istanbul.js](./test/test-istanbul.js)
 - Node.js
     - Collecting coverage data from `global.__coverage__`
 
 ## Collecting V8 Coverage Data
-- Sourcemap for source code: enable `sourcemap` and do not compress/minify:
-    - [webpack](https://webpack.js.org/configuration/): `devtool: source-map` and `mode: development`, example [webpack.config-v8.js](./test/webpack.config-v8.js)
+- Before coverage collection: Enabling `sourcemap` for source code
+    - [webpack](https://webpack.js.org/configuration/): `devtool: source-map` and `mode: development`, example [webpack.config-v8.js](./test/build/webpack.config-v8.js)
     - [rollup](https://rollupjs.org/configuration-options/): `sourcemap: true`
     - [vite](https://vitejs.dev/config/build-options.html): `sourcemap: true` and `minify: false`
     - [esbuild](https://esbuild.github.io/api/): `sourcemap: true` and `minify: false`
@@ -238,7 +239,7 @@ mcr.cleanCache();
     - [Collecting Raw V8 Coverage Data with Puppeteer](#collecting-raw-v8-coverage-data-with-puppeteer)
 
 - Node.js
-    - [Node.js V8 Coverage Report for Server Side](#nodejs-v8-coverage-report-for-server-side)
+    - [Collecting V8 Coverage Data from Node.js](#collecting-v8-coverage-data-from-nodejs)
 
 - CDP
     - [Collecting V8 Coverage Data with `CDPClient` API](#collecting-v8-coverage-data-with-cdpclient-api)
@@ -264,7 +265,7 @@ const [jsCoverage, cssCoverage] = await Promise.all([
 const coverageData = [... jsCoverage, ... cssCoverage];
 
 ```
-see [./test/test-v8.js](./test/test-v8.js), and [anonymous](./test/test-anonymous.js), [css](./test/test-css.js)
+For more examples, see [./test/test-v8.js](./test/test-v8.js), and [anonymous](./test/test-anonymous.js), [css](./test/test-css.js)
 
 ### Collecting Raw V8 Coverage Data with Puppeteer
 ```js
@@ -294,9 +295,9 @@ const coverageData = [... jsCoverage.map((it) => {
     };
 }), ... cssCoverage];
 ```
-see example: [./test/test-puppeteer.js](./test/test-puppeteer.js)
+Example: [./test/test-puppeteer.js](./test/test-puppeteer.js)
 
-### Node.js V8 Coverage Report for Server Side
+### Collecting V8 Coverage Data from Node.js
 Possible solutions:
 - [NODE_V8_COVERAGE](https://nodejs.org/docs/latest/api/cli.html#node_v8_coveragedir)=`dir`
     - Sets Node.js env `NODE_V8_COVERAGE`=`dir` before the program running, the coverage data will be saved to the `dir` after the program exits gracefully.
@@ -330,7 +331,7 @@ Possible solutions:
     - see [Command Line](#command-line)
 
 ### Collecting V8 Coverage Data with `CDPClient` API
-- Work with node debugger `--inspect=9229`
+- Work with node debugger port `--inspect=9229`
 ```js
 const MCR = require('monocart-coverage-reports');
 const client = await MCR.CDPClient({
@@ -372,12 +373,46 @@ await client.startCoverage();
 await page.goto("your page url");
 const coverageData = await client.stopCoverage();
 ```
+- Work with [Selenium Webdriver](https://www.selenium.dev/documentation/webdriver/) WebSocket (Chrome/Edge Browser)
+```js
+const { Builder, Browser } = require('selenium-webdriver');
+const MCR = require('monocart-coverage-reports');
+const driver = await new Builder().forBrowser(Browser.CHROME).build();
+const pageCdpConnection = await driver.createCDPConnection('page');
+const session = new MCR.WSSession(pageCdpConnection._wsConnection);
+const client = await MCR.CDPClient({
+    session
+})
+```
+ - `CDPClient` available APIs
+ ```js
+/** start js coverage */
+startJSCoverage: () => Promise<void>;
+/** stop and return js coverage */
+stopJSCoverage: () => Promise<V8CoverageEntry[]>;
+
+/** start css coverage */
+startCSSCoverage: () => Promise<void>;
+/** stop and return css coverage */
+stopCSSCoverage: () => Promise<V8CoverageEntry[]>;
+
+/** start both js and css coverage */
+startCoverage: () => Promise<void>;
+/** stop and return both js and css coverage */
+stopCoverage: () => Promise<V8CoverageEntry[]>;
+
+/** write the coverage started by NODE_V8_COVERAGE to disk on demand, returns v8 coverage dir */
+writeCoverage: () => Promise<string>;
+
+/** get istanbul coverage data */
+getIstanbulCoverage: (coverageKey?: string) => Promise<any>;
+ ```
 
 ### V8 Coverage Data API
-- [V8 coverage report](https://v8.dev/blog/javascript-code-coverage) - Native support for JavaScript code coverage to V8. (Chromium only)
+- [JavaScript code coverage in V8](https://v8.dev/blog/javascript-code-coverage)
 - [Playwright Coverage Class](https://playwright.dev/docs/api/class-coverage)
-- [Puppeteer Coverage class](https://pptr.dev/api/puppeteer.coverage)
-- [DevTools Protocol for Coverage](https://chromedevtools.github.io/devtools-protocol/tot/Profiler/#method-startPreciseCoverage) see devtools-protocol [ScriptCoverage](https://chromedevtools.github.io/devtools-protocol/tot/Profiler/#type-ScriptCoverage) and [v8-coverage](https://github.com/bcoe/v8-coverage)
+- [Puppeteer Coverage Class](https://pptr.dev/api/puppeteer.coverage)
+- [DevTools Protocol for Coverage](https://chromedevtools.github.io/devtools-protocol/tot/Profiler/#method-startPreciseCoverage) see [ScriptCoverage](https://chromedevtools.github.io/devtools-protocol/tot/Profiler/#type-ScriptCoverage) and [v8-coverage](https://github.com/bcoe/v8-coverage)
 ```js
 // Coverage data for a source range.
 export interface CoverageRange {
@@ -388,7 +423,6 @@ export interface CoverageRange {
     // Collected execution count of the source range.
     count: integer;
 }
-
 // Coverage data for a JavaScript function.
 /**
  * @functionName can be an empty string.
@@ -405,7 +439,6 @@ export interface FunctionCoverage {
     // Whether coverage data for this function has block granularity.
     isBlockCoverage: boolean;
 }
-
 // Coverage data for a JavaScript script.
 export interface ScriptCoverage {
     // JavaScript script id.
@@ -415,32 +448,31 @@ export interface ScriptCoverage {
     // Functions contained in the script that has coverage data.
     functions: FunctionCoverage[];
 }
-
 export type V8CoverageData = ScriptCoverage[];
 ```
 
 ## Using `entryFilter` and `sourceFilter` to filter the results for V8 report
 When V8 coverage data collected, it actually contains the data of all entry files, for example:
-```
-dist/main.js
-dist/vendor.js
-dist/something-else.js
-```
+
+- *dist/main.js*
+- *dist/vendor.js*
+- *dist/something-else.js*
+
 We can use `entryFilter` to filter the entry files. For example, we should remove `vendor.js` and `something-else.js` if they are not in our coverage scope. 
-```
-dist/main.js
-```
+
+- *dist/main.js*
+
 When inline or linked sourcemap exists to the entry file, the source files will be extracted from the sourcemap for the entry file, and the entry file will be removed if `logging` is not `debug`.
-```
-> src/index.js
-> src/components/app.js
-> node_modules/dependency/dist/dependency.js
-```
+
+- *src/index.js*
+- *src/components/app.js*
+- *node_modules/dependency/dist/dependency.js*
+
 We can use `sourceFilter` to filter the source files. For example, we should remove `dependency.js` if it is not in our coverage scope.
-```
-> src/index.js
-> src/components/app.js
-```
+
+- *src/index.js*
+- *src/components/app.js*
+
 For example:
 ```js
 const coverageOptions = {
@@ -600,7 +632,6 @@ mcr.cleanCache();
 const MCR = require('monocart-coverage-reports');
 const coverageOptions = require('path-to/same-options.js');
 const mcr = MCR(coverageOptions);
-// do not clean cache in the stage
 await mcr.add(coverageData1);
 ```
 
@@ -609,7 +640,6 @@ await mcr.add(coverageData1);
 const MCR = require('monocart-coverage-reports');
 const coverageOptions = require('path-to/same-options.js');
 const mcr = MCR(coverageOptions);
-// do not clean cache in the stage
 await mcr.add(coverageData2);
 ```
 
@@ -619,7 +649,6 @@ await mcr.add(coverageData2);
 const MCR = require('monocart-coverage-reports');
 const coverageOptions = require('path-to/same-options.js');
 const mcr = MCR(coverageOptions);
-// do not clean cache before generating reports
 await mcr.generate();
 ```
 
@@ -629,13 +658,13 @@ await mcr.generate();
 - Installing globally
 ```sh
 npm i monocart-coverage-reports -g
-mcr node ./test/specs/node.test.js -r v8,console-summary --lcov
+mcr node ./test/specs/node.test.js -r v8,console-details --lcov
 ```
 
 - Locally in your project
 ```sh
 npm i monocart-coverage-reports
-npx mcr node ./test/specs/node.test.js -r v8,console-summary --lcov
+npx mcr node ./test/specs/node.test.js -r v8,console-details --lcov
 ```
 
 - CLI Options
@@ -692,6 +721,7 @@ The following usage scenarios may require merging coverage reports:
 
 If the reports cannot be merged automatically, then here is how to manually merge the reports.
 First, using the `raw` report to export the original coverage data to the specified directory.
+For example, we have `raw` coverage data from unit tests:
 ```js
 const coverageOptions = {
     name: 'My Unit Test Coverage Report',
@@ -699,15 +729,18 @@ const coverageOptions = {
     reports: [
         ['raw', {
             // relative path will be "./coverage-reports/unit/raw"
+            // defaults to raw
             outputDir: "raw"
         }],
         ['v8'],
-        ['console-summary']
+        ['console-details']
     ]
 };
 ```
-Then, after all the tests are completed, generate a merged report with option `inputDir`:
+We also have `raw` coverage data from e2e tests, which is output to `./coverage-reports/e2e/raw`.
+After all the tests are completed, generate a merged report with option `inputDir`:
 ```js
+// merge-coverage.js
 const fs = require('fs');
 const { CoverageReport } = require('monocart-coverage-reports');
 const inputDir = [
@@ -731,6 +764,10 @@ const coverageOptions = {
     
     sourcePath: (filePath, info) => {
         // Unify the file path for the same files
+        // For example, the file index.js has different paths:
+        // unit: unit-dist/src/index.js
+        // e2e: e2e-dist/src/index.js
+        // return filePath.replace("unit-dist/", "").replace("e2e-dist/", "")
         return filePath;
     },
 
@@ -741,12 +778,12 @@ const coverageOptions = {
     
     onEnd: () => {
         // remove the raw files if it useless
-        inputDir.forEach((p) => {
-            fs.rmSync(p, {
-                recursive: true,
-                force: true
-            });
-        });
+        // inputDir.forEach((p) => {
+        //     fs.rmSync(p, {
+        //         recursive: true,
+        //         force: true
+        //     });
+        // });
     }
 };
 await new CoverageReport(coverageOptions).generate();
@@ -763,7 +800,7 @@ const a = tf ? 'true' : 'false';
 `m1` and `m2` are two consecutive mappings, `p` is the position we looking for. However, we can only get the position of the `m1` or `m2` if we don't fix it to `p`. Especially the generated code is different from the original code, such as the code was minified, compressed or converted, it is difficult to find the exact position. You can try [Debug for Coverage and Sourcemap](#debug-for-coverage-and-sourcemap)
 
 How `MCR` Works:
-- 1, Trying to fix the middle position if not found the exact mapping for the position. However, for non-JS code, such as Vue template, JSX, etc., it might be hard to find a perfect solution.
+- 1, Trying to fix the middle original position with string comparison and [`diff-sequences`](https://github.com/jestjs/jest/tree/main/packages/diff-sequences). However, for non-JS code, such as Vue template, JSX, etc., it might be hard to find a perfect solution.
 - 2, Finding all functions, statements and branches by parsing the source code [AST](https://github.com/acornjs/acorn). However, there's a small issue, which is the V8 cannot provide effective branch coverage information for `AssignmentPattern`.
 
 
@@ -795,7 +832,7 @@ const coverageOptions = {
     logging: 'debug',
     reports: [
         ['v8'],
-        ['console-summary']
+        ['console-details']
     ]
 };
 ```
@@ -818,6 +855,7 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
 ## Integration Examples
 
 ### [Playwright](https://github.com/microsoft/playwright)
+- [playwright-coverage](https://github.com/cenfun/playwright-coverage) - A Example for Playwright Coverage Reports
 - [monocart-reporter](https://github.com/cenfun/monocart-reporter) - A Playwright custom reporter, supports generating [Code Coverage Report](https://github.com/cenfun/monocart-reporter?#code-coverage-report)
 - Coverage for component testing:
     - [playwright-ct-vue](https://github.com/cenfun/playwright-ct-vue)
@@ -829,6 +867,7 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
 
 ### [Jest](https://github.com/jestjs/jest/)
 - [jest-monocart-coverage](https://github.com/cenfun/jest-monocart-coverage) - A Jest custom reporter for coverage reports
+- [jest-puppeteer-coverage](https://github.com/cenfun/jest-puppeteer-coverage) - A Jest Puppeteer Coverage Example
 - Example for Jest (unit) + Puppeteer (e2e) + Codecov: [maplibre-gl-js](https://github.com/maplibre/maplibre-gl-js)
 
 ### [Vitest](https://github.com/vitest-dev/vitest)
@@ -850,6 +889,9 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
 ### [TestCafe](https://github.com/DevExpress/testcafe)
 - [testcafe-reporter-coverage](https://github.com/cenfun/testcafe-reporter-coverage) - A TestCafe custom reporter for coverage reports
 
+### [Selenium Webdriver](https://github.com/seleniumhq/selenium)
+- [selenium-webdriver-coverage](https://github.com/cenfun/selenium-webdriver-coverage) - Selenium Webdriver V8 Coverage Example
+
 ### [Mocha](https://github.com/mochajs/mocha)
 ```sh
 mcr mocha ./test/**/*.js

package/lib/cli.js

@@ -21,25 +21,12 @@ const getRegisterPath = (filename) => {
     return `./${rel}`;
 };
 
-const isFeatureSupported = (nv) => {
-    // module register added in Node.js: v20.6.0
-    const [major, minor] = nv.split('.').map((s) => parseInt(s));
-    if (major < 20) {
-        return false;
-    }
-    if (major > 20) {
-        return true;
-    }
-    if (minor < 6) {
-        return false;
-    }
-    return true;
-};
-
 const initNodeOptions = async (cliOptions) => {
+
+    // module register added in Node.js: v20.6.0
     const nv = process.versions.node;
-    if (!isFeatureSupported(nv)) {
-        Util.logInfo(EC.yellow(`The current Node.js version "${nv}" does NOT support "module.register", it requires "20.6.0" or higher.`));
+    if (Util.cmpVersion(nv, '20.6.0') < 0) {
+        Util.logInfo(`The current Node.js version "${nv}" does NOT support "module.register", it requires "20.6.0" or higher.`);
         return;
     }
 

package/lib/client/coverage-client.js

@@ -131,19 +131,22 @@ class CoverageClient {
         unbindEvents(this.session, this.jsEvents);
         this.jsEvents = null;
 
-        const jsCoverage = profileResponse.result;
-        // console.log('coverageList', coverageList);
+        const jsCoverage = [];
 
-        jsCoverage.forEach((entry) => {
-            // anonymous url
-            entry.url = entry.url || '';
-            // add source
-            const source = this.scriptSources.get(entry.scriptId);
-            if (!source) {
-                Util.logDebug(`Not found js source: ${entry.url}`);
-            }
-            entry.source = source || '';
-        });
+        // console.log('coverageList', coverageList);
+        if (profileResponse && profileResponse.result) {
+            profileResponse.result.forEach((entry) => {
+                // anonymous url
+                entry.url = entry.url || '';
+                // add source
+                const source = this.scriptSources.get(entry.scriptId);
+                if (!source) {
+                    Util.logDebug(`Not found js source: ${entry.url}`);
+                }
+                entry.source = source || '';
+                jsCoverage.push(entry);
+            });
+        }
 
         this.scriptSources.clear();
         this.enabledJS = false;
@@ -239,22 +242,39 @@ class CoverageClient {
     }
 
     async stopCoverage() {
+        if (!this.session) {
+            return;
+        }
         const [jsCoverage, cssCoverage] = await Promise.all([
             this.stopJSCoverage(),
             this.stopCSSCoverage()
         ]);
-        return [... jsCoverage, ... cssCoverage];
+        // could be undefined
+        let coverageList = [];
+        if (jsCoverage) {
+            coverageList = coverageList.concat(jsCoverage);
+        }
+        if (cssCoverage) {
+            coverageList = coverageList.concat(cssCoverage);
+        }
+        return coverageList;
     }
 
     // =================================================================================================
     // write the coverage started by NODE_V8_COVERAGE to disk on demand
     async writeCoverage() {
-        // // enable and start v8 coverage
+        if (!this.session) {
+            return;
+        }
+
         await this.session.send('Runtime.enable');
 
-        //  write the coverage started by NODE_V8_COVERAGE to disk on demand
+        // write the coverage started by NODE_V8_COVERAGE to disk on demand
         const res = await this.session.send('Runtime.evaluate', {
-            expression: 'new Promise(resolve=>{ require("v8").takeCoverage(); resolve(process.env.NODE_V8_COVERAGE); })',
+            expression: `new Promise((resolve) => { 
+                require("v8").takeCoverage();
+                resolve(process.env.NODE_V8_COVERAGE);
+            })`,
             includeCommandLineAPI: true,
             returnByValue: true,
             awaitPromise: true
@@ -262,7 +282,31 @@ class CoverageClient {
 
         await this.session.send('Runtime.disable');
 
-        return res.result.value;
+        return res && res.result && res.result.value;
+    }
+
+    // get istanbul coverage data
+    async getIstanbulCoverage(coverageKey = '__coverage__') {
+        if (!this.session) {
+            return;
+        }
+
+        await this.session.send('Runtime.enable');
+
+        // both browser and Node.js
+        const res = await this.session.send('Runtime.evaluate', {
+            expression: `new Promise((resolve) => { 
+                const globalTarget = typeof window !== 'undefined' ? window : global;
+                resolve(globalTarget['${coverageKey}']);
+            })`,
+            includeCommandLineAPI: true,
+            returnByValue: true,
+            awaitPromise: true
+        });
+
+        await this.session.send('Runtime.disable');
+
+        return res && res.result && res.result.value;
     }
 
     // =================================================================================================
@@ -270,10 +314,8 @@ class CoverageClient {
         if (!this.session) {
             return;
         }
-
         await this.session.detach();
         this.session = null;
-
     }
 }
 

package/lib/index.d.ts

@@ -119,7 +119,7 @@ declare namespace MCR {
             outputDir?: string;
         }] |
         [string] | [string, {
-            type?: "v8" | "istanbul" | "both";
+            type?: "v8" | "istanbul" | "both" | string;
             [key: string]: any;
         }];
 
@@ -192,7 +192,7 @@ declare namespace MCR {
             ignores?: IgnoredRange[];
             /** codecov json format */
             lines: {
-                [key: string]: number | string
+                [key: string]: number | string;
             };
         }
     }
@@ -287,7 +287,7 @@ declare namespace MCR {
             */
             filter?: string | {
                 [pattern: string]: "js" | "css" | boolean;
-            } | ((filePath: string) => "js" | "css" | boolean)
+            } | ((filePath: string) => "js" | "css" | boolean);
         };
 
         /** (V8 only) {boolean} Enable/Disable ignoring uncovered codes with the special comments: v8 ignore next/next N/start/stop */
@@ -320,6 +320,7 @@ declare namespace MCR {
         /** {function} onEnd hook */
         onEnd?: (coverageResults: CoverageResults) => Promise<void>;
 
+        [key: string]: any;
     }
 
     export interface McrCliOptions extends CoverageReportOptions {
@@ -441,15 +442,19 @@ declare namespace MCR {
         stopCoverage: () => Promise<V8CoverageEntry[]>;
 
         /** write the coverage started by NODE_V8_COVERAGE to disk on demand, returns v8 coverage dir */
-        writeCoverage: () => Promise<string>
+        writeCoverage: () => Promise<string>;
 
+        /** get istanbul coverage data
+         * @param coverageKey defaults to `__coverage__`
+         */
+        getIstanbulCoverage: (coverageKey?: string) => Promise<any>;
     }
 
     /** Adapt to the CDPSession of Playwright or Puppeteer */
     export interface CDPSession {
         send: (method: string, params?: any) => Promise<any>;
         on: (type: string, handler: (e: any) => void) => void;
-        detach: () => Promise<void>
+        detach: () => Promise<void>;
     }
 
     /** custom websocket CDPSession */
@@ -457,7 +462,7 @@ declare namespace MCR {
         constructor(ws: any);
         send: (method: string, params?: any) => Promise<any>;
         on: (type: string, handler: (e: any) => void) => void;
-        detach: () => Promise<void>
+        detach: () => Promise<void>;
     }
 
     export interface CDPOptions {
@@ -472,7 +477,7 @@ declare namespace MCR {
         /** enable https, defaults to false (http) */
         secure?: boolean;
         /** target filter, defaults to first page */
-        target?: (targets) => any;
+        target?: (targets: any) => any;
         /** websocket options */
         ws?: any;
         /** timeout, defaults to 10 * 1000 */

package/lib/utils/util.js

@@ -442,6 +442,18 @@ const Util = {
         return str;
     },
 
+    cmpVersion: (v1, v2) => {
+        const [major1, minor1, patch1] = `${v1}`.split('.').map((s) => parseInt(s));
+        const [major2, minor2, patch2] = `${v2}`.split('.').map((s) => parseInt(s));
+        if (major1 === major2) {
+            if (minor1 === minor2) {
+                return Util.toNum(patch1) - Util.toNum(patch2);
+            }
+            return Util.toNum(minor1) - Util.toNum(minor2);
+        }
+        return Util.toNum(major1) - Util.toNum(major2);
+    },
+
     // ==========================================================================================
 
     loggingLevels: {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-coverage-reports",
-    "version": "2.7.6",
+    "version": "2.7.7",
     "description": "A code coverage tool to generate native V8 reports or Istanbul reports.",
     "main": "./lib/index.js",
     "bin": {
@@ -24,7 +24,7 @@
     },
     "types": "./lib/index.d.ts",
     "scripts": {
-        "build-test": "node ./scripts/build-test.js",
+        "build-test": "node ./test/build/build-test.js",
         "build": "sf lint && sf b -p && npm run build-test",
         "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",
@@ -33,7 +33,7 @@
         "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": "npm run test-node-env && npm run test-node-api && npm run test-node-ins && npm run test-node-cdp && npm run test-node-vm && npm run test-node-koa",
+        "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",
@@ -43,15 +43,14 @@
         "test-esbuild": "node ./test/test-esbuild.js",
         "test-rollup": "node ./test/test-rollup.js",
         "test-v8-and-istanbul": "node ./test/test-v8-and-istanbul.js",
-        "test-browser": "npm run test-istanbul && npm run test-v8 && npm run test-puppeteer && npm run test-anonymous && npm run test-css && npm run test-minify && npm run test-esbuild && npm run test-rollup && npm run test-v8-and-istanbul",
+        "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": "npm run test-node && npm run test-browser && npm run test-cli && npm run test-tsx && npm run test-merge && node ./scripts/docs.js",
-        "test-node-14": "npm run test-node && npm run test-v8 && npm run test-anonymous && npm run test-css && npm run test-minify && npm run test-esbuild && npm run test-v8-and-istanbul && npm run test-cli",
+        "test-all": "node ./test/test.js && node ./scripts/docs.js",
         "test": "npx mcr npm run test-all -c test/mcr.config.mcr.js",
         "test:snap": "cross-env TEST_SNAPSHOT=true npm run test",
         "dev": "sf d v8",
@@ -89,7 +88,7 @@
         "eslint-plugin-html": "^8.0.0",
         "eslint-plugin-vue": "^9.23.0",
         "minimatch": "^9.0.3",
-        "stylelint": "^16.2.1",
+        "stylelint": "^16.3.0",
         "stylelint-config-plus": "^1.1.0",
         "supports-color": "^9.4.0",
         "tsx": "^4.7.1",