[WIKI-343] [WIKI-312] Fix: html characters

[iam-vipin]

Description

This PR removes the preserveWhitespace option when setting content in the editor. Previously, this option was causing issues with the HTML parser, where characters like <, >, and & were incorrectly converted to <, >, and &.

Screenshots and Media (if applicable)

Screen.Recording.2025-05-15.at.12.47.59.PM.mov

https://prosemirror.net/docs/ref/#model.ParseOptions.preserveWhitespace

Summary by CodeRabbit

• Chores
  • Improved editor content handling to better preserve whitespace during editing and content updates.

[coderabbitai]

Walkthrough

The changes update the editor initialization in both useEditor and useReadOnlyEditor hooks to include parseOptions: { preserveWhitespace: true }. All calls to editor.commands.setContent that used { preserveWhitespace: "full" } now use { preserveWhitespace: true }. No exported or public entity signatures were altered.

Changes

File(s)	Change Summary
packages/editor/src/core/hooks/use-editor.ts	Added parseOptions: { preserveWhitespace: true } to editor initialization and updated setContent calls to use { preserveWhitespace: true }.
packages/editor/src/core/hooks/use-read-only-editor.ts	Added parseOptions: { preserveWhitespace: true } to editor initialization and updated setContent calls to use { preserveWhitespace: true }.

Poem

A hop and a skip, whitespace stays true,
Preserved with care in all that we do.
Editors tuned with a delicate touch,
Content flows gently, never too much.
🐇🌿✨

---

📜 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 ba863a1 and 5f1d23a.

📒 Files selected for processing (1)

• packages/editor/src/core/hooks/use-editor.ts (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/editor/src/core/hooks/use-editor.ts

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Analyze (javascript)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[makeplane]

Pull Request Linked with Plane Work Items

• [WIKI-343] '>' Greater than symbol not working in editor
• [WIKI-312] Invalid value displayed when HTML code is added in comments.

Comment Automatically Generated by Plane

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 75d81f9 and 9a289d8.

📒 Files selected for processing (2)

• packages/editor/src/core/hooks/use-editor.ts (2 hunks)
• packages/editor/src/core/hooks/use-read-only-editor.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (javascript)
• GitHub Check: Analyze (python)

🔇 Additional comments (4)

packages/editor/src/core/hooks/use-editor.ts (2)

116-116: Properly fixed HTML symbol handling 👍

The removal of the preserveWhitespace option from setContent is correct. This change will fix the issue with special characters like <, >, and & being incorrectly converted to HTML entities.

---

149-149: Consistent fix applied to imperative handle method

This change correctly removes the preserveWhitespace option from the setEditorValue method, ensuring consistent behavior across all content setting operations.

packages/editor/src/core/hooks/use-read-only-editor.ts (2)

74-74: Properly fixed HTML symbol handling in useEffect

This correctly removes the preserveWhitespace option, fixing the HTML special characters handling issue when syncing external content.

---

82-82: Consistent fix applied to imperative handle method

This change correctly removes the preserveWhitespace option from the setEditorValue method, ensuring consistent behavior across all content setting operations.