chore: add format and lint to .md guides#4057
Conversation
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughUpdated repository guidance in four docs. The changes replace generic linting references with 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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.
Devin Review found 1 potential issue.
⚠️ 1 issue in files not directly in the diff
⚠️ Agent guidance file still references Prettier instead of oxfmt, contradicting all other updated docs (AGENTS.md:58)
The AGENTS.md file still tells agents that formatting is enforced using Prettier (AGENTS.md:58), while the updated CLAUDE.md, .claude/REVIEW.md, and CONTRIBUTING.md now all say oxfmt/oxlint — so agents following AGENTS.md will give wrong tooling advice.
Impact: Coding agents reading AGENTS.md will incorrectly believe Prettier is the formatter and may give users wrong instructions.
Incomplete documentation migration from Prettier to oxfmt
The PR's intent is a mechanical renaming of Prettier/ESLint → oxfmt/oxlint across documentation. The root package.json:21-23 confirms the actual tooling:
"format": "oxfmt .""lint": "oxlint""lint:fix": "oxlint --fix"
But AGENTS.md:58 was not updated and still reads:
"Formatting is enforced using Prettier. Run
pnpm run formatbefore committing."
This creates contradictory guidance across the repo's special rule files.
follow on from #3977 #4056