@test2doc/playwright 0.10.0 → 0.11.0
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/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/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.0",
|
|
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
|
}
|