microsoft / microsoft/playwright

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

Open
#42,544 0 comments 0 reactions 0 assignees View on GitHub

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)
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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.