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

Show new line in comments #10004

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

rajku-dev
Copy link
Contributor

@rajku-dev rajku-dev commented Jan 15, 2025

Proposed Changes

BEFORE
image

AFTER
image
image

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • Bug Fixes
    • Improved comment text rendering to preserve line breaks and whitespace formatting.
    • Normalized multiple consecutive newline characters in comments.
    • Corrected display logic for author's name in comments.
  • New Features
    • Added the display of comment creation dates in a relative format.

@rajku-dev rajku-dev requested a review from a team as a code owner January 15, 2025 23:40
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request modifies the ResourceCommentSection component to enhance the rendering of comments. Changes include the addition of a created_date property to the Comment component, which is displayed using the relativeTime function. The CommentSection component has also been updated to handle whitespace more effectively, ensuring that multiple newline characters are consolidated into a single line break while retaining original formatting.

Changes

File Change Summary
src/components/Resource/ResourceCommentSection.tsx Updated Comment component to include created_date and modified rendering logic to use relativeTime. Enhanced comment text rendering with whitespace-pre-wrap CSS class and string manipulation for newline normalization. The author's name rendering logic was corrected.

Assessment against linked issues

Objective Addressed Explanation
Normalize consecutive newlines in comments [#9984]
Rendering comments with proper line breaks [#9984]
Comment rendering order [#9984] No changes visible in the provided diff related to comment sorting.
Adding created date to comments [#9984]
Duplication of first and last name in Avatar [#9984] No changes were made to address the duplication issue.

Poem

🐰 A Rabbit's Ode to Newline Delight
Newlines dancing, no longer lost,
With pre-wrap magic, formatting's boss!
Consecutive breaks, now tamed with care,
Comments flow smoothly, beyond compare!
Code poetry in motion, oh so bright! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a5c2d8 and 28e79a0.

📒 Files selected for processing (1)
  • src/components/Resource/ResourceCommentSection.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/components/Resource/ResourceCommentSection.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: cypress-run (1)

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.

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

netlify bot commented Jan 15, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 28e79a0
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/678a1c559d496b00084d58ee
😎 Deploy Preview https://deploy-preview-10004--care-ohc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

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 comments (1)
src/components/Resource/ResourceCommentSection.tsx (1)

Line range hint 97-100: Fix Avatar name prop using incorrect name fields.

The Avatar component is using first_name twice instead of using both first_name and last_name.

-        name={`${created_by.first_name} ${created_by.first_name}`}
+        name={`${created_by.first_name} ${created_by.last_name}`}
🧹 Nitpick comments (1)
src/components/Resource/ResourceCommentSection.tsx (1)

92-92: Consider normalizing all whitespace characters.

While the current implementation handles newlines well, you might want to consider normalizing other whitespace characters for consistency.

-        {comment.replace(/\n+/g, "\n")}
+        {comment.replace(/[\s\n]+/g, " ").replace(/\n+/g, "\n").trim()}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3e98ab7 and 3942232.

📒 Files selected for processing (1)
  • src/components/Resource/ResourceCommentSection.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: cypress-run (1)
  • GitHub Check: OSSAR-Scan
🔇 Additional comments (1)
src/components/Resource/ResourceCommentSection.tsx (1)

91-93: LGTM! Changes effectively implement newline preservation.

The combination of whitespace-pre-wrap class and newline normalization successfully addresses the issue of preserving line breaks in comments while maintaining clean formatting.

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: 1

🧹 Nitpick comments (1)
src/components/Resource/ResourceCommentSection.tsx (1)

95-96: Consider preserving intentional double newlines.

The current implementation consolidates all consecutive newlines into a single newline. While this prevents excessive spacing, it might remove intentional paragraph breaks (double newlines).

Consider this alternative approach:

-        {comment.replace(/\n+/g, "\n")}
+        {comment.replace(/\n{3,}/g, "\n\n")}

This preserves double newlines for paragraph breaks while still consolidating 3 or more newlines.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3942232 and 8b5fbfa.

📒 Files selected for processing (1)
  • src/components/Resource/ResourceCommentSection.tsx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: cypress-run (1)
🔇 Additional comments (2)
src/components/Resource/ResourceCommentSection.tsx (2)

14-14: LGTM! Import statement correctly updated.

The relativeTime utility function is properly imported alongside the existing formatName function.


88-92: LGTM! Component signature and layout updated correctly.

The Comment component has been properly updated to:

  • Accept the new created_date prop
  • Display the author info and timestamp in a well-structured layout

Also applies to: 99-101, 103-109

src/components/Resource/ResourceCommentSection.tsx Outdated Show resolved Hide resolved
rajku-dev and others added 2 commits January 16, 2025 05:32
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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

🧹 Nitpick comments (1)
src/components/Resource/ResourceCommentSection.tsx (1)

95-97: Consider a more robust whitespace handling approach.

While the current implementation handles multiple newlines, consider these improvements:

  1. Handle other whitespace characters (spaces, tabs) that might cause formatting issues
  2. Preserve intentional paragraph breaks (double newlines)
-      <p className="break-words whitespace-pre-wrap">
-        {comment.replace(/\n+/g, "\n")}
+      <p className="break-words whitespace-pre-wrap">
+        {comment
+          .replace(/[\t ]+/g, " ")           // normalize spaces and tabs
+          .replace(/\n{3,}/g, "\n\n")        // preserve double newlines for paragraphs
+          .trim()}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b5fbfa and 9a5c2d8.

📒 Files selected for processing (1)
  • src/components/Resource/ResourceCommentSection.tsx (2 hunks)
🔇 Additional comments (4)
src/components/Resource/ResourceCommentSection.tsx (4)

14-14: LGTM!

The addition of the relativeTime import is appropriate for the new date formatting functionality.


88-92: LGTM!

The Comment component signature has been properly updated to include the created_date prop with appropriate TypeScript typing.


100-108: LGTM!

The user info section is well-structured with proper alignment and spacing. The Avatar component now correctly uses first_name and last_name.


109-109: Remove italic styling as per previous feedback.

Jacobjeevan previously commented: "Let's not add italics (doesn't fit with our current design anyways)."

-      <div className="italic text-xs">{relativeTime(created_date)}</div>
+      <div className="text-xs">{relativeTime(created_date)}</div>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancements in Resource Details Comment Section
2 participants