Skip to content

docs: use Prettier for rs fmt - #108

Merged
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-prettier-fmt
Jul 30, 2026
Merged

docs: use Prettier for rs fmt#108
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-prettier-fmt

Conversation

@chenjiahan

Copy link
Copy Markdown
Member

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.

@chenjiahan
chenjiahan merged commit ab67e68 into main Jul 30, 2026
3 checks passed
@chenjiahan
chenjiahan deleted the chenjiahan/docs-prettier-fmt branch July 30, 2026 07:06
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updated the README to replace Oxfmt references with Prettier in the Rstack CLI overview and the rs fmt command table, including the formatter attribution link.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the main change: switching rs fmt documentation to Prettier.
Description check ✅ Passed The description directly matches the README update and references the same Prettier vs. Oxfmt change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chenjiahan/docs-prettier-fmt

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5bac862b-a9d8-4f58-b538-017e4c0ec376

📥 Commits

Reviewing files that changed from the base of the PR and between 1d1d8e6 and 3ec376f.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
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.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant