Skip to content
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

fix: 代码块嵌入小代码块时渲染错误 #5827

Merged

Conversation

OPChips
Copy link
Contributor

@OPChips OPChips commented Nov 15, 2024

💻 变更类型 | Change Type

  • feat
  • fix
  • refactor
  • perf
  • style
  • test
  • docs
  • ci
  • chore
  • build

🔀 变更说明 | Description of Change

📝 补充信息 | Additional Information

#5797
before:
ff101299-c037-4b4d-9844-6eb05eacd7e5

after:
2e6f6f3f-02fc-4f35-a077-41c7e7e57613

Summary by CodeRabbit

  • New Features

    • Enhanced handling of embedded code blocks in markdown, preventing HTML wrapping for text containing code marked with triple backticks (```).
  • Bug Fixes

    • Improved logic to ensure that embedded code blocks remain unchanged when processing markdown.

Copy link

vercel bot commented Nov 15, 2024

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

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Nov 15, 2024

Walkthrough

The pull request introduces a modification to the tryWrapHtmlCode function in the app/components/markdown.tsx file. A new conditional check has been added to prevent the wrapping of HTML code when the text contains embedded code blocks marked with triple backticks (```), ensuring that such text remains unchanged. Other components remain unaffected, and there are no changes to the declarations of exported or public entities.

Changes

File Change Summary
app/components/markdown.tsx Added a conditional check in tryWrapHtmlCode to ignore wrapping for text containing embedded code blocks (```), ensuring such text remains unchanged.

Possibly related PRs

  • fix quoteEnd extract regex #5564: This PR modifies the tryWrapHtmlCode function in the same file, addressing issues with the regex used for extracting quote ends, which is directly related to the changes made in the main PR that also involves modifications to the tryWrapHtmlCode function.

Suggested reviewers

  • lloydzhou

Poem

In a world of code so bright,
A rabbit hops with pure delight.
"No wrapping here!" it gleefully sings,
For embedded blocks, joy it brings!
With every change, the code does dance,
A hop, a skip, a coder's chance! 🐇✨


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.

Copy link
Contributor

@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

🧹 Outside diff range and nitpick comments (1)
app/components/markdown.tsx (1)

251-254: Consider a more precise implementation for detecting embedded code blocks.

While the current implementation fixes the rendering issue, the condition text.includes("```") might be too broad. It will skip processing any text that contains triple backticks, even if the HTML code itself is not within a code block.

Consider using a more precise check:

-  if (text.includes("```")) {
+  // Check if the HTML code is already within a code block
+  const codeBlockRegex = /^```[\s\S]*?<!DOCTYPE html>[\s\S]*?```$/m;
+  if (codeBlockRegex.test(text)) {
     return text;
   }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b08ce56 and e562165.

📒 Files selected for processing (1)
  • app/components/markdown.tsx (1 hunks)
🔇 Additional comments (1)
app/components/markdown.tsx (1)

251-254: Verify the fix resolves the original issue.

Let's verify this change fixes the rendering error described in issue #5797.

@lloydzhou lloydzhou merged commit f22cec1 into ChatGPTNextWeb:main Nov 15, 2024
1 check failed
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.

2 participants