@test2doc/playwright 0.10.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.
- package/README.md +29 -1
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +39 -3
- package/dist/index.js.map +1 -1
- package/dist/screenshots.d.ts +2 -2
- package/dist/screenshots.d.ts.map +1 -1
- package/dist/screenshots.js +19 -12
- package/dist/screenshots.js.map +1 -1
- package/dist/types.d.ts +10 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/package.json +10 -4
package/README.md
CHANGED
|
@@ -204,7 +204,7 @@ describe(withDocMeta("Title of Page", {
|
|
|
204
204
|
### Adding Docusaurus Category Routes
|
|
205
205
|
Docusaurus supports grouping docs by [category](https://docusaurus.io/docs/sidebar/autogenerated#category-item-metadata).
|
|
206
206
|
|
|
207
|
-
By using the `withDocCategory` function for a describe block's title, this will add the metadata to allow Test2Doc to generate a new directory and a `
|
|
207
|
+
By using the `withDocCategory` function for a describe block's title, this will add the metadata to allow Test2Doc to generate a new directory and a `_category_.json` file. It will then place all subsequent describes and tests under this new route.
|
|
208
208
|
|
|
209
209
|
```ts
|
|
210
210
|
|
|
@@ -399,3 +399,31 @@ test.describe(withDocMeta("describe block"), async () => {
|
|
|
399
399
|
})
|
|
400
400
|
})
|
|
401
401
|
```
|
|
402
|
+
|
|
403
|
+
##### Configure Annotation Defaults
|
|
404
|
+
If you want to set default values for the annotation object you can do so in your `playwright-test2doc.config.ts`. Just set the `annotationDefaults` object in the `test2doc` playwright global options. These defaults will be applied to all screenshots, but can still be overridden on a per-screenshot basis.
|
|
405
|
+
```ts
|
|
406
|
+
import { defineConfig, ... } from "@playwright/test"
|
|
407
|
+
import "@test2doc/types" // Add this import to add test2doc to the global options
|
|
408
|
+
|
|
409
|
+
export default defineConfig({
|
|
410
|
+
...
|
|
411
|
+
use: {
|
|
412
|
+
...
|
|
413
|
+
test2doc: {
|
|
414
|
+
annotationDefaults: {
|
|
415
|
+
fillStyle: "white",
|
|
416
|
+
labelBoxFillStyle: "rgba(0, 123, 255, 0.6)",
|
|
417
|
+
font: "bold 16px Helvetica, Arial, sans-serif",
|
|
418
|
+
highlightStrokeStyle: "rgba(0, 123, 255, 1)",
|
|
419
|
+
highlightFillStyle: "rgba(0, 0, 0, 0)",
|
|
420
|
+
highlightLineWidth: 3,
|
|
421
|
+
showArrow: true,
|
|
422
|
+
arrowStrokeStyle: "rgba(0, 123, 255, 1)",
|
|
423
|
+
},
|
|
424
|
+
},
|
|
425
|
+
...
|
|
426
|
+
},
|
|
427
|
+
...
|
|
428
|
+
})
|
|
429
|
+
```
|
package/dist/index.d.ts
CHANGED
|
@@ -12,6 +12,9 @@ declare class Test2DocReporter implements Reporter {
|
|
|
12
12
|
private outputDir;
|
|
13
13
|
private screenshotMoveQueue;
|
|
14
14
|
private seenScreenshot;
|
|
15
|
+
private totalTests;
|
|
16
|
+
private completedTests;
|
|
17
|
+
private testResults;
|
|
15
18
|
constructor(options?: Test2DocReporterOptions);
|
|
16
19
|
onBegin(_config: FullConfig, suite: Suite): void;
|
|
17
20
|
private buildTestDocTree;
|
|
@@ -20,6 +23,7 @@ declare class Test2DocReporter implements Reporter {
|
|
|
20
23
|
onStepBegin(test: TestCase, _result: TestResult, step: TestStep): void;
|
|
21
24
|
onStepEnd(test: TestCase, result: TestResult, step: TestStep): void;
|
|
22
25
|
onTestEnd(test: TestCase, result: TestResult): void;
|
|
26
|
+
private updateProgressBar;
|
|
23
27
|
onEnd(): void;
|
|
24
28
|
private buildDocFiles;
|
|
25
29
|
private generateScreenshots;
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,UAAU,EACV,QAAQ,EACT,MAAM,2BAA2B,CAAA;AAoClC,UAAU,uBAAuB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAwBD;;;GAGG;AACH,cAAM,gBAAiB,YAAW,QAAQ;IACxC,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,MAAM,CAA4C;IAC1D,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,mBAAmB,CAAsB;IACjD,OAAO,CAAC,cAAc,CAAoB;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,UAAU,EACV,QAAQ,EACT,MAAM,2BAA2B,CAAA;AAoClC,UAAU,uBAAuB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAwBD;;;GAGG;AACH,cAAM,gBAAiB,YAAW,QAAQ;IACxC,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,MAAM,CAA4C;IAC1D,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,mBAAmB,CAAsB;IACjD,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,UAAU,CAAI;IACtB,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,WAAW,CAAgC;gBAGjD,OAAO,GAAE,uBAER;IAKH,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK;IAsBzC,OAAO,CAAC,gBAAgB;IAYxB,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,YAAY;IAmBpB,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI;IAOtE,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI;IAqBnE,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAkB5C,OAAO,CAAC,iBAAiB;IAYzB,KAAK;IAeL,OAAO,CAAC,aAAa;IA8BrB,OAAO,CAAC,mBAAmB;IAQ3B,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,cAAc;IAiCtB,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,gBAAgB;CA6BzB;AAOD,eAAe,gBAAgB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -14,6 +14,9 @@ class Test2DocReporter {
|
|
|
14
14
|
outputDir;
|
|
15
15
|
screenshotMoveQueue = [];
|
|
16
16
|
seenScreenshot = new Set();
|
|
17
|
+
totalTests = 0;
|
|
18
|
+
completedTests = 0;
|
|
19
|
+
testResults = [];
|
|
17
20
|
constructor(options = {
|
|
18
21
|
outputDir: "./docs",
|
|
19
22
|
}) {
|
|
@@ -30,6 +33,10 @@ class Test2DocReporter {
|
|
|
30
33
|
...(tests.length > 0 ? [this.buildTestDocTree(title, tests)] : []),
|
|
31
34
|
];
|
|
32
35
|
}) || []);
|
|
36
|
+
this.testResults = new Array(this.totalTests).fill(".");
|
|
37
|
+
writeLine(`Starting documentation generation for ${this.totalTests} tests...`);
|
|
38
|
+
writeLine(`Found ${this.docs.length} documentation sections\n`);
|
|
39
|
+
this.updateProgressBar();
|
|
33
40
|
}
|
|
34
41
|
buildTestDocTree(filename, tests) {
|
|
35
42
|
const title = filename.match(/^(.*?)\.(test|spec)\.(ts|js)$/)?.[1] ?? filename;
|
|
@@ -42,6 +49,7 @@ class Test2DocReporter {
|
|
|
42
49
|
}
|
|
43
50
|
buildDocTests(tests) {
|
|
44
51
|
return tests.map((test) => {
|
|
52
|
+
++this.totalTests;
|
|
45
53
|
const testDoc = {
|
|
46
54
|
title: test.title,
|
|
47
55
|
steps: [],
|
|
@@ -90,16 +98,40 @@ class Test2DocReporter {
|
|
|
90
98
|
}
|
|
91
99
|
}
|
|
92
100
|
onTestEnd(test, result) {
|
|
93
|
-
if (result.status === "
|
|
94
|
-
|
|
101
|
+
if (result.status === "passed") {
|
|
102
|
+
this.testResults[this.completedTests] = "P";
|
|
103
|
+
}
|
|
104
|
+
else if (result.status === "failed" || result.status === "timedOut") {
|
|
105
|
+
this.testResults[this.completedTests] = "F";
|
|
106
|
+
this.updateProgressBar();
|
|
107
|
+
writeLine(`Documentation generation aborted due to test failure: ${test.title}`);
|
|
95
108
|
process.exit(1);
|
|
96
109
|
}
|
|
110
|
+
else if (result.status === "skipped") {
|
|
111
|
+
this.testResults[this.completedTests] = "S";
|
|
112
|
+
}
|
|
113
|
+
this.completedTests++;
|
|
114
|
+
this.updateProgressBar();
|
|
115
|
+
}
|
|
116
|
+
updateProgressBar() {
|
|
117
|
+
// Move cursor to beginning of line and clear it
|
|
118
|
+
process.stdout.write("\r\x1b[K");
|
|
119
|
+
// Write the progress bar
|
|
120
|
+
const progressBar = `[${this.testResults.join("")}]`;
|
|
121
|
+
const percentage = Math.round((this.completedTests / this.totalTests) * 100);
|
|
122
|
+
process.stdout.write(`${progressBar} ${this.completedTests}/${this.totalTests} (${percentage}%)`);
|
|
97
123
|
}
|
|
98
124
|
onEnd() {
|
|
125
|
+
writeLine("\n");
|
|
126
|
+
writeLine("Cleaning up old screenshots...");
|
|
99
127
|
this.deleteScreenshots(this.outputDir);
|
|
128
|
+
writeLine("Generating documentation files...");
|
|
100
129
|
this.docs.forEach((doc) => {
|
|
101
130
|
this.buildDocFiles(doc);
|
|
102
131
|
});
|
|
132
|
+
writeLine("Documentation generation completed.");
|
|
133
|
+
writeLine(`Output directory: ${this.outputDir}`);
|
|
134
|
+
writeLine(`Processed ${this.seenScreenshot.size} screenshots`);
|
|
103
135
|
}
|
|
104
136
|
buildDocFiles(doc, outputDir = this.outputDir) {
|
|
105
137
|
const [title, metadata, metaType] = this.extractDocMetadata(doc.title);
|
|
@@ -177,7 +209,7 @@ class Test2DocReporter {
|
|
|
177
209
|
}
|
|
178
210
|
break;
|
|
179
211
|
default:
|
|
180
|
-
|
|
212
|
+
writeLine(`Unsupported metadata type for key "${key}": ${typeof value}`);
|
|
181
213
|
break;
|
|
182
214
|
}
|
|
183
215
|
}
|
|
@@ -218,5 +250,9 @@ class Test2DocReporter {
|
|
|
218
250
|
return markdown;
|
|
219
251
|
}
|
|
220
252
|
}
|
|
253
|
+
function writeLine(line) {
|
|
254
|
+
// eslint-disable-next-line no-restricted-properties
|
|
255
|
+
process.stdout.write(`${line}\n`);
|
|
256
|
+
}
|
|
221
257
|
export default Test2DocReporter;
|
|
222
258
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,SAAS,EACT,WAAW,EACX,QAAQ,EACR,UAAU,EACV,aAAa,GACd,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAM/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AA4ChC,0EAA0E;AAC1E,gBAAgB,EAAE,CAAA;AAElB;;;GAGG;AACH,MAAM,gBAAgB;IACZ,IAAI,GAAc,EAAE,CAAA;IACpB,MAAM,GAAmC,IAAI,GAAG,EAAE,CAAA;IAClD,SAAS,CAAQ;IACjB,mBAAmB,GAAoB,EAAE,CAAA;IACzC,cAAc,GAAG,IAAI,GAAG,EAAU,CAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,SAAS,EACT,WAAW,EACX,QAAQ,EACR,UAAU,EACV,aAAa,GACd,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAM/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AA4ChC,0EAA0E;AAC1E,gBAAgB,EAAE,CAAA;AAElB;;;GAGG;AACH,MAAM,gBAAgB;IACZ,IAAI,GAAc,EAAE,CAAA;IACpB,MAAM,GAAmC,IAAI,GAAG,EAAE,CAAA;IAClD,SAAS,CAAQ;IACjB,mBAAmB,GAAoB,EAAE,CAAA;IACzC,cAAc,GAAG,IAAI,GAAG,EAAU,CAAA;IAClC,UAAU,GAAG,CAAC,CAAA;IACd,cAAc,GAAG,CAAC,CAAA;IAClB,WAAW,GAA8B,EAAE,CAAA;IAEnD,YACE,UAAmC;QACjC,SAAS,EAAE,QAAQ;KACpB;QAED,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,QAAQ,CAAA;IAChD,CAAC;IAED,OAAO,CAAC,OAAmB,EAAE,KAAY;QACvC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QACd,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QACnB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAC9B,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE;YAClD,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC;gBAAE,OAAO,EAAE,CAAA;YAC5C,OAAO;gBACL,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAC1C,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aACnE,CAAA;QACH,CAAC,CAAC,IAAI,EAAE,CACX,CAAA;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAEvD,SAAS,CACP,yCAAyC,IAAI,CAAC,UAAU,WAAW,CACpE,CAAA;QACD,SAAS,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,MAAM,2BAA2B,CAAC,CAAA;QAC/D,IAAI,CAAC,iBAAiB,EAAE,CAAA;IAC1B,CAAC;IAEO,gBAAgB,CAAC,QAAgB,EAAE,KAAiB;QAC1D,MAAM,KAAK,GACT,QAAQ,CAAC,KAAK,CAAC,+BAA+B,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAA;QAClE,MAAM,OAAO,GAAY;YACvB,KAAK,EAAE,KAAK;YACZ,QAAQ,EAAE,EAAE;YACZ,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;SACjC,CAAA;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAEO,aAAa,CAAC,KAAiB;QACrC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACxB,EAAE,IAAI,CAAC,UAAU,CAAA;YACjB,MAAM,OAAO,GAAY;gBACvB,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,KAAK,EAAE,EAAE;aACV,CAAA;YACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;YACjC,OAAO,OAAO,CAAA;QAChB,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,YAAY,CAAC,KAAY;QAC/B,MAAM,OAAO,GAAY;YACvB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,QAAQ,EAAE,EAAE;SACb,CAAA;QAED,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;YAC7C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;YAC1C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACrC,CAAC;QAED,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACjD,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,WAAW,CAAC,IAAc,EAAE,OAAmB,EAAE,IAAc;QAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC3C,IAAI,UAAU,IAAI,IAAI,CAAC,QAAQ,KAAK,WAAW,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC;YACzE,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;QAC9C,CAAC;IACH,CAAC;IAED,SAAS,CAAC,IAAc,EAAE,MAAkB,EAAE,IAAc;QAC1D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC3C,IAAI,UAAU,IAAI,IAAI,CAAC,QAAQ,KAAK,WAAW,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC;YACzE,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC5C,IAAI,CAAC,UAAU,EAAE,IAAI;oBAAE,SAAQ;gBAE/B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAA;gBAE9D,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;gBAEzC,IAAI,cAAc,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;oBACxC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC;wBACpB,UAAU,EAAE,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,IAAI,EAAE;qBAC/D,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,SAAS,CAAC,IAAc,EAAE,MAAkB;QAC1C,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,GAAG,CAAA;QAC7C,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACtE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,GAAG,CAAA;YAC3C,IAAI,CAAC,iBAAiB,EAAE,CAAA;YACxB,SAAS,CACP,yDAAyD,IAAI,CAAC,KAAK,EAAE,CACtE,CAAA;YACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,GAAG,CAAA;QAC7C,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,IAAI,CAAC,iBAAiB,EAAE,CAAA;IAC1B,CAAC;IAEO,iBAAiB;QACvB,gDAAgD;QAChD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAEhC,yBAAyB;QACzB,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAA;QACpD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAA;QAC5E,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,GAAG,WAAW,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU,IAAI,CAC5E,CAAA;IACH,CAAC;IAED,KAAK;QACH,SAAS,CAAC,IAAI,CAAC,CAAA;QAEf,SAAS,CAAC,gCAAgC,CAAC,CAAA;QAC3C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAEtC,SAAS,CAAC,mCAAmC,CAAC,CAAA;QAC9C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACxB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;QACzB,CAAC,CAAC,CAAA;QACF,SAAS,CAAC,qCAAqC,CAAC,CAAA;QAChD,SAAS,CAAC,qBAAqB,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;QAChD,SAAS,CAAC,aAAa,IAAI,CAAC,cAAc,CAAC,IAAI,cAAc,CAAC,CAAA;IAChE,CAAC;IAEO,aAAa,CAAC,GAAY,EAAE,YAAoB,IAAI,CAAC,SAAS;QACpE,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAEtE,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;YACxB,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAA;YACpD,MAAM,QAAQ,GACZ,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,EAAE,GAAG,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAA;YAC9D,MAAM,QAAQ,GAAG,GAAG,SAAS,IAAI,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAA;YAC/D,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;YACjC,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAA;QACrC,CAAC;aAAM,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnC,MAAM,QAAQ,GAAG,GAAG,SAAS,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAA;YAC5D,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;YAExC,aAAa,CACX,GAAG,QAAQ,kBAAkB,EAC7B,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAClC,CAAA;YACD,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7B,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;YACrC,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAA;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YAC9C,MAAM,QAAQ,GAAG,GAAG,SAAS,IAAI,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAA;YACnE,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;YACjC,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;IAEO,mBAAmB,CAAC,MAAc;QACxC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE;YACpD,MAAM,IAAI,GAAG,GAAG,MAAM,IAAI,IAAI,EAAE,CAAA;YAChC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAC7B,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAA;IAC/B,CAAC;IAEO,iBAAiB,CAAC,MAAc;QACtC,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;YACnC,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC/B,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;gBACvB,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAA;YAClC,CAAC;iBAAM,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;gBACzD,UAAU,CAAC,QAAQ,CAAC,CAAA;YACtB,CAAC;QACH,CAAC;IACH,CAAC;IAEO,kBAAkB,CAAC,QAAgB;QACzC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC,GAC5C,QAAQ,CAAC,KAAK,CAAC,+BAA+B,CAAC,IAAI,EAAE,CAAA;QAEvD,OAAO;YACL,KAAK,IAAI,QAAQ;YACjB,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE;YAC5C,QAAwB;SACzB,CAAA;IACH,CAAC;IAEO,cAAc,CAAC,QAAgC;QACrD,IAAI,MAAM,GAAG,OAAO,CAAA;QACpB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACpD,QAAQ,OAAO,KAAK,EAAE,CAAC;gBACrB,KAAK,QAAQ,CAAC;gBACd,KAAK,QAAQ,CAAC;gBACd,KAAK,SAAS;oBACZ,MAAM,IAAI,GAAG,GAAG,KAAK,KAAK,IAAI,CAAA;oBAC9B,MAAK;gBACP,KAAK,QAAQ;oBACX,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;wBACzB,MAAM,IAAI,GAAG,GAAG,KAAK,CAAA;wBACrB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;4BACzB,MAAM,IAAI,OAAO,IAAI,IAAI,CAAA;wBAC3B,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,GAAG,GAAG,KAAK,CAAA;wBACrB,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;4BACvD,MAAM,IAAI,KAAK,MAAM,KAAK,QAAQ,IAAI,CAAA;wBACxC,CAAC;oBACH,CAAC;oBACD,MAAK;gBACP;oBACE,SAAS,CACP,sCAAsC,GAAG,MAAM,OAAO,KAAK,EAAE,CAC9D,CAAA;oBACD,MAAK;YACT,CAAC;QACH,CAAC;QACD,MAAM,IAAI,SAAS,CAAA;QACnB,OAAO,MAAM,CAAA;IACf,CAAC;IAEO,aAAa,CAAC,KAAa,EAAE,KAAa;QAChD,IAAI,aAAa,GAAG,EAAE,CAAA;QACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC;YAC/B,aAAa,IAAI,GAAG,CAAA;QACtB,CAAC;QACD,OAAO,GAAG,aAAa,IAAI,KAAK,MAAM,CAAA;IACxC,CAAC;IAEO,gBAAgB,CAAC,OAAgB,EAAE,KAAa;QACtD,IAAI,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QAEvD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBACjC,QAAQ,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;gBACrD,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC1B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;wBAC9B,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;4BACf,QAAQ,IAAI,GAAG,IAAI,CAAC,KAAK,IAAI,CAAA;wBAC/B,CAAC;wBACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;4BACpB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;4BAC9C,QAAQ,IAAI,mBAAmB,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,CAAA;wBAC1D,CAAC;oBACH,CAAC;oBACD,QAAQ,IAAI,IAAI,CAAA;gBAClB,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrC,QAAQ,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AAED,SAAS,SAAS,CAAC,IAAY;IAC7B,oDAAoD;IACpD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI,CAAC,CAAA;AACnC,CAAC;AAED,eAAe,gBAAgB,CAAA"}
|
package/dist/screenshots.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Locator, Page, PageScreenshotOptions, TestInfo } from "@playwright/test";
|
|
2
2
|
type Position = "above" | "below" | "left" | "right";
|
|
3
|
-
interface AnnotationOptions {
|
|
3
|
+
export interface AnnotationOptions {
|
|
4
4
|
text?: string;
|
|
5
5
|
fillStyle?: string;
|
|
6
6
|
font?: string;
|
|
@@ -20,6 +20,6 @@ interface AnnotationOptions {
|
|
|
20
20
|
interface ScreenshotOptions extends PageScreenshotOptions {
|
|
21
21
|
annotation?: AnnotationOptions;
|
|
22
22
|
}
|
|
23
|
-
export declare const screenshot: (testInfo: TestInfo, target: Page | Locator, { annotation, ...options }?: ScreenshotOptions) => Promise<void>;
|
|
23
|
+
export declare const screenshot: (testInfo: TestInfo, target: Page | Locator, { annotation: overrideAnnotations, ...options }?: ScreenshotOptions) => Promise<void>;
|
|
24
24
|
export {};
|
|
25
25
|
//# sourceMappingURL=screenshots.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"screenshots.d.ts","sourceRoot":"","sources":["../src/screenshots.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,IAAI,EACJ,qBAAqB,EACrB,QAAQ,EACT,MAAM,kBAAkB,CAAA;AAIzB,KAAK,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAA;AAEpD,
|
|
1
|
+
{"version":3,"file":"screenshots.d.ts","sourceRoot":"","sources":["../src/screenshots.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,IAAI,EACJ,qBAAqB,EACrB,QAAQ,EACT,MAAM,kBAAkB,CAAA;AAIzB,KAAK,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAA;AAEpD,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,UAAU,iBAAkB,SAAQ,qBAAqB;IACvD,UAAU,CAAC,EAAE,iBAAiB,CAAA;CAC/B;AAED,eAAO,MAAM,UAAU,GACrB,UAAU,QAAQ,EAClB,QAAQ,IAAI,GAAG,OAAO,EACtB,kDAAiD,iBAAsB,kBAuPxE,CAAA"}
|
package/dist/screenshots.js
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
let screenshotCounter = 0;
|
|
2
|
-
export const screenshot = async (testInfo, target, { annotation, ...options } = {}) => {
|
|
2
|
+
export const screenshot = async (testInfo, target, { annotation: overrideAnnotations, ...options } = {}) => {
|
|
3
|
+
const annotation = {
|
|
4
|
+
...(testInfo.project?.use?.test2doc?.annotationDefaults ?? {}),
|
|
5
|
+
...overrideAnnotations,
|
|
6
|
+
};
|
|
3
7
|
const filename = `test2doc-${Date.now()}-${++screenshotCounter}.png`;
|
|
4
8
|
let screenshot;
|
|
5
9
|
if ("highlight" in target) {
|
|
@@ -48,13 +52,13 @@ export const screenshot = async (testInfo, target, { annotation, ...options } =
|
|
|
48
52
|
if (box.y - window.scrollY > window.innerHeight * 0.6) {
|
|
49
53
|
return "above";
|
|
50
54
|
}
|
|
51
|
-
|
|
55
|
+
if (box.y - textHeight < window.scrollY &&
|
|
52
56
|
box.y + box.height + textHeight >
|
|
53
57
|
window.innerHeight + window.scrollY) {
|
|
54
58
|
if (box.x + box.width + textWidth < window.innerWidth) {
|
|
55
59
|
return "right";
|
|
56
60
|
}
|
|
57
|
-
|
|
61
|
+
if (box.x - textWidth > 0) {
|
|
58
62
|
return "left";
|
|
59
63
|
}
|
|
60
64
|
}
|
|
@@ -94,26 +98,26 @@ export const screenshot = async (testInfo, target, { annotation, ...options } =
|
|
|
94
98
|
? labelPosition.x + textWidth + padding
|
|
95
99
|
: position === "right"
|
|
96
100
|
? labelPosition.x - padding / 2
|
|
97
|
-
// top or bottom
|
|
98
|
-
|
|
101
|
+
: // top or bottom
|
|
102
|
+
labelPosition.x + textWidth / 2;
|
|
99
103
|
const arrowLabelEndY = position === "above"
|
|
100
104
|
? labelPosition.y + padding / 2
|
|
101
105
|
: position === "below"
|
|
102
106
|
? labelPosition.y - textHeight - padding / 2
|
|
103
|
-
// left or right
|
|
104
|
-
|
|
107
|
+
: // left or right
|
|
108
|
+
box.y + box.height / 2;
|
|
105
109
|
const arrowStartX = position === "left"
|
|
106
110
|
? box.x
|
|
107
111
|
: position === "right"
|
|
108
112
|
? box.x + box.width
|
|
109
|
-
// top or bottom
|
|
110
|
-
|
|
113
|
+
: // top or bottom
|
|
114
|
+
box.x + box.width / 2;
|
|
111
115
|
const arrowStartY = position === "above"
|
|
112
116
|
? box.y
|
|
113
117
|
: position === "below"
|
|
114
118
|
? box.y + box.height
|
|
115
|
-
// left or right
|
|
116
|
-
|
|
119
|
+
: // left or right
|
|
120
|
+
box.y + box.height / 2;
|
|
117
121
|
const arrowColor = annotation.arrowStrokeStyle ?? "rgba(255, 0, 0, 1)";
|
|
118
122
|
ctx.strokeStyle = arrowColor;
|
|
119
123
|
ctx.lineWidth = annotation.arrowLineWidth ?? 2;
|
|
@@ -146,7 +150,10 @@ export const screenshot = async (testInfo, target, { annotation, ...options } =
|
|
|
146
150
|
ctx.lineWidth = annotation.labelBoxLineWidth ?? 2;
|
|
147
151
|
const paddingBothSides = padding * 2;
|
|
148
152
|
const labelBoxX = labelPosition.x - padding;
|
|
149
|
-
const labelBoxY = labelPosition.y -
|
|
153
|
+
const labelBoxY = labelPosition.y -
|
|
154
|
+
textHeight +
|
|
155
|
+
actualBoundingBoxDescent -
|
|
156
|
+
padding;
|
|
150
157
|
const labelBoxWidth = textWidth + paddingBothSides;
|
|
151
158
|
const labelBoxHeight = textHeight + paddingBothSides;
|
|
152
159
|
ctx.fillRect(labelBoxX, labelBoxY, labelBoxWidth, labelBoxHeight);
|
package/dist/screenshots.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"screenshots.js","sourceRoot":"","sources":["../src/screenshots.ts"],"names":[],"mappings":"AAOA,IAAI,iBAAiB,GAAG,CAAC,CAAA;AA0BzB,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAC7B,QAAkB,EAClB,MAAsB,EACtB,EAAE,UAAU,EAAE,GAAG,OAAO,KAAwB,EAAE,
|
|
1
|
+
{"version":3,"file":"screenshots.js","sourceRoot":"","sources":["../src/screenshots.ts"],"names":[],"mappings":"AAOA,IAAI,iBAAiB,GAAG,CAAC,CAAA;AA0BzB,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAC7B,QAAkB,EAClB,MAAsB,EACtB,EAAE,UAAU,EAAE,mBAAmB,EAAE,GAAG,OAAO,KAAwB,EAAE,EACvE,EAAE;IACF,MAAM,UAAU,GAAsB;QACpC,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,kBAAkB,IAAI,EAAE,CAAC;QAC9D,GAAG,mBAAmB;KACvB,CAAA;IACD,MAAM,QAAQ,GAAG,YAAY,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,iBAAiB,MAAM,CAAA;IAEpE,IAAI,UAAkB,CAAA;IACtB,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,CAAA;QAE1B,MAAM,MAAM,CAAC,sBAAsB,EAAE,CAAA;QAErC,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAA;QAC9C,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,IAAI,CAAC,QAAQ,CACjB,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE;gBACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;gBAC/C,MAAM,CAAC,EAAE,GAAG,2BAA2B,CAAA;gBACvC,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG;;;;;;;;;;;WAWtB,CAAA;gBAED,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,UAAU,CAAA;gBAChC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,CAAA;gBAElC,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;gBACnC,IAAI,GAAG,EAAE,CAAC;oBACR,2BAA2B;oBAC3B,GAAG,CAAC,WAAW;wBACb,UAAU,EAAE,oBAAoB,IAAI,sBAAsB,CAAA;oBAC5D,GAAG,CAAC,SAAS,GAAG,UAAU,EAAE,kBAAkB,IAAI,CAAC,CAAA;oBACnD,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;oBAEnD,kBAAkB;oBAClB,GAAG,CAAC,SAAS;wBACX,UAAU,EAAE,kBAAkB,IAAI,wBAAwB,CAAA;oBAC5D,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;oBAEjD,IAAI,UAAU,EAAE,IAAI,EAAE,CAAC;wBACrB,GAAG,CAAC,IAAI,GAAG,UAAU,EAAE,IAAI,IAAI,YAAY,CAAA;wBAC3C,MAAM,EACJ,KAAK,EAAE,SAAS,EAChB,uBAAuB,EACvB,wBAAwB,GACzB,GAAG,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;wBACpC,MAAM,UAAU,GACd,uBAAuB,GAAG,wBAAwB,CAAA;wBACpD,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;wBAC5C,MAAM,OAAO,GAAG,CAAC,CAAA;wBAEjB,MAAM,WAAW,GAAG,CAAC,GAAc,EAAY,EAAE;4BAC/C,IAAI,GAAG;gCAAE,OAAO,GAAG,CAAA;4BAEnB,8CAA8C;4BAC9C,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,GAAG,GAAG,EAAE,CAAC;gCACtD,OAAO,OAAO,CAAA;4BAChB,CAAC;4BAED,IACE,GAAG,CAAC,CAAC,GAAG,UAAU,GAAG,MAAM,CAAC,OAAO;gCACnC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,UAAU;oCAC7B,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,OAAO,EACrC,CAAC;gCACD,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,SAAS,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;oCACtD,OAAO,OAAO,CAAA;gCAChB,CAAC;gCACD,IAAI,GAAG,CAAC,CAAC,GAAG,SAAS,GAAG,CAAC,EAAE,CAAC;oCAC1B,OAAO,MAAM,CAAA;gCACf,CAAC;4BACH,CAAC;4BACD,OAAO,OAAO,CAAA;wBAChB,CAAC,CAAA;wBAED,MAAM,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;wBAEjD,IAAI,aAAuC,CAAA;wBAC3C,QAAQ,QAAQ,EAAE,CAAC;4BACjB,KAAK,OAAO;gCACV,aAAa,GAAG;oCACd,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,SAAS,GAAG,CAAC;oCACxC,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,UAAU,GAAG,CAAC,GAAG,OAAO,GAAG,CAAC,GAAG,MAAM;iCACjD,CAAA;gCACD,MAAK;4BACP,KAAK,MAAM;gCACT,aAAa,GAAG;oCACd,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM;oCACvC,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,UAAU,GAAG,CAAC;iCAC3C,CAAA;gCACD,MAAK;4BACP,KAAK,OAAO;gCACV,aAAa,GAAG;oCACd,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,OAAO,GAAG,MAAM;oCACvC,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,UAAU,GAAG,CAAC;iCAC3C,CAAA;gCACD,MAAK;4BACP;gCACE,aAAa,GAAG;oCACd,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,SAAS,GAAG,CAAC;oCACxC,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM;iCACtD,CAAA;gCACD,MAAK;wBACT,CAAC;wBAED,0BAA0B;wBAC1B,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC;4BACzB,MAAM,cAAc,GAClB,QAAQ,KAAK,MAAM;gCACjB,CAAC,CAAC,aAAa,CAAC,CAAC,GAAG,SAAS,GAAG,OAAO;gCACvC,CAAC,CAAC,QAAQ,KAAK,OAAO;oCACpB,CAAC,CAAC,aAAa,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC;oCAC/B,CAAC,CAAC,gBAAgB;wCAChB,aAAa,CAAC,CAAC,GAAG,SAAS,GAAG,CAAC,CAAA;4BACvC,MAAM,cAAc,GAClB,QAAQ,KAAK,OAAO;gCAClB,CAAC,CAAC,aAAa,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC;gCAC/B,CAAC,CAAC,QAAQ,KAAK,OAAO;oCACpB,CAAC,CAAC,aAAa,CAAC,CAAC,GAAG,UAAU,GAAG,OAAO,GAAG,CAAC;oCAC5C,CAAC,CAAC,gBAAgB;wCAChB,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAA;4BAE9B,MAAM,WAAW,GACf,QAAQ,KAAK,MAAM;gCACjB,CAAC,CAAC,GAAG,CAAC,CAAC;gCACP,CAAC,CAAC,QAAQ,KAAK,OAAO;oCACpB,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK;oCACnB,CAAC,CAAC,gBAAgB;wCAChB,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,CAAC,CAAA;4BAC7B,MAAM,WAAW,GACf,QAAQ,KAAK,OAAO;gCAClB,CAAC,CAAC,GAAG,CAAC,CAAC;gCACP,CAAC,CAAC,QAAQ,KAAK,OAAO;oCACpB,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM;oCACpB,CAAC,CAAC,gBAAgB;wCAChB,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAA;4BAC9B,MAAM,UAAU,GACd,UAAU,CAAC,gBAAgB,IAAI,oBAAoB,CAAA;4BAErD,GAAG,CAAC,WAAW,GAAG,UAAU,CAAA;4BAC5B,GAAG,CAAC,SAAS,GAAG,UAAU,CAAC,cAAc,IAAI,CAAC,CAAA;4BAC9C,GAAG,CAAC,SAAS,EAAE,CAAA;4BACf,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,cAAc,CAAC,CAAA;4BAC1C,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,CAAA;4BACpC,GAAG,CAAC,MAAM,EAAE,CAAA;4BAEZ,iBAAiB;4BACjB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CACtB,WAAW,GAAG,cAAc,EAC5B,WAAW,GAAG,cAAc,CAC7B,CAAA;4BACD,MAAM,UAAU,GAAG,CAAC,UAAU,CAAC,cAAc,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA,CAAC,0BAA0B;4BAClF,GAAG,CAAC,SAAS,GAAG,UAAU,CAAA;4BAC1B,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAA;4BACtB,GAAG,CAAC,OAAO,GAAG,OAAO,CAAA;4BACrB,GAAG,CAAC,SAAS,EAAE,CAAA;4BACf,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,CAAA;4BACpC,GAAG,CAAC,MAAM,CACR,WAAW,GAAG,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,EACxD,WAAW,GAAG,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CACzD,CAAA;4BACD,GAAG,CAAC,MAAM,CACR,WAAW,GAAG,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,EACxD,WAAW,GAAG,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CACzD,CAAA;4BACD,GAAG,CAAC,SAAS,EAAE,CAAA;4BACf,GAAG,CAAC,IAAI,EAAE,CAAA;4BACV,GAAG,CAAC,MAAM,EAAE,CAAA;4BAEZ,GAAG,CAAC,cAAc,EAAE,CAAA;wBACtB,CAAC;wBAED,iBAAiB;wBACjB,IACE,UAAU,CAAC,iBAAiB;4BAC5B,UAAU,CAAC,mBAAmB,EAC9B,CAAC;4BACD,GAAG,CAAC,SAAS;gCACX,UAAU,CAAC,iBAAiB,IAAI,kBAAkB,CAAA;4BACpD,GAAG,CAAC,WAAW;gCACb,UAAU,CAAC,mBAAmB,IAAI,kBAAkB,CAAA;4BACtD,GAAG,CAAC,SAAS,GAAG,UAAU,CAAC,iBAAiB,IAAI,CAAC,CAAA;4BACjD,MAAM,gBAAgB,GAAG,OAAO,GAAG,CAAC,CAAA;4BACpC,MAAM,SAAS,GAAG,aAAa,CAAC,CAAC,GAAG,OAAO,CAAA;4BAC3C,MAAM,SAAS,GACb,aAAa,CAAC,CAAC;gCACf,UAAU;gCACV,wBAAwB;gCACxB,OAAO,CAAA;4BACT,MAAM,aAAa,GAAG,SAAS,GAAG,gBAAgB,CAAA;4BAClD,MAAM,cAAc,GAAG,UAAU,GAAG,gBAAgB,CAAA;4BACpD,GAAG,CAAC,QAAQ,CACV,SAAS,EACT,SAAS,EACT,aAAa,EACb,cAAc,CACf,CAAA;4BACD,GAAG,CAAC,UAAU,CACZ,SAAS,EACT,SAAS,EACT,aAAa,EACb,cAAc,CACf,CAAA;wBACH,CAAC;wBAED,kBAAkB;wBAClB,GAAG,CAAC,WAAW,GAAG,UAAU,EAAE,WAAW,IAAI,oBAAoB,CAAA;wBACjE,GAAG,CAAC,SAAS,GAAG,UAAU,EAAE,SAAS,IAAI,CAAC,CAAA;wBAC1C,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAA;wBACjE,GAAG,CAAC,SAAS,GAAG,UAAU,EAAE,SAAS,IAAI,kBAAkB,CAAA;wBAC3D,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAA;oBACjE,CAAC;gBACH,CAAC;gBAED,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;YACnC,CAAC,EACD,EAAE,WAAW,EAAE,UAAU,EAAE,CAC5B,CAAA;YAED,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;YAE3C,kBAAkB;YAClB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACvB,MAAM,MAAM,GAAG,QAAQ,CAAC,cAAc,CAAC,2BAA2B,CAAC,CAAA;gBACnE,IAAI,MAAM;oBAAE,MAAM,CAAC,MAAM,EAAE,CAAA;YAC7B,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QAC7C,CAAC;IACH,CAAC;SAAM,CAAC;QACN,2BAA2B;QAC3B,UAAU,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;IAC/C,CAAC;IAED,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE;QAC9B,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,WAAW;KACzB,CAAC,CAAA;AACJ,CAAC,CAAA"}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { AnnotationOptions } from "./screenshots.js";
|
|
2
|
+
export interface Test2DocConfig {
|
|
3
|
+
annotationDefaults?: Partial<AnnotationOptions>;
|
|
4
|
+
}
|
|
5
|
+
declare module "@playwright/test" {
|
|
6
|
+
interface PlaywrightTestOptions {
|
|
7
|
+
test2doc?: Test2DocConfig;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AAEzD,MAAM,WAAW,cAAc;IAC7B,kBAAkB,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;CAChD;AAED,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,qBAAqB;QAC7B,QAAQ,CAAC,EAAE,cAAc,CAAA;KAC1B;CACF"}
|
package/dist/types.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@test2doc/playwright",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.11.1",
|
|
4
4
|
"description": "A reporter that generates docs based off playwright test files",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"documentation",
|
|
@@ -40,6 +40,11 @@
|
|
|
40
40
|
"import": "./dist/screenshots.js",
|
|
41
41
|
"require": "./dist/screenshots.js",
|
|
42
42
|
"types": "./dist/screenshots.d.ts"
|
|
43
|
+
},
|
|
44
|
+
"./types": {
|
|
45
|
+
"types": "./dist/types.d.ts",
|
|
46
|
+
"import": "./dist/types.js",
|
|
47
|
+
"require": "./dist/types.js"
|
|
43
48
|
}
|
|
44
49
|
},
|
|
45
50
|
"main": "dist/index.js",
|
|
@@ -60,17 +65,18 @@
|
|
|
60
65
|
},
|
|
61
66
|
"devDependencies": {
|
|
62
67
|
"@playwright/test": "^1.55.0",
|
|
63
|
-
"@types/node": "^24.0
|
|
68
|
+
"@types/node": "^24.5.0",
|
|
64
69
|
"typescript": "^5.9.2",
|
|
65
70
|
"vitest": "^3.2.4"
|
|
66
71
|
},
|
|
67
72
|
"scripts": {
|
|
68
|
-
"clean": "rm -rf dist",
|
|
73
|
+
"clean": "rm -rf dist && rm -rf tsconfig.tsbuildinfo",
|
|
69
74
|
"build": "tsc --project tsconfig.json",
|
|
70
75
|
"build:watch": "tsc --project tsconfig.json --watch",
|
|
71
|
-
"test": "vitest run && pnpm int",
|
|
76
|
+
"test": "vitest run && pnpm int && pnpm int:a",
|
|
72
77
|
"unit": "vitest",
|
|
73
78
|
"int": "playwright test",
|
|
79
|
+
"int:a": "playwright test --config=playwright-annotation.config.ts",
|
|
74
80
|
"lint": "biome lint .",
|
|
75
81
|
"format": "biome format --write ."
|
|
76
82
|
}
|