refactor(core): move report template out of core js output

Author: EAGzzyCSL

.github/workflows/studio-headless-linux.yml

@@ -91,9 +91,6 @@ jobs:
     - name: Build Studio
       run: npx nx run-many --target=build --projects=studio,@midscene/report
 
-    - name: Re-inject report template into @midscene/core dist
-      run: node apps/report/scripts/inject-report-template.mjs
-
     - name: Run Studio startup smoke test
       run: xvfb-run -a --server-args="-screen 0 1920x1080x24" pnpm --dir apps/studio run test:smoke
       env:

CONTRIBUTING.md

@@ -152,13 +152,13 @@ cd apps/playground && pnpm run dev
 cd apps/chrome-extension && pnpm run dev
 ```
 
-### `REPLACE_ME_WITH_REPORT_HTML` error in the report file
+### Missing report template errors
 
 `apps/report` is not standalone at runtime. Its built `index.html` template is
-injected back into `packages/core/dist` during build. If report UI changes do
-not show up, or you see `REPLACE_ME_WITH_REPORT_HTML` in the report file, the
-template injection is usually stale. Rebuild the entire workspace without Nx
-cache to fix it:
+synced into `packages/core/dist/report-template/index.html` during build. If
+report UI changes do not show up, or the runtime says the Midscene report
+template is missing, rebuild the entire workspace without Nx cache to refresh
+the synced template:
 
 ```sh
 # Rebuild the entire project without cache

apps/android-playground/package.json

@@ -15,6 +15,7 @@
     "react-dom": "18.3.1"
   },
   "devDependencies": {
+    "@midscene/report": "workspace:*",
     "@rsbuild/core": "^1.6.15",
     "@rsbuild/plugin-less": "^1.5.0",
     "@rsbuild/plugin-node-polyfill": "1.4.2",

apps/android-playground/rsbuild.config.ts

@@ -9,6 +9,7 @@ import { pluginWorkspaceDev } from 'rsbuild-plugin-workspace-dev';
 import { version as playgroundVersion } from '../../packages/playground/package.json';
 import {
   commonIgnoreWarnings,
+  createCoreReportTemplateReplacementPlugin,
   createPlaygroundCopyPlugin,
 } from '../../scripts/rsbuild-utils.ts';
 
@@ -63,6 +64,9 @@ export default defineConfig({
     pluginNodePolyfill(),
     pluginLess(),
     pluginSvgr(),
+    createCoreReportTemplateReplacementPlugin({
+      appDir: __dirname,
+    }),
     createPlaygroundCopyPlugin(
       path.join(__dirname, 'dist'),
       path.join(__dirname, '../../packages/android-playground/static'),

apps/chrome-extension/rsbuild.config.ts

@@ -7,7 +7,10 @@ import { pluginSvgr } from '@rsbuild/plugin-svgr';
 import { pluginTypeCheck } from '@rsbuild/plugin-type-check';
 import { pluginWorkspaceDev } from 'rsbuild-plugin-workspace-dev';
 import { version } from '../../packages/visualizer/package.json';
-import { commonIgnoreWarnings } from '../../scripts/rsbuild-utils.ts';
+import {
+  commonIgnoreWarnings,
+  createCoreReportTemplateReplacementPlugin,
+} from '../../scripts/rsbuild-utils.ts';
 
 export default defineConfig({
   tools: {
@@ -119,6 +122,9 @@ export default defineConfig({
     pluginNodePolyfill(),
     pluginLess(),
     pluginSvgr(),
+    createCoreReportTemplateReplacementPlugin({
+      appDir: __dirname,
+    }),
     pluginTypeCheck(),
     pluginWorkspaceDev({
       projects: {

apps/computer-playground/package.json

@@ -15,6 +15,7 @@
     "react-dom": "18.3.1"
   },
   "devDependencies": {
+    "@midscene/report": "workspace:*",
     "@rsbuild/core": "^1.6.15",
     "@rsbuild/plugin-less": "^1.5.0",
     "@rsbuild/plugin-node-polyfill": "1.4.2",

apps/computer-playground/rsbuild.config.ts

@@ -9,6 +9,7 @@ import { pluginWorkspaceDev } from 'rsbuild-plugin-workspace-dev';
 import { version as playgroundVersion } from '../../packages/playground/package.json';
 import {
   commonIgnoreWarnings,
+  createCoreReportTemplateReplacementPlugin,
   createPlaygroundCopyPlugin,
 } from '../../scripts/rsbuild-utils.ts';
 
@@ -63,6 +64,9 @@ export default defineConfig({
     pluginNodePolyfill(),
     pluginLess(),
     pluginSvgr(),
+    createCoreReportTemplateReplacementPlugin({
+      appDir: __dirname,
+    }),
     createPlaygroundCopyPlugin(
       path.join(__dirname, 'dist'),
       path.join(__dirname, '../../packages/computer-playground/static'),

apps/playground/package.json

@@ -18,6 +18,7 @@
     "react-dom": "18.3.1"
   },
   "devDependencies": {
+    "@midscene/report": "workspace:*",
     "@midscene/web": "workspace:*",
     "@rsbuild/core": "^1.6.15",
     "@rsbuild/plugin-less": "^1.5.0",

apps/playground/rsbuild.config.ts

@@ -9,6 +9,7 @@ import { pluginWorkspaceDev } from 'rsbuild-plugin-workspace-dev';
 import { version as playgroundVersion } from '../../packages/playground/package.json';
 import {
   commonIgnoreWarnings,
+  createCoreReportTemplateReplacementPlugin,
   createPlaygroundCopyPlugin,
 } from '../../scripts/rsbuild-utils.ts';
 
@@ -23,6 +24,9 @@ export default defineConfig({
     pluginLess(),
     pluginNodePolyfill(),
     pluginSvgr(),
+    createCoreReportTemplateReplacementPlugin({
+      appDir: __dirname,
+    }),
     createPlaygroundCopyPlugin(
       path.join(__dirname, 'dist'),
       path.join(__dirname, '../../packages/playground/static'),

apps/report/package.json

@@ -13,6 +13,16 @@
     "generate-demo": "node scripts/generate-demo-report.mjs",
     "e2e": "node scripts/generate-demo-report.mjs && node ../../packages/cli/bin/midscene ./e2e/"
   },
+  "nx": {
+    "targets": {
+      "build": {
+        "outputs": [
+          "{projectRoot}/dist",
+          "{workspaceRoot}/packages/core/dist/report-template"
+        ]
+      }
+    }
+  },
   "dependencies": {
     "@ant-design/icons": "^5.3.1",
     "@midscene/core": "workspace:*",