feat: add syntax highlighting for more languages #5532

Aloxaf · 2024-09-25T15:16:42Z

💻 变更类型 | Change Type

🔀 变更说明 | Description of Change

Add syntax highlighting for more languages

📝 补充信息 | Additional Information

Before

After

Summary by CodeRabbit

New Features
- Introduced enhanced syntax highlighting for code blocks in Markdown content using the Lowlight library.
Chores
- Added a new dependency for the Lowlight library to the project.

vercel · 2024-09-25T15:16:46Z

@Aloxaf is attempting to deploy a commit to the NextChat Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2024-09-25T15:16:50Z

Walkthrough

The changes involve the addition of the lowlight library for syntax highlighting in Markdown-rendered content. The app/components/markdown.tsx file has been updated to import the lowlight/lib/all module, while the package.json file has been modified to include lowlight as a new dependency. No other modifications to the component's logic or exported entities have been made.

Changes

Files	Change Summary
app/components/markdown.tsx	Added import statement for `lowlight/lib/all` for syntax highlighting.
package.json	Added new dependency: `"lowlight": "^2.0.0"`

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MarkdownComponent
    participant LowlightLibrary

    User->>MarkdownComponent: Render Markdown
    MarkdownComponent->>LowlightLibrary: Import syntax highlighting
    LowlightLibrary-->>MarkdownComponent: Highlighted code
    MarkdownComponent-->>User: Display rendered Markdown with highlights

Poem

In the code where rabbits play,
Lowlight hops in, brightening the day.
With colors that dance and gleam,
Our Markdown shines, a coder's dream!
So let us cheer, with joy we sing,
For syntax highlights, a wondrous thing! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 93ff7d2 and 959201e.

📒 Files selected for processing (2)

app/components/markdown.tsx (1 hunks)
package.json (1 hunks)

🔇 Additional comments not posted (2)

package.json (1)

34-34: Approved: Addition of lowlight for enhanced syntax highlighting

The addition of lowlight (version ^2.0.0) aligns well with the PR objective of adding syntax highlighting for more languages. This library is a popular choice for syntax highlighting and supports a wide range of programming languages.

However, I noticed that the project already uses rehype-highlight for syntax highlighting. Let's verify if both libraries are needed or if lowlight is intended to replace rehype-highlight. Run the following script to check the usage of both libraries in the project:

If lowlight is intended to replace rehype-highlight, consider removing rehype-highlight in a future PR to avoid potential conflicts and reduce bundle size.

app/components/markdown.tsx (1)

10-10: LGTM! Verify new syntax highlighting capabilities.

The addition of import "lowlight/lib/all"; aligns with the PR objective of adding syntax highlighting for more languages. This import should enhance the capabilities of the rehype-highlight plugin used in the ReactMarkdown component.

To ensure the new highlighting capabilities are working as expected, please run the following script to check for supported languages and test the highlighting:

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

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

github-actions · 2024-09-25T15:21:27Z

Your build has completed!

Preview deployment

lloydzhou · 2024-09-25T15:58:15Z

可能需要关注一下，引入的这个包的体积

Issues-translate-bot · 2024-09-25T15:58:29Z

Bot detected the issue body's language is not English, translate it automatically.

You may need to pay attention to the size of the introduced package.

Aloxaf · 2024-09-26T03:02:34Z

可能需要关注一下，引入的这个包的体积

对比产物吗？我对比了一下两个分支 yarn build 后的体积，看上去是大了 700K

main

8.5M    .next/server
52M     .next/standalone
8.6M    .next/static

branch

9.2M    .next/server
53M     .next/standalone
9.3M    .next/static

feat: add syntax highlighting for more languages

959201e

lloydzhou added low priority maybe labels Oct 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add syntax highlighting for more languages #5532

feat: add syntax highlighting for more languages #5532

Aloxaf commented Sep 25, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Sep 25, 2024

coderabbitai bot commented Sep 25, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Sep 25, 2024

lloydzhou commented Sep 25, 2024

Issues-translate-bot commented Sep 25, 2024

Aloxaf commented Sep 26, 2024

feat: add syntax highlighting for more languages #5532

Are you sure you want to change the base?

feat: add syntax highlighting for more languages #5532

Conversation

Aloxaf commented Sep 25, 2024 • edited by coderabbitai bot Loading

💻 变更类型 | Change Type

🔀 变更说明 | Description of Change

📝 补充信息 | Additional Information

Summary by CodeRabbit

vercel bot commented Sep 25, 2024

coderabbitai bot commented Sep 25, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Sep 25, 2024

lloydzhou commented Sep 25, 2024

Issues-translate-bot commented Sep 25, 2024

Aloxaf commented Sep 26, 2024

Aloxaf commented Sep 25, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 25, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)