Skip to content

Conversation

@Mash707
Copy link
Contributor

@Mash707 Mash707 commented Jan 8, 2026

Towards #11952

Summary by CodeRabbit

  • Documentation
    • Updated syntax highlighting for code examples across React packages (react-core, react-docs, react-icons, react-styles, react-table) from JavaScript/JSX to TypeScript/TSX in README files.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 8, 2026

Walkthrough

All 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

Cohort / File(s) Change Summary
README code block language hint updates
packages/react-core/README.md, packages/react-docs/README.md, packages/react-icons/README.md, packages/react-styles/README.md, packages/react-table/README.md
Updated markdown code block language identifiers from js/jsx to ts/tsx in example code snippets to enable TypeScript/TSX syntax highlighting. No code content or behavior changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change—updating code fence language flags from js to ts across multiple README files in the monorepo.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

❤️ Share

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

Copy link

@coderabbitai coderabbitai bot left a 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 jsx while line 7 was updated to tsx for the same context (React imports). For consistency with the PR objective to update flags from js to ts, update this code block to tsx.

♻️ Proposed fix
-```jsx
+```tsx
 // In HTML
 <img src="/icons/static/times-icon.svg" alt="Close" />
packages/react-docs/README.md (1)

18-24: Use tsx language hint for JSX code blocks.

The code block contains JSX syntax (<YourComponent />), so the language hint should be tsx (TypeScript + JSX) rather than ts for accurate syntax highlighting. This aligns with the pattern from parallel updates in other packages (e.g., react-icons, react-styles) where JSX was updated to tsx.

📝 Proposed fix for language hint
-```ts
+```tsx
packages/react-table/README.md (1)

27-65: Use tsx language 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 be tsx (TypeScript + JSX) rather than ts. This resolves the static analysis warning (MD040: fenced-code-language) and aligns with the broader pattern in this PR where JSX code uses tsx.

📝 Proposed fix for language hint
-```ts
+```tsx

This change also resolves the markdownlint violation at this line.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bc46a52 and 5f55b2b.

📒 Files selected for processing (5)
  • packages/react-core/README.md
  • packages/react-docs/README.md
  • packages/react-icons/README.md
  • packages/react-styles/README.md
  • packages/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 js to ts is appropriate for the example component usage. The CSS import on line 34 reasonably remains as js since it's a setup import rather than TypeScript code.

packages/react-styles/README.md (1)

7-19: Language hint update complete.

The change from jsx to tsx on line 7 is correct and aligns with the PR objective. The example code block shows proper TypeScript/React usage.

@patternfly-build
Copy link
Collaborator

patternfly-build commented Jan 8, 2026

@nicolethoen nicolethoen merged commit bb43f01 into patternfly:main Jan 9, 2026
14 checks passed
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.

4 participants