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

Fix custom query hotkey settings issue #3354

Merged
merged 5 commits into from
Mar 17, 2025

Conversation

Jack251970
Copy link
Contributor

@Jack251970 Jack251970 commented Mar 17, 2025

Add new enum type to handle logic for custom query hotkey setting dialog

As you can see, the new version of HotkeyControl uses Type to specific the Hotkey getter and setter.

And previously, the default value of Type is Hotkey so the HotkeyControl in CustomQueryHotkeySettings will fallback to case HotkeyType.Hotkey:, resulting the change of the search hotkey.

So we need to add a new enum type so that HotkeyControl will cache the hotkey value and return it as result which is needed for CustomQueryHotkeySettings (it uses )

Follow on with #3310.

Test

  • Set / Update / Delete custom query hotkey.

@prlabeler prlabeler bot added bug Something isn't working enhancement New feature or request labels Mar 17, 2025

This comment has been minimized.

Copy link

gitstream-cm bot commented Mar 17, 2025

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

Copy link
Contributor

coderabbitai bot commented Mar 17, 2025

📝 Walkthrough

Walkthrough

The pull request updates the hotkey handling in the HotkeyControl class. It changes the default initialization for the TypeProperty from HotkeyType.Hotkey to HotkeyType.None, incorporates a new enum value None in HotkeyType, and adjusts the getter and setter logic to correctly handle custom hotkeys. Additionally, the changes improve error handling by explicitly throwing a NotImplementedException for unsupported hotkey types. The XAML layout has also been modified for margin formatting and a new property has been added.

Changes

File(s) Change summary
Flow.Launcher/HotkeyControl.xaml.cs - Changed default for TypeProperty from HotkeyType.Hotkey to HotkeyType.None
- Added None to the HotkeyType enum
- Modified getter/setter to process custom hotkeys when type is HotkeyType.CustomQueryHotkey
- Enhanced error handling with NotImplementedException for unsupported types
Flow.Launcher/CustomQueryHotkeySetting.xaml - Changed margin syntax from comma-separated to space-separated format
- Added Type="CustomQueryHotkey" attribute to flowlauncher:HotkeyControl element

Possibly related PRs

  • Enable the use of Win hotkey to trigger flow #3262: The changes in the main PR, which modify the HotkeyControl class and its handling of hotkeys, are directly related to the changes in the retrieved PR, which also involves modifications to the HotkeyControl class, specifically in the logic for hotkey availability concerning the "LWin" and "RWin" keys.

Suggested labels

bug, enhancement

Suggested reviewers

  • jjw24
  • taooceros

Poem

I'm a rabbit, hopping through lines of code,
Skipping bugs, where custom hotkeys now explode.
Carrots of clarity, in each change I see,
Bouncing on keys, setting new defaults with glee.
With a twitch of my ears and a digital cheer,
I celebrate this PR, a joy for all to hear!
(_/) 🥕


📜 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 83c7ee1 and 497ac91.

📒 Files selected for processing (1)
  • Flow.Launcher/HotkeyControl.xaml.cs (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Flow.Launcher/HotkeyControl.xaml.cs
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm

🪧 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.
  • @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)
Flow.Launcher/HotkeyControl.xaml.cs (2)

145-145: Error message has grammatical error.

The error message "Hotkey type not setted" contains a grammatical error. The correct form would be "Hotkey type not set" or "Hotkey type not specified".

- _ => throw new System.NotImplementedException("Hotkey type not setted")
+ _ => throw new System.NotImplementedException("Hotkey type not set")

200-200: Same grammatical error in setter's error message.

The error message "Hotkey type not setted" contains the same grammatical error as in the getter. The correct form would be "Hotkey type not set" or "Hotkey type not specified".

- throw new System.NotImplementedException("Hotkey type not setted");
+ throw new System.NotImplementedException("Hotkey type not set");
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eb2a24d and b1ec0bd.

📒 Files selected for processing (1)
  • Flow.Launcher/HotkeyControl.xaml.cs (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
🔇 Additional comments (4)
Flow.Launcher/HotkeyControl.xaml.cs (4)

87-87: Good change to default TypeProperty value.

Changing the default initialization from HotkeyType.Hotkey to HotkeyType.None aligns with the new enum value and properly supports custom hotkeys from dialog results.


98-99: Appropriate addition of None enum value.

Adding the None enum value with a descriptive comment clarifies its purpose for getting hotkeys from dialog results. This addition is necessary for handling custom hotkeys that aren't part of the settings.


121-121: Good implementation for custom hotkey storage.

The addition of the private hotkey field and its usage in the getter when Type is HotkeyType.None properly separates custom hotkeys from settings-based hotkeys.

Also applies to: 128-130


152-156: Good implementation for custom hotkey assignment.

The addition of the HotkeyType.None case in the setter properly handles custom hotkeys by storing the value in the private hotkey field.

This comment has been minimized.

@Jack251970 Jack251970 requested a review from jjw24 March 17, 2025 03:08
@Jack251970 Jack251970 enabled auto-merge March 17, 2025 03:08
@Jack251970 Jack251970 added this to the 1.20.0 milestone Mar 17, 2025
@taooceros
Copy link
Member

do you mind briefly introduce what's the issue?

@Jack251970
Copy link
Contributor Author

Jack251970 commented Mar 17, 2025

do you mind briefly introduce what's the issue?

As you can see, the new version of HotkeyControl uses Type to specific the Hotkey getter and setter.

And previously, the default value of Type is Hotkey so the HotkeyControl in CustomQueryHotkeySettings will fallback to case HotkeyType.Hotkey:, resulting the change of the search hotkey.

@Jack251970
Copy link
Contributor Author

Now I added new enum type so that HotkeyControl will cache the hotkey value and return it as result which is needed for CustomQueryHotkeySettings.

@jjw24 jjw24 added Dev branch only An issue or fix for the Dev branch build and removed bug Something isn't working enhancement New feature or request 1 min review labels Mar 17, 2025

This comment has been minimized.

This comment has been minimized.

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.

@Jack251970 Jack251970 merged commit 9d1e305 into Flow-Launcher:dev Mar 17, 2025
7 checks passed
Copy link

gitstream-cm bot commented Mar 17, 2025

🥷 Code experts: Yusyuriv, onesounds

Jack251970 has most 👩‍💻 activity in the files.
Jack251970, Yusyuriv have most 🧠 knowledge in the files.

See details

Flow.Launcher/CustomQueryHotkeySetting.xaml

Activity based on git-commit:

Jack251970
MAR 14 additions & 14 deletions
FEB 1 additions & 4 deletions
JAN
DEC
NOV
OCT

Knowledge based on git-blame:
Yusyuriv: 37%
Jack251970: 9%

Flow.Launcher/HotkeyControl.xaml.cs

Activity based on git-commit:

Jack251970
MAR 146 additions & 34 deletions
FEB
JAN
DEC
NOV
OCT

Knowledge based on git-blame:
Jack251970: 42%
Yusyuriv: 17%

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

@Jack251970 Jack251970 mentioned this pull request Mar 17, 2025
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dev branch only An issue or fix for the Dev branch build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants