monocart-coverage-reports 2.6.0 → 2.6.2

package/README.md

@@ -39,6 +39,7 @@
     - [Vitest](#vitest)
     - [CodeceptJS](#codeceptjs)
     - [WebdriverIO](#webdriverio)
+    - [Storybook Test Runner](#storybook-test-runner)
     - [Codecov](#codecov)
     - [Coveralls](#coveralls)
     - [Sonar Cloud](#sonar-cloud)
@@ -257,15 +258,15 @@ const coverageOptions = {
 
 ## `mcr` CLI
 > The CLI will run the program as a [child process](https://nodejs.org/docs/latest/api/child_process.html) with `NODE_V8_COVERAGE=dir` until it exits gracefully, and generate the coverage report with the coverage data from the `dir`.
-- Global mode
+- Installing globally
 ```sh
 npm i monocart-coverage-reports -g
-mcr "node ./test/test-node-env.js" -r v8,console-summary --lcov
+mcr node ./test/test-node-env.js -r v8,console-summary --lcov
 ```
-- Current working directory mode
+- Locally in your project
 ```sh
 npm i monocart-coverage-reports
-npx mcr "node ./test/test-node-env.js" -r v8,console-summary --lcov
+npx mcr node ./test/test-node-env.js -r v8,console-summary --lcov
 ```
 - CLI Options
 ```sh
@@ -292,15 +293,15 @@ Options:
   --logging <logging>          off, error, info, debug
   -h, --help                   display help for command
 ```
-- Supports loading default configuration file
+- Loading default configuration file
     - `.mcrrc`
     - `mcr.config.json`
     - `mcr.config.mjs`
     - `mcr.config.cjs`
     - `mcr.config.js`
-- Specify custom configuration file
+- Or loading custom configuration file with `-c` or `--config`
 ```sh
-mcr "node ./test.js" -c path-to/my-custom-config.js
+mcr node ./test.js -c path-to/my-custom-config.js
 ```
 
 ## Compare Reports
@@ -723,6 +724,9 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
 ### [WebdriverIO](https://github.com/webdriverio/webdriverio)
 - [wdio-monocart-service](https://github.com/cenfun/wdio-monocart-service) - A WebdriverIO service for coverage reports
 
+### [Storybook Test Runner](https://github.com/storybookjs/test-runner)
+- [storybook-monocart-coverage](https://github.com/cenfun/storybook-monocart-coverage) - Storybook V8 Coverage Example
+
 ### [Codecov](https://codecov.com/)
 [![codecov](https://codecov.io/gh/cenfun/monocart-coverage-reports/graph/badge.svg?token=H0LW7UKYU3)](https://codecov.io/gh/cenfun/monocart-coverage-reports)
 - Supports native `codecov` built-in report ([specification](https://docs.codecov.com/docs/codecov-custom-coverage-format))

package/lib/cli.js

@@ -4,6 +4,7 @@ const fs = require('fs');
 const path = require('path');
 const EC = require('eight-colors');
 const { fileURLToPath, pathToFileURL } = require('url');
+
 const {
     foregroundChild,
     program
@@ -98,6 +99,71 @@ const initOptions = async (cliOptions) => {
     return options;
 };
 
+const resolveEntrySource = (entry, sourceMapCache = {}) => {
+    let source;
+    const filePath = fileURLToPath(entry.url);
+    const extname = path.extname(filePath);
+    if (fs.existsSync(filePath)) {
+        source = fs.readFileSync(filePath).toString('utf8');
+    }
+
+    // not for typescript
+    if (source && !['.ts', '.tsx'].includes(extname)) {
+        entry.source = source;
+        return;
+    }
+
+    const sourcemapData = sourceMapCache[entry.url];
+    const lineLengths = sourcemapData && sourcemapData.lineLengths;
+
+    // for fake source file (can not parse to AST)
+    if (lineLengths) {
+        // get runtime code with ts-node
+        let fakeSource = '';
+        sourcemapData.lineLengths.forEach((length) => {
+            fakeSource += `${''.padEnd(length, '*')}\n`;
+        });
+        entry.fake = true;
+        entry.source = fakeSource;
+    }
+
+    // Note: no runtime code in source map cache
+    // This is a problem for typescript
+
+};
+
+const resolveEntrySourceMap = (entry, sourceMapCache = {}) => {
+    // sourcemap data
+    const sourcemapData = sourceMapCache[entry.url];
+    if (sourcemapData) {
+        if (sourcemapData.data) {
+            entry.sourceMap = resolveSourceMap(sourcemapData.data, entry.url);
+        }
+    }
+};
+
+const collectCoverageData = (coverageList, entryFilterHandler, sourceMapCache = {}) => {
+
+    if (!Util.isList(coverageList)) {
+        return;
+    }
+
+    // filter node internal files
+    coverageList = coverageList.filter((entry) => entry.url && entry.url.startsWith('file:'));
+    coverageList = coverageList.filter(entryFilterHandler);
+
+    if (!Util.isList(coverageList)) {
+        return;
+    }
+
+    for (const entry of coverageList) {
+        resolveEntrySource(entry, sourceMapCache);
+        resolveEntrySourceMap(entry, sourceMapCache);
+    }
+
+    return coverageList;
+};
+
 const executeCommand = async (command, cliOptions) => {
 
     const options = await initOptions(cliOptions);
@@ -130,49 +196,18 @@ const executeCommand = async (command, cliOptions) => {
             return 1;
         }
 
+        const entryFilterHandler = coverageReport.getEntryFilter();
+
         const files = fs.readdirSync(nodeV8CoverageDir);
         for (const filename of files) {
             const content = fs.readFileSync(path.resolve(nodeV8CoverageDir, filename)).toString('utf-8');
             const json = JSON.parse(content);
-            let coverageList = json.result;
-
-            // for node sourcemap
-            const sourceMapCache = json['source-map-cache'] || {};
-
-            // filter node internal files
-            coverageList = coverageList.filter((entry) => entry.url && entry.url.startsWith('file:'));
-
-            if (!coverageList.length) {
-                continue;
+            const coverageList = json.result;
+            const sourceMapCache = json['source-map-cache'];
+            const coverageData = await collectCoverageData(coverageList, entryFilterHandler, sourceMapCache);
+            if (coverageData) {
+                await coverageReport.add(coverageData);
             }
-            // attached source content
-            coverageList.forEach((entry) => {
-                // source content
-                const filePath = fileURLToPath(entry.url);
-                if (fs.existsSync(filePath)) {
-                    entry.source = fs.readFileSync(filePath).toString('utf8');
-                }
-
-                // sourcemap data
-                const sourcemapData = sourceMapCache[entry.url];
-                if (sourcemapData) {
-                    if (sourcemapData.data) {
-                        entry.sourceMap = resolveSourceMap(sourcemapData.data, entry.url);
-                    }
-                    // sourcemapData.lineLengths just for fake source file (can not parse to AST)
-                    if (!entry.source && sourcemapData.lineLengths) {
-                        // get runtime code with ts-node
-                        let source = '';
-                        sourcemapData.lineLengths.forEach((length) => {
-                            source += `${''.padEnd(length, '*')}\n`;
-                        });
-                        entry.fake = true;
-                        entry.source = source;
-                    }
-                }
-            });
-
-            await coverageReport.add(coverageList);
         }
 
         await coverageReport.generate();
@@ -192,6 +227,7 @@ program
     .description('CLI to generate coverage reports')
     .version(version)
     .argument('<command>', 'command to execute')
+    .allowUnknownOption()
     .option('-c, --config <path>', 'custom config path')
     .option('-o, --outputDir <dir>', 'output dir for reports')
     .option('-r, --reports <name[,name]>', 'coverage reports to use')
@@ -209,7 +245,8 @@ program
 
     .option('--logging <logging>', 'off, error, info, debug')
 
-    .action((command, cliOptions) => {
+    .action((_command, cliOptions) => {
+        const command = program.args.join(' ');
         executeCommand(command, cliOptions);
     });
 

package/lib/converter/collect-source-maps.js

@@ -135,8 +135,8 @@ const collectSourceMaps = async (v8list, options) => {
 
         // save source and sourceMap to separated json file
         const sourceData = {
-            url,
             id,
+            url,
             source,
             sourceMap
         };

package/lib/generate.js

@@ -21,21 +21,22 @@ const { getGroupedRows } = require('./utils/snapshot.js');
 // maybe v8 or to istanbul reports
 const generateV8ListReports = async (v8list, coverageData, fileSources, options) => {
 
-    let report;
-
-    const { v8, istanbul } = options.reportGroup;
-
-    // generate istanbul reports first
-    if (istanbul) {
-        report = await saveIstanbulReports(coverageData, fileSources, options);
+    let istanbulCoverageResults;
+    // v8 to istanbul reports
+    if (options.reportGroup.istanbul) {
+        istanbulCoverageResults = await saveIstanbulReports(coverageData, fileSources, options);
     }
 
-    // generate v8 report
-    if (v8) {
-        report = await saveV8Report(v8list, options);
+    // v8 reports and v8 coverage results
+    // could be no v8 or v8-json, but requires v8 coverage results
+    const v8CoverageResults = await saveV8Report(v8list, options);
+
+    // fix reportPath
+    if (!v8CoverageResults.reportPath && istanbulCoverageResults) {
+        v8CoverageResults.reportPath = istanbulCoverageResults.reportPath;
     }
 
-    return report;
+    return v8CoverageResults;
 };
 
 // ========================================================================================================

package/lib/index.js

@@ -3,7 +3,7 @@ const path = require('path');
 const defaultOptions = require('./default/options.js');
 const Util = require('./utils/util.js');
 
-const { initV8ListAndSourcemap } = require('./v8/v8.js');
+const { initV8ListAndSourcemap, getEntryFilter } = require('./v8/v8.js');
 const { getInputData, generateCoverageReports } = require('./generate.js');
 const { getSnapshot, diffSnapshot } = require('./utils/snapshot.js');
 
@@ -63,12 +63,12 @@ class CoverageReport {
         const dataPath = path.resolve(this.options.cacheDir, dataName);
 
         const results = {
-            id: dataId,
-            path: dataPath
+            id: dataId
         };
 
         if (Array.isArray(data)) {
             results.type = 'v8';
+            // could be empty list after entryFilter
             results.data = await initV8ListAndSourcemap(data, this.options);
         } else {
             results.type = 'istanbul';
@@ -170,6 +170,10 @@ class CoverageReport {
         return false;
     }
 
+    getEntryFilter() {
+        return getEntryFilter(this.options);
+    }
+
 }
 
 /** create coverage report */

package/lib/v8/v8.js

@@ -356,7 +356,7 @@ const saveV8Report = async (v8list, options) => {
         files: v8list
     };
 
-    // v8 reports
+    // v8 only reports
     const buildInV8Reports = {
         'v8': handleV8HtmlReport,
         'v8-json': handleV8JsonReport
@@ -364,14 +364,17 @@ const saveV8Report = async (v8list, options) => {
 
     const outputs = {};
     const v8Group = options.reportGroup.v8;
-    const v8Reports = Object.keys(v8Group);
-    for (const reportName of v8Reports) {
-        const reportOptions = v8Group[reportName];
-        const buildInHandler = buildInV8Reports[reportName];
-        if (buildInHandler) {
-            outputs[reportName] = await buildInHandler(reportData, reportOptions, options);
-        } else {
-            outputs[reportName] = await Util.runCustomReporter(reportName, reportData, reportOptions, options);
+    // could be no v8 only reports, but have `both` data reports
+    if (v8Group) {
+        const v8Reports = Object.keys(v8Group);
+        for (const reportName of v8Reports) {
+            const reportOptions = v8Group[reportName];
+            const buildInHandler = buildInV8Reports[reportName];
+            if (buildInHandler) {
+                outputs[reportName] = await buildInHandler(reportData, reportOptions, options);
+            } else {
+                outputs[reportName] = await Util.runCustomReporter(reportName, reportData, reportOptions, options);
+            }
         }
     }
 
@@ -395,5 +398,6 @@ const saveV8Report = async (v8list, options) => {
 module.exports = {
     initV8ListAndSourcemap,
     mergeV8Coverage,
-    saveV8Report
+    saveV8Report,
+    getEntryFilter
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-coverage-reports",
-    "version": "2.6.0",
+    "version": "2.6.2",
     "description": "Monocart coverage reports",
     "main": "./lib/index.js",
     "bin": {
@@ -34,11 +34,11 @@
         "test-browser": "node ./test/test-browser.js && npm run test-istanbul && npm run test-v8 && npm run test-puppeteer && npm run test-anonymous && npm run test-css",
         "test-anonymous": "node ./test/test-anonymous.js",
         "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-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",
+        "test": "npx mcr npm run test-all -c test/mcr-options.js",
         "test:snap": "cross-env TEST_SNAPSHOT=true npm run test",
         "dev": "sf d v8",
         "open": "node ./scripts/open.js",