monocart-coverage-reports 2.13.2 → 3.1.0

package/lib/default/options.js

@@ -1,4 +1,4 @@
-module.exports = {
+const defaultOptions = {
 
     // {string} logging levels: off, error, info, debug
     logging: 'info',
@@ -24,6 +24,12 @@ module.exports = {
     // {string|string[]} input raw dir(s)
     inputDir: null,
 
+    // (mcr test only) {string|string[]|null} Test file paths or glob patterns accepted by node --test.
+    // A string is one positional argument; an array supplies multiple arguments unchanged.
+    // Used when no CLI targets are supplied; null skips tests and is not passed to Node.
+    // Ignored by other CLI commands and the API.
+    test: null,
+
     // {string} base dir for normalizing the relative source path, defaults to cwd
     baseDir: null,
 
@@ -43,6 +49,10 @@ module.exports = {
     // sourceFilter: (sourcePath) => sourcePath.search(/src\/.+/) !== -1,
     sourceFilter: null,
 
+    // (V8 only) Filter final files by sourcePath after sourcemap conversion and adding untested files.
+    // outputFilter: (entry) => entry.sourcePath.startsWith('src/'),
+    outputFilter: null,
+
     // The combined filter for entryFilter and sourceFilter
     filter: null,
 
@@ -105,3 +115,5 @@ module.exports = {
     // onEnd: async (reportData) => {}
     onEnd: null
 };
+
+export { defaultOptions };

package/lib/generate.js

@@ -1,35 +1,28 @@
-const fs = require('fs');
-const path = require('path');
-const { fileURLToPath } = require('url');
-const EC = require('eight-colors');
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import EC from 'eight-colors';
 
-const Util = require('./utils/util.js');
-const { convertV8List } = require('./converter/converter.js');
-const { resolveSourceMap } = require('./converter/collect-source-maps.js');
-const { StreamZip } = require('./packages/monocart-coverage-vendor.js');
+import { Util } from './utils/util.js';
+import { resolveSourceMap } from './converter/collect-source-maps.js';
 
 // ========================================================================================================
 // built-in reports
 
-// istanbul
-const { mergeIstanbulCoverage, saveIstanbulReports } = require('./istanbul/istanbul.js');
-
 // v8
-const { mergeV8Coverage, saveV8Report } = require('./v8/v8.js');
+import { mergeV8Coverage, saveV8Report } from './v8/v8.js';
 
 // both
-const { codecovReport } = require('./reports/codecov.js');
-const { codacyReport } = require('./reports/codacy.js');
-
-const { consoleDetailsReport } = require('./reports/console-details.js');
-const { consoleSummaryReport } = require('./reports/console-summary.js');
+import { codecovReport } from './reports/codecov.js';
+import { codacyReport } from './reports/codacy.js';
 
-const { markdownDetailsReport } = require('./reports/markdown-details.js');
-const { markdownSummaryReport } = require('./reports/markdown-summary.js');
+import { consoleDetailsReport } from './reports/console-details.js';
+import { consoleSummaryReport } from './reports/console-summary.js';
 
-const { rawReport } = require('./reports/raw.js');
+import { markdownDetailsReport } from './reports/markdown-details.js';
+import { markdownSummaryReport } from './reports/markdown-summary.js';
 
-const { customReport } = require('./reports/custom.js');
+import { customReport } from './reports/custom.js';
 
 const allBuiltInReports = {
     // v8
@@ -71,7 +64,10 @@ const bothBuiltInReports = {
     'markdown-details': markdownDetailsReport,
     'markdown-summary': markdownSummaryReport,
 
-    'raw': rawReport
+    'raw': async (... args) => {
+        const { rawReport } = await import('./reports/raw.js');
+        return rawReport(... args);
+    }
 };
 
 // ========================================================================================================
@@ -146,6 +142,7 @@ const generateV8ListReports = async (v8list, coverageData, fileSources, options)
     let istanbulReportPath;
     // v8 to istanbul reports
     if (options.reportGroup.has('istanbul')) {
+        const { saveIstanbulReports } = await import('./istanbul/istanbul.js');
         const istanbulCoverageResults = await saveIstanbulReports(coverageData, fileSources, options);
         istanbulReportPath = istanbulCoverageResults.reportPath;
     }
@@ -175,17 +172,34 @@ const getCoverageResults = async (dataList, sourceCache, options) => {
         // console.log('after merge', v8list.map((it) => it.url));
 
         const t2 = Date.now();
-        const results = await convertV8List(v8list, options);
+        const { convertV8List } = await import('./converter/converter.js');
+        const results = await convertV8List(v8list, options, options.reportGroup.has('istanbul'));
         Util.logTime(`${EC.magenta('├')} [generate] converted coverage data`, t2);
 
         const {
             v8DataList, coverageData, fileSources
         } = results;
-        return generateV8ListReports(v8DataList, coverageData, fileSources, options);
+
+        let filteredV8DataList = v8DataList;
+        if (options.outputFilter) {
+            const outputFilter = Util.createFilterHandler(options.outputFilter, (entry) => entry.sourcePath);
+            filteredV8DataList = v8DataList.filter(outputFilter);
+            // Keep V8 and converted Istanbul reports in sync.
+            const sourcePaths = new Set(filteredV8DataList.map((entry) => entry.sourcePath));
+            Object.keys(coverageData).forEach((sourcePath) => {
+                if (!sourcePaths.has(sourcePath)) {
+                    delete coverageData[sourcePath];
+                    delete fileSources[sourcePath];
+                }
+            });
+        }
+
+        return generateV8ListReports(filteredV8DataList, coverageData, fileSources, options);
     }
 
     // istanbul data
     const t3 = Date.now();
+    const { mergeIstanbulCoverage, saveIstanbulReports } = await import('./istanbul/istanbul.js');
     const istanbulData = await mergeIstanbulCoverage(dataList, options);
     Util.logTime(`${EC.magenta('├')} [generate] prepared istanbul coverage data`, t3);
     const fileSources = options.fileSources || {};
@@ -277,6 +291,8 @@ const addDirData = async (mcr, dataList, sourceCache, dir) => {
 };
 
 const addZipData = async (mcr, dataList, sourceCache, dir) => {
+    const { default: StreamZipModule } = await import('node-stream-zip');
+    const StreamZip = StreamZipModule.async;
     const zip = new StreamZip({
         file: dir
     });
@@ -327,7 +343,9 @@ const getInputData = async (mcr) => {
             return;
         }
         // No coverage input: use V8 so `all` can add untested files.
-        dataList.push({ type: 'v8', data: [] });
+        dataList.push({
+            type: 'v8', data: []
+        });
     }
 
     return {
@@ -491,7 +509,7 @@ const readFromDir = async (mcr, dir) => {
 
 };
 
-module.exports = {
+export {
     getInputData,
     readFromDir,
     generateCoverageReports

package/lib/index.d.ts

@@ -322,6 +322,14 @@ declare namespace MCR {
             [pattern: string]: boolean;
         } | ((sourcePath: string) => boolean);
 
+        /** (V8 only) Filter final files after sourcemap conversion and adding untested files.
+         * Applies to V8 reports and converted Istanbul reports. Defaults to null (disabled).
+         * Strings and object keys match sourcePath using the same rules as entryFilter and sourceFilter.
+         */
+        outputFilter?: string | {
+            [pattern: string]: boolean;
+        } | ((entry: CoverageFile) => boolean) | null;
+
         /**
          * The combined filter for entryFilter and sourceFilter
          */
@@ -405,7 +413,7 @@ declare namespace MCR {
         cleanCache?: boolean;
 
         /**
-         * {number} gc threshold
+         * {number} JavaScript heapUsed threshold in MB
          * for example: sets gc to 1024 means that force gc when the memory > 1024M at certain critical stages
          * https://nodejs.org/docs/latest/api/v8.html#v8setflagsfromstringflags
          */
@@ -432,6 +440,15 @@ declare namespace MCR {
 
     export interface McrCliOptions extends CoverageReportOptions {
 
+        /** Only used by `mcr test`. Test file paths or glob patterns accepted by node --test.
+         * A string is one positional argument; an array supplies multiple arguments unchanged.
+         * Node handles parsing and discovery relative to cwd; null is not passed to Node.
+         * Positional CLI targets override this option.
+         * Defaults to null (skip tests unless CLI targets are supplied).
+         * Requires Node.js >= 22.15.0. Ignored by other commands and the API.
+         */
+        test?: string | string[] | null;
+
         /** (CLI only) {function} onStart hook */
         onStart?: (coverageReport: CoverageReport) => void | Promise<void>;
 
@@ -479,6 +496,8 @@ declare namespace MCR {
         /** load config file. 
          * 
          * @param configFile custom config file path
+         * Throws if a custom config is missing or a discovered config fails to load.
+         * If no custom config is specified and no default config is found, returns normally.
          * 
          * Supports loading default config file if no custom config specified: 
             'mcr.config.js',
@@ -532,6 +551,9 @@ declare namespace MCR {
     //=====================================================================================================
 
     export class CoverageClient {
+        /** Best-effort command: logs failures at debug level and resolves to null instead of rejecting. */
+        safeSend: (method: string, params?: any) => Promise<any>;
+
         /** start js coverage */
         startJSCoverage: () => Promise<void>;
         /** stop and return js coverage */
@@ -567,7 +589,8 @@ declare namespace MCR {
 
     /** custom websocket CDPSession */
     export class WSSession implements CDPSession {
-        constructor(ws: any);
+        /** Request timeout defaults to 30000ms; 0 disables the deadline. */
+        constructor(ws: any, options?: { timeout?: number });
         send: (method: string, params?: any) => Promise<any>;
         on: (type: string, handler: (e: any) => void) => void;
         detach: () => Promise<void>;
@@ -588,8 +611,10 @@ declare namespace MCR {
         target?: (targets: any) => any;
         /** websocket options */
         ws?: any;
-        /** timeout, defaults to 10 * 1000 */
+        /** HTTP discovery / WebSocket connection timeout, defaults to 10000ms; 0 disables it. */
         timeout?: number;
+        /** Per-command timeout for built-in WebSocket sessions, defaults to 30000ms; 0 disables it. */
+        requestTimeout?: number;
     }
 
     export function CDPClient(cdpOptions: CDPOptions): Promise<CoverageClient | undefined>;
@@ -603,4 +628,27 @@ declare namespace MCR {
 /** create coverage report */
 declare function MCR(options?: MCR.CoverageReportOptions): MCR.CoverageReport;
 
-export = MCR;
+export { MCR as default, MCR };
+export import V8CoverageEntry = MCR.V8CoverageEntry;
+export import Watermarks = MCR.Watermarks;
+export import ReportDescription = MCR.ReportDescription;
+export import AddedResults = MCR.AddedResults;
+export import MetricsSummary = MCR.MetricsSummary;
+export import CoverageSummary = MCR.CoverageSummary;
+export import CoverageRange = MCR.CoverageRange;
+export import IgnoredRange = MCR.IgnoredRange;
+export import CoverageFile = MCR.CoverageFile;
+export import CoverageResults = MCR.CoverageResults;
+export import LoggingType = MCR.LoggingType;
+export import CoverageReportOptions = MCR.CoverageReportOptions;
+export import McrCliOptions = MCR.McrCliOptions;
+export import CoverageSnapshot = MCR.CoverageSnapshot;
+export import CoverageClient = MCR.CoverageClient;
+export import CDPSession = MCR.CDPSession;
+export import CDPOptions = MCR.CDPOptions;
+export import CoverageReport = MCR.CoverageReport;
+export import getSnapshot = MCR.getSnapshot;
+export import diffSnapshot = MCR.diffSnapshot;
+export import WSSession = MCR.WSSession;
+export import CDPClient = MCR.CDPClient;
+export import Util = MCR.Util;

package/lib/index.js

@@ -1,46 +1,41 @@
-const fs = require('fs');
-const path = require('path');
-const { pathToFileURL } = require('url');
-const EC = require('eight-colors');
+import fs from 'node:fs';
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import EC from 'eight-colors';
 
-const defaultOptions = require('./default/options.js');
-const Util = require('./utils/util.js');
+import { defaultOptions } from './default/options.js';
+import { Util } from './utils/util.js';
 
-const { initV8ListAndSourcemap } = require('./v8/v8.js');
-const {
+import { initV8ListAndSourcemap } from './v8/v8.js';
+import {
     getInputData, readFromDir, generateCoverageReports
-} = require('./generate.js');
-const { getSnapshot, diffSnapshot } = require('./utils/snapshot.js');
+} from './generate.js';
+import { getSnapshot, diffSnapshot } from './utils/snapshot.js';
 
-const WSSession = require('./client/ws-session.js');
-const CDPClient = require('./client/cdp-client.js');
+import { WSSession } from './client/ws-session.js';
+import { CDPClient } from './client/cdp-client.js';
+import { CoverageClient } from './client/coverage-client.js';
 
 const resolveConfigOptions = async (configPath) => {
-    // json format
-    const ext = path.extname(configPath);
-    if (ext === '.json' || configPath.slice(-2) === 'rc') {
-        return JSON.parse(Util.readFileSync(configPath));
-    }
-
-    let configOptions;
-    let err;
     try {
-        configOptions = await import(pathToFileURL(configPath));
-    } catch (ee) {
-        err = ee;
-    }
-
-    if (err) {
-        Util.logError(`ERROR: failed to load config "${configPath}": ${err && err.message} `);
-        return;
-    }
+        // json format
+        const ext = path.extname(configPath);
+        if (ext === '.json' || configPath.slice(-2) === 'rc') {
+            return JSON.parse(Util.readFileSync(configPath));
+        }
 
-    // could be multiple level default
-    while (configOptions && configOptions.default) {
-        configOptions = configOptions.default;
+        let configOptions = await import(pathToFileURL(configPath));
+        // could be multiple level default
+        while (configOptions && configOptions.default) {
+            configOptions = configOptions.default;
+        }
+        return configOptions;
+    } catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        throw new Error(`Failed to load config file "${configPath}": ${message}`, {
+            cause: error
+        });
     }
-
-    return configOptions;
 };
 
 class CoverageReport {
@@ -237,7 +232,7 @@ class CoverageReport {
         const configPath = Util.findUpConfig(customConfigFile);
         if (!configPath) {
             if (customConfigFile) {
-                Util.logError(`The config file does not exist: ${customConfigFile}`);
+                throw new Error(`The config file does not exist: ${customConfigFile}`);
             }
             // not found config
             return;
@@ -245,11 +240,7 @@ class CoverageReport {
 
         const configOptions = await resolveConfigOptions(configPath);
         if (!configOptions) {
-            // failed to load config options
-            if (customConfigFile) {
-                Util.logError(`Failed to load config file: ${customConfigFile}`);
-            }
-            return;
+            throw new Error(`Failed to load config file: ${configPath}`);
         }
 
         Util.logInfo(`Loaded: ${EC.cyan(Util.relativePath(configPath))}`);
@@ -271,10 +262,13 @@ const MCR = function(options) {
     return new CoverageReport(options);
 };
 MCR.CoverageReport = CoverageReport;
+MCR.CoverageClient = CoverageClient;
 MCR.getSnapshot = getSnapshot;
 MCR.diffSnapshot = diffSnapshot;
 MCR.WSSession = WSSession;
 MCR.CDPClient = CDPClient;
 MCR.Util = Util;
 
-module.exports = MCR;
+export {
+    MCR as default, MCR, CoverageReport, CoverageClient, getSnapshot, diffSnapshot, WSSession, CDPClient, Util
+};

package/lib/istanbul/istanbul-summary.js

@@ -1,4 +1,4 @@
-const istanbulLibReport = require('istanbul-lib-report');
+import istanbulLibReport from 'istanbul-lib-report';
 
 const ReportBase = istanbulLibReport.ReportBase;
 class IstanbulSummary extends ReportBase {
@@ -70,4 +70,4 @@ class IstanbulSummary extends ReportBase {
 }
 
 
-module.exports = IstanbulSummary;
+export { IstanbulSummary };

package/lib/istanbul/istanbul.js

@@ -1,15 +1,15 @@
-const fs = require('fs');
-const path = require('path');
-const istanbulReports = require('istanbul-reports');
-const istanbulLibCoverage = require('istanbul-lib-coverage');
-const istanbulLibReport = require('istanbul-lib-report');
-const EC = require('eight-colors');
+import fs from 'node:fs';
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import istanbulLibCoverage from 'istanbul-lib-coverage';
+import istanbulLibReport from 'istanbul-lib-report';
+import EC from 'eight-colors';
 
-const Util = require('../utils/util.js');
-const IstanbulSummary = require('./istanbul-summary.js');
+import { Util } from '../utils/util.js';
+import { IstanbulSummary } from './istanbul-summary.js';
 
-const { initIstanbulSourcePath } = require('../utils/source-path.js');
-const { getUntestedList } = require('../converter/untested.js');
+import { initIstanbulSourcePath } from '../utils/source-path.js';
+import { getUntestedList } from '../converter/untested.js';
 
 const findHtmlPath = (outputDir) => {
     const defaultHtml = path.resolve(outputDir, 'index.html');
@@ -35,7 +35,29 @@ const findHtmlPath = (outputDir) => {
 
 };
 
-const saveIstanbulReports = (coverageData, fileSources, options) => {
+const createIstanbulReport = async (name, options) => {
+    let reporter;
+    const isFile = path.isAbsolute(name) || name.startsWith('.');
+    // Built-in reports remain CommonJS dependencies; custom reports may be ESM.
+    if (!isFile) {
+        try {
+            reporter = await import(`istanbul-reports/lib/${name}/index.js`);
+        } catch (error) {
+            if (error.code !== 'ERR_MODULE_NOT_FOUND') {
+                throw error;
+            }
+        }
+    }
+    if (!reporter) {
+        // Native import() also handles CJS reporters without a separate loader.
+        const specifier = isFile ? pathToFileURL(path.resolve(name)).href : name;
+        reporter = await import(specifier);
+    }
+    const Reporter = reporter.default || reporter;
+    return new Reporter(options);
+};
+
+const saveIstanbulReports = async (coverageData, fileSources, options) => {
 
     coverageData = initIstanbulSourcePath(coverageData, fileSources, options);
 
@@ -96,7 +118,7 @@ const saveIstanbulReports = (coverageData, fileSources, options) => {
     if (istanbulGroup) {
         for (const [reportName, reportOptions] of istanbulGroup) {
             const t1 = Date.now();
-            const report = istanbulReports.create(reportName, reportOptions);
+            const report = await createIstanbulReport(reportName, reportOptions);
             report.execute(context);
             Util.logTime(`${EC.magenta('├')} [generate] saved report: ${reportName}`, t1);
         }
@@ -163,7 +185,7 @@ const mergeIstanbulCoverage = async (dataList, options) => {
     return istanbulData;
 };
 
-module.exports = {
+export {
     saveIstanbulReports,
     mergeIstanbulDataList,
     mergeIstanbulCoverage