monocart-reporter 2.2.5 → 2.3.0

package/README.md

@@ -25,6 +25,7 @@
         - [Column Formatter](#column-formatter)
         - [Searchable Fields](#searchable-fields)
     * [Custom Fields in Comments](#custom-fields-in-comments)
+        - [Create Diagrams and Visualizations with Mermaid](#create-diagrams-and-visualizations-with-mermaid)
     * [Custom Data Visitor](#custom-data-visitor)
         - [Collect Data from the Title](#collect-data-from-the-title)
         - [Collect Data from the Annotations](#collect-data-from-the-annotations)
@@ -402,6 +403,46 @@ test.beforeEach(() => {
 });
 ```
 
+#### Create Diagrams and Visualizations with [Mermaid](https://mermaid.js.org/)
+- Enable Mermaid 
+```js
+// playwright.config.js
+module.exports = {
+     reporter: [
+        ['monocart-reporter', {  
+            name: "My Test Report",
+            outputFile: './test-results/report.html',
+            mermaid: {
+                // mermaid script url, using mermaid CDN: https://www.jsdelivr.com/package/npm/mermaid
+                scriptSrc: 'https://cdn.jsdelivr.net/npm/mermaid@latest/dist/mermaid.min.js',
+                // mermaid config: https://mermaid.js.org/config/schema-docs/config.html
+                config: {
+                    startOnLoad: false
+                }
+            }
+        }]
+    ]
+};
+```
+- Write Mermaid code in markdown:
+````js
+/**
+ * @description Sequence diagram for Monocart Reporter
+```mermaid
+flowchart LR
+
+A[Hard] -->|Text| B(Round)
+B --> C{Decision}
+C -->|One| D[Result 1]
+C -->|Two| E[Result 2]
+```
+*/
+test('case description', () => {
+
+});
+````
+
+
 ### Custom Data Visitor
 The `visitor` function will be executed for each row item (suite, case and step). Arguments:
 - `data` data item (suite/case/step) for reporter, you can rewrite some of its properties or add more

package/lib/default/options.js

@@ -52,6 +52,16 @@ module.exports = {
     // enable/disable custom fields in comments. Defaults to true.
     customFieldsInComments: true,
 
+    // mermaid options
+    mermaid: null,
+    // mermaid: {
+    //     scriptSrc: 'https://cdn.jsdelivr.net/npm/mermaid@latest/dist/mermaid.min.js',
+    //     // mermaid config https://mermaid.js.org/config/schema-docs/config.html
+    //     config: {
+    //         startOnLoad: false
+    //     }
+    // },
+
     // onEnd hook
     onEnd: null
     // onEnd: async (reportData, capability) => {}

package/lib/generate-data.js

@@ -79,6 +79,8 @@ const generateData = async (results) => {
     data.caseTypes = ['passed', 'flaky', 'skipped', 'failed'];
     data.traceViewerUrl = options.traceViewerUrl;
 
+    data.mermaid = options.mermaid;
+
     calculateSummary(data, options);
 
     // global metadata

package/lib/index.d.ts

@@ -28,31 +28,39 @@ export type {
 }
 
 export type MonocartReporterOptions = {
-    // the report name
+    /** the report name */
     name?: string,
 
-    // the output file path (relative process.cwd)
+    /** the output file path (relative process.cwd) */
     outputFile?: string,
 
-    // attachment path handler
+    /** attachment path handler, for example:  
+     * ```js
+     * attachmentPath: (currentPath, extras) => `https://cenfun.github.io/monocart-reporter/${currentPath}` 
+     * ```
+     */
     attachmentPath?: (currentPath: string, extras: any) => string,
-    // attachmentPath: (currentPath, extras) => `https://cenfun.github.io/monocart-reporter/${currentPath}`,
 
+    /** custom trace viewer url: https://github.com/cenfun/monocart-reporter?#view-trace-online */
     traceViewerUrl?: string,
 
-    // logging levels: off, error, info, debug
+    /** logging levels: off, error, info, debug */
     logging?: string,
 
-    // timezone offset in minutes, GMT+0800 = -480
+    /** timezone offset in minutes, For example: GMT+0800 = -480 */
     timezoneOffset?: number,
 
-    // global coverage settings for addCoverageReport API
+    /** global coverage options: https://github.com/cenfun/monocart-reporter?#code-coverage-report 
+     * ```js
+     * coverage: {
+     *   entryFilter: (entry) => true,
+     *   sourceFilter: (sourcePath) => sourcePath.search(/src\/.+/) !== -1,
+     * }
+     * ```
+    */
     coverage?: CoverageReportOptions,
-    // coverage: {
-    //     entryFilter: (entry) => true,
-    //     sourceFilter: (sourcePath) => sourcePath.search(/src\/.+/) !== -1,
-    // },
 
+    /** Global State Management: https://github.com/cenfun/monocart-reporter?#global-state-management */
     state?: {
         data?: any,
         server?: {
@@ -63,41 +71,59 @@ export type MonocartReporterOptions = {
         onClose?: (data: any, config: any) => void
     },
 
-    // trend data handler
-    trend?: string | (() => Promise<string | object>),
-    // trend: () => './test-results/report.json',
-
-    // custom tags style
-    tags?: object,
-    // tags: {
-    //     smoke: {
-    //         'background': '#6F9913'
-    //     },
-    //     sanity: {
-    //         'background': '#178F43'
-    //     }
-    // },
-
-    // columns data handler
-    columns?: (defaultColumns: object[]) => void,
-    // columns: (defaultColumns) => {},
-
-    // rows data handler (suite, case and step)
+    /** trend data handler: https://github.com/cenfun/monocart-reporter?#trend-chart 
+     * ```js
+     * trend: () => './test-results/report.json'
+     * ```
+    */
+    trend?: string | (() => Promise<string | any>),
+
+    /** custom tags style: https://github.com/cenfun/monocart-reporter?#style-tags 
+     * ```js
+     * tags: {
+     *   smoke: {
+     *     'background': '#6F9913'
+     *   },
+     *   sanity: {
+     *     'background': '#178F43'
+     *   }
+     * }
+     * ```
+    */
+    tags?: {
+        [key: string]: any;
+    },
+
+    /** columns data handler: https://github.com/cenfun/monocart-reporter?#style-tags */
+    columns?: (defaultColumns: any[]) => void,
+
+    /** rows data handler (suite, case and step) https://github.com/cenfun/monocart-reporter?#custom-data-visitor */
     visitor?: (data: any, metadata: any) => void,
-    // visitor: (data, metadata) => {},
 
-    // enable/disable custom fields in comments. Defaults to true.
+    /** enable/disable custom fields in comments. Defaults to true. */
     customFieldsInComments?: boolean,
 
-    // onEnd hook
-    onEnd?: (reportData: object, capability: {
+    /** mermaid options */
+    mermaid?: {
+        /** mermaid script url, for example: https://cdn.jsdelivr.net/npm/mermaid@latest/dist/mermaid.min.js */
+        scriptSrc?: string;
+        /** mermaid config: https://mermaid.js.org/config/schema-docs/config.html */
+        config?: any;
+    }
+
+    /** onEnd hook: https://github.com/cenfun/monocart-reporter?#onend-hook */
+    onEnd?: (reportData: any, capability: {
+        /** send email with nodemailer: https://nodemailer.com/ */
         sendEmail?: (emailOptions: {
-            transport: object,
-            message: object
+            /** email transport: https://nodemailer.com/smtp/ */
+            transport: any,
+            /** email message: https://nodemailer.com/message/ */
+            message: any
         }) => Promise<void>,
+        /** Traverse all cases, suites, and steps. */
         forEach?: (callback: ((item: any) => void)) => void
     }) => Promise<void>
-    // onEnd: async (reportData, capability) => {}
+
 }
 
 /**
@@ -175,7 +201,7 @@ export type State = {
     },
     set: {
         (key: string, value: any): Promise<void>,
-        (obj: object): Promise<void>
+        (obj: any): Promise<void>
     },
     remove: {
         (key: string): Promise<void>,