monocart-reporter 1.7.4 → 1.7.5

package/README.md

@@ -43,7 +43,7 @@
     - [Get, Set, and Remove Global Data](#get-set-and-remove-global-data)
     - [Send and Receive Messages between Processes](#send-and-receive-messages-between-processes)
 * [Merge Shard Reports](#merge-shard-reports)
-* [onEnd hook](#onend-hook)
+* [onEnd Hook](#onend-hook)
     - [Send Email](#send-email)
     - [Testrail Integration](#testrail-integration)
     - [Jira + Zephyr Scale Integration](#jira--zephyr-scale-integration)
@@ -636,7 +636,7 @@ Preview [Audit HTML Report](https://cenfun.github.io/monocart-reporter/audit-78a
 There are two APIs for coverage report:
 - `attachCoverageReport(data, testInfo, options)`
 Attach a coverage report to a test. Arguments:
-    - `data` There are two supported data inputs `Istanbul` (Object) or `V8` (Array)
+    - `data` There are two supported data inputs: [Istanbul](#istanbul) (Object) or [V8](#v8) (Array)
     - `testInfo` see [TestInfo](https://playwright.dev/docs/api/class-testinfo)
     - `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)
@@ -734,14 +734,14 @@ const report = await attachCoverageReport(coverageList, test.info(), {
 | | Istanbul | V8 | V8 to Istanbul |
 | :--------------| :------ | :------ | :----------------------  |
 | Input data format | Istanbul (Object) | V8 (Array) | V8 (Array) |
-| Options  | `watermarks: {}`  | `watermarks: [50, 80]` | `toIstanbul: true, watermarks: {}` |
-| Output report | [Istanbul HTML report](https://cenfun.github.io/monocart-reporter/coverage-77aa6f37601a97417803/index.html) | [V8 HTML report](https://cenfun.github.io/monocart-reporter/coverage/index.html)  | [Istanbul HTML report](https://cenfun.github.io/monocart-reporter/coverage-01eebe0ebc796534d759-1/index.html) |
-| Indicators | Covered Lines, Branches, Statements and Functions, Execution Counts | Covered Bytes, Lines (after formatted) Execution Counts | Covered Lines, Branches, Statements and Functions, Execution Counts |
+| Output | [Istanbul HTML report](https://cenfun.github.io/monocart-reporter/coverage-77aa6f37601a97417803/index.html) | [V8 HTML report](https://cenfun.github.io/monocart-reporter/coverage/index.html)  | [Istanbul HTML report](https://cenfun.github.io/monocart-reporter/coverage-01eebe0ebc796534d759-1/index.html) |
+| Indicators | Covered Lines, Branches, Statements and Functions, Execution Counts | Covered Bytes, Lines❔, Execution Counts | Covered Lines, Branches❔, Statements and Functions, Execution Counts |
 | Source code without [instrumentation](https://github.com/istanbuljs/babel-plugin-istanbul) | ❌ | ✅ | ✅ |
-| CSS coverage | ❌ | ✅ | ❌ |
+| CSS coverage | ❌ | ✅ | ✅ |
 | Minified code | N/A | ✅ | ❌ |
 | Code formatting | N/A | ✅ | ❌ |
 
+❔ - Partial or conditional support
 ### 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 options see [Coverage Options](#coverage-options)
@@ -881,8 +881,7 @@ test('finally, attach HAR', async () => {
     await attachNetworkReport(harPath, test.info());
 });
 ```
-Preview [Network HTML Report](https://cenfun.github.io/monocart-reporter/network-38e613e8d93547bdb27f/index.html)
-
+Preview [Network HTML Report](https://cenfun.github.io/monocart-reporter/network-da7f5b4cceb1e6280782/index.html)
 
 ## Global State Management
 When tests are executed in [isolation](https://playwright.dev/docs/browser-contexts) mode, the reporter and each test may run in a different process, they cannot share data with each other. we can start a local WebSocket server to serve the global data, and read/write the global data with `useState` API from a test.
@@ -968,9 +967,7 @@ module.exports = {
                     if (test) {
                         // current test
                     }
-
                     console.log('receive message on server', message);
-
                     return {
                         data: 'my response data'
                     };
@@ -980,7 +977,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)
 
 ## Merge Shard Reports
 There will be multiple reports to be generated if Playwright test executes in sharding mode. for example:

package/lib/index.js

@@ -96,8 +96,11 @@ class Reporter {
 
     // ==========================================================================
 
+    // Whether this reporter uses stdio for reporting.
+    // When it does not, Playwright Test could add some output to enhance user experience.
+    // If your reporter does not print to the terminal, it is strongly recommended to return false.
     printsToStdio() {
-        return false;
+        return true;
     }
 
     // root suite in the reporter.onBegin(config, suite) method.