yorkie-team / codepair

Build your own AI-powered collaborative markdown editor in just 5 minutes
https://codepair.yorkie.dev
Apache License 2.0
49 stars 19 forks source link

Add hyperlink creation feature #332

Closed choidabom closed 1 month ago

choidabom commented 2 months ago

What this PR does / why we need it?

This PR introduces a feature that enhances text selection by enabling the automatic creation of hyperlinks when dragging and selecting text prior to pasting a link. Currently, users experience the inconvenience of having URLs pasted directly into the text instead of being applied as hyperlinks to the selected text.

With this enhancement, the system will automatically detect if the copied content is a link and generate a Markdown link format that connects the selected text with the URL, thus improving the overall user experience.

Any background context you want to provide?

Streamlining the hyperlink creation process will not only save time for users but also ensure that linking text is more intuitive. This is particularly useful for users who frequently need to reference external sources, as they can now create clickable links with a simple drag-and-select action, enhancing productivity and usability.

What are the relevant tickets?

Fixes https://github.com/yorkie-team/codepair/issues/322

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve the introduction of a new useToolBar hook for managing the state of a formatting toolbar in a text editor, refactoring the Editor component to utilize this hook. Additionally, a new utility for hyperlink insertion has been created, allowing users to easily link selected text to URLs. These modifications enhance the overall functionality and structure of the codebase.

Changes

Files Change Summary
frontend/src/components/editor/Editor.tsx Refactored to use useToolBar for toolbar state management; removed unused imports.
frontend/src/hooks/useToolBar.ts Introduced a new hook for managing toolbar visibility and selected formats.
frontend/src/hooks/useFormatUtils.ts Added checkAndAddFormat function to conditionally modify format sets based on text selection.
frontend/src/utils/urlHyperlinkInserter.ts Added functionality for inserting hyperlinks into the editor based on pasted URLs.
frontend/package.json Added dependencies for validator and @types/validator to support hyperlink functionality.

Assessment against linked issues

Objective Addressed Explanation
Add hyperlink creation feature (#322) βœ…

🐰 Hopping through the code so bright,
A toolbar that dances, oh what a sight!
Links now can flourish with just a quick paste,
Formatting made easy, no time to waste!
In the editor's garden, we play and we cheer,
With each little change, the magic draws near! 🌟


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 show all the console.log statements in this repository.` - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.