Skip to content

docs: sync CLI docs with v12 options and defaults#6140

Open
mostafaNazari702 wants to merge 3 commits into
mochajs:mainfrom
mostafaNazari702:docs-cli-v12-sync
Open

docs: sync CLI docs with v12 options and defaults#6140
mostafaNazari702 wants to merge 3 commits into
mochajs:mainfrom
mostafaNazari702:docs-cli-v12-sync

Conversation

@mostafaNazari702

Copy link
Copy Markdown
Contributor

PR Checklist

Overview

The CLI docs got out of sync with the actual --help output because a few changes either only made it into the old docs/index.md (which was removed in #5583) or never got documented at all.

I now added the the two missing option docs, update the --forbid-only docs to explain the new CI default, refreshed the --help snapshot so it match the actual output and fix the tip on the exclusive tests page that still tells people to manually add --forbid-only to their CI command.

One thing i want to say is that the snapshot still shows --forbid-only as [default: false] because that's what --help prints in a normal shell. The default is actually automatic so the option's docs now explain that it's enabled automatically in CI.

mark-wiemer
mark-wiemer previously approved these changes Jul 18, 2026

@mark-wiemer mark-wiemer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nits, thank you!

Comment thread docs/src/content/docs/declaring/exclusive-tests.mdx Outdated
Comment thread docs/src/content/docs/running/cli.mdx Outdated
mostafaNazari702 and others added 3 commits July 19, 2026 20:00
Co-authored-by: Mark Wiemer <7833360+mark-wiemer@users.noreply.github.com>
Co-authored-by: Mark Wiemer <7833360+mark-wiemer@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants