monocart-coverage-reports 1.0.7 → 1.0.9

package/README.md

@@ -35,6 +35,7 @@ console.log(coverageResults.summary);
 ## Multiple Reports
 - v8 report
     - v8
+    - v8-json
 - [istanbul reports](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-reports/lib)
     - clover
     - cobertura
@@ -101,7 +102,7 @@ console.log(coverageResults.summary);
 | :--------------| :------ | :------ | :----------------------  |
 | Input | Istanbul (Object) | V8 (Array) | V8 (Array) |
 | Output | [Istanbul HTML report](https://cenfun.github.io/monocart-coverage-reports/istanbul) | [V8 HTML report](https://cenfun.github.io/monocart-coverage-reports/v8)  | [Istanbul HTML report](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/istanbul) |
-| Indicators | Covered Lines, Branches, Statements and Functions, Execution Counts | Covered Bytes, Lines❔, Execution Counts | Covered Lines, Branches❔, Statements and Functions, Execution Counts |
+| Indicators | Covered Lines, Branches, Statements and Functions, Execution Counts | Covered Bytes, Lines❔, Execution Counts | Covered Lines, Branches❔, Statements and Functions❔, Execution Counts |
 | CSS coverage | ❌ | ✅ | ✅ |
 | Minified code | N/A | ✅ | ❌ |
 | Code formatting | N/A | ✅ | ❌ |
@@ -115,7 +116,7 @@ console.log(coverageResults.summary);
     - 3, Generating coverage report.
 
 - V8 Workflows
-    - 1, For any runtime code: nothing to do. For source code: building code with `development` mode and sourcemap support, see [webpack.config-v8.js](https://github.com/cenfun/monocart-coverage-reports/blob/main/mock/webpack.config-v8.js).
+    - 1, For any runtime code: nothing to do. For source code: building code with `development` [mode](https://webpack.js.org/configuration/mode/) and [sourcemap](https://webpack.js.org/configuration/devtool/) support, see [webpack.config-v8.js](https://github.com/cenfun/monocart-coverage-reports/blob/main/mock/webpack.config-v8.js).
     - 2, Collecting coverage data with [Chromium Coverage API](#chromium-coverage-api), see [example](https://github.com/cenfun/monocart-coverage-reports/blob/main/tests/test-v8.js).
     - 3, Generating coverage report.
 

package/lib/generate.js

@@ -26,7 +26,7 @@ const generateV8ListReports = async (v8list, coverageData, fileSources, options)
 
     // generate v8 report
     if (v8) {
-        report = await saveV8Report(v8list, options, v8);
+        report = await saveV8Report(v8list, options);
     }
 
     return report;
@@ -68,6 +68,7 @@ const getReportGroup = (reports, lcov, dataType) => {
 
     const allSupportedReports = [
         'v8',
+        'v8-json',
         'clover',
         'cobertura',
         'html',
@@ -86,13 +87,20 @@ const getReportGroup = (reports, lcov, dataType) => {
     // group v8 and istanbul
     const reportGroup = {};
     Object.keys(reportMap).forEach((k) => {
-        if (k === 'v8') {
-            reportGroup.v8 = reportMap.v8;
+        if (!allSupportedReports.includes(k)) {
             return;
         }
-        if (!allSupportedReports.includes(k)) {
+
+        if (k.startsWith('v8')) {
+            // v8
+            if (!reportGroup.v8) {
+                reportGroup.v8 = {};
+            }
+            reportGroup.v8[k] = reportMap[k];
             return;
         }
+
+        // istanbul
         if (!reportGroup.istanbul) {
             reportGroup.istanbul = {};
         }

package/lib/index.d.ts

@@ -25,6 +25,9 @@ export type ReportDescription =
         inline?: boolean,
         assetsPath?: string
     }] |
+    ['v8-json'] | ["v8-json", {
+        outputFile?: string
+    }] |
     ['clover'] | ['clover', {
         file?: string
     }] |

package/lib/utils/util.js

@@ -103,6 +103,35 @@ const Util = {
         return htmlPathHandler();
     },
 
+    resolveNodeModule: (p) => {
+
+        // root
+        const cwd = path.resolve('node_modules', p);
+        if (fs.existsSync(cwd)) {
+            return cwd;
+        }
+
+        // sub node modules
+        const sub = path.resolve(__dirname, '../../node_modules', p);
+        if (fs.existsSync(sub)) {
+            return sub;
+        }
+
+        // same level dep
+        const dep = path.resolve(__dirname, '../../../', p);
+        if (fs.existsSync(dep)) {
+            return dep;
+        }
+
+        Util.logError(`Not found module: ${p}`);
+
+        return cwd;
+    },
+
+    resolvePackage: (p) => {
+        return path.resolve(__dirname, '../packages', p);
+    },
+
     saveHtmlReport: async (options) => {
 
         const {

package/lib/v8/v8.js

@@ -167,7 +167,30 @@ const mergeV8Coverage = async (dataList, options) => {
 
 // ============================================================
 
-const saveV8HtmlReport = async (reportData, options, v8MergedOptions) => {
+const saveV8JsonReport = async (reportData, options, v8JsonOptions) => {
+    const v8MergedOptions = {
+        outputFile: 'coverage-report.json',
+        ... v8JsonOptions
+    };
+
+    // console.log(v8MergedOptions);
+    const jsonPath = path.resolve(options.outputDir, v8MergedOptions.outputFile);
+    // console.log(reportPath);
+    await Util.writeFile(jsonPath, JSON.stringify(reportData));
+
+    return Util.relativePath(jsonPath);
+};
+
+
+const saveV8HtmlReport = async (reportData, options, v8HtmlOptions) => {
+
+    // V8 only options, merged with root options
+    const v8MergedOptions = {
+        outputFile: options.outputFile,
+        inline: options.inline,
+        assetsPath: options.assetsPath,
+        ... v8HtmlOptions
+    };
 
     const {
         outputFile, inline, assetsPath
@@ -180,11 +203,11 @@ const saveV8HtmlReport = async (reportData, options, v8MergedOptions) => {
 
     // deps
     const jsFiles = ['monocart-code-viewer', 'monocart-formatter', 'turbogrid'].map((it) => {
-        return path.resolve(`node_modules/${it}/dist/${it}.js`);
+        return Util.resolveNodeModule(`${it}/dist/${it}.js`);
     });
 
     // package v8 ui
-    jsFiles.push(path.resolve(__dirname, '../packages/monocart-coverage-v8.js'));
+    jsFiles.push(Util.resolvePackage('monocart-coverage-v8.js'));
 
     // console.log(jsFiles);
 
@@ -204,8 +227,7 @@ const saveV8HtmlReport = async (reportData, options, v8MergedOptions) => {
     return htmlPath;
 };
 
-
-const saveV8Report = async (v8list, options, v8Options) => {
+const saveV8Report = async (v8list, options) => {
     const defaultWatermarks = {
         bytes: [50, 80]
     };
@@ -245,24 +267,32 @@ const saveV8Report = async (v8list, options, v8Options) => {
         status
     };
 
-    // V8 only options, merged with root options
-    const v8MergedOptions = {
-        outputFile: options.outputFile,
-        inline: options.inline,
-        assetsPath: options.assetsPath,
-        ... v8Options
-    };
-
-    const htmlOptions = {
+    const reportData = {
         name: options.name,
         watermarks,
         summary,
         files: v8list
     };
 
-    const htmlPath = await saveV8HtmlReport(htmlOptions, options, v8MergedOptions);
+    let outputPath;
+
+    // v8 reports
+    const v8Map = options.reportGroup.v8;
+
+    // v8 json
+    const v8JsonOptions = v8Map['v8-json'];
+    if (v8JsonOptions) {
+        outputPath = await saveV8JsonReport(reportData, options, v8JsonOptions);
+    }
+
+    // v8 html
+    const v8HtmlOptions = v8Map.v8;
+    if (v8HtmlOptions) {
+        outputPath = await saveV8HtmlReport(reportData, options, v8HtmlOptions);
+    }
+
     const reportPath = Util.resolveReportPath(options, () => {
-        return htmlPath;
+        return outputPath;
     });
 
     const report = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-coverage-reports",
-    "version": "1.0.7",
+    "version": "1.0.9",
     "description": "Monocart coverage reports",
     "main": "lib/index.js",
     "exports": {
@@ -52,12 +52,12 @@
         "eslint-config-plus": "^1.0.6",
         "eslint-plugin-html": "^7.1.0",
         "eslint-plugin-vue": "^9.19.2",
-        "github-markdown-css": "^5.4.0",
+        "github-markdown-css": "^5.5.0",
         "koa": "^2.14.2",
         "koa-static-resolver": "^1.0.4",
-        "marked": "^11.0.0",
+        "marked": "^11.0.1",
         "playwright": "^1.40.1",
-        "stylelint": "^15.11.0",
+        "stylelint": "^16.0.2",
         "stylelint-config-plus": "^1.0.4",
         "webpack": "^5.89.0",
         "webpack-cli": "^5.1.4"