fix(prettier): ignore generated genui API docs#1118
Conversation
Every other auto-generated API doc dir (rspeedy, react, the two TypeDoc dirs) is already in .prettierignore; genui was missed when its generation was added. Previously the husky pre-commit prettier --write masked this by formatting genui on commit, but the update-api-docs workflow now commits with HUSKY=0, so unformatted genui docs reach the PR and fail the Format Check (prettier --check) gate. Ignore genui like the others.
✅ Deploy Preview for lynx-doc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughTwo entries are added to ChangesPrettier Ignore Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
Why
Every auto-generated API doc directory is already excluded from Prettier —
react,rspeedy,lynx-testing-environment,reactlynx-testing-library.genuiwas missed when its generation was added toscripts/update-api-docs.sh.It went unnoticed because the husky
pre-commithook ranprettier --writeand silently formatted the generated genui files on commit. Theupdate-api-docsworkflow now commits withHUSKY=0(to avoid the cspell hook blocking the bot PR — see #1117), so the generated genui docs are committed as-generated and theFormat Check(prettier --check .) CI gate fails on them.Generated docs shouldn't be hand-formatted; they should be ignored — same as the sibling generated dirs. This adds
genuito.prettierignorefor both locales.Effect
Format Check.Add
genuito.prettierignorefor auto-generated API documentationAdd
genuito.prettierignorefor both English and Chinese locale directories (/docs/en/api/genui/**and/docs/zh/api/genui/**) to exclude auto-generated API documentation from formatting checks. This prevents the Format Check CI gate from failing on unformatted generated files while maintaining consistency with other auto-generated documentation directories likereact,rspeedy,lynx-testing-environment, andreactlynx-testing-library.