docs: fix reporter configuration pattern in all documentation#24
Merged
Conversation
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.
7bcd991 to
e9b4221
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the incorrect reporter configuration examples throughout the documentation.
Problem
The documentation showed an incorrect pattern that doesn't work with Playwright:
Solution
Updated all documentation to show the correct pattern (matching how
lytics-playwrightactually uses it):Files Changed
README.md(root)packages/reporter/README.mdpackages/reporter/src/CoreReporter.ts(JSDoc)packages/reporter/src/index.ts(JSDoc)packages/adapters/README.mdpackages/adapters/src/index.ts(JSDoc)packages/annotations/README.mdwebsite/content/index.mdxwebsite/content/docs/quickstart.mdxwebsite/content/docs/reporter/index.mdxwebsite/content/docs/reporter/usage.mdxwebsite/content/docs/annotations/index.mdxwebsite/content/docs/adapters/*.mdx(all adapter docs)Testing
pnpm buildpassespnpm typecheckpassesNo code changes - documentation only.