Skip to content

docs: use Prettier for rs fmt #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chenjiahan merged 1 commit into from
Jul 30, 2026
Merged

docs: use Prettier for rs fmt #108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Rstack CLI brings the Rstack toolchain together for JavaScript development, with one CLI, one configuration, and one consistent workflow.

It also covers local development needs outside Rstack's scope, with Oxfmt formatting and lint-staged commands.
It also covers local development needs outside Rstack's scope, with Prettier formatting and lint-staged commands.

@coderabbitai coderabbitai Bot Jul 30, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift

Align both README references with the actual formatter implementation.

The repository currently pins and invokes Oxfmt through its formatting configuration, so documenting Prettier is inaccurate. Either migrate the formatter implementation and dependencies to Prettier, or keep both README references pointed at Oxfmt until that migration is complete.

  • README.md#L13-L13: restore the formatter description to match the current tooling.
  • README.md#L24-L24: restore the rs fmt attribution or update the implementation first.
📍 Affects 1 file
  • README.md#L13-L13 (this comment)
  • README.md#L24-L24
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 13, Update README.md lines 13-13 and 24-24 to reference
Oxfmt consistently with the current formatter configuration and rs fmt
implementation; do not document Prettier unless the formatter implementation and
dependencies are migrated first.


| Command | Description | Powered by |
| ------------ | -------------------------------- | --------------------------------------------------------- |
Expand All @@ -21,7 +21,7 @@ It also covers local development needs outside Rstack's scope, with Oxfmt format
| `rs lint` | Lint code | [Rslint](https://github.com/web-infra-dev/rslint) |
| `rs lib` | Build library | [Rslib](https://github.com/web-infra-dev/rslib) |
| `rs doc` | Serve or build docs | [Rspress](https://github.com/web-infra-dev/rspress) |
| `rs fmt` | Format code (TODO) | [Oxfmt](https://github.com/oxc-project/oxc) |
| `rs fmt` | Format code (TODO) | [Prettier](https://github.com/prettier/prettier) |
| `rs setup` | Install Git hooks | - |
| `rs staged` | Run tasks on staged Git files | [lint-staged](https://github.com/lint-staged/lint-staged) |

Expand Down