Skip to content

docs: add --reporter option#434

Merged
9aoy merged 1 commit intomainfrom
docs/reporters
Aug 1, 2025
Merged

docs: add --reporter option#434
9aoy merged 1 commit intomainfrom
docs/reporters

Conversation

@9aoy
Copy link
Copy Markdown
Collaborator

@9aoy 9aoy commented Aug 1, 2025

Summary

add --reporter option.

Related Links

Checklist

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

Copilot AI review requested due to automatic review settings August 1, 2025 06:54
@netlify
Copy link
Copy Markdown

netlify bot commented Aug 1, 2025

Deploy Preview for rstest-dev ready!

Name Link
🔨 Latest commit 4515dc3
🔍 Latest deploy log https://app.netlify.com/projects/rstest-dev/deploys/688c6498a7469b0008f9e191
😎 Deploy Preview https://deploy-preview-434--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 adds documentation for the --reporter CLI option to the Rstest documentation. The changes update both English and Chinese documentation to include the new CLI option and simplify the reporter description.

  • Added --reporter option to CLI documentation tables in both languages
  • Simplified the description of the reporters configuration by removing redundant text

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
website/docs/zh/guide/basic/cli.mdx Added --reporter option to Chinese CLI options table
website/docs/zh/config/test/reporters.mdx Simplified Chinese reporter description
website/docs/en/guide/basic/cli.mdx Added --reporter option to English CLI options table
website/docs/en/config/test/reporters.mdx Simplified English reporter description

| `--testTimeout <value>` | 设置单个测试的超时时间(毫秒),详见 [testTimeout](/config/test/testTimeout) |
| `--hookTimeout <value>` | 设置单个测试 hook 的超时时间(毫秒),详见 [hookTimeout](/config/test/hookTimeout) |
| `--retry <retry>` | 测试失败时重试次数,详见 [retry](/config/test/retry) |
| `--reporter <reporter>` | 指定测试报告器,详见 [reporters](/config/test/reporters) |
Copy link

Copilot AI Aug 1, 2025

Choose a reason for hiding this comment

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

[nitpick] The --reporter option is placed inconsistently in the table. It should be positioned after --retry to maintain logical grouping with other test configuration options, rather than being inserted between --retry and --maxConcurrency.

Copilot uses AI. Check for mistakes.
| `-r, --root <root>` | Specify the project root directory, see [root](/config/test/root) |
| `--globals` | Provide global APIs, see [globals](/config/test/globals) |
| `--isolate` | Run tests in an isolated environment, see [isolate](/config/test/isolate) |
| `--reporter <reporter>` | Specify the test reporter, see [reporters](/config/test/reporters) |
Copy link

Copilot AI Aug 1, 2025

Choose a reason for hiding this comment

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

[nitpick] The --reporter option placement is inconsistent between the English and Chinese documentation. In the English version, it's placed after --isolate, while in the Chinese version it's after --retry. Consider maintaining consistent ordering across both language versions.

Suggested change
| `--reporter <reporter>` | Specify the test reporter, see [reporters](/config/test/reporters) |

Copilot uses AI. Check for mistakes.
@9aoy 9aoy merged commit 8535188 into main Aug 1, 2025
17 checks passed
@9aoy 9aoy deleted the docs/reporters branch August 1, 2025 07:20
@9aoy 9aoy mentioned this pull request Aug 5, 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