docs: use Prettier for rs fmt - #108
Conversation
📝 WalkthroughWalkthroughUpdated the README to replace Oxfmt references with Prettier in the Rstack CLI overview and the 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with 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.
Inline comments:
In `@README.md`:
- 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.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| 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. |
There was a problem hiding this comment.
🎯 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 thers fmtattribution 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.
Rstack CLI plans to use Prettier to implement
rs fmt, while the README still attributes formatting to Oxfmt.This PR updates the README overview and command table to reference Prettier.