@test2doc/playwright 0.5.1 → 0.5.3

package/README.md

@@ -106,6 +106,74 @@ The `TEST2DOC=true` is required to activate the test2doc metadata to pass to the
 ## Verify installation
 To verify your setup works, run `npm run docs:generate` and check that markdown files appear in your `./doc/docs` directory, or wherever you specified the output directory in the `playwright-test2doc.config.ts` file.
 
+## Filtering Tests
+It is possible you may wish to opt-in some tests or opt-out other tests from doc generation. This is possible with playwright tags.
+
+### Tag tests
+Adding tags to playwright tests is easy. See the [official docs](https://playwright.dev/docs/test-annotations#tag-tests) for more details. 
+
+There are a few different approaches to tagging, but for this README we're going with passing in a tag array to help support multiple tags. But if you prefer one of the other options playwright supports, feel free to use it.
+
+```ts
+// Add tag to describe block level
+test.describe('Describe Block', {
+  tag: ['@test2doc']
+}, () => {
+  test('this test inherits from the describe block', () => {
+    ...
+  })
+})
+
+// Add tag to tests
+// This example has multiple tags
+test('test title', {
+  tag: ['@test2doc', '@other-tag'],
+}, async ({ page }) => {
+  ...
+});
+
+// Add tag to skip doc generation
+test('test will skip doc generation', {
+  tag: ['@skip-docs'],
+}, async ({ page }) => {
+  ...
+});
+```
+
+### Opt-in Approach
+**Best for:** Legacy codebases or when you want explicit control over which tests generate documentation.
+
+Run only tests with the `@test2doc` tag.
+
+#### Update package.json
+```json
+{
+  ...
+  "scripts": {
+    ...
+    "docs:generate": "TEST2DOC=true playwright test --config=playwright-test2doc.config.ts --grep @test2doc"
+  }
+  ...
+}
+```
+
+### Opt-out Approach
+**Best for:** Tests that don't need documentation generated, like flaky tests or internal API tests.
+
+Skip tests with the `@skip-docs` tag.
+
+#### Update package.json
+```json
+{
+  ...
+  "scripts": {
+    ...
+    "docs:generate": "TEST2DOC=true playwright test --config=playwright-test2doc.config.ts --grep-invert @skip-docs"
+  }
+  ...
+}
+```
+
 ## How it works
 
 After this setup, every time you run your Playwright tests, the `@test2doc/playwright` reporter will automatically generate a new markdown file in your specified Docusaurus docs directory for each test file and/or top-level describe block found in your Playwright test files.

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,kBA0BxE,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,kBA+DxE,CAAA"}

package/dist/screenshots.js

@@ -3,15 +3,49 @@ export const screenshot = async (testInfo, target, options) => {
     const filename = `test2doc-${Date.now()}-${++screenshotCounter}.png`;
     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());
-        });
+        const boundingBox = await target.boundingBox();
+        if (boundingBox) {
+            await page.evaluate((box) => {
+                const canvas = document.createElement("canvas");
+                canvas.id = "test2doc-highlight-canvas";
+                canvas.style.cssText = `
+          position: fixed !important;
+          top: 0 !important;
+          left: 0 !important;
+          width: 100vw !important;
+          height: 100vh !important;
+          pointer-events: none !important;
+          z-index: 9999 !important;
+          display: block !important;
+          visibility: visible !important;
+          opacity: 1 !important;
+        `;
+                canvas.width = window.innerWidth;
+                canvas.height = window.innerHeight;
+                const ctx = canvas.getContext("2d");
+                if (ctx) {
+                    // Draw highlight rectangle
+                    ctx.strokeStyle = "rgba(246, 255, 0, 0.8)";
+                    ctx.lineWidth = 2;
+                    ctx.strokeRect(box.x, box.y, box.width, box.height);
+                    // Add subtle fill
+                    ctx.fillStyle = "rgba(240, 255, 107, 0.25)";
+                    ctx.fillRect(box.x, box.y, box.width, box.height);
+                }
+                document.body.appendChild(canvas);
+            }, boundingBox);
+            screenshot = await page.screenshot(options);
+            // Clean up canvas
+            await page.evaluate(() => {
+                const canvas = document.getElementById("test2doc-highlight-canvas");
+                if (canvas)
+                    canvas.remove();
+            });
+        }
+        else {
+            screenshot = await page.screenshot(options);
+        }
     }
     else {
         // Target is already a page

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;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"}
+{"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,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,CAAA;QAE1B,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAA;QAC9C,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC1B,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;;;;;;;;;;;SAWtB,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,GAAG,wBAAwB,CAAA;oBAC1C,GAAG,CAAC,SAAS,GAAG,CAAC,CAAA;oBACjB,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,GAAG,2BAA2B,CAAA;oBAC3C,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;gBACnD,CAAC;gBAED,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;YACnC,CAAC,EAAE,WAAW,CAAC,CAAA;YAEf,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/package.json

@@ -1,11 +1,19 @@
 {
   "name": "@test2doc/playwright",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "A reporter that generates docs based off playwright test files",
   "keywords": [
+    "documentation",
+    "document",
+    "living documentation",
+    "markdown",
+    "generation",
+    "generator",
     "docs",
     "test",
     "playwright",
+    "docusaurus",
+    "reporter",
     "automation"
   ],
   "homepage": "https://github.com/dethstrobe/theDenverNexus/tree/main/packages/test2doc-playwright",
@@ -48,7 +56,7 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@playwright/test": "^1.52.0"
+    "@playwright/test": "^1.54.1"
   },
   "devDependencies": {
     "vitest": "^3.2.4",