[Docs]: incomplete reporter lists in unions, missing trace/video modes, and version annotation errors
Page(s)
Description
Several API doc unions/lists are incomplete or carry wrong version annotations:
blob missing from BuiltInReporter unions. The TestConfig.reporter and FullConfig.reporter doc unions (and the FullConfig.reporter type override in utils/generate_types/overrides-test.d.ts) omit blob, although it is part of builtInReporters and ReporterDescription. As a result, reporter: ['blob'] fails type checking in the generated @playwright/test types.
perfetto missing from the merge-reports --reporter list in test-cli-js.md.
- Missing trace modes:
retain-on-first-failure and retain-on-failure-and-retries are absent from the trace option union in TestConfig/FullConfig docs (both shipped and announced in release notes).
- Missing video modes:
on-all-retries, retain-on-first-failure, and retain-on-failure-and-retries are absent from the video option union.
FullConfig.configFile is documented as an empty string when no config file exists; it is actually undefined.
colorScheme also supports 'no-preference', missing from the docs (emulation.md / TestConfig).
maskColor version annotation: listed as since v1.34 on ElementHandle.screenshot/Locator.screenshot/Page.screenshot; the shared template says v1.35 (release notes confirm v1.35) — the local since overrides should be removed.
- Malformed
since strings: v.1.30 and bare 1.30/1.46 instead of v1.30/v1.46 in class-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.
[Docs]: incomplete reporter lists in unions, missing trace/video modes, and version annotation errors
Page(s)
merge-reports)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.retain-on-first-failureandretain-on-failure-and-retriesare absent from thetraceoption union inTestConfig/FullConfigdocs (both shipped and announced in release notes).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.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.