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

feat: Enable Copy with Markdown Formatting #102

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Adebesin-Cell
Copy link
Collaborator

@Adebesin-Cell Adebesin-Cell commented Dec 28, 2024

✨ feat: Enable Copy with Markdown Formatting πŸ“‹βœοΈ

Summary:

  • πŸ› οΈ Added functionality to copy content with markdown formatting using a copy-to-clipboard action.
  • 🧹 Refactored msg.content.replace logic into a reusable formatContent function to clean up line breaks and improve formatting.
  • πŸ”˜ Integrated a copy button for assistant messages (ChatRole.ASSISTANT) that triggers the handleCopyMessage function for quick copying.
  • βœ… Updated permissions in the manifest to include clipboardWrite for enabling clipboard functionality.

Fixes #98

Summary by CodeRabbit

  • New Features

    • Added clipboard write permission to the browser extension
    • Introduced ability to copy assistant messages to clipboard
    • Enhanced sidebar interaction with clipboard copy functionality
  • Bug Fixes

    • Improved message content formatting in chat list

Copy link

stackblitz bot commented Dec 28, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

changeset-bot bot commented Dec 28, 2024

⚠️ No Changeset found

Latest commit: 1f182cc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Dec 28, 2024

Walkthrough

The pull request introduces a new feature to enable copying messages from the assistant in a browser extension. This is achieved by adding a clipboardWrite permission to the manifest configuration, implementing a copy message function in the ChatList component, and adding an event listener in the sidebar component to handle clipboard write operations. The changes focus on enhancing user interaction by providing a convenient way to copy formatted text.

Changes

File Change Summary
manifest.config.ts Added clipboardWrite permission to enable clipboard write functionality
src/components/Sidebar/chat/ChatList.tsx - Imported RiFileCopyLine icon
- Added formatContent function to process message content
- Added handleCopyMessage function to copy message to clipboard
- Added copy button for assistant messages
src/pages/content/sidebar.tsx Implemented event listener for 'copy-to-clipboard' action using navigator.clipboard.writeText

Assessment against linked issues

Objective Addressed Explanation
Add copy button to answers [#98] βœ…

Poem

🐰 A rabbit's tale of copy and paste,
With buttons so swift, no time to waste!
Markdown magic at your command,
Text flows freely across the land
Clipboard dancing with rabbit's glee! πŸ“‹βœ¨


πŸ“œ 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 751273f and 1f182cc.

πŸ“’ Files selected for processing (1)
  • src/pages/content/sidebar.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/pages/content/sidebar.tsx

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
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 (2)
src/pages/content/sidebar.tsx (1)

59-63: Consider error handling or fallback for clipboard operations
Although navigator.clipboard.writeText typically succeeds in modern browsers, it can reject under certain conditions (e.g., user denies permissions or if invoked outside a user gesture). A try/catch block or user notification can help provide better UX.

  if (action === 'copy-to-clipboard') {
    const { content } = _payload as { content: string }
-   navigator.clipboard.writeText(content)
+   navigator.clipboard.writeText(content).catch((err) => {
+     console.error('Clipboard write failed', err)
+   })
  }
src/components/Sidebar/chat/ChatList.tsx (1)

94-102: Assistant copy button
Providing a dedicated copy button is a great UX enhancement. Consider adding a tooltip or confirmation toast to inform users that content has been copied successfully.

πŸ“œ Review details

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

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 838475e and 751273f.

πŸ“’ Files selected for processing (3)
  • manifest.config.ts (1 hunks)
  • src/components/Sidebar/chat/ChatList.tsx (4 hunks)
  • src/pages/content/sidebar.tsx (1 hunks)
πŸ”‡ Additional comments (5)
manifest.config.ts (1)

44-44: Looks good: introduction of 'clipboardWrite' permission
Great addition for enabling clipboard functionality. Ensure your use cases comply with user expectations and privacy best practices, as some users may be sensitive to clipboard writes.

src/components/Sidebar/chat/ChatList.tsx (4)

2-7: Import addition for copy icon
Importing RiFileCopyLine is consistent with the new clipboard feature. No issues found.


41-43: Regex approach for formatting
The positive lookbehind (?<=\n\n) is modern and may not be supported in older browsers, but is typically acceptable for extensions on modern Chromium-based browsers. Just be mindful of potential compatibility issues.


45-53: Validate window parent usage
Using window.parent.postMessage is an effective cross-context communication approach. Confirm that the iframe and parent environment always have matching domains or appropriate event listeners configured to ensure secure and consistent message handling.


111-111: Consistent formatting usage
Using formatContent(msg.content) in ReactMarkdown ensures consistent transformations. Keep an eye on rendering performance and verify that additional spaces or <nbsp> tags do not unexpectedly alter message display.

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

Successfully merging this pull request may close these issues.

Add copy button to answers
1 participant