monocart-reporter 2.9.10 → 2.9.11

package/README.md

@@ -101,7 +101,21 @@ Single HTML file (data compressed), easy to transfer/deploy or open directly any
 - path-to/your-filename.json  (requires option `json` is true)
 Separated data file which can be used for debugging or data provider (It's included in the above HTML and compressed).
 - path-to/your-filename.zip  (requires option `zip` is true)
-Zip file for merging reports
+ Zip file for merging reports
+    - custom zip options
+```js
+{
+    // zip: true,
+    // zip: `${YourOutputDir}/monocart-shard-${your-shard-number}.zip`,
+    zip: {
+        // custom zip `outputFile`, defaults to reporter `outputFile` but uses `.zip` extension
+        outputFile: `${YourOutputDir}/monocart-shard-${your-shard-number}.zip`,
+        // clean other report files except for zip file, defaults to false
+        clean: true
+    }
+}
+```
+
 
 ## Reporter Options
 - Default options: [lib/default/options.js](./lib/default/options.js)
@@ -1036,7 +1050,7 @@ const reportDataList = [
     'path-to/shard2/index.json',
     'path-to/shard3/index.json'
 
-    // Or load zip file directly if the output files is zipped
+    // Or load zip file directly if the output files is zipped with option `zip` is true
     // 'path-to/shard1/index.zip',
     // 'path-to/shard2/index.zip',
     // 'path-to/shard3/index.zip'
@@ -1050,6 +1064,7 @@ await merge(reportDataList, {
     }
 });
 ```
+see [Output](#output) for `zip` options
 
 > Note: The coverage reports will be merged automatically if we specify the `raw` report in coverage options:
 ```js

package/lib/default/options.js

@@ -5,6 +5,9 @@ module.exports = () => ({
     // the report name
     name: '',
 
+    // image url (supports data url)
+    logo: null,
+
     // the output html file path (relative process.cwd)
     outputFile: './monocart-report/index.html',
 

package/lib/generate-data.js

@@ -144,6 +144,7 @@ const generateData = async (results) => {
     const reportData = {
         // for report title
         name: reportName,
+        logo: options.logo,
 
         date,
         dateH,

package/lib/index.d.ts

@@ -51,6 +51,12 @@ export type MonocartReporterOptions = {
     /** the report name */
     name?: string;
 
+    /** 
+     * image url, supports data url:
+     * `data:image/png;base64,${fs.readFileSync('path-to/your-logo.png').toString('base64')}`
+    */
+    logo?: string;
+
     /** the output file path (relative process.cwd) */
     outputFile?: string;
 

package/lib/merge-data.js

@@ -333,6 +333,7 @@ const mergeDataList = async (dataList, options) => {
     });
 
     const reportName = options.name || mergedData.name;
+    const reportLogo = options.logo || mergedData.logo;
 
     const date = Math.min.apply(null, startDates);
     const dateH = new Date(date).toLocaleString();
@@ -342,6 +343,7 @@ const mergeDataList = async (dataList, options) => {
 
     Object.assign(mergedData, {
         name: reportName,
+        logo: reportLogo,
 
         date,
         dateH,