microsoft / microsoft/playwright
[Docs]: incomplete reporter unions, missing trace/video modes, and version annotation errors
Open
Nobody has claimed this yet.
P3-collecting-feedback
- Dominant language
- TypeScript
- Stars
- 96.4k
- Forks
- 6.5k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 180
Description
[Docs]: incomplete reporter lists in unions, missing trace/video modes, and version annotation errors
Page(s)
- https://playwright.dev/docs/api/class-testconfig (JS: https://playwright.dev/docs/test-api? not applicable)
- https://playwright.dev/docs/test-api/class-testconfig (Python/C#/Java TestConfig)
- https://playwright.dev/docs/test-api/class-fullconfig
- https://playwright.dev/docs/test-cli (
merge-reports) - https://playwright.dev/docs/api/class-cdpsession
- https://playwright.dev/docs/api/class-cdpsessionevent
- https://playwright.dev/docs/api/class-apirequest
- https://playwright.dev/docs/api/class-browser
- https://playwright.dev/docs/api/class-browsertype
- https://playwright.dev/docs/api/class-locator
- https://playwright.dev/docs/api/class-elementhandle
- https://playwright.dev/docs/api/class-page
- https://playwright.dev/docs/emulation
- https://playwright.dev/docs/trace-viewer
- https://playwright.dev/docs/videos
Description
Several API doc unions/lists are incomplete or carry wrong version annotations:
blobmissing fromBuiltInReporterunions. TheTestConfig.reporterandFullConfig.reporterdoc unions (and theFullConfig.reportertype override inutils/generate_types/overrides-test.d.ts) omitblob, although it is part ofbuiltInReportersandReporterDescription. As a result,reporter: ['blob']fails type checking in the generated@playwright/testtypes.perfettomissing from themerge-reports --reporterlist intest-cli-js.md.- Missing trace modes:
retain-on-first-failureandretain-on-failure-and-retriesare absent from thetraceoption union inTestConfig/FullConfigdocs (both shipped and announced in release notes). - Missing video modes:
on-all-retries,retain-on-first-failure, andretain-on-failure-and-retriesare absent from thevideooption union. FullConfig.configFileis documented as an empty string when no config file exists; it is actuallyundefined.colorSchemealso supports'no-preference', missing from the docs (emulation.md / TestConfig).maskColorversion annotation: listed assince v1.34onElementHandle.screenshot/Locator.screenshot/Page.screenshot; the shared template says v1.35 (release notes confirm v1.35) — the localsinceoverrides should be removed.- Malformed
sincestrings:v.1.30and bare1.30/1.46instead ofv1.30/v1.46inclass-cdpsession.md,class-cdpsessionevent.md,class-apirequest.md,class-browser.md,class-browsertype.md(inconsistent rendering across languages).
I'd like to work on this myself.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the listed TestConfig and FullConfig documentation, test-cli-js.md, emulation.md, and the class pages containing the version annotations; also inspect utils/generate_types/overrides-test.d.ts. Compare each union, reporter list, value, and since annotation with the issue description, then verify that all listed documentation and type definitions consistently show the corrected values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 70/100