-
Notifications
You must be signed in to change notification settings - Fork 376
chore(miscellaneous): update flags from js to ts #12200
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.
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
Conversation
WalkthroughAll changes involve updating code block language hints in README files across multiple packages from JavaScript/JSX to TypeScript/TSX for improved syntax highlighting, with no functional or code behavior modifications. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
packages/react-icons/README.md (1)
84-94: Incomplete language hint update on line 84.Line 84 still uses
jsxwhile line 7 was updated totsxfor the same context (React imports). For consistency with the PR objective to update flags from js to ts, update this code block totsx.♻️ Proposed fix
-```jsx +```tsx // In HTML <img src="/icons/static/times-icon.svg" alt="Close" />packages/react-docs/README.md (1)
18-24: Usetsxlanguage hint for JSX code blocks.The code block contains JSX syntax (
<YourComponent />), so the language hint should betsx(TypeScript + JSX) rather thantsfor accurate syntax highlighting. This aligns with the pattern from parallel updates in other packages (e.g., react-icons, react-styles) where JSX was updated totsx.📝 Proposed fix for language hint
-```ts +```tsxpackages/react-table/README.md (1)
27-65: Usetsxlanguage hint for JSX code blocks; resolves static analysis warning.The code block contains JSX syntax (React components like
<Table>,<Thead>,<Tbody>), so the language hint should betsx(TypeScript + JSX) rather thants. This resolves the static analysis warning (MD040: fenced-code-language) and aligns with the broader pattern in this PR where JSX code usestsx.📝 Proposed fix for language hint
-```ts +```tsxThis change also resolves the markdownlint violation at this line.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
packages/react-core/README.mdpackages/react-docs/README.mdpackages/react-icons/README.mdpackages/react-styles/README.mdpackages/react-table/README.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
packages/react-table/README.md
27-27: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Build
- GitHub Check: Build, test & deploy
🔇 Additional comments (2)
packages/react-core/README.md (1)
34-44: Language hint updates look good.The change on line 40 from
jstotsis appropriate for the example component usage. The CSS import on line 34 reasonably remains asjssince it's a setup import rather than TypeScript code.packages/react-styles/README.md (1)
7-19: Language hint update complete.The change from
jsxtotsxon line 7 is correct and aligns with the PR objective. The example code block shows proper TypeScript/React usage.
|
Preview: https://pf-react-pr-12200.surge.sh A11y report: https://pf-react-pr-12200-a11y.surge.sh |
Towards #11952
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.