monocart-reporter 1.7.0 → 1.7.1

package/README.md

@@ -123,8 +123,6 @@ Separated metadata file (Already included in the above HTML and compressed, it c
     coverage: null,
     // coverage: {
     //     entryFilter: (entry) => true,
-    //     unpackSourceMap: true,
-    //     excludeDistFile: true,
     //     sourceFilter: (sourceName) => sourceName.search(/src\/.+/) !== -1,
     // },
 
@@ -632,14 +630,12 @@ Attach a code coverage report with API `attachCoverageReport(data, testInfo, opt
     - `title` (String) report title.
     - `toIstanbul` (Boolean) Whether to convert to Istanbul report from V8 list.
     - `entryFilter` (Function) A filter function to execute for each element in the V8 list.
-    - `unpackSourceMap` (Boolean) Whether to unpack all sources from the source map if a related source map file is found.
-    - `excludeDistFile` (Boolean) Whether to exclude the dist file (usually minified) if the sources are successfully unpacked from the source map.
     - `sourceFilter` (Function) A filter function to execute for each element in the sources which unpacked from the source map.
     - `watermarks` (Object) Istanbul watermarks, see [here](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-lib-report) | (Array) V8 watermarks, Defaults to `[50, 80]`.
     - `lcov` (Boolean) Whether to create `lcov.info`. Istanbul only.
     - `sourcePath` (Function) source path handler, return a new source path. Istanbul only.
-    - `inline` (Boolean) Whether inline all scripts to the single HTML file.
-    - `debug` (Boolean) The temporary artifacts will not be removed.
+    - `inline` (Boolean) Whether inline all scripts to the single HTML file. V8 only.
+    - `debug` (Boolean) The dist file which has source map will be included, and the temporary artifacts will not be removed.
 
  (see example: [report-coverage.spec.js](https://github.com/cenfun/monocart-reporter/blob/main/tests/report-coverage/report-coverage.spec.js))
 
@@ -705,7 +701,7 @@ test('Take V8 and Istanbul coverage report', async ({ page }) => {
     const coverageList = [... jsCoverage, ... cssCoverage];
 
     const v8 = await attachCoverageReport(coverageList, test.info(), {
-        excludeDistFile: false
+        debug: true
     });
     console.log(v8.summary);
 
@@ -745,8 +741,6 @@ module.exports = {
             // global coverage report options
             coverage: {
                 entryFilter: (entry) => true,
-                unpackSourceMap: true,
-                excludeDistFile: true,
                 sourceFilter: (sourceName) => sourceName.search(/src\/.+/) !== -1,
             }
         }]

package/lib/default/options.js

@@ -15,8 +15,6 @@ module.exports = {
     coverage: null,
     // coverage: {
     //     entryFilter: (entry) => true,
-    //     unpackSourceMap: true,
-    //     excludeDistFile: true,
     //     sourceFilter: (sourceName) => sourceName.search(/src\/.+/) !== -1,
     // },
 

package/lib/index.d.ts

@@ -44,11 +44,6 @@ export type CoverageReportOptions = {
     // A filter function to execute for each element in the V8 list.
     entryFilter?: (entry: any) => boolean,
 
-    // Whether to unpack all sources from the source map if a related source map file is found.
-    unpackSourceMap?: boolean,
-    // Whether to exclude the dist file (usually minified) if the sources are successfully unpacked from the source map.
-    excludeDistFile?: boolean,
-
     // A filter function to execute for each element in the sources which unpacked from the source map.
     sourceFilter?: (sourcePath: string) => boolean,
 

package/lib/plugins/coverage/coverage.js

@@ -5,9 +5,12 @@ const EC = require('eight-colors');
 const Util = require('../../utils/util.js');
 const { convertV8ToIstanbul, saveIstanbulReport } = require('./istanbul/istanbul.js');
 const {
-    initV8ListAndSourcemap, unpackV8List, mergeV8Coverage, saveV8Report
+    initV8ListAndSourcemap, mergeV8Coverage, saveV8Report
 } = require('./v8/v8.js');
 
+const { convertFunctionsToRanges } = require('./coverage-utils.js');
+const { unpackSourceMaps } = require('./v8/source-map.js');
+
 const defaultOptions = {
 
     // Defaults to test title
@@ -20,10 +23,7 @@ const defaultOptions = {
 
     // (Function) A filter function to execute for each element in the V8 list.
     entryFilter: null,
-    // (Boolean) Whether to unpack all sources from the source map if a related source map file is found.
-    unpackSourceMap: true,
-    // (Boolean) Whether to exclude the dist file (usually minified) if the sources are successfully unpacked from the source map.
-    excludeDistFile: true,
+
     // (Function) A filter function to execute for each element in the sources which unpacked from the source map.
     sourceFilter: null,
 
@@ -36,19 +36,35 @@ const defaultOptions = {
     sourceFinder: null,
 
     // (Boolean) Whether to create `lcov.info`
-    lcov: false
+    lcov: false,
 
     // (Object) Istanbul watermarks, see [here](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-lib-report)
     // watermarks: {},
     // (Array) V8 watermarks, Defaults to `[50, 80]`
     // watermarks: [50, 80],
 
-    // (Boolean) Whether inline all scripts to the single HTML file.
-    // inline: false,
+    // (Boolean) Whether inline all scripts to the single HTML file. V8 only.
+    inline: false,
 
-    // debug: false
+    // (Boolean) The dist file which has source map will be included, and the temporary artifacts will not be removed.
+    debug: false
 };
 
+// ========================================================================================================
+
+const unpackV8List = async (v8list, options) => {
+    v8list.forEach((item, i) => {
+        if (item.type === 'js') {
+            item.ranges = convertFunctionsToRanges(item.functions);
+            delete item.functions;
+        }
+    });
+
+    // requires ranges before unpack
+    await unpackSourceMaps(v8list, options);
+
+    // console.log(v8list.length);
+};
 
 // ========================================================================================================
 
@@ -101,7 +117,7 @@ const generateV8Coverage = async (v8list, testInfo, options) => {
         return report;
     }
 
-    // ================================================================
+    // =================================================================
 
     // functions to ranges, and unpack source maps
     await unpackV8List(v8list, options);
@@ -222,6 +238,8 @@ const getGlobalCoverageData = async (dataList, options) => {
     const v8list = await mergeV8Coverage(dataList, options);
     // console.log('after merge', v8list.map((it) => it.url));
 
+    // ================================================================
+
     if (options.toIstanbul) {
 
         const { coverageData, fileSources } = await convertV8ToIstanbul(v8list, options);
@@ -233,6 +251,8 @@ const getGlobalCoverageData = async (dataList, options) => {
         return report;
     }
 
+    // ================================================================
+
     // functions to ranges, and unpack source maps
     await unpackV8List(v8list, options);
 

package/lib/plugins/coverage/istanbul/istanbul.js

@@ -43,6 +43,12 @@ const saveIstanbulReport = (coverageData, fileSources, options) => {
 
     const coverageMap = istanbulLibCoverage.createCoverageMap(data);
 
+    const { watermarks, defaultSummarizer } = options;
+    const istanbulOptions = {
+        watermarks,
+        defaultSummarizer
+    };
+
     // https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-lib-report
     const contextOptions = {
         watermarks: {
@@ -55,7 +61,7 @@ const saveIstanbulReport = (coverageData, fileSources, options) => {
         // values can be nested/flat/pkg. Defaults to 'pkg'
         defaultSummarizer: 'nested',
 
-        ... options,
+        ... istanbulOptions,
 
         dir: options.htmlDir,
         sourceFinder: (filePath) => {
@@ -90,7 +96,7 @@ const saveIstanbulReport = (coverageData, fileSources, options) => {
     // create a context for report generation
     const context = istanbulLibReport.createContext(contextOptions);
 
-    const htmlReport = istanbulReports.create('html', {});
+    const htmlReport = istanbulReports.create('html-spa', {});
     htmlReport.execute(context);
 
     const htmlPath = Util.relativePath(path.resolve(options.htmlDir, 'index.html'));

package/lib/plugins/coverage/v8/source-map.js

@@ -388,10 +388,6 @@ const saveSourceFile = async (filePath, data) => {
 
 const collectSourceMaps = async (v8list, options, inlineSourceMap) => {
 
-    if (!options.unpackSourceMap) {
-        return;
-    }
-
     if (inlineSourceMap) {
         await collectInlineSourceMaps(v8list);
         return;
@@ -420,12 +416,8 @@ const filterSourceMapList = (v8list, options) => {
     }
 
     // do not remove in debug mode
-    if (options.debug) {
-        return sourceMapList;
-    }
-
-    // remove dist file if found sourceMap
-    if (options.excludeDistFile) {
+    if (!options.debug) {
+        // remove dist file if found sourceMap
         indexes.reverse();
         indexes.forEach((i) => {
             v8list.splice(i, 1);
@@ -438,11 +430,6 @@ const filterSourceMapList = (v8list, options) => {
 // requires ranges before unpack
 const unpackSourceMaps = async (v8list, options) => {
 
-    // collect source maps
-    if (!options.unpackSourceMap) {
-        return;
-    }
-
     const sourceMapList = filterSourceMapList(v8list, options);
     if (!sourceMapList) {
         // nothing to unpack

package/lib/plugins/coverage/v8/v8.js

@@ -3,8 +3,8 @@ const EC = require('eight-colors');
 const Util = require('../../../utils/util.js');
 const { getV8Summary } = require('./v8-summary.js');
 const { dedupeRanges } = require('./dedupe.js');
-const { getSourcePath, convertFunctionsToRanges } = require('../coverage-utils.js');
-const { collectSourceMaps, unpackSourceMaps } = require('./source-map.js');
+const { getSourcePath } = require('../coverage-utils.js');
+const { collectSourceMaps } = require('./source-map.js');
 const { mergeScriptCovs } = require('../../../runtime/monocart-coverage.js');
 
 
@@ -70,22 +70,6 @@ const initV8ListAndSourcemap = async (v8list, options, inlineSourceMap) => {
 
 // ========================================================================================================
 
-const unpackV8List = async (v8list, options) => {
-    v8list.forEach((item, i) => {
-        if (item.type === 'js') {
-            item.ranges = convertFunctionsToRanges(item.functions);
-            delete item.functions;
-        }
-    });
-
-    // requires ranges before unpack
-    await unpackSourceMaps(v8list, options);
-
-    // console.log(v8list.length);
-};
-
-// ========================================================================================================
-
 // force to async
 const mergeCssRanges = (itemList) => {
     return new Promise((resolve) => {
@@ -262,7 +246,6 @@ const saveV8Report = async (v8list, options) => {
 
 module.exports = {
     initV8ListAndSourcemap,
-    unpackV8List,
     mergeV8Coverage,
     saveV8Report
 };