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

[WebSearch] Add copy URL to menu #3082

Merged
merged 2 commits into from
Dec 7, 2024

Conversation

NoPlagiarism
Copy link
Contributor

URL -> ContextData -> Context Menu

This comment has been minimized.

Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

This pull request introduces new string resources for English and Russian language support in the Plugins/Flow.Launcher.Plugin.WebSearch plugin, specifically for copying URLs. Additionally, it modifies the Main class to implement the IContextMenu interface, adding a method to generate context menu items that allow users to copy URLs associated with search results. The changes enhance the plugin's functionality and localization capabilities.

Changes

File Path Change Summary
Plugins/Flow.Launcher.Plugin.WebSearch/Languages/en.xaml Added two new strings: flowlauncher_plugin_websearch_copyurl_title and flowlauncher_plugin_websearch_copyurl_subtitle.
Plugins/Flow.Launcher.Plugin.WebSearch/Languages/ru.xaml Added two new strings: flowlauncher_plugin_websearch_copyurl_title and flowlauncher_plugin_websearch_copyurl_subtitle.
Plugins/Flow.Launcher.Plugin.WebSearch/Main.cs Updated Main class to implement IContextMenu, added LoadContextMenus method, and modified QueryAsync and SuggestionsAsync methods to include ContextData for URLs.

Possibly related PRs

  • Add "Enabled" Column in Customize Action Keyword Tab #2918: The changes in this PR involve adding new string resources related to enabling and disabling features in the en.xaml file, which is similar to the addition of new string resources for copying URLs in the main PR. Both PRs enhance the localization and user interface of their respective plugins.

Suggested labels

bug, kind/i18n

Suggested reviewers

  • jjw24
  • taooceros

Poem

In the land of search, a new feature's born,
With strings added bright, for users to adorn.
Copy the URL, it's now just a click,
Language support grows, it's a clever little trick!
So hop with delight, let the clipboard be free,
A web search adventure, for you and for me! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4fbd74a and 386ac97.

📒 Files selected for processing (1)
  • Plugins/Flow.Launcher.Plugin.WebSearch/Main.cs (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Plugins/Flow.Launcher.Plugin.WebSearch/Main.cs

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 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: 1

🧹 Outside diff range and nitpick comments (3)
Plugins/Flow.Launcher.Plugin.WebSearch/Languages/en.xaml (1)

34-35: LGTM with a minor naming suggestion!

The new string resources are well-structured and clearly describe the copy URL functionality. However, consider using underscore for consistency in the key names:

  • flowlauncher_plugin_websearch_copy_url_title
  • flowlauncher_plugin_websearch_copy_url_subtitle

This matches the pattern used in other keys like flowlauncher_plugin_websearch_action_keyword.

-    <system:String x:Key="flowlauncher_plugin_websearch_copyurl_title">Copy URL</system:String>
-    <system:String x:Key="flowlauncher_plugin_websearch_copyurl_subtitle">Copy search URL to clipboard</system:String>
+    <system:String x:Key="flowlauncher_plugin_websearch_copy_url_title">Copy URL</system:String>
+    <system:String x:Key="flowlauncher_plugin_websearch_copy_url_subtitle">Copy search URL to clipboard</system:String>
Plugins/Flow.Launcher.Plugin.WebSearch/Main.cs (2)

79-80: Consider extracting URL generation to reduce duplication

The URL generation logic is duplicated between the Action and ContextData assignments. Consider extracting this into a local variable to improve maintainability.

+                        var generatedUrl = searchSource.Url.Replace("{q}", Uri.EscapeDataString(keyword));
                         Action = c =>
                         {
-                            _context.API.OpenUrl(searchSource.Url.Replace("{q}", Uri.EscapeDataString(keyword)));
+                            _context.API.OpenUrl(generatedUrl);
                             return true;
                         },
-                        ContextData = searchSource.Url.Replace("{q}", Uri.EscapeDataString(keyword)),
+                        ContextData = generatedUrl,

143-144: Apply the same URL generation extraction here

Similar to the previous comment, the URL generation logic is duplicated. Apply the same refactoring pattern here.

+                var generatedUrl = searchSource.Url.Replace("{q}", Uri.EscapeDataString(o));
                 Action = c =>
                 {
-                    _context.API.OpenUrl(searchSource.Url.Replace("{q}", Uri.EscapeDataString(o)));
+                    _context.API.OpenUrl(generatedUrl);
                     return true;
                 },
-                ContextData = searchSource.Url.Replace("{q}", Uri.EscapeDataString(o)),
+                ContextData = generatedUrl,
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ed53736 and 4fbd74a.

⛔ Files ignored due to path filters (1)
  • Plugins/Flow.Launcher.Plugin.WebSearch/Images/copylink.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • Plugins/Flow.Launcher.Plugin.WebSearch/Languages/en.xaml (1 hunks)
  • Plugins/Flow.Launcher.Plugin.WebSearch/Languages/ru.xaml (1 hunks)
  • Plugins/Flow.Launcher.Plugin.WebSearch/Main.cs (3 hunks)
🔇 Additional comments (2)
Plugins/Flow.Launcher.Plugin.WebSearch/Languages/ru.xaml (1)

32-33: LGTM! Verify translation consistency.

The Russian translations appear accurate and well-formatted:

  • "Скопировать URL-адрес" → "Copy URL"
  • "Скопировать URL поиска в буфер обмена" → "Copy search URL to clipboard"

Let's verify the corresponding English strings exist:

✅ Verification successful

Russian translations are accurate and consistent with English strings

The Russian translations perfectly match their English counterparts:

  • flowlauncher_plugin_websearch_copyurl_title:
    • EN: "Copy URL"
    • RU: "Скопировать URL-адрес"
  • flowlauncher_plugin_websearch_copyurl_subtitle:
    • EN: "Copy search URL to clipboard"
    • RU: "Скопировать URL поиска в буфер обмена"
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the English translations exist in en.xaml
# Expected: Should find both string keys with their English translations

rg "flowlauncher_plugin_websearch_copyurl_title" "Plugins/Flow.Launcher.Plugin.WebSearch/Languages/en.xaml"
rg "flowlauncher_plugin_websearch_copyurl_subtitle" "Plugins/Flow.Launcher.Plugin.WebSearch/Languages/en.xaml"

Length of output: 429

Plugins/Flow.Launcher.Plugin.WebSearch/Main.cs (1)

14-14: LGTM: Clean interface implementation

The addition of IContextMenu interface is appropriate for implementing context menu functionality.

Plugins/Flow.Launcher.Plugin.WebSearch/Main.cs Outdated Show resolved Hide resolved
Copy link

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors Count
❌ forbidden-pattern 22
❌ ignored-expect-variant 1
⚠️ non-alpha-in-dictionary 19

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Copy link

gitstream-cm bot commented Nov 21, 2024

🥷 Code experts: jjw24

jjw24 has most 👩‍💻 activity in the files.
jjw24, onesounds have most 🧠 knowledge in the files.

See details

Plugins/Flow.Launcher.Plugin.WebSearch/Languages/en.xaml

Activity based on git-commit:

jjw24
NOV
OCT
SEP
AUG
JUL
JUN

Knowledge based on git-blame:
jjw24: 42%
onesounds: 38%

Plugins/Flow.Launcher.Plugin.WebSearch/Languages/ru.xaml

Activity based on git-commit:

jjw24
NOV
OCT
SEP
AUG
JUL
JUN

Knowledge based on git-blame:
jjw24: 98%

Plugins/Flow.Launcher.Plugin.WebSearch/Main.cs

Activity based on git-commit:

jjw24
NOV
OCT
SEP
AUG
JUL
JUN

Knowledge based on git-blame:
jjw24: 16%
onesounds: 1%

To learn more about /:\ gitStream - Visit our Docs

Copy link
Member

@jjw24 jjw24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, let's hold off merging this in until we do 1.20.0 release.

Copy link

gitstream-cm bot commented Nov 21, 2024

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

@jjw24 jjw24 added this to the Future milestone Nov 21, 2024
@jjw24 jjw24 added the enhancement New feature or request label Nov 21, 2024
@jjw24 jjw24 modified the milestones: Future, 1.20.0 Dec 7, 2024
@jjw24 jjw24 merged commit 304f98e into Flow-Launcher:dev Dec 7, 2024
6 checks passed
@NoPlagiarism NoPlagiarism deleted the search_copy_url branch December 8, 2024 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants