feat: tip for refreshing the report

apps/site/docs/en/API.md

@@ -10,7 +10,7 @@ There are multiple agents in Midscene, each with its own constructor.
 Here are the common options for all agents:
 
 * `generateReport: boolean`: If true, the agent will generate a report file. Default is true.
-* `autoPrintReportMsg: boolean`: If true, the agent will print the report message. Default is true.
+* `autoPrintReportMsg: boolean`: If true, the agent will print the report message once generated. Default is true.
 * `cacheId: string | undefined`: If set, the agent will use this cacheId to match the cache. Default is undefined.
 
 And also, puppeteer agent has an extra option:

apps/site/docs/zh/API.md

@@ -10,7 +10,7 @@ Midscene 中每个 Agent 都有自己的构造函数。
 这些 Agent 有一些相同的构造参数：
 
 * `generateReport: boolean`: 如果为 true，则生成报告文件。默认值为 true。
-* `autoPrintReportMsg: boolean`: 如果为 true，则打印报告消息。默认值为 true。
+* `autoPrintReportMsg: boolean`: 如果为 true，则生成报告后自动打印报告信息。默认值为 true。
 * `cacheId: string | undefined`: 如果配置，则使用此 cacheId 匹配缓存。默认值为 undefined。
 
 在 puppeteer 中，还有一个额外的参数：

packages/web-integration/src/common/utils.ts

@@ -126,8 +126,11 @@ export function reportFileName(tag = 'web') {
   return `${reportTagName || tag}-${dateTimeInFileName}`;
 }
 
-export function printReportMsg(filepath: string) {
-  console.log('Midscene - report file updated:', filepath);
+export function printReportMsg(
+  filepath: string,
+  prefix = 'Midscene - report file updated:',
+) {
+  console.log(prefix, filepath);
 }
 
 /**

packages/web-integration/src/playwright/ai-fixture.ts

@@ -46,7 +46,7 @@ export const PlaywrightAiFixture = () => {
         cacheId: `${taskFile}(${taskTitle})`,
         groupName: taskTitle,
         groupDescription: taskFile,
-        generateReport: false, // we will generate it in the reporter
+        generateReport: true,
       });
     }
     return pageAgentMap[idForPage];

packages/web-integration/src/playwright/reporter/index.ts

@@ -20,16 +20,14 @@ const testDataList: Array<ReportDumpWithAttributes> = [];
 let filename: string;
 function updateReport() {
   const reportPath = writeDumpReport(filename, testDataList);
-  reportPath && printReportMsg(reportPath);
+  reportPath && printReportMsg(reportPath, 'Midscene - merged report file:');
 }
 
 class MidsceneReporter implements Reporter {
   async onBegin(config: FullConfig, suite: Suite) {
     if (!filename) {
       filename = reportFileName('playwright-merged');
     }
-    // const suites = suite.allTests();
-    // logger(`Starting the run with ${suites.length} tests`);
   }
 
   onTestBegin(test: TestCase, _result: TestResult) {