New API for StringMatcherKey of Results

[Jack251970]

StringMatcherKey is the key to be compared with the user input for fuzzy search.

This can be useful when the plugin wants to provide a different string for fuzzy search.

If the plugin does not specific this, FL just uses Title and SubTitle to compare with the user input.

For a plugin like Obsidian, the user would expect title and note content to match the string, we can set this property with title and note content.

[gitstream-cm]

🥷 Code experts: jjw24

Jack251970 has most 👩‍💻 activity in the files.
jjw24 has most 🧠 knowledge in the files.

See details

Flow.Launcher.Infrastructure/StringMatcher.cs

Activity based on git-commit:

	Jack251970
FEB	7 additions & 4 deletions
JAN	18 additions & 11 deletions
DEC
NOV
OCT
SEP

Knowledge based on git-blame:
jjw24: 61%

Flow.Launcher.Plugin/Result.cs

Activity based on git-commit:

	Jack251970
FEB	2 additions & 1 deletions
JAN	17 additions & 0 deletions
DEC	10 additions & 0 deletions
NOV
OCT
SEP

Knowledge based on git-blame:
jjw24: 11%

Flow.Launcher/ViewModel/MainViewModel.cs

Activity based on git-commit:

	Jack251970
FEB	62 additions & 20 deletions
JAN	17 additions & 21 deletions
DEC	59 additions & 63 deletions
NOV	39 additions & 15 deletions
OCT
SEP

Knowledge based on git-blame:
jjw24: 2%

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

[github-actions]

@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.

[gitstream-cm]

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

[taooceros]

This is only used for context menu?

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes update two private methods to be static within the StringMatcher class, add a new public property StringMatcherKey to the Result class, and modify the search logic in the MainViewModel to prioritize the StringMatcherKey (if present) over the title or subtitle. These modifications allow static method invocation for acronym checks and enhance the search functionality by providing an alternate fuzzy search key.

Changes

File	Summary
Flow.Launcher/…/StringMatcher.cs	Changed access modifiers for IsAcronym and IsAcronymCount from private to private static to allow static invocation.
Flow.Launcher/…/Result.cs	Added new property public string StringMatcherKey { get; set; } to hold an alternative string for fuzzy search comparisons.
Flow.Launcher/…/MainViewModel.cs	Modified QueryContextMenu and QueryHistory to check for a non-empty StringMatcherKey and use it for search matching; otherwise, fallback to title/subtitle.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant M as MainViewModel
    participant R as Result
    participant SM as StringMatcher

    U->>M: Enter search query
    M->>R: Fetch results (with possible StringMatcherKey)
    alt StringMatcherKey exists
        M->>SM: Perform static search using StringMatcherKey
    else
        M->>SM: Search using title and subtitle
    end
    M->>U: Return filtered search results

Loading

Suggested labels

enhancement

Suggested reviewers

• jjw24

Poem

I'm a bunny hopping through the code,
With static leaps and keys bestowed.
New paths in search now brightly shine,
Hopping through changes, oh so fine!
🐇 Cheers to improvements, line by line!

---

📜 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 65f85cf and 15dbfdb.

📒 Files selected for processing (3)

• Flow.Launcher.Infrastructure/StringMatcher.cs (2 hunks)
• Flow.Launcher.Plugin/Result.cs (1 hunks)
• Flow.Launcher/ViewModel/MainViewModel.cs (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: gitStream.cm

🔇 Additional comments (5)

Flow.Launcher.Plugin/Result.cs (1)

273-278: Well-implemented property with clear documentation

The addition of StringMatcherKey property provides a useful extension to the search functionality by allowing plugins to specify alternative text for fuzzy search operations. The documentation clearly explains its purpose and default behavior.

Flow.Launcher.Infrastructure/StringMatcher.cs (2)

231-231: Good refactoring: method made static

Converting this method to static is appropriate since it doesn't access any instance state. This improves code quality and allows the method to be called without an instance of the class.

---

240-240: Good refactoring: method made static

Converting this method to static is appropriate since it doesn't access any instance state. This improves code quality and allows the method to be called without an instance of the class.

Flow.Launcher/ViewModel/MainViewModel.cs (2)

1020-1034: Proper implementation of StringMatcherKey search logic

The conditional logic correctly prioritizes the StringMatcherKey property when performing fuzzy searches. The code now checks if StringMatcherKey exists and uses it exclusively, with a good comment explaining that when StringMatcherKey is provided, Title and SubTitle should not be checked.

---

1081-1084: Improved search logic with StringMatcherKey integration

The conditional expression properly incorporates the StringMatcherKey property into the search logic for history results, maintaining consistent behavior with the context menu search implementation.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[Jack251970]

This is only used for context menu?

No, it is for general search score.

[taooceros]

If you go through the code more carefully, only context menu will automatically do a fuzzy search based on title/subtitle. It could be helpful, but I think the usage needs to be discussed more (like null means plugin do its own fuzzy search while non-null means flow do it for general query).

[Jack251970]

If you go through the code more carefully, only context menu will automatically do a fuzzy search based on title/subtitle. It could be helpful, but I think the usage needs to be discussed more (like null means plugin do its own fuzzy search while non-null means flow do it for general query).

Oh.... That's not why I created the PR. I will close it.