Skip to content

docs: update cli options#760

Merged
9aoy merged 2 commits intomainfrom
docs/cli-options
Dec 12, 2025
Merged

docs: update cli options#760
9aoy merged 2 commits intomainfrom
docs/cli-options

Conversation

@9aoy
Copy link
Copy Markdown
Collaborator

@9aoy 9aoy commented Dec 12, 2025

Summary

update cli options

Related Links

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings December 12, 2025 02:59
@netlify
Copy link
Copy Markdown

netlify bot commented Dec 12, 2025

Deploy Preview for rstest-dev ready!

Name Link
🔨 Latest commit 5a75988
🔍 Latest deploy log https://app.netlify.com/projects/rstest-dev/deploys/693b88332913ce0008058035
😎 Deploy Preview https://deploy-preview-760--rstest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the CLI documentation and reorganizes configuration options for better logical grouping. It adds 13 new CLI option entries to both English and Chinese documentation, and restructures the ConfigOverview component to create a dedicated snapshot configuration group.

Key changes:

  • Created a new "snapshot" group in ConfigOverview.tsx containing snapshot-related options (update, snapshotFormat, resolveSnapshotPath)
  • Moved globals option from basic to runtime group for better categorization
  • Added 13 CLI options to documentation: --include, --includeSource, --logHeapUsage, --hideSkippedTests, --chaiConfig, --env, --pool, --setupFiles, --snapshotFormat, --resolveSnapshotPath, --onConsoleLog, --name, and --projects

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
website/theme/components/ConfigOverview.tsx Reorganized configuration groups: created snapshot group, moved globals to runtime, and relocated snapshot-related options from output to the new snapshot group
website/docs/en/guide/basic/cli.mdx Added 13 new CLI option entries to the English documentation table
website/docs/zh/guide/basic/cli.mdx Added 13 new CLI option entries to the Chinese documentation table with parallel content

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@9aoy 9aoy merged commit 172176a into main Dec 12, 2025
16 checks passed
@9aoy 9aoy deleted the docs/cli-options branch December 12, 2025 03:28
@9aoy 9aoy mentioned this pull request Dec 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants