fix: copying mentions as text
Description
Before: The whole html of the mention node got copied
Now: The renderText method calculates and returns the correct the text properly as @{userDisplayName}
Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Feature (non-breaking change which adds functionality)
- [ ] Improvement (change that would cause existing functionality to not work as expected)
- [ ] Code refactoring
- [ ] Performance improvements
- [ ] Documentation update
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit
-
New Features
- Copied Markdown text now retains its original formatting without automatic transformation.
- Mention display has been enhanced, providing clearer and more accurate presentation.
- Improved integration retrieves richer details for mentions, resulting in a more intuitive in-editor experience.
Walkthrough
The pull request updates several components within the editor. The Markdown extension now disables text transformation on copy, while the mention extension is enhanced with new configuration options, helper methods, and type updates to support detailed entity retrieval and markdown serialization. Additionally, the editor components now integrate a member hook to fetch user details for mentions.
Changes
| File(s) | Change Summary |
|---|---|
packages/editor/.../extensions.tsx |
Updated Markdown extension: changed transformCopiedText from true to false. |
packages/editor/.../mentions/extension-config.ts,packages/editor/.../mentions/extension.tsx,packages/editor/.../types/mention.ts |
Enhanced mention extension configuration: added new imports, extended types with getMentionedEntityDetails, introduced renderText and getMentionDisplayText, and modified markdown serialization in addStorage. |
web/core/.../editor-body.tsx,web/core/.../lite-text-editor/lite-text-editor.tsx,web/core/.../lite-text-read-only-editor.tsx,web/core/.../rich-text-editor/rich-text-editor.tsx,web/core/.../rich-text-read-only-editor.tsx,web/core/.../pages/version/editor.tsx |
Integrated useMember hook to utilize getUserDetails for retrieving mention entity details in the editor components. |
space/core/.../lite-text-read-only-editor.tsx,space/core/.../rich-text-editor.tsx |
Modified component structure to include getMemberById logic and updated mentionHandler to add getMentionedEntityDetails. |
Sequence Diagram(s)
sequenceDiagram
participant E as EditorBody
participant CME as CustomMentionExtension
participant CMC as CustomMentionConfig
participant S as MarkdownSerializer
participant U as useMember
E->>CME: Initialize mention (with new options)
CME->>CMC: Configure mention (adding getMentionedEntityDetails & renderText)
CMC->>S: Serialize mention using getMentionDisplayText
E->>U: Call getUserDetails to fetch entity details
Possibly related PRs
- makeplane/plane#5864: Updates to the CustomMention extension involving markdown serialization are closely related to the handling of copied text and mention details in this PR.
Suggested labels
🐛bug, 🌟improvement, ✍️editor
Suggested reviewers
- SatishGandham
- aaryan610
Poem
I'm a bunny with code, hopping through the night,
Tweaking markdown and mentions till everything's just right.
With bits of magic in each line I write,
My paws dance over keys in pure delight.
Here's to clean commits and features taking flight!
🐇✨
[!TIP]
⚡🧪 Multi-step agentic review comment chat (experimental)
- We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments. - To enable this feature, set early_access to true under in the settings.
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.