@stacknext/playwright 0.11.0 → 0.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +50 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -23,8 +23,55 @@ is inert outside an active `stacknext capture` run. A sample is verified only
23
23
  when the collector finds the injected trace and a server span parented to the
24
24
  injected span id. There is no time-window fallback.
25
25
 
26
- Captured runs must use one Playwright worker. The package is ESM-only, requires
27
- Node.js 20.9 or newer, and has an optional `@playwright/test` peer dependency
28
- (1.40 or newer).
26
+ ## Capture workflow
27
+
28
+ ```bash
29
+ stacknext capture --name baseline -- \
30
+ pnpm exec playwright test --workers=1 --repeat-each=3
31
+ stacknext baseline save <run-id> --name baseline
32
+ stacknext compare <baseline-id> <candidate-run-id>
33
+ ```
34
+
35
+ Captured runs must use one Playwright worker. Use the explicit
36
+ `stacknext.scenario` annotation for stable identity. Running `playwright test`
37
+ directly does not capture or compare anything.
38
+
39
+ ## Exports
40
+
41
+ | Export | Purpose |
42
+ | --- | --- |
43
+ | `test` | Playwright test with the auto `stacknextCapture` fixture. |
44
+ | `expect` | Re-exported Playwright expect. |
45
+ | `stackNextFixtures` | Returns `{ test, expect }`. |
46
+ | `resolveCaptureConfig` | Reads and validates capture environment variables. |
47
+ | `CaptureTransportError` | Capture configuration/transport error. |
48
+ | `createTraceparent` | Creates a W3C trace context pair. |
49
+
50
+ ## Documentation
51
+
52
+ - [Package overview](docs/index.md)
53
+ - [Fixture](docs/fixture.md)
54
+ - [Correlation](docs/correlation.md)
55
+ - [Troubleshooting](docs/troubleshooting.md)
56
+
57
+ The `docs/` directory ships in the npm archive. Public guides live on the
58
+ [documentation site](https://github.com/marrrkkk/stacknext/tree/main/apps/docs).
59
+
60
+ ## AI agents
61
+
62
+ Agents should not treat a captured run as a performance benchmark or a
63
+ statistical test. Read `docs/correlation.md` before explaining verification, and
64
+ keep ambiguous samples `inconclusive`.
65
+
66
+ ## Development
67
+
68
+ ```bash
69
+ pnpm --filter @stacknext/playwright build
70
+ pnpm --filter @stacknext/playwright typecheck
71
+ pnpm test
72
+ ```
73
+
74
+ The package is ESM-only, requires Node.js 20.9 or newer, and has an optional
75
+ `@playwright/test` peer dependency (`>=1.40.0 <2`).
29
76
 
30
77
  License: MIT.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stacknext/playwright",
3
- "version": "0.11.0",
3
+ "version": "0.11.1",
4
4
  "description": "Playwright fixtures that correlate browser scenarios with StackNext server telemetry",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -19,7 +19,7 @@
19
19
  "./package.json": "./package.json"
20
20
  },
21
21
  "dependencies": {
22
- "@stacknext/regression": "0.11.0"
22
+ "@stacknext/regression": "0.11.1"
23
23
  },
24
24
  "peerDependencies": {
25
25
  "@playwright/test": ">=1.40.0 <2"