Fix abnormal line spacing in Markdown lists caused by Soft Line Breaks

[devleejb]

What this PR does / why we need it:
This PR addresses an issue where the line spacing in Markdown lists appears excessively wide due to the addition of Soft Line Breaks. The changes ensure that new line breaks are not added to lines that consist solely of whitespace, thus preserving the intended appearance of lists.

Which issue(s) this PR fixes:

Fixes #338

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

• Added relevant tests or not required
• Didn't break anything

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of empty lines in text formatting, reducing unnecessary whitespace in outputs.

[coderabbitai]

Walkthrough

The changes made in the pull request involve an update to the addSoftLineBreak function in the document.ts file. This update introduces a conditional check to prevent the addition of unnecessary whitespace for empty lines. The function now only appends spaces to non-empty lines, thereby improving the formatting of text processed by the function.

Changes

File	Change Summary
frontend/src/utils/document.ts	Updated addSoftLineBreak function to handle empty lines by avoiding unnecessary whitespace.

Assessment against linked issues

Objective	Addressed	Explanation
Excessive white space in Markdown Preview (Issue #338)	✅
Maintain cleaner and more readable format in Markdown	✅

Poem

In the land of Markdown, so neat and bright,
A rabbit fixed whitespace, what a delight!
With soft line breaks now trimmed just right,
Our text flows smoothly, a joyful sight!
Hopping with glee, we celebrate this change,
For cleaner lines make our writing less strange! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0a75db5 and 4a17a11.

Files selected for processing (1)

• frontend/src/utils/document.ts (1 hunks)

Additional comments not posted (1)

frontend/src/utils/document.ts (1)

8-11: LGTM!

The conditional check correctly handles empty lines by returning an empty string instead of appending two spaces. This prevents unnecessary whitespace from being added to empty lines, preserving the original formatting of the text.

The change aligns with the PR objectives of preventing new line breaks from being added to lines that consist solely of whitespace. It does not introduce any breaking changes or require a release note, as indicated in the PR objectives.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 generate interesting stats about this repository and render them as a table.
  -- @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.