You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[Docs]: --debug mode argument and --run-agents missing from test-cli options table #42889
Two playwright test options that appear in npx playwright test --help are missing from the CLI docs, and a documented option is missing its mode argument. packages/playwright/src/program.ts carries an explicit note — "update docs/src/test-cli-js.md when you update this, program is the source of truth" — both options below landed without that docs update.
--debug [mode] modes undocumented. The option is defined with choices: ['inspector', 'cli'] and preset: 'inspector' in program.ts (added in feat(cli): running with --debug=cli allows attaching and debugging over cli #39717). Both --debug rows in test-cli-js.md document the plain flag and the PWDEBUG=1 shortcut, but not the optional mode argument: --debug=cli allows attaching and debugging over the CLI.
--run-agents <mode> undocumented. The option is defined with choices: ['missing', 'all', 'none'] and preset: 'none' (made visible again in Revert "chore: hide stuff" #38917) and is printed by --help, but it has no row in the options table and is not mentioned in the agents guide either.
Suggested fix
Extend both --debug rows with the [mode] argument and the two modes (default inspector).
Add a --run-agents <mode> row to the options table.
Related gaps noticed in the same table while auditing (possibly separate, happy to follow up):
Page(s)
docs/src/test-cli-js.md)Description
Two
playwright testoptions that appear innpx playwright test --helpare missing from the CLI docs, and a documented option is missing its mode argument.packages/playwright/src/program.tscarries an explicit note — "update docs/src/test-cli-js.md when you update this, program is the source of truth" — both options below landed without that docs update.--debug [mode]modes undocumented. The option is defined withchoices: ['inspector', 'cli']andpreset: 'inspector'inprogram.ts(added in feat(cli): running with --debug=cli allows attaching and debugging over cli #39717). Both--debugrows intest-cli-js.mddocument the plain flag and thePWDEBUG=1shortcut, but not the optional mode argument:--debug=cliallows attaching and debugging over the CLI.--run-agents <mode>undocumented. The option is defined withchoices: ['missing', 'all', 'none']andpreset: 'none'(made visible again in Revert "chore: hide stuff" #38917) and is printed by--help, but it has no row in the options table and is not mentioned in the agents guide either.Suggested fix
--debugrows with the[mode]argument and the two modes (defaultinspector).--run-agents <mode>row to the options table.Related gaps noticed in the same table while auditing (possibly separate, happy to follow up):
merge-reports --reporterrow omits"coverage", which the generated help does print frombuiltInReporters(docs(test): complete reporter/trace unions and fix stale option descriptions #42839 adds"perfetto"to this row but not"coverage").docs/src/test-reporters-js.mdhas no sections for thecoverage,github, andnullbuilt-in reporters.