@test2doc/playwright 0.3.3 → 0.4.0

package/README.md

@@ -179,4 +179,22 @@ test.describe(withDocMeta("describe block"), async () => {
       })
     })
   })
+```
+
+#### Highlight an element
+It's possible to highlight an element by passing in a locator of an element on the page.
+
+```ts
+import { screenshot } from "@test2doc/playwright/screenshots"
+...
+
+test.describe(withDocMeta("describe block"), async () => {
+    test("test block", async ({ page }, testInfo) => {
+      ...
+      test.step("step block", async () => {
+        await page.goto("http://localhost:5173/")
+        await screenshot(testInfo, page.getByRole("header", {name: "Page Title"}))
+      })
+    })
+  })
 ```

package/dist/screenshots.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"screenshots.d.ts","sourceRoot":"","sources":["../src/screenshots.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,IAAI,EACJ,qCAAqC,EACrC,qBAAqB,EACrB,QAAQ,EACT,MAAM,kBAAkB,CAAA;AAIzB,eAAO,MAAM,UAAU,GACrB,UAAU,QAAQ,EAClB,QAAQ,IAAI,GAAG,OAAO,EACtB,UAAU,qBAAqB,GAAG,qCAAqC,kBASxE,CAAA"}
+{"version":3,"file":"screenshots.d.ts","sourceRoot":"","sources":["../src/screenshots.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,IAAI,EACJ,qCAAqC,EACrC,qBAAqB,EACrB,QAAQ,EACT,MAAM,kBAAkB,CAAA;AAIzB,eAAO,MAAM,UAAU,GACrB,UAAU,QAAQ,EAClB,QAAQ,IAAI,GAAG,OAAO,EACtB,UAAU,qBAAqB,GAAG,qCAAqC,kBA0BxE,CAAA"}

package/dist/screenshots.js

@@ -1,9 +1,24 @@
 let screenshotCounter = 0;
 export const screenshot = async (testInfo, target, options) => {
     const filename = `test2doc-${Date.now()}-${++screenshotCounter}.png`;
-    const screenshot = target.screenshot(options);
+    let screenshot;
+    if ("highlight" in target) {
+        // Target is a locator - highlight it first, then get its page
+        await target.highlight();
+        const page = target.page();
+        screenshot = await page.screenshot(options);
+        // Remove highlighting after taking the screenshot
+        const glassElements = page.locator("X-PW-GLASS");
+        await glassElements.evaluateAll((elements) => {
+            elements.forEach((el) => el.remove());
+        });
+    }
+    else {
+        // Target is already a page
+        screenshot = await target.screenshot(options);
+    }
     await testInfo.attach(filename, {
-        body: await screenshot,
+        body: screenshot,
         contentType: "image/png",
     });
 };

package/dist/screenshots.js.map

@@ -1 +1 @@
-{"version":3,"file":"screenshots.js","sourceRoot":"","sources":["../src/screenshots.ts"],"names":[],"mappings":"AAQA,IAAI,iBAAiB,GAAG,CAAC,CAAA;AAEzB,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAC7B,QAAkB,EAClB,MAAsB,EACtB,OAAuE,EACvE,EAAE;IACF,MAAM,QAAQ,GAAG,YAAY,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,iBAAiB,MAAM,CAAA;IACpE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;IAE7C,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE;QAC9B,IAAI,EAAE,MAAM,UAAU;QACtB,WAAW,EAAE,WAAW;KACzB,CAAC,CAAA;AACJ,CAAC,CAAA"}
+{"version":3,"file":"screenshots.js","sourceRoot":"","sources":["../src/screenshots.ts"],"names":[],"mappings":"AAQA,IAAI,iBAAiB,GAAG,CAAC,CAAA;AAEzB,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAC7B,QAAkB,EAClB,MAAsB,EACtB,OAAuE,EACvE,EAAE;IACF,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,8DAA8D;QAC9D,MAAM,MAAM,CAAC,SAAS,EAAE,CAAA;QACxB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,CAAA;QAE1B,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QAE3C,kDAAkD;QAClD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAChD,MAAM,aAAa,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC3C,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAA;QACvC,CAAC,CAAC,CAAA;IACJ,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@test2doc/playwright",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "A reporter that generates docs based off playwright test files",
   "keywords": [
     "docs",