[PE-254] fix: custom color extension markdown rule added

[Palanikannan1437]

Description

Added markdown rules for color and background color such that it doesn't get copy pasted while copying to editors that don't really support colors.

Type of Change

• Bug fix (non-breaking change which fixes an issue)

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

• New Features
  • Enhanced markdown serialization capabilities for custom color extension in the editor.

[coderabbitai]

Walkthrough

The pull request introduces a new addStorage method to the CustomColorExtension class in the Tiptap editor's extension system. This method adds markdown serialization capabilities to the custom color extension by defining a markdown property with specific serialization configurations. The change is purely additive, expanding the extension's functionality without modifying existing behavior.

Changes

File	Change Summary
packages/editor/src/core/extensions/custom-color.ts	Added addStorage() method to CustomColorExtension with markdown serialization configuration

Possibly related PRs

• [PE-68] fix: markdown transformation of mention and custom image components #5864: Similar addStorage method update in CustomImageExtension with markdown serialization
• [PE-80] fix: escape markdown content for images #6096: Modifications to CustomImageExtension related to markdown serialization
• [PE-83] fix: reset text and background color in issue description #6336: Color handling changes in BubbleMenuColorSelector component

Suggested labels

🐛bug, 🌐frontend, ✍️editor

Suggested reviewers

• SatishGandham
• aaryan610

Poem

🎨 A rabbit's ode to color's might,
In markdown's realm, a serialized delight!
Extensions grow, with storage so neat,
Where colors dance and syntax meets 🐰
A code ballet of chromatic grace

---

📜 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 7f22cd1 and f7476f0.

📒 Files selected for processing (1)

• packages/editor/src/core/extensions/custom-color.ts (1 hunks)

🔇 Additional comments (1)

packages/editor/src/core/extensions/custom-color.ts (1)

96-107: LGTM! The implementation effectively prevents color attributes from being copied.

The markdown serialization configuration correctly strips color attributes during copy-paste operations, which solves the compatibility issues with editors that don't support color formatting.

Consider adding documentation to explain the serialization behavior.

Add a comment explaining why color attributes are intentionally stripped during markdown serialization to help future maintainers understand the rationale.

   addStorage() {
     return {
+      // Strip color attributes during markdown serialization to ensure compatibility
+      // with editors that don't support color formatting
       markdown: {
         serialize: {
           open: "",
           close: "",
           mixable: true,
           expelEnclosingWhitespace: true,
         },
       },
     };
   },

Verify the copy-paste behavior across different editors.

Let's verify that the color stripping works as expected across different editors.

✅ Verification successful

Implementation verified as correct and consistent with other extensions

The serialization approach in custom-color extension follows the same pattern as other extensions in the codebase, where each extension controls its own serialization behavior. The implementation to strip color attributes during markdown serialization is appropriate and aligns with the editor's architecture.

Consider adding tests to verify the copy-paste behavior:

• Test copying colored text between editors
• Verify color attributes are properly stripped in markdown format
• Test compatibility with different editor configurations

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find test files that verify copy-paste behavior

# Look for test files related to custom color extension
echo "Looking for test files..."
fd -e test.ts -e spec.ts -e test.tsx -e spec.tsx custom-color

# Look for copy-paste related tests
echo "Looking for copy-paste related tests..."
rg -i "copy|paste|clipboard" -t ts -t tsx

Length of output: 285

---

Script:

#!/bin/bash
# Description: Search for editor tests and clipboard/serialization related code

# Look for editor test files
echo "Looking for editor test files..."
fd -e test.ts -e spec.ts editor

# Look for clipboard and serialization related code
echo "Looking for clipboard/serialization related code..."
rg -t ts "clipboard|serialize|copy|paste" packages/editor/src/

# Look for integration tests
echo "Looking for integration tests..."
rg -t ts "describe|test|it.*editor.*copy|paste|serialize" packages/editor/src/

Length of output: 7152

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 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.