docs: fix reporter configuration pattern in all documentation (#24)

Playwright reporters must be specified as file paths, not class instances.
Updated all documentation and JSDoc to show the correct pattern:

1. Create a reporter file that extends CoreReporter
2. Reference it by path in playwright.config.ts

This matches how lytics-playwright actually uses the reporter.

Author: prosdev

.dev-agent/config.json

@@ -0,0 +1,62 @@
+{
+  "version": "1.0",
+  "repository": {
+    "path": ".",
+    "excludePatterns": [
+      "**/node_modules/**",
+      "**/dist/**",
+      "**/.git/**",
+      "**/coverage/**"
+    ],
+    "languages": [
+      "typescript",
+      "javascript",
+      "markdown"
+    ]
+  },
+  "mcp": {
+    "adapters": {
+      "search": {
+        "enabled": true
+      },
+      "refs": {
+        "enabled": true
+      },
+      "map": {
+        "enabled": true
+      },
+      "history": {
+        "enabled": true
+      },
+      "plan": {
+        "enabled": true
+      },
+      "explore": {
+        "enabled": true
+      },
+      "github": {
+        "enabled": true
+      },
+      "status": {
+        "enabled": true
+      },
+      "health": {
+        "enabled": true
+      }
+    }
+  },
+  "repositoryPath": "/Users/prosseng/workspace/playwright-core",
+  "excludePatterns": [
+    "**/node_modules/**",
+    "**/dist/**",
+    "**/.git/**",
+    "**/coverage/**"
+  ],
+  "languages": [
+    "typescript",
+    "javascript",
+    "markdown"
+  ],
+  "embeddingModel": "Xenova/all-MiniLM-L6-v2",
+  "dimension": 384
+}

README.md

@@ -38,20 +38,40 @@ npm install @lytics/playwright-journey
 
 ### Basic Usage
 
+**Step 1: Create a reporter file**
+
 ```typescript
-import { test as base } from "@playwright/test";
-import { pushSuiteAnnotation, pushTestAnnotations } from "@lytics/playwright-annotations";
+// reporter.ts
 import { CoreReporter } from "@lytics/playwright-reporter";
 import { FilesystemAdapter } from "@lytics/playwright-adapters/filesystem";
 
-// Configure reporter
-export default new CoreReporter({
-  adapters: [
-    new FilesystemAdapter({ outputDir: './test-results' })
-  ]
-});
+class CustomReporter extends CoreReporter {
+  constructor() {
+    super({
+      adapters: [new FilesystemAdapter({ outputDir: './test-results' })]
+    });
+  }
+}
+
+export default CustomReporter;
+```
+
+**Step 2: Configure Playwright**
+
+```typescript
+// playwright.config.ts
+export default {
+  reporter: [['list'], ['./reporter.ts']]
+};
+```
+
+**Step 3: Write annotated tests**
+
+```typescript
+// tests/my-feature.spec.ts
+import { test } from "@playwright/test";
+import { pushSuiteAnnotation, pushTestAnnotations } from "@lytics/playwright-annotations";
 
-// Write tests
 test.describe("My Feature @smoke", () => {
   test.beforeEach(async ({}, testInfo) => {
     pushSuiteAnnotation(testInfo, "MY-PRODUCT");

packages/adapters/README.md

@@ -27,24 +27,35 @@ Writes test results to JSON files on the local filesystem. Useful for local deve
 
 **Example:**
 
+Create a reporter file:
+
 ```typescript
+// reporter.ts
 import { CoreReporter } from '@lytics/playwright-reporter';
 import { FilesystemAdapter } from '@lytics/playwright-adapters/filesystem';
 
+class CustomReporter extends CoreReporter {
+  constructor() {
+    super({
+      adapters: [
+        new FilesystemAdapter({
+          outputDir: './test-results',
+          pretty: true, // default: true
+        }),
+      ],
+    });
+  }
+}
+
+export default CustomReporter;
+```
+
+Reference it in your config:
+
+```typescript
+// playwright.config.ts
 export default {
-  reporter: [
-    ['list'],
-    [
-      new CoreReporter({
-        adapters: [
-          new FilesystemAdapter({
-            outputDir: './test-results',
-            pretty: true, // default: true
-          }),
-        ],
-      }),
-    ],
-  ],
+  reporter: [['list'], ['./reporter.ts']],
 };
 ```
 
@@ -88,32 +99,32 @@ Sends test results to Slack channels using `@lytics/playwright-slack`. Automatic
 **Example:**
 
 ```typescript
+// reporter.ts
 import { CoreReporter } from '@lytics/playwright-reporter';
 import { FilesystemAdapter } from '@lytics/playwright-adapters/filesystem';
 import { SlackAdapter } from '@lytics/playwright-adapters/slack';
 
-export default {
-  reporter: [
-    ['list'],
-    [
-      new CoreReporter({
-        adapters: [
-          new FilesystemAdapter({ outputDir: './test-results' }),
-          new SlackAdapter({
-            webhookUrl: process.env.SLACK_WEBHOOK_URL,
-            environment: 'Production',
-            productionOnly: true, // default: true
-            skipPullRequests: true, // default: true
-            dashboardUrl: 'https://dashboard.example.com',
-            ciJobUrl: process.env.CI_JOB_URL,
-            artifactBaseUrl: process.env.ARTIFACT_BASE_URL,
-            triggerType: process.env.TRIGGER_TYPE,
-          }),
-        ],
-      }),
-    ],
-  ],
-};
+class CustomReporter extends CoreReporter {
+  constructor() {
+    super({
+      adapters: [
+        new FilesystemAdapter({ outputDir: './test-results' }),
+        new SlackAdapter({
+          webhookUrl: process.env.SLACK_WEBHOOK_URL!,
+          environment: 'Production',
+          productionOnly: true, // default: true
+          skipPullRequests: true, // default: true
+          dashboardUrl: 'https://dashboard.example.com',
+          ciJobUrl: process.env.CI_JOB_URL,
+          artifactBaseUrl: process.env.ARTIFACT_BASE_URL,
+          triggerType: process.env.TRIGGER_TYPE,
+        }),
+      ],
+    });
+  }
+}
+
+export default CustomReporter;
 ```
 
 **Configuration:**
@@ -165,33 +176,33 @@ Writes test results to Google Cloud Firestore. Supports automatic retry with exp
 **Example:**
 
 ```typescript
+// reporter.ts
 import { CoreReporter } from '@lytics/playwright-reporter';
 import { FirestoreAdapter } from '@lytics/playwright-adapters/firestore';
 
-export default {
-  reporter: [
-    ['list'],
-    [
-      new CoreReporter({
-        adapters: [
-          new FirestoreAdapter({
-            projectId: 'my-gcp-project',
-            credentials: process.env.GOOGLE_APPLICATION_CREDENTIALS_JSON,
-            // Configure your own collection names to match your Firestore schema
-            collections: {
-              testRuns: 'your_test_runs_collection',
-              testCases: 'your_test_cases_collection',
-              latestTestCases: 'your_latest_test_cases_collection',
-            },
-            skipConditions: {
-              skipPullRequests: true,
-            },
-          }),
-        ],
-      }),
-    ],
-  ],
-};
+class CustomReporter extends CoreReporter {
+  constructor() {
+    super({
+      adapters: [
+        new FirestoreAdapter({
+          projectId: 'my-gcp-project',
+          credentials: process.env.GOOGLE_APPLICATION_CREDENTIALS_JSON,
+          // Configure your own collection names to match your Firestore schema
+          collections: {
+            testRuns: 'your_test_runs_collection',
+            testCases: 'your_test_cases_collection',
+            latestTestCases: 'your_latest_test_cases_collection',
+          },
+          skipConditions: {
+            skipPullRequests: true,
+          },
+        }),
+      ],
+    });
+  }
+}
+
+export default CustomReporter;
 ```
 
 **Configuration:**

packages/adapters/src/index.ts

@@ -11,25 +11,32 @@
  *
  * @example
  * ```typescript
+ * // reporter.ts
  * import { CoreReporter } from '@lytics/playwright-reporter';
  * import { FilesystemAdapter } from '@lytics/playwright-adapters/filesystem';
  * import { SlackAdapter } from '@lytics/playwright-adapters/slack';
  * import { FirestoreAdapter } from '@lytics/playwright-adapters/firestore';
  *
- * const reporter = new CoreReporter({
- *   adapters: [
- *     new FilesystemAdapter({ outputDir: './test-results' }),
- *     new SlackAdapter({ webhookUrl: process.env.SLACK_WEBHOOK_URL }),
- *     new FirestoreAdapter({
- *       projectId: 'my-gcp-project',
- *       collections: {
- *         testRuns: 'test_runs',
- *         testCases: 'test_cases',
- *         latestTestCases: 'latest_test_cases'
- *       }
- *     })
- *   ]
- * });
+ * class CustomReporter extends CoreReporter {
+ *   constructor() {
+ *     super({
+ *       adapters: [
+ *         new FilesystemAdapter({ outputDir: './test-results' }),
+ *         new SlackAdapter({ webhookUrl: process.env.SLACK_WEBHOOK_URL! }),
+ *         new FirestoreAdapter({
+ *           projectId: 'my-gcp-project',
+ *           collections: {
+ *             testRuns: 'test_runs',
+ *             testCases: 'test_cases',
+ *             latestTestCases: 'latest_test_cases'
+ *           }
+ *         })
+ *       ]
+ *     });
+ *   }
+ * }
+ *
+ * export default CustomReporter;
  * ```
  *
  * @packageDocumentation

packages/annotations/README.md

@@ -301,20 +301,37 @@ Annotations enable:
 
 ### With Reporter
 
-Annotations are consumed by `@lytics/playwright-reporter`:
+Annotations are consumed by `@lytics/playwright-reporter`. Create a reporter file:
 
 ```typescript
+// reporter.ts
 import { CoreReporter } from '@lytics/playwright-reporter';
 import { FirestoreAdapter } from '@lytics/playwright-adapters/firestore';
 
-export default new CoreReporter({
-  adapters: [
-    new FirestoreAdapter({
-      projectId: 'my-project',
-      // Adapter uses annotations for querying and grouping
-    }),
-  ],
-});
+class CustomReporter extends CoreReporter {
+  constructor() {
+    super({
+      adapters: [
+        new FirestoreAdapter({
+          projectId: 'my-project',
+          collections: { /* ... */ },
+          // Adapter uses annotations for querying and grouping
+        }),
+      ],
+    });
+  }
+}
+
+export default CustomReporter;
+```
+
+Reference it in your config:
+
+```typescript
+// playwright.config.ts
+export default {
+  reporter: [['list'], ['./reporter.ts']]
+};
 ```
 
 ### With Journey Tools