Skip to content

[Docs]: incomplete reporter unions, missing trace/video modes, and version annotation errors #42544

Description

[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:

  1. 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.
  2. perfetto missing from the merge-reports --reporter list in test-cli-js.md.
  3. 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).
  4. Missing video modes: on-all-retries, retain-on-first-failure, and retain-on-failure-and-retries are absent from the video option union.
  5. FullConfig.configFile is documented as an empty string when no config file exists; it is actually undefined.
  6. colorScheme also supports 'no-preference', missing from the docs (emulation.md / TestConfig).
  7. 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.
  8. 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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions