monocart-reporter 2.1.1 → 2.2.1

package/README.md

@@ -3,6 +3,8 @@
 [![](https://img.shields.io/npm/v/monocart-reporter)](https://www.npmjs.com/package/monocart-reporter)
 [![](https://badgen.net/npm/dw/monocart-reporter)](https://www.npmjs.com/package/monocart-reporter)
 ![](https://img.shields.io/github/license/cenfun/monocart-reporter)
+![](https://img.shields.io/github/actions/workflow/status/cenfun/monocart-reporter/static.yml)
+
 
 * A [Playwright](https://github.com/microsoft/playwright) Test [Reporter](https://playwright.dev/docs/test-reporters) (Node.js)
     - Shows Test Report in A `Tree Grid`
@@ -15,29 +17,25 @@
 * [Install](#install)
 * [Playwright Config](#playwright-config)
 * [Examples](#examples)
-* [Output](#output) HTML and JSON
+* [Output](#output)
 * [Reporter Options](#reporter-options)
 * [View Trace Online](#view-trace-online)
 * [Custom Fields Report](#custom-fields-report)
-    * [Custom Columns](#custom-columns) (Extra properties for suite/case/step)
+    * [Custom Columns](#custom-columns)
         - [Column Formatter](#column-formatter)
         - [Searchable Fields](#searchable-fields)
-    * [Custom Data Visitor](#custom-data-visitor) (Extra data collection for suite/case/step)
+    * [Custom Fields in Comments](#custom-fields-in-comments)
+    * [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)
-        - [Collect Data from the Comments](#collect-data-from-the-comments) (Recommended)
         - [Remove Secrets and Sensitive Data](#remove-secrets-and-sensitive-data)
 * [Style Tags](#style-tags)
 * [Metadata](#metadata)
 * [Trend Chart](#trend-chart)
 * [Attach Lighthouse Audit Report](#attach-lighthouse-audit-report)
 * [Code Coverage Report](#code-coverage-report)
-    - [Coverage Options](#coverage-options)
-    - [Istanbul](#istanbul)
-    - [V8](#v8)
-    - [V8 to Istanbul](#v8-to-istanbul)
-    - [Istanbul vs V8](#istanbul-vs-v8)
     - [Global Coverage Report](#global-coverage-report)
+    - [Coverage Options](#coverage-options)
     - [Coverage Examples](#coverage-examples)
 * [Attach Network Report](#attach-network-report)
 * [Global State Management](#global-state-management)
@@ -63,8 +61,6 @@
 
 ![](/docs/cli.png)
 
-[More Test Reports](https://github.com/cenfun/monocart-reporter-test)
-
 ## Install
 ```sh
 npm i -D monocart-reporter
@@ -88,7 +84,8 @@ Playwright Docs [https://playwright.dev/docs/test-reporters](https://playwright.
 
 ## Examples
 - [tests](/tests/)
-- [more](https://github.com/cenfun/monocart-reporter-test/tree/main/tests) 
+- More Examples [monocart-reporter-examples](https://github.com/cenfun/monocart-reporter-examples)
+
 ## Output
 - path-to/your-filename.html  
 Single HTML file (data compressed), easy to transfer/deploy or open directly anywhere   
@@ -162,7 +159,10 @@ Separated metadata file (Already included in the above HTML and compressed, it c
 
     // rows data handler (suite, case and step)
     visitor: null,
-    // visitor: (data, metadata, collect) => {},
+    // visitor: (data, metadata) => {},
+
+    // enable/disable custom fields in comments. Defaults to true.
+    customFieldsInComments: true,
 
     // onEnd hook
     onEnd: null
@@ -183,8 +183,8 @@ Or customize your own trace viewer url with option `traceViewerUrl` defaults to
 
 ## Custom Fields Report
 You can add custom fields to the report. for example: Owner, JIRA Key etc.
-- First, you need to add [custom columns](#custom-columns) for the fields.
-- Then, collect data for these fields with [custom data visitor](#custom-data-visitor)
+- First, you need to add [Custom Columns](#custom-columns) for the fields.
+- Then, collect data for these fields with [Custom Fields in Comments](#custom-fields-in-comments) or [Custom Data Visitor](#custom-data-visitor)
 
 ### Custom Columns
 The report will be displayed in a `Tree Grid`. The `columns` function is used to customize the grid columns. The column properties following:
@@ -297,11 +297,97 @@ module.exports = {
 };
 ```
 
+### Custom Fields in Comments
+> The code comments are good enough to provide extra information without breaking existing code, and no dependencies, clean, easy to read, etc. 
+- First, enable option `customFieldsInComments` to `true`
+```js
+// playwright.config.js
+module.exports = {
+    reporter: [
+        ['monocart-reporter', {  
+            // enable/disable custom fields in comments. Defaults to true.
+            customFieldsInComments: true
+        }]
+    ]
+};
+```
+
+- Then, add comments for the tests
+> Note: Each comment item must start with `@` which is similar to [JSDoc](https://jsdoc.app/).
+
+For example, adding `owner` and `jira` to the cases, steps, and suites. or updating the value if the field exists like `title`
+```js
+/**
+ * for file (comment file in the first line)
+ * @owner FO
+ */
+const { test, expect } = require('@playwright/test');
+
+/**
+ * for case
+ * @owner Kevin
+ * @jira MCR-16888
+ */
+test('case title', () => { 
+
+});
+
+/**
+ * @description multiple lines text description
+multiple lines text description
+multiple lines text description
+ * @jira MCR-16888
+*/
+test('case description', () => {
+
+});
+
+/**
+ * for describe suite
+ * @owner Mark
+ * @jira MCR-16900
+ */
+test.describe('suite title', () => {
+
+    test('case title', ({ browserName }, testInfo) => {
+
+        /**
+         * rewrite assert step title "expect.toBe" to
+         * @title my custom assert step title
+         * @annotations important
+         */
+        expect(testInfo).toBe(test.info());
+
+        // @owner Steve
+        await test.step('step title', () => {
+        
+        });
+
+    });
+
+});
+
+/**
+ * rewrite "beforeAll hook" title to
+ * @title do something before all
+ */
+test.beforeAll(() => { 
+
+});
+
+/**
+ * rewrite "beforeEach hook" title to
+ * @title do something before each
+ */
+test.beforeEach(() => { 
+    
+});
+```
+
 ### 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
 - `metadata` original data object from Playwright test, could be one of [Suite](https://playwright.dev/docs/api/class-suite), [TestCase](https://playwright.dev/docs/api/class-testcase) or [TestStep](https://playwright.dev/docs/api/class-teststep)
-- `collect` see [collect data from the comments](#collect-data-from-the-comments)
 
 #### Collect Data from the Title
 For example, we want to parse out the jira key from the title:
@@ -318,7 +404,7 @@ module.exports = {
         ['monocart-reporter', {  
             name: "My Test Report",
             outputFile: './test-results/report.html',
-            visitor: (data, metadata, collect) => {
+            visitor: (data, metadata) => {
                 // [MCR-123] collect data from the title
                 const matchResult = metadata.title.match(/\[(.+)\]/);
                 if (matchResult && matchResult[1]) {
@@ -329,7 +415,7 @@ module.exports = {
     ]
 };
 ```
-multiple matches example: [collect-data](https://github.com/cenfun/monocart-reporter-test/tree/main/tests/collect-data)
+multiple matches example: [collect-data](https://github.com/cenfun/monocart-reporter-examples/tree/main/tests/collect-data)
 
 #### Collect Data from the Annotations
 It should be easier than getting from title. see [custom annotations](https://playwright.dev/docs/test-annotations#custom-annotations) via `test.info().annotations`
@@ -348,7 +434,7 @@ module.exports = {
         ['monocart-reporter', {  
             name: "My Test Report",
             outputFile: './test-results/report.html',
-            visitor: (data, metadata, collect) => {
+            visitor: (data, metadata) => {
                 // collect data from the annotations
                 if (metadata.annotations) {
                     const jiraItem = metadata.annotations.find((item) => item.type === 'jira');
@@ -362,119 +448,6 @@ module.exports = {
 };
 ```
 
-#### Collect Data from the Comments
-> The code comments are good enough to provide extra information without breaking existing code, and no dependencies, clean, easy to read, etc. 
-- First, add the collection of comments in the visitor. 
-> Note: If there are any parsing error messages in red lines, try other parser options like `sourceType: 'module'` or `plugins: ['typescript']` according to your situation.
-```js
-// playwright.config.js
-module.exports = {
-    reporter: [
-        ['monocart-reporter', {  
-            name: "My Test Report",
-            outputFile: './test-results/report.html',
-            // additional custom visitor for columns
-            visitor: (data, metadata, collect) => {
-                
-                // auto collect data from the comments
-                const parserOptions = {
-                    // Indicate the mode the code should be parsed in.
-                    // Can be one of "script", "module", or "unambiguous". Defaults to "script".
-                    // sourceType: 'module',
-
-                    // enable typescript syntax.
-                    // plugins: ['typescript']
-
-                    // more https://babeljs.io/docs/babel-parser
-                };
-                const comments = collect.comments(parserOptions);
-                if (comments) {
-                    // Append all collected comments data to report data
-                    Object.assign(data, comments);
-                }
-
-            }
-        }]
-    ]
-};
-```
-
-- Then, add comments to your tests
-> Note: Each comment item must start with `@` which is similar to [JSDoc](https://jsdoc.app/).
-
-For example, we want to add `owner` and `jira` or others for the cases, steps, and suites, or rewrite the step `title`
-```js
-/**
- * for case
- * @owner Kevin
- * @jira MCR-16888
- */
-test('case title', () => { 
-
-});
-
-/**
- * @description multiple lines text description
-multiple lines text description
-multiple lines text description
- * @jira MCR-16888
-*/
-test('case description', () => {
-
-});
-
-```
-```js
-test('case title', ({ browserName }, testInfo) => {
-
-    /**
-     * rewrite assert step title "expect.toBe" to
-     * @title my custom assert step title
-     * @annotations important
-     */
-    expect(testInfo).toBe(test.info());
-
-    // @owner Steve
-    await test.step('step title', () => {
-       
-    });
-
-});
-
-/**
- * rewrite "beforeAll hook" title to
- * @title do something before all
- */
-test.beforeAll(() => { 
-
-});
-
-/**
- * rewrite "beforeEach hook" title to
- * @title do something before each
- */
-test.beforeEach(() => { 
-    
-});
-```
-```js
-/**
- * for describe
- * @owner Mark
- * @jira MCR-16900
- */
-test.describe('suite title', () => {
-
-});
-```
-```js
-/**
- * for file (comment file in the first line)
- * @owner FO
- */
-const { test, expect } = require('@playwright/test');
-```
-
 #### Remove Secrets and Sensitive Data
 > The report may hosted outside of the organization’s internal boundaries, security becomes a big issue. Any secrets or sensitive data, such as usernames, passwords, tokens and API keys, should be handled with extreme care. The following example is removing the password and token from the report data with the string replacement in `visitor` function.
 ```js
@@ -484,7 +457,7 @@ module.exports = {
         ['monocart-reporter', {  
             name: "My Test Report",
             outputFile: './test-results/report.html',
-            visitor: (data, metadata, collect) => {
+            visitor: (data, metadata) => {
                 const mySecrets = [process.env.PASSWORD, process.env.TOKEN];
                 mySecrets.forEach((secret) => {
                     // remove from title
@@ -503,7 +476,7 @@ module.exports = {
     ]
 };
 ```
-see example: [remove-secrets](https://github.com/cenfun/monocart-reporter-test/tree/main/tests/remove-secrets)
+see example: [remove-secrets](https://github.com/cenfun/monocart-reporter-examples/tree/main/tests/remove-secrets)
 
 ## Style Tags
 * Add tag to test/describe title ( starts with `@` )
@@ -643,101 +616,18 @@ test('attach lighthouse audit report', async () => {
 
 ## Code Coverage Report
 The reporter integrates [monocart-coverage-reports](https://github.com/cenfun/monocart-coverage-reports) for coverage reports, there are two APIs:
-- `attachCoverageReport(data, testInfo, options)` Attach a coverage report to a test. Arguments:
-    - `data` There are two supported data inputs: [Istanbul](#istanbul) (Object) or [V8](#v8) (Array)
+- `addCoverageReport(data, testInfo)` Add coverage to global coverage report from a test. see [Global Coverage Report](#global-coverage-report)
+    - `data` There are two supported data inputs: [Istanbul](https://github.com/cenfun/monocart-coverage-reports?#collecting-istanbul-coverage-data) (Object) or [V8](https://github.com/cenfun/monocart-coverage-reports?#collecting-v8-coverage-data) (Array)
     - `testInfo` see [TestInfo](https://playwright.dev/docs/api/class-testinfo)
+- `attachCoverageReport(data, testInfo, options)` Attach a coverage report to a test. Arguments:
+    - `data` same as above
+    - `testInfo` same as above
     - `options` (Object) see [Coverage Options](#coverage-options)
-- `addCoverageReport(data, testInfo)` Add coverage to global coverage report from a test. see [Global Coverage Report](#global-coverage-report)
-
-### Coverage Options
-- Default [options](https://github.com/cenfun/monocart-coverage-reports/blob/main/lib/default/options.js)
-- More examples [monocart-coverage-reports](https://github.com/cenfun/monocart-coverage-reports)
-
-### [Istanbul](https://github.com/istanbuljs) 
-Requires your source code is instrumented. Usually we can use the tool [babel-plugin-istanbul](https://github.com/istanbuljs/babel-plugin-istanbul) to build instrumenting code. (see example: [webpack.config-istanbul.js](https://github.com/cenfun/monocart-reporter-test/blob/main/packages/coverage/webpack.config-istanbul.js)) The instrumented code will automatically generate coverage data and save it on `window.__coverage__`. The Istanbul HTML report will be generated and attached to the test report as an attachment.
-```js
-import { test, expect } from '@playwright/test';
-import { attachCoverageReport } from 'monocart-reporter';
-
-test('Take Istanbul coverage report', async ({ page }) => {
-
-    await page.goto('http://localhost:8090/coverage/istanbul.html');
-
-    // delay for mock code execution
-    await new Promise((resolve) => {
-        setTimeout(resolve, 500);
-    });
-
-    // take Istanbul coverage
-    const coverageData = await page.evaluate(() => window.__coverage__);
-    await page.close();
-    expect(coverageData, 'expect found Istanbul data: __coverage__').toBeTruthy();
-
-    // coverage report
-    const report = await attachCoverageReport(coverageData, test.info(), {
-        lcov: true
-    });
-    console.log(report.summary);
-
-});
-```
-
-### [V8](https://v8.dev/blog/javascript-code-coverage)
-Simply take coverage data with  [class-coverage](https://playwright.dev/docs/api/class-coverage) APIs, so it is [Chromium-based only](https://chromedevtools.github.io/devtools-protocol/tot/Profiler/#type-ScriptCoverage), the V8 HTML report will be generated.
-```js
-import { test, expect } from '@playwright/test';
-import { attachCoverageReport } from 'monocart-reporter';
-
-test('Take V8 and Istanbul coverage report', async ({ page }) => {
-
-    await Promise.all([
-        page.coverage.startJSCoverage({
-            resetOnNavigation: false
-        }),
-        page.coverage.startCSSCoverage({
-            resetOnNavigation: false
-        })
-    ]);
-
-    await page.goto('http://localhost:8090/coverage/v8.html');
-
-    // delay for mock code execution
-    await new Promise((resolve) => {
-        setTimeout(resolve, 500);
-    });
-
-    const [jsCoverage, cssCoverage] = await Promise.all([
-        page.coverage.stopJSCoverage(),
-        page.coverage.stopCSSCoverage()
-    ]);
-    await page.close();
-
-    const coverageList = [... jsCoverage, ... cssCoverage];
-
-    const v8 = await attachCoverageReport(coverageList, test.info(), {
-        
-    });
-    console.log(v8.summary);
-
-});
-```
 
 ![](/docs/v8.gif)
 
-### V8 to Istanbul
-Take V8 coverage data and convert it to Istanbul's coverage format. The Istanbul HTML report will be generated. 
-```js
-const report = await attachCoverageReport(coverageList, test.info(), {
-    reports: "html"
-});
-```
-
-### Istanbul vs V8
-- [Compare Istanbul, V8 and V8 to Istanbul Reports](https://github.com/cenfun/monocart-coverage-reports#compare-reports)
-- [Compare Istanbul and V8 Workflows](https://github.com/cenfun/monocart-coverage-reports#compare-workflows)
-
 ### Global Coverage Report
-The global coverage report will not be attached to any test case, but will merge all coverages into one global report after all the tests are finished. 
+The global coverage report will merge all coverages into one global report after all the tests are finished. 
 - The global coverage options see [Coverage Options](#coverage-options)
 ```js
 // playwright.config.js
@@ -755,15 +645,16 @@ module.exports = {
     ]
 };
 ```
-- It is recommended to use [automatic fixtures](https://playwright.dev/docs/test-fixtures#automatic-fixtures) to add coverage for each test:
+- Adding coverage data for each test with [automatic fixtures](https://playwright.dev/docs/test-fixtures#automatic-fixtures)
 ```js
-// fixtures.js for v8
+// fixtures.js for v8 coverage
 import { test as testBase, expect } from '@playwright/test';
 import { addCoverageReport } from 'monocart-reporter';
 
 const test = testBase.extend({
     autoTestFixture: [async ({ page }, use) => {
 
+        // NOTE: it depends on your project name
         const isChromium = test.info().project.name === 'Desktop Chromium';
 
         // console.log('autoTestFixture setup...');
@@ -799,13 +690,54 @@ const test = testBase.extend({
 });
 export { test, expect };
 ```
+- Adding server side coverage on global teardown
+> For example, a Node.js web server start at the beginning of the test with the env `NODE_V8_COVERAGE=dir`, the V8 coverage data will be saved to `dir` with calling API `v8.takeCoverage()` manually or terminating server gracefully. On global teardown, reading all from `dir` and adding them to global coverage report. For Node.js, the V8 coverage data requires appending source manually.
+```js
+// global-teardown.js
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { addCoverageReport } from 'monocart-reporter';
+
+export default async (config) => {
+
+    const dir = "your-v8-coverage-data-dir";
+
+    const files = fs.readdirSync(dir);
+    for (const filename of files) {
+        const content = fs.readFileSync(path.resolve(dir, filename)).toString('utf-8');
+        const json = JSON.parse(content);
+        let coverageList = json.result;
+        coverageList = coverageList.filter((entry) => entry.url && entry.url.startsWith('file:'));
+
+        // appending source
+        coverageList.forEach((entry) => {
+            entry.source = fs.readFileSync(fileURLToPath(entry.url)).toString('utf8');
+        });
+
+        // there is no test info on teardown, just mock one with required config
+        const mockTestInfo = {
+            config
+        };
+        await addCoverageReport(coverageList, mockTestInfo);
+    }
+}
+```
+see [Node.js V8 Coverage Report for Server Side](https://github.com/cenfun/monocart-coverage-reports?#nodejs-v8-coverage-report-for-server-side)
+
+### Coverage Options
+- Default [options](https://github.com/cenfun/monocart-coverage-reports/blob/main/lib/default/options.js)
+- [Available Reports](https://github.com/cenfun/monocart-coverage-reports?#available-reports)
+- [Using entryFilter and sourceFilter to filter the results for V8 report](https://github.com/cenfun/monocart-coverage-reports?#using-entryfilter-and-sourcefilter-to-filter-the-results-for-v8-report)
+- Checking thresholds with [onEnd Hook](https://github.com/cenfun/monocart-coverage-reports?#onend-hook)
+- More Introduction [monocart-coverage-reports](https://github.com/cenfun/monocart-coverage-reports)
 
 ### Coverage Examples
 - For Playwright component testing:
     - [playwright-ct-vue](https://github.com/cenfun/playwright-ct-vue)
     - [playwright-ct-react](https://github.com/cenfun/playwright-ct-react)
     - [playwright-ct-svelte](https://github.com/cenfun/playwright-ct-svelte)
-- [playwright-nextjs-coverage-example](https://github.com/michaelhays/playwright-nextjs-coverage-example)
+- [nextjs-with-playwright](https://github.com/cenfun/nextjs-with-playwright)
 - [code-coverage-with-monocart-reporter](https://github.com/edumserrano/playwright-adventures/blob/main/demos/code-coverage-with-monocart-reporter/) 
 
 ## Attach Network Report
@@ -975,7 +907,7 @@ module.exports = {
     ]
 };
 ```
-see example: [Allow specified test cases to run in sequence mode with lock/unlock state](https://github.com/cenfun/monocart-reporter-test/tree/main/tests/global-state)
+see example: [Allow specified test cases to run in sequence mode with lock/unlock state](https://github.com/cenfun/monocart-reporter-examples/tree/main/tests/global-state)
 
 ## Merge Shard Reports
 There will be multiple reports to be generated if Playwright test executes in sharding mode. for example:
@@ -1008,7 +940,7 @@ await merge(reportDataList, {
     }
 });
 ```
-Preview [merged report](https://cenfun.github.io/monocart-reporter-test/merged)
+see example [merge.js](https://github.com/cenfun/monocart-reporter-examples/blob/main/scripts/merge.js)
 
 ## onEnd Hook
 The `onEnd` function will be executed after report generated. Arguments:
@@ -1048,39 +980,39 @@ module.exports = {
 ```
 ## Send Email
 - Simply send email with [nodemailer](https://nodemailer.com)
-- Example: [send-email](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/send-email)
+- Example: [send-email](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/send-email)
 
 ## Testrail Integration
 - Send test results to your [Testrail](https://www.testrail.com/)
-- Example: [testrail](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/testrail)
+- Example: [testrail](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/testrail)
 
 ## Jira + Zephyr Scale Integration
 - Create test cycle and executions with [zephyr-scale-api](https://support.smartbear.com/zephyr-scale-cloud/api-docs/)
-- Example: [zephyr-scale](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/zephyr-scale)
+- Example: [zephyr-scale](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/zephyr-scale)
 
 ## Jira + Xray Integration
 - Import test execution results with [Xray REST API](https://docs.getxray.app/display/XRAYCLOUD/REST+API)
 - Update Jira issue status with [Jira Transition API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-transitions-post)
-- Example: [xray](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/xray)
+- Example: [xray](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/xray)
 
 ## Slack Integration
 - Simply send message with [@slack/webhook](https://github.com/slackapi/node-slack-sdk) 
-- Example: [slack-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/slack-webhook)
+- Example: [slack-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/slack-webhook)
 - Post chat message and upload image with [@slack/web-api](https://github.com/slackapi/node-slack-sdk) 
-- Example: [slack-web-api](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/slack-web-api)
+- Example: [slack-web-api](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/slack-web-api)
 
 ## Discord Integration
 - Using [Discord webhooks](https://discord.com/developers/docs/resources/webhook) to post messages to channels.
-- Example: [discord-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/discord-webhook)
+- Example: [discord-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/discord-webhook)
 
 ## Teams Integration
 - Please create an [Incoming Webhooks](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) for the channel first. 
-- Example: [teams-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/teams-webhook)
+- Example: [teams-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/teams-webhook)
 
 ## Dingtalk/Weixin/Feishu Integration
-- [dingtalk-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/dingtalk-webhook)
-- [weixin-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/weixin-webhook)
-- [feishu-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/feishu-webhook)
+- [dingtalk-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/dingtalk-webhook)
+- [weixin-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/weixin-webhook)
+- [feishu-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/feishu-webhook)
 
 
 ## Contributing

package/lib/default/options.js

@@ -47,7 +47,10 @@ module.exports = {
 
     // rows data handler (suite, case and step)
     visitor: null,
-    // visitor: (data, metadata, collect) => {},
+    // visitor: (data, metadata) => {},
+
+    // enable/disable custom fields in comments. Defaults to true.
+    customFieldsInComments: true,
 
     // onEnd hook
     onEnd: null

package/lib/generate-report.js

@@ -22,7 +22,7 @@ const generateHtml = async (outputDir, htmlFile, reportData, inline) => {
     });
 
     jsFiles.push(Util.resolvePackage('monocart-common.js'));
-    jsFiles.push(Util.resolvePackage('monocart-reporter.js'));
+    jsFiles.push(Util.resolvePackage('monocart-reporter-app.js'));
 
     const options = {
         inline,
@@ -51,7 +51,7 @@ const sendEmail = (emailOptions) => {
 };
 
 const showTestResults = (reportData) => {
-    Util.logInfo(`test results: ${reportData.name}`);
+    Util.logInfo(EC.cyan(reportData.name));
 
     const summary = reportData.summary;
 

package/lib/index.d.ts

@@ -59,11 +59,11 @@ export type MonocartReporterOptions = {
     // columns: (defaultColumns) => {},
 
     // rows data handler (suite, case and step)
-    visitor?: (data: any, metadata: any, collect: {
-        //ParserOptions https://github.com/babel/babel/blob/main/packages/babel-parser/typings/babel-parser.d.ts
-        comments?: (parserOptions: any) => void
-    }) => void,
-    // visitor: (data, metadata, collect) => {},
+    visitor?: (data: any, metadata: any) => void,
+    // visitor: (data, metadata) => {},
+
+    // enable/disable custom fields in comments. Defaults to true.
+    customFieldsInComments?: boolean,
 
     // onEnd hook
     onEnd?: (reportData: object, capability: {