Skip to content

fix(cli): improve command usage display#6506

Merged
chenjiahan merged 2 commits intomainfrom
cli_help_1105
Nov 5, 2025
Merged

fix(cli): improve command usage display#6506
chenjiahan merged 2 commits intomainfrom
cli_help_1105

Conversation

@chenjiahan
Copy link
Member

@chenjiahan chenjiahan commented Nov 5, 2025

Summary

The usage section now shows the command format in green for better visibility.

Before

Screenshot 2025-11-05 at 17 55 22

After

Screenshot 2025-11-05 at 17 58 59

Checklist

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

Copilot AI review requested due to automatic review settings November 5, 2025 09:55
@netlify
Copy link

netlify bot commented Nov 5, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 0ee1224
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/690b2003ebf795000865f6fa
😎 Deploy Preview https://deploy-preview-6506--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 71 (🟢 up 3 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

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

Copy link
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 usage message to clarify that both command and options are optional parameters by changing the angle brackets (<>) to square brackets ([]). This better represents the actual CLI behavior where commands are optional (defaulting to the dev command).

  • Updated the usage documentation in both English and Chinese documentation files to reflect optional command syntax
  • Modified the CLI help output formatting logic to explicitly set the usage line with correct bracket notation

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 Updated Chinese documentation to show command as optional parameter
website/docs/en/guide/basic/cli.mdx Updated English documentation to show command as optional parameter
packages/core/src/cli/commands.ts Added logic to format the Usage section with correct optional parameter syntax

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

@chenjiahan chenjiahan merged commit a793a18 into main Nov 5, 2025
12 checks passed
@chenjiahan chenjiahan deleted the cli_help_1105 branch November 5, 2025 10:17
@chenjiahan chenjiahan mentioned this pull request Nov 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.

1 participant