docs(playwright): fixes

3v0k4 · 3v0k4 · commit 8560b279be7c · 2025-12-16T17:40:03.000+01:00
diff --git a/docusaurus/docs/playwright/cookbook.md b/docusaurus/docs/playwright/cookbook.md
@@ -11,13 +11,13 @@ To run a subset of your test suite you can use the `KNAPSACK_PRO_TEST_FILE_LIST_
 
 - [`KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE`](reference.md#knapsack_pro_test_file_list_source_file)
 
-## Test coverage
+## Reporters
 
-Use the [blob reporter](https://playwright.dev/docs/test-reporters#blob-reporter) without specifying an `outputDir` or `outputFile`. Later, execute `playwright --merge-reports` to output coverage or any aggregated reports you need (e.g., `json`):
+Use the [blob reporter](https://playwright.dev/docs/test-reporters#blob-reporter) without specifying an `outputDir` or `outputFile`. Later, execute `playwright --merge-reports` to output any aggregated reports you need (e.g., `json`):
 
 ```bash
-npx @knapsack-pro/playwright --coverage --reporter=blob,@knapsack-pro/playwright/reporters/batch
-npx playwright merge-reports --coverage
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
+npx playwright merge-reports --reporter=list blob-report/
 ```
 
-Knapsack Pro generates one blob file per batch of tests executed named as follows: `blob-report/TODO` (e.g., `TODO`).
+Knapsack Pro generates one blob file per batch of tests executed named as follows: `blob-report/report-[HASH].zip` (e.g., `blob-report/report-24ad5ce.zip`).
diff --git a/docusaurus/docs/playwright/guide/index.mdx b/docusaurus/docs/playwright/guide/index.mdx
@@ -94,7 +94,7 @@ Remember to configure the number of parallel CI nodes in AppVeyor.
 KNAPSACK_PRO_CI_NODE_TOTAL=N \
 KNAPSACK_PRO_CI_NODE_INDEX=0 \
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN \
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
@@ -104,7 +104,7 @@ npx @knapsack-pro/playwright
 KNAPSACK_PRO_CI_NODE_TOTAL=N \
 KNAPSACK_PRO_CI_NODE_INDEX=1 \
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN \
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
@@ -114,7 +114,7 @@ npx @knapsack-pro/playwright
 KNAPSACK_PRO_CI_NODE_TOTAL=N \
 KNAPSACK_PRO_CI_NODE_INDEX=N-1 \
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN \
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
@@ -134,21 +134,21 @@ Remember to configure the `parallelism` parameter in your build step.
 <TabItem value="node-1" label="Node 1">
 
 ```bash
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
 <TabItem value="node-2" label="Node 2">
 
 ```bash
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
 <TabItem value="node-n" label="Node N">
 
 ```bash
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
@@ -164,7 +164,7 @@ steps:
       - docker-compose#3.0.3:
         run: app
         # highlight-next-line
-        command: npx @knapsack-pro/playwright
+        command: npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
         config: docker-compose.test.yml
         # highlight-start
         env:
@@ -210,7 +210,7 @@ jobs:
       # highlight-start
       - run:
         name: playwright with @knapsack-pro/playwright
-        command: npx @knapsack-pro/playwright
+        command: npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
       # highlight-end
 ```
 
@@ -235,7 +235,7 @@ task:
     name: CI Node 1
     name: CI Node 2
   test_script:
-    - npx @knapsack-pro/playwright
+    - npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 Remember to set up the `KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT` as an [encrypted variable](https://cirrus-ci.org/guide/writing-tasks/#encrypted-variables).
@@ -263,7 +263,7 @@ For each [parallel pipeline](https://docs.cloudbees.com/docs/cloudbees-codeship/
 KNAPSACK_PRO_CI_NODE_TOTAL=N \
 KNAPSACK_PRO_CI_NODE_INDEX=0 \
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN \
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
@@ -273,7 +273,7 @@ npx @knapsack-pro/playwright
 KNAPSACK_PRO_CI_NODE_TOTAL=N \
 KNAPSACK_PRO_CI_NODE_INDEX=1 \
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN \
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
@@ -283,7 +283,7 @@ npx @knapsack-pro/playwright
 KNAPSACK_PRO_CI_NODE_TOTAL=N \
 KNAPSACK_PRO_CI_NODE_INDEX=N-1 \
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN \
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
@@ -353,7 +353,7 @@ steps:
     # highlight-end
     commands:
       # highlight-start
-      - npx @knapsack-pro/playwright
+      - npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
       # highlight-end
 ```
 
@@ -442,7 +442,7 @@ jobs:
           KNAPSACK_PRO_CI_NODE_TOTAL: ${{ matrix.ci_node_total }}
           KNAPSACK_PRO_CI_NODE_INDEX: ${{ matrix.ci_node_index }}
         run: |
-          npx @knapsack-pro/playwright
+          npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
       # highlight-end
 ```
 
@@ -461,7 +461,7 @@ test:
   parallel: 2
 
   script:
-    - KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN npx @knapsack-pro/playwright
+    - KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 See also [how to configure running parallel CI nodes in GitLab](https://docs.gitlab.com/ee/ci/yaml/#parallel).
@@ -490,15 +490,15 @@ test_ci_first_node:
   script:
     # highlight-start
     - export KNAPSACK_PRO_CI_NODE_INDEX=0
-    - KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN npx @knapsack-pro/playwright
+    - KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
     # highlight-end
 
 test_ci_second_node:
   stage: test
   script:
     # highlight-start
     - export KNAPSACK_PRO_CI_NODE_INDEX=1
-    - KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN npx @knapsack-pro/playwright
+    - KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
     # highlight-end
 ```
 
@@ -534,7 +534,7 @@ Define in `app.json`:
       ],
       // highlight-start
       "scripts": {
-        "test": "npx @knapsack-pro/playwright"
+        "test": "npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch"
       },
       "env": {
         "KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT": "MY_PLAYWRIGHT_API_TOKEN"
@@ -596,7 +596,7 @@ timeout(time: 60, unit: 'MINUTES') {
         """
 
         stage('Run tests') {
-          sh """${knapsack_options} npx @knapsack-pro/playwright"""
+          sh """${knapsack_options} npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch"""
         }
         // highlight-end
       }
@@ -653,7 +653,7 @@ blocks:
         - name: Run tests with Knapsack Pro
           parallelism: 2
           commands:
-            - npx @knapsack-pro/playwright
+            - npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
       # highlight-end
 ```
 
@@ -675,7 +675,7 @@ Define in `.travis.yml`:
 
 ```yaml
 script:
-  - "npx @knapsack-pro/playwright"
+  - "npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch"
 
 env:
   global:
@@ -714,7 +714,7 @@ KNAPSACK_PRO_CI_NODE_TOTAL=N \
 KNAPSACK_PRO_CI_NODE_INDEX=0 \
 KNAPSACK_PRO_CI_NODE_BUILD_ID=MY_BUILD_ID \
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN \
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
@@ -725,7 +725,7 @@ KNAPSACK_PRO_CI_NODE_TOTAL=N \
 KNAPSACK_PRO_CI_NODE_INDEX=1 \
 KNAPSACK_PRO_CI_NODE_BUILD_ID=MY_BUILD_ID \
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN \
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
@@ -736,7 +736,7 @@ KNAPSACK_PRO_CI_NODE_TOTAL=N \
 KNAPSACK_PRO_CI_NODE_INDEX=N-1 \
 KNAPSACK_PRO_CI_NODE_BUILD_ID=MY_BUILD_ID \
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN \
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 </TabItem>
diff --git a/docusaurus/docs/playwright/reference.md b/docusaurus/docs/playwright/reference.md
@@ -18,7 +18,7 @@ Unless specified otherwise, everything on this page is environment variables.
 You can pass all the [supported Playwright CLI options](https://playwright.dev/docs/test-cli) as command-line arguments:
 
 ```bash
-npx @knapsack-pro/playwright --coverage
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch --retries 2
 ```
 
 ## `KNAPSACK_PRO_BRANCH`
@@ -152,11 +152,11 @@ Example:
 ```bash
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_PLAYWRIGHT_API_TOKEN \
 KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE="user_tests.txt" \
-  npx @knapsack-pro/playwright
+  npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 
 KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT=MY_OTHER_PLAYWRIGHT_API_TOKEN \
 KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE="admin_tests.txt" \
-  npx @knapsack-pro/playwright
+  npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 ## `KNAPSACK_PRO_USER_SEAT`
diff --git a/docusaurus/docs/playwright/troubleshooting.md b/docusaurus/docs/playwright/troubleshooting.md
@@ -12,7 +12,7 @@ You can increase the memory available to Node with [`--max_old_space_size`](http
 ```bash
 export NODE_OPTIONS=--max_old_space_size=4096
 
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 ## Debug Knapsack Pro on your development environment/machine
@@ -28,7 +28,7 @@ KNAPSACK_PRO_COMMIT_HASH=MY_COMMIT \
 KNAPSACK_PRO_CI_NODE_BUILD_ID=MY_BUILD_ID \
 KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true \
 KNAPSACK_PRO_TEST_FILE_PATTERN="**/*.{test,spec}.?(c|m)[jt]s?(x)" \
-npx @knapsack-pro/playwright
+npx @knapsack-pro/playwright --reporter=blob,@knapsack-pro/playwright/reporters/batch
 ```
 
 `KNAPSACK_PRO_CI_NODE_BUILD_ID` must be the same as the CI build you are trying to reproduce (if it helps, take a look at what Knapsack Pro uses as `ciNodeBuildId` for your [CI provider](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/core/src/ci-providers)).
