fix: component CodeBlock not able to highlight lines. #3480

SahilDahekar · 2024-12-16T14:59:04Z

Description

The lineProps property on Highlight component exported styles with className property using tailwind css which for some reason react-sytax-highlight library was not able to recognize.
Changed the lineProps & lineNumberStyle logic to export exact css object instead of tailwind css.

Related issue(s)

Fixes #3478

Summary by CodeRabbit

New Features
- Enhanced visual representation of highlighted lines in the CodeBlock component.
- Updated styling for line numbers and highlighted lines for improved readability.

coderabbitai · 2024-12-16T14:59:13Z

Walkthrough

The changes modify the CodeBlock component in components/editor/CodeBlock.tsx, focusing on the visual representation of highlighted lines. The update introduces a new approach to styling line numbers and highlighted lines, changing background and text colors. The lineProps function has been refactored to create a more dynamic style object that conditionally applies highlighting based on the line's status.

Changes

File	Change Summary
`components/editor/CodeBlock.tsx`	- Updated line highlighting logic - Modified background color for highlighted lines from `#252f3f` to `#3e4d64` - Changed text color for highlighted lines from `#8B9394` to `#A3ACAD` - Refactored `lineProps` to create dynamic style objects

Assessment against linked issues

Objective	Addressed	Explanation
Support for `highlightedLines` prop [#3478]	✅

Poem

🐰 Code blocks dancing with light,
Lines highlighted, oh so bright!
From dark to blue, a subtle gleam,
Revealing secrets of our coding dream.
A rabbit's touch of style so neat! 🖥️

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8c8c5ab and 8d30dd1.

📒 Files selected for processing (1)

components/editor/CodeBlock.tsx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

components/editor/CodeBlock.tsx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

netlify · 2024-12-16T14:59:27Z

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`5688b93`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/67669b26cae31b000885e9cd
😎 Deploy Preview	https://deploy-preview-3480--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

components/editor/CodeBlock.tsx (2)
278-286: LGTM! Consider adding type annotation for better maintainability.

The refactored lineNumberStyle implementation looks good with improved color contrast and explicit spacing.

Consider adding a type annotation for better maintainability:
-              const styles = {
+              const styles: React.CSSProperties = {
292-303: LGTM! Consider performance optimization.

The switch from Tailwind classes to explicit styles successfully fixes the highlighting issue. However, consider memoizing the styles to avoid creating new objects for each line.

Consider this optimization:
+ const baseStyle: React.CSSProperties = { paddingRight: '2rem' };
+ const highlightedStyle: React.CSSProperties = {
+   ...baseStyle,
+   display: 'block',
+   width: '100%',
+   backgroundColor: '#3e4d64'
+ };

  lineProps={(lineNumber: number) => ({
-   style: {
-     paddingRight: '2rem',
-     ...(isHighlighted && {
-       display: 'block',
-       width: '100%',
-       backgroundColor: '#3e4d64'
-     })
-   }
+   style: isHighlighted ? highlightedStyle : baseStyle
  })}

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dc7d0d3 and 8c8c5ab.

📒 Files selected for processing (1)

components/editor/CodeBlock.tsx (1 hunks)

🧰 Additional context used

🪛 Biome (1.9.4)

components/editor/CodeBlock.tsx

[error] 290-290: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

components/editor/CodeBlock.tsx

asyncapi-bot · 2024-12-16T15:03:19Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	34
🟢 Accessibility	98
🟢 Best practices	92
🟢 SEO	100
🔴 PWA	33

Lighthouse ran on https://deploy-preview-3480--asyncapi-website.netlify.app/

sambhavgupta0705 · 2024-12-16T15:31:24Z

@SahilDahekar have a look at coderabbitai suggestions

SahilDahekar · 2024-12-16T15:35:18Z

@SahilDahekar have a look at coderabbitai suggestions

Done 👍

derberg · 2024-12-16T17:23:16Z

Technically looks fixed: https://deploy-preview-3480--asyncapi-website.netlify.app/docs/tutorials/getting-started/servers

but I do not own code here for quite some time, so not reviewing if applied approach was correct

codecov · 2024-12-17T14:40:11Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.59%. Comparing base (9c1fda0) to head (5688b93).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3480   +/-   ##
=======================================
  Coverage   86.59%   86.59%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          575      575           
  Misses         89       89

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

derberg · 2024-12-20T08:10:08Z

/ptal

asyncapi-bot · 2024-12-20T08:10:19Z

@derberg @magicmatatjahu @devilkiller-ag @akshatnema @sambhavgupta0705 @anshgoyalevil @Mayaleeeee Please take a look at this PR. Thanks! 👋

components/editor/CodeBlock.tsx

Fixed code highlighting bug

8c8c5ab

SahilDahekar requested review from derberg, akshatnema, magicmatatjahu, anshgoyalevil, Mayaleeeee and asyncapi-bot-eve as code owners December 16, 2024 14:59

asyncapi-bot requested review from devilkiller-ag and sambhavgupta0705 December 16, 2024 14:59

SahilDahekar changed the title ~~fix: CodeBlock component not able to highlight lines.~~ fix: component CodeBlock not able to highlight lines. Dec 16, 2024

coderabbitai bot reviewed Dec 16, 2024

View reviewed changes

components/editor/CodeBlock.tsx Outdated Show resolved Hide resolved

Added coderabbit recommendation

8d30dd1

Merge branch 'asyncapi:master' into code-highlight

aba345a

Merge branch 'master' into code-highlight

abae053

Merge branch 'master' into code-highlight

6e58b47

akshatnema reviewed Dec 20, 2024

View reviewed changes

components/editor/CodeBlock.tsx Show resolved Hide resolved

Merge branch 'master' into code-highlight

5688b93

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: component CodeBlock not able to highlight lines. #3480

fix: component CodeBlock not able to highlight lines. #3480

SahilDahekar commented Dec 16, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 16, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

netlify bot commented Dec 16, 2024 •

edited

Loading

coderabbitai bot left a comment

asyncapi-bot commented Dec 16, 2024 •

edited

Loading

sambhavgupta0705 commented Dec 16, 2024

SahilDahekar commented Dec 16, 2024

derberg commented Dec 16, 2024

codecov bot commented Dec 17, 2024 •

edited

Loading

derberg commented Dec 20, 2024

asyncapi-bot commented Dec 20, 2024

fix: component CodeBlock not able to highlight lines. #3480

Are you sure you want to change the base?

fix: component CodeBlock not able to highlight lines. #3480

Conversation

SahilDahekar commented Dec 16, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Dec 16, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

netlify bot commented Dec 16, 2024 • edited Loading

✅ Deploy Preview for asyncapi-website ready!

coderabbitai bot left a comment

Choose a reason for hiding this comment

asyncapi-bot commented Dec 16, 2024 • edited Loading

sambhavgupta0705 commented Dec 16, 2024

SahilDahekar commented Dec 16, 2024

derberg commented Dec 16, 2024

codecov bot commented Dec 17, 2024 • edited Loading

Codecov Report

derberg commented Dec 20, 2024

asyncapi-bot commented Dec 20, 2024

SahilDahekar commented Dec 16, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 16, 2024 •

edited

Loading

netlify bot commented Dec 16, 2024 •

edited

Loading

asyncapi-bot commented Dec 16, 2024 •

edited

Loading

codecov bot commented Dec 17, 2024 •

edited

Loading