Skip to content

docs: add CLI shortcuts section#458

Merged
9aoy merged 2 commits intomainfrom
docs/cliShortcuts
Aug 8, 2025
Merged

docs: add CLI shortcuts section#458
9aoy merged 2 commits intomainfrom
docs/cliShortcuts

Conversation

@9aoy
Copy link
Copy Markdown
Collaborator

@9aoy 9aoy commented Aug 8, 2025

Summary

add CLI shortcuts section.

Related Links

Checklist

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

Copilot AI review requested due to automatic review settings August 8, 2025 08:09
@netlify
Copy link
Copy Markdown

netlify bot commented Aug 8, 2025

Deploy Preview for rstest-dev ready!

Name Link
🔨 Latest commit a35308d
🔍 Latest deploy log https://app.netlify.com/projects/rstest-dev/deploys/6895b1b592a8be00083aa0b1
😎 Deploy Preview https://deploy-preview-458--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 a new "CLI Shortcuts" documentation section to both English and Chinese versions of the CLI guide, describing keyboard shortcuts available when running Rstest in watch mode. The changes also include improvements to console clearing behavior in the watch mode implementation.

  • Adds comprehensive documentation for CLI shortcuts in watch mode
  • Implements console clearing functionality for better user experience
  • Adds newline prefixes to existing warning messages for better formatting

Reviewed Changes

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

File Description
website/docs/zh/guide/basic/cli.mdx Adds Chinese documentation for CLI shortcuts section
website/docs/en/guide/basic/cli.mdx Adds English documentation for CLI shortcuts section
packages/core/src/core/runTests.ts Implements console clearing and improves message formatting

console.clear();
};
rsbuildInstance.onDevCompileDone(async ({ isFirstCompile }) => {
// TODO: clean logs before dev recompile
Copy link

Copilot AI Aug 8, 2025

Choose a reason for hiding this comment

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

The TODO comment mentions 'clean logs before dev recompile' but the implementation immediately follows on lines 168-170. This TODO should be updated or removed since the functionality appears to be implemented.

Suggested change
// TODO: clean logs before dev recompile

Copilot uses AI. Check for mistakes.
@9aoy 9aoy merged commit 2aae947 into main Aug 8, 2025
16 checks passed
@9aoy 9aoy deleted the docs/cliShortcuts branch August 8, 2025 08:25
@9aoy 9aoy mentioned this pull request Aug 8, 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