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.

Sign up for GitHub

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

Jump to bottom

fixed: html codeblock include 2 newline #5418

Merged
merged 1 commit into from
Sep 13, 2024
Merged

fixed: html codeblock include 2 newline #5418

merged 1 commit into from
Sep 13, 2024
+19 βˆ’2

Conversation

lloydzhou
Copy link
Member

@lloydzhou lloydzhou commented Sep 13, 2024 •
edited by coderabbitai bot
Loading

πŸ’» ε˜ζ›΄η±»εž‹ | Change Type

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

πŸ”€ ε˜ζ›΄θ―΄ζ˜Ž | Description of Change

πŸ“ θ‘₯充俑息 | Additional Information

Summary by CodeRabbit

  • New Features

    • Improved HTML code processing in Markdown, allowing better formatting for HTML code blocks.
    • Added a function to ensure proper wrapping of HTML content within Markdown.

  • Bug Fixes

    • Enhanced the timing of ResizeObserver initialization for improved height measurement reliability.

@vercel Vercel
Copy link

vercel bot commented Sep 13, 2024

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

A member of the Team first needs to authorize it.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 13, 2024 •
edited
Loading

Walkthrough

The changes involve two main updates in the codebase. The HTMLPreview component now initializes a ResizeObserver within a DOMContentLoaded event listener, ensuring proper timing for DOM readiness. Additionally, a new function, tryWrapHtmlCode, has been introduced in the _MarkDownContent component to enhance the formatting of HTML code blocks in Markdown content, specifically handling <!DOCTYPE html> declarations and ensuring proper wrapping of closing tags.

Changes

Files Change Summary
app/components/artifacts.tsx Modified the HTMLPreview component to wrap the ResizeObserver setup in a DOMContentLoaded event listener for improved timing of script execution.
app/components/markdown.tsx Introduced the tryWrapHtmlCode function to enhance HTML code block processing in Markdown, replacing the previous escapeBrackets logic for better formatting.

Poem

In the code where bunnies play,
A script now waits for the day.
With HTML wrapped just so right,
Our Markdown shines, a lovely sight!
Hopping through changes, we cheer and sing,
For every tweak, new joy they bring! πŸ‡βœ¨

Tip

OpenAI O1 model for chat
  • We have deployed OpenAI's latest O1 model for chat.
  • OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
  • Please share any feedback with us in the discussions post.
Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between affc194 and 3dabe47.

Files selected for processing (2)
  • app/components/artifacts.tsx (1 hunks)
  • app/components/markdown.tsx (1 hunks)
Additional comments not posted (2)
app/components/artifacts.tsx (1)

83-83: LGTM!

The change improves the timing of the ResizeObserver setup by wrapping it in a DOMContentLoaded event listener. This ensures that the observer is only initialized after the HTML document has been fully loaded, potentially enhancing the reliability of the height measurement of the document body.

The change also includes a minor correction in how the script is appended to the document, ensuring that it is correctly integrated into the HTML structure.

app/components/markdown.tsx (1)

240-255: LGTM! The tryWrapHtmlCode function is a great addition to enhance the formatting of HTML code blocks in Markdown.

The function is well-implemented and addresses the issue of properly wrapping HTML code blocks in Markdown syntax. It uses regular expressions to match specific patterns and adds the necessary code block syntax when needed.

A few suggestions for further improvement:

  • Consider adding a brief comment explaining the purpose of the function and the specific patterns it targets. This will help future maintainers understand the intent behind the code.
  • Consider using named capture groups in the regular expressions for better readability and maintainability. For example, instead of using numbered capture groups like ([\n\r]*?), you could use named capture groups like (?<newLine>[\n\r]*?). This makes the code more self-explanatory and easier to understand.

Overall, great work on implementing this function to enhance the Markdown rendering!

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 GitHub Actions
Copy link
Contributor

Your build has completed!

Preview deployment

@Dogtiti Dogtiti merged commit 6a464b3 into ChatGPTNextWeb:main Sep 13, 2024
1 of 2 checks passed
@lloydzhou lloydzhou deleted the hotfix/artifact branch September 26, 2024 13:35
@coderabbitai coderabbitai bot mentioned this pull request Sep 29, 2024
Merged
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Dogtiti Dogtiti Dogtiti approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lloydzhou @Dogtiti