monocart-coverage-reports 2.11.0 → 2.11.2

package/README.md

@@ -1,10 +1,12 @@
 # Monocart Coverage Reports
 
-[![](https://img.shields.io/npm/v/monocart-coverage-reports)](https://www.npmjs.com/package/monocart-coverage-reports)
-[![](https://devimg.vercel.app/npm/downloads/monocart-coverage-reports?label={total}%20downloads/month)](https://www.npmjs.com/package/monocart-coverage-reports)
-![](https://img.shields.io/librariesio/github/cenfun/monocart-coverage-reports)
-![](https://img.shields.io/github/license/cenfun/monocart-coverage-reports)
-![](https://img.shields.io/github/actions/workflow/status/cenfun/monocart-coverage-reports/ci.yml)
+[![npm](https://img.shields.io/npm/v/monocart-coverage-reports)](https://www.npmjs.com/package/monocart-coverage-reports)
+![license](https://img.shields.io/github/license/cenfun/monocart-coverage-reports)
+![build](https://img.shields.io/github/actions/workflow/status/cenfun/monocart-coverage-reports/ci.yml)
+[![install size](https://packagephobia.com/badge?p=monocart-coverage-reports)](https://packagephobia.com/result?p=monocart-coverage-reports)
+[![npm graph](https://img.shields.io/badge/npm-graph-blue)](https://npmgraph.js.org/?q=monocart-coverage-reports)
+![dependencies](https://img.shields.io/librariesio/github/cenfun/monocart-coverage-reports)
+[![downloads](https://devimg.vercel.app/npm/downloads/monocart-coverage-reports?label={total}%20downloads/month)](https://www.npmjs.com/package/monocart-coverage-reports)
 
 🌐 English | [简体中文](README.zh-Hans.md)
 
@@ -485,6 +487,16 @@ export interface ScriptCoverage {
 export type V8CoverageData = ScriptCoverage[];
 ```
 
+| JavaScript Runtime | V8 Coverage |  |
+| :--------------| :----: | :----------------------  |
+| Chrome (65%) | ✅ | Chromium-based |
+| Safari (18%) | ❌ |  |
+| Edge (5%) | ✅ | Chromium-based |
+| Firefox (2%) | ❌ |  |
+| Node.js | ✅ |  |
+| Deno | ❌ | [issue](https://github.com/denoland/deno/issues/23359) |
+| Bun | ❌ |  |
+
 ## Filtering Results
 ### 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:

package/README.zh-Hans.md

@@ -1,10 +1,12 @@
 # Monocart Coverage Reports
 
-[![](https://img.shields.io/npm/v/monocart-coverage-reports)](https://www.npmjs.com/package/monocart-coverage-reports)
-[![](https://devimg.vercel.app/npm/downloads/monocart-coverage-reports?label={total}%20downloads/month)](https://www.npmjs.com/package/monocart-coverage-reports)
-![](https://img.shields.io/librariesio/github/cenfun/monocart-coverage-reports)
-![](https://img.shields.io/github/license/cenfun/monocart-coverage-reports)
-![](https://img.shields.io/github/actions/workflow/status/cenfun/monocart-coverage-reports/ci.yml)
+[![npm](https://img.shields.io/npm/v/monocart-coverage-reports)](https://www.npmjs.com/package/monocart-coverage-reports)
+![license](https://img.shields.io/github/license/cenfun/monocart-coverage-reports)
+![build](https://img.shields.io/github/actions/workflow/status/cenfun/monocart-coverage-reports/ci.yml)
+[![install size](https://packagephobia.com/badge?p=monocart-coverage-reports)](https://packagephobia.com/result?p=monocart-coverage-reports)
+[![npm graph](https://img.shields.io/badge/npm-graph-blue)](https://npmgraph.js.org/?q=monocart-coverage-reports)
+![dependencies](https://img.shields.io/librariesio/github/cenfun/monocart-coverage-reports)
+[![downloads](https://devimg.vercel.app/npm/downloads/monocart-coverage-reports?label={total}%20downloads/month)](https://www.npmjs.com/package/monocart-coverage-reports)
 
 🌐 [English](README.md) | 简体中文
 
@@ -489,6 +491,16 @@ export interface ScriptCoverage {
 export type V8CoverageData = ScriptCoverage[];
 ```
 
+| JavaScript Runtime | V8 Coverage |  |
+| :--------------| :----: | :----------------------  |
+| Chrome (65%) | ✅ | Chromium-based |
+| Safari (18%) | ❌ |  |
+| Edge (5%) | ✅ | Chromium-based |
+| Firefox (2%) | ❌ |  |
+| Node.js | ✅ |  |
+| Deno | ❌ | [issue](https://github.com/denoland/deno/issues/23359) |
+| Bun | ❌ |  |
+
 ## Filtering Results
 ## Using `entryFilter` and `sourceFilter` to filter the results for V8 report
 当收集到V8的覆盖数据时，它实际上包含了所有的入口文件的覆盖率数据, 比如有以下3个文件:

package/lib/converter/converter.js

@@ -1348,7 +1348,7 @@ const convertCoverages = (list, options, untested) => {
             }
         }
 
-        logConvertTime(`  ┌ [convert] parsed ast: ${sourcePath} (${EC.cyan(Util.BSF(maxContentLength))})`, time_start_ast, untested);
+        logConvertTime(`${EC.magenta('│ ')}${EC.cyan('├')} [convert] parsed ast: ${sourcePath} (${EC.cyan(Util.BSF(maxContentLength))})`, time_start_ast, untested);
 
         // console.log(sourcePath, astInfo.statements.length);
         // ============================
@@ -1390,7 +1390,7 @@ const convertCoverages = (list, options, untested) => {
 
         stateList.push(state);
 
-        logConvertTime(`  ┌ [convert] unpacked sourcemap: ${sourcePath} (${unpackedFiles})`, time_start_unpack, untested);
+        logConvertTime(`${EC.magenta('│ ')}${EC.cyan('├')} [convert] unpacked sourcemap: ${sourcePath} (${unpackedFiles})`, time_start_unpack, untested);
 
     }
 
@@ -1616,7 +1616,7 @@ const addUntestedFiles = async (stateList, options) => {
 
     // console.log('untestedList', untestedList);
 
-    Util.logTime(`  ┌ [convert] added untested files: ${EC.yellow(untestedList.length)}`, time_start_untested);
+    Util.logTime(`${EC.magenta('│ ')}${EC.cyan('├')} [convert] added untested files: ${EC.yellow(untestedList.length)}`, time_start_untested);
 
 
 };
@@ -1708,7 +1708,7 @@ const convertV8List = async (v8list, options) => {
     const time_start_convert = Date.now();
     const dataList = generateV8DataList(stateList, options);
     const dataFiles = EC.cyan(`${dataList.v8DataList.length} files`);
-    Util.logTime(`  ┌ [convert] converted data list (${dataFiles})`, time_start_convert);
+    Util.logTime(`${EC.magenta('│ ')}${EC.cyan('├')} [convert] converted data list (${dataFiles})`, time_start_convert);
 
     return dataList;
 };

package/lib/default/options.js

@@ -88,6 +88,9 @@ module.exports = {
     // {boolean} Indicates whether to clean previous cache in output dir before generating report. Defaults to false.
     cleanCache: false,
 
+    // {number} gc threshold
+    gc: null,
+
     // {function} onEntry hook
     // onEntry: async (entry) => {}
     onEntry: null,

package/lib/generate.js

@@ -1,6 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 const { fileURLToPath } = require('url');
+const EC = require('eight-colors');
 
 const Util = require('./utils/util.js');
 const { convertV8List } = require('./converter/converter.js');
@@ -172,12 +173,12 @@ const getCoverageResults = async (dataList, sourceCache, options) => {
         // merge v8list first
         const t1 = Date.now();
         const v8list = await mergeV8Coverage(dataList, sourceCache, options);
-        Util.logTime('┌ [generate] merged v8 coverage data', t1);
+        Util.logTime(`${EC.magenta('├')} [generate] merged v8 coverage data`, t1);
         // console.log('after merge', v8list.map((it) => it.url));
 
         const t2 = Date.now();
         const results = await convertV8List(v8list, options);
-        Util.logTime('┌ [generate] converted coverage data', t2);
+        Util.logTime(`${EC.magenta('├')} [generate] converted coverage data`, t2);
 
         const {
             v8DataList, coverageData, fileSources
@@ -189,7 +190,7 @@ const getCoverageResults = async (dataList, sourceCache, options) => {
     const t3 = Date.now();
     const istanbulData = await mergeIstanbulCoverage(dataList, options);
     const { coverageData, fileSources } = initIstanbulData(istanbulData, options);
-    Util.logTime('┌ [generate] prepared istanbul coverage data', t3);
+    Util.logTime(`${EC.magenta('├')} [generate] prepared istanbul coverage data`, t3);
     const results = await saveIstanbulReports(coverageData, fileSources, options);
     return results;
 };
@@ -210,7 +211,7 @@ const generateCoverageReports = async (dataList, sourceCache, options) => {
             } else {
                 await customReport(reportName, coverageResults, reportOptions, options);
             }
-            Util.logTime(`┌ [generate] saved report: ${reportName}`, t1);
+            Util.logTime(`${EC.magenta('├')} [generate] saved report: ${reportName}`, t1);
         }
     }
 
@@ -340,7 +341,7 @@ const resolveEntrySource = (entry, sourceMapCache, sourceCache) => {
     const url = entry.url;
 
     // source from `source-id.json`
-    const sourceData = sourceCache[url];
+    const sourceData = sourceCache.get(url);
     if (sourceData) {
         entry.source = sourceData.source;
         return;
@@ -424,7 +425,7 @@ const readCoverageData = async (dir, filename, entryFilter, sourceCache) => {
 };
 
 const readSourceList = async (dir, sourceList) => {
-    const sourceCache = {};
+    const sourceCache = new Map();
 
     for (const filename of sourceList) {
         const content = await Util.readFile(path.resolve(dir, filename));
@@ -436,7 +437,7 @@ const readSourceList = async (dir, sourceList) => {
             continue;
         }
         if (json.url) {
-            sourceCache[json.url] = json;
+            sourceCache.set(json.url, json);
         }
     }
 
@@ -476,16 +477,16 @@ const readFromDir = async (mcr, dir) => {
 
     const entryFilter = mcr.getEntryFilter();
 
-    const results = [];
     for (const filename of coverageList) {
         const coverageData = await readCoverageData(dir, filename, entryFilter, sourceCache);
         if (coverageData) {
-            const res = await mcr.add(coverageData);
-            results.push(res);
+            await mcr.add(coverageData);
         }
     }
 
-    return results;
+    // GC
+    sourceCache.clear();
+
 };
 
 module.exports = {

package/lib/index.d.ts

@@ -404,6 +404,13 @@ declare namespace MCR {
         */
         cleanCache?: boolean;
 
+        /**
+         * {number} gc threshold
+         * 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
+         */
+        gc?: number;
+
         /** (V8 only) {function} onEntry hook */
         onEntry?: (entry: V8CoverageEntry) => Promise<void>;
 

package/lib/index.js

@@ -68,6 +68,10 @@ class CoverageReport {
         // init logging for clean after generated
         this.logging = Util.initLoggingLevel(this.options.logging);
 
+        if (Util.isNum(this.options.gc)) {
+            Util.setGC(this.options.gc);
+        }
+
         // init outputDir
         const outputDir = `${this.options.outputDir || defaultOptions.outputDir}`;
         this.options.outputDir = outputDir;
@@ -124,9 +128,8 @@ class CoverageReport {
     // add coverage from dir
     async addFromDir(dir) {
         const time_start = Date.now();
-        const results = await readFromDir(this, dir);
+        await readFromDir(this, dir);
         Util.logTime(`added from dir: ${dir}`, time_start);
-        return results;
     }
 
     // generate report
@@ -165,7 +168,7 @@ class CoverageReport {
             });
         }
 
-        Util.logTime('┌ [generate] prepared coverage data', time_start);
+        Util.logTime(`${EC.magenta('├')} [generate] prepared coverage data`, time_start);
 
         const coverageResults = await generateCoverageReports(dataList, sourceCache, this.options);
 
@@ -249,7 +252,7 @@ class CoverageReport {
             return;
         }
 
-        Util.logInfo(`Loaded: ${EC.cyan(configPath)}`);
+        Util.logInfo(`Loaded: ${EC.cyan(Util.relativePath(configPath))}`);
 
         // init options again
         this.options = {

package/lib/istanbul/istanbul.js

@@ -3,6 +3,7 @@ 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');
 
 const Util = require('../utils/util.js');
 const IstanbulSummary = require('./istanbul-summary.js');
@@ -95,7 +96,7 @@ const saveIstanbulReports = (coverageData, fileSources, options) => {
             const t1 = Date.now();
             const report = istanbulReports.create(reportName, reportOptions);
             report.execute(context);
-            Util.logTime(`┌ [generate] saved report: ${reportName}`, t1);
+            Util.logTime(`${EC.magenta('├')} [generate] saved report: ${reportName}`, t1);
         }
     }
 
@@ -144,7 +145,7 @@ const addUntestedFiles = async (istanbulData, options) => {
 
 };
 
-const mergeIstanbulDataList = (dataList) => {
+const mergeIstanbulDataList = (dataList, options) => {
     const istanbulCoverageList = dataList.map((it) => it.data);
     const coverageMap = istanbulLibCoverage.createCoverageMap();
     istanbulCoverageList.forEach((coverage) => {
@@ -155,7 +156,7 @@ const mergeIstanbulDataList = (dataList) => {
 };
 
 const mergeIstanbulCoverage = async (dataList, options) => {
-    const istanbulData = mergeIstanbulDataList(dataList);
+    const istanbulData = mergeIstanbulDataList(dataList, options);
     await addUntestedFiles(istanbulData, options);
     return istanbulData;
 };