added onData hook

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 * 2.8.0
   - (New Feature) added new merge command for CLI: `npx monocart merge path-to/*/*.json` (#142)
+  - added `onData` hook
   - better support for playwright multiple reports generation:
     - added new option `copyAttachments` to copy attachments for reporter (#143)
     - updated default `outputFile` to `./monocart-report/index.html` from `./test-results/report.html`

README.md

@@ -1049,7 +1049,7 @@ see example [merge.js](https://github.com/cenfun/monocart-reporter-examples/blob
 
 ### Using `merge` CLI
 ```sh
-npx monocart merge path-to/shard*/index.json
+npx monocart merge <glob-patterns>
 
 # -o --outputFile
 npx monocart merge path-to/shard*/index.json -o merged-reports/index.html

lib/generate-report.js

@@ -183,8 +183,17 @@ const onEndHandler = async (reportData, options) => {
     await onEnd(reportData, helper);
 };
 
+const onDataHandler = async (reportData, options, rawData) => {
+    // onData callback
+    const onData = options.onData;
+    if (typeof onData !== 'function') {
+        return;
+    }
+    await onData(reportData, rawData);
+};
 
-const generateReport = async (reportData, options) => {
+
+const generateReport = async (reportData, options, rawData) => {
 
     Util.logInfo('generating test report ...');
 
@@ -209,6 +218,8 @@ const generateReport = async (reportData, options) => {
 
     }
 
+    await onDataHandler(reportData, options, rawData);
+
     // console.log(reportData);
     const htmlFile = path.basename(outputFile);
 

lib/index.d.ts

@@ -147,6 +147,12 @@ export type MonocartReporterOptions = {
         merge?: boolean;
     }
 
+    /**
+     * onData hook
+     */
+    onData?: (reportData: any, rawData: any) => Promise<void>;
+
+
     /** onEnd hook: https://github.com/cenfun/monocart-reporter?#onend-hook */
     onEnd?: (reportData: any, helper: Helper) => Promise<void>;
 

lib/index.js

@@ -231,7 +231,7 @@ class MonocartReporter {
             trends: this.trends
         });
 
-        return generateReport(reportData, this.options);
+        return generateReport(reportData, this.options, this.root);
     }
 
 }

lib/merge-data.js

@@ -328,6 +328,6 @@ module.exports = async (reportDataList, userOptions = {}) => {
     const reportData = await mergeDataList(dataList, options);
     // console.log(reportData.artifacts);
 
-    return generateReport(reportData, options);
+    return generateReport(reportData, options, dataList);
 
 };