From 7c6630b1a2fb67c1d439d4a69bec01b5c4744154 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gon=C3=A7alo=20Basto?=
 <1653045+gbasto@users.noreply.github.com>
Date: Fri, 24 Feb 2023 11:29:08 +0000
Subject: [PATCH] docs: add custom reporter options documentation  (#21144)

---
 docs/src/test-reporter-api/class-reporter.md     | 12 ++++++++++--
 packages/playwright-test/types/testReporter.d.ts |  6 +++++-
 2 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/docs/src/test-reporter-api/class-reporter.md b/docs/src/test-reporter-api/class-reporter.md
index b3cac403de..41c2ea7e55 100644
--- a/docs/src/test-reporter-api/class-reporter.md
+++ b/docs/src/test-reporter-api/class-reporter.md
@@ -12,6 +12,10 @@ You can create a custom reporter by implementing a class with some of the report
 
 /** @implements {import('@playwright/test/reporter').Reporter} */
 class MyReporter {
+  constructor(options) {
+    console.log(`my-awesome-reporter setup with customOption set to ${options.customOption}`);
+  }
+
   onBegin(config, suite) {
     console.log(`Starting the run with ${suite.allTests().length} tests`);
   }
@@ -37,6 +41,10 @@ module.exports = MyReporter;
 import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
 
 class MyReporter implements Reporter {
+  constructor(options: {customOption: { customOption?: string } = {}) {
+    console.log(`my-awesome-reporter setup with customOption set to ${options.customOption}`);
+  }
+
   onBegin(config: FullConfig, suite: Suite) {
     console.log(`Starting the run with ${suite.allTests().length} tests`);
   }
@@ -65,7 +73,7 @@ Now use this reporter with [`property: TestConfig.reporter`]. Learn more about [
 const { defineConfig } = require('@playwright/test');
 
 module.exports = defineConfig({
-  reporter: './my-awesome-reporter.js',
+  reporter: ['./my-awesome-reporter.js', { customOption: 'some value' }],
 });
 ```
 
@@ -74,7 +82,7 @@ module.exports = defineConfig({
 import { defineConfig } from '@playwright/test';
 
 export default defineConfig({
-  reporter: './my-awesome-reporter.ts',
+  reporter: ['./my-awesome-reporter.ts', { customOption: 'some value' }],
 });
 ```
 
diff --git a/packages/playwright-test/types/testReporter.d.ts b/packages/playwright-test/types/testReporter.d.ts
index 753c49395d..e7f77db6d6 100644
--- a/packages/playwright-test/types/testReporter.d.ts
+++ b/packages/playwright-test/types/testReporter.d.ts
@@ -319,6 +319,10 @@ export interface FullResult {
  * import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
  *
  * class MyReporter implements Reporter {
+ *   constructor(options: {customOption: { customOption?: string } = {}) {
+ *     console.log(`my-awesome-reporter setup with customOption set to ${options.customOption}`);
+ *   }
+ *
  *   onBegin(config: FullConfig, suite: Suite) {
  *     console.log(`Starting the run with ${suite.allTests().length} tests`);
  *   }
@@ -347,7 +351,7 @@ export interface FullResult {
  * import { defineConfig } from '@playwright/test';
  *
  * export default defineConfig({
- *   reporter: './my-awesome-reporter.ts',
+ *   reporter: ['./my-awesome-reporter.ts', { customOption: 'some value' }],
  * });
  * ```
  *