feat: Exclude certain File Types from the Index search result

[z1nc0r3]

• User can add file types through Explorer Settings which should be ignored in search results.
• Partially fixes Exclude certain File Types or directories in the index searching results. #2144 since there was another idea to filter certain folders.

[coderabbitai]

Walkthrough

Walkthrough

The changes introduce support for excluding specific file types from search results in the Flow Launcher Explorer plugin. Users can now specify file types to exclude in the plugin settings, enhancing control over search behavior. The implementation includes updates to the settings model, view model, and user interface to accommodate this feature, as well as a new method in the search manager to filter out excluded file types during searches.

Changes

Files	Change Summary
Plugins/Flow.Launcher.Plugin.Explorer/Languages/en.xaml	Added UI strings and tooltip for setting excluded file types.
Plugins/Flow.Launcher.Plugin.Explorer/Search/SearchManager.cs	Introduced IsExcludedFile method to filter files based on their extensions during search.
Plugins/Flow.Launcher.Plugin.Explorer/Settings.cs	Added ExcludedFileTypes property to store user-defined excluded file types.
Plugins/Flow.Launcher.Plugin.Explorer/ViewModels/SettingsViewModel.cs	Added logic to sanitize and save ExcludedFileTypes input from users.
Plugins/Flow.Launcher.Plugin.Explorer/Views/ExplorerSettings.xaml	Updated UI to include input fields for managing excluded file types.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SettingsView
    participant SettingsViewModel
    participant Settings
    participant SearchManager

    User->>+SettingsView: Open Settings
    SettingsView->>+SettingsViewModel: Display current settings

    User->>+SettingsView: Enter excluded file types
    SettingsView->>+SettingsViewModel: Update ExcludedFileTypes
    SettingsViewModel->>+Settings: Save ExcludedFileTypes
    
    User->>+SearchManager: Perform Search
    SearchManager->>+Settings: Get ExcludedFileTypes
    SearchManager->>+IsExcludedFile: Check file type
    IsExcludedFile-->>SearchManager: Return true/false
    SearchManager->>User: Display filtered results

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Exclude certain file types in search results (#2144)	✅
Provide a field box in settings to specify excluded file types (#2144)	✅
Ensure excluded file types are not indexed or shown in search results (#2144)	✅

Poem

In the depths of code, a change so bright,
Excluded file types take their flight.
Searches now, so clean and pure,
With settings that let you ensure,
No .mp3, .jpg in sight,
Flow Launcher shines in the night. 🌟

---

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>.
  • 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 1

[VictoriousRaptor]

Is it possible to pass the exclude list when using everything so we don't have to filter the results ourselves?

[z1nc0r3]

Yeah, that would be the best solution here. But it seems there are no such parameters (options) acceps from Everything API as I checked the SDK.

[github-actions]

@check-spelling-bot Report

🔴 Please review

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

❌ Errors	Count
❌ ignored-expect-variant	1
⚠️ non-alpha-in-dictionary	13

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]

🥷 Code experts: Yusyuriv, onesounds

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

See details

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

Activity based on git-commit:

	Yusyuriv	onesounds
JUL
JUN	4 additions & 3 deletions	4 additions & 0 deletions
MAY	6 additions & 1 deletions	8 additions & 6 deletions
APR
MAR
FEB

Knowledge based on git-blame:
jjw24: 28%
onesounds: 15%

Plugins/Flow.Launcher.Plugin.Explorer/Search/SearchManager.cs

Activity based on git-commit:

	Yusyuriv	onesounds
JUL
JUN
MAY
APR
MAR
FEB

Knowledge based on git-blame:
jjw24: 20%

Plugins/Flow.Launcher.Plugin.Explorer/Settings.cs

Activity based on git-commit:

	Yusyuriv	onesounds
JUL
JUN	7 additions & 3 deletions
MAY	11 additions & 1 deletions
APR
MAR
FEB

Knowledge based on git-blame:
jjw24: 9%

Plugins/Flow.Launcher.Plugin.Explorer/ViewModels/SettingsViewModel.cs

Activity based on git-commit:

	Yusyuriv	onesounds
JUL
JUN	39 additions & 5 deletions
MAY	101 additions & 0 deletions
APR
MAR
FEB

Knowledge based on git-blame:
jjw24: 6%

Plugins/Flow.Launcher.Plugin.Explorer/Views/ExplorerSettings.xaml

Activity based on git-commit:

	Yusyuriv	onesounds
JUL
JUN	65 additions & 10 deletions	48 additions & 47 deletions
MAY	51 additions & 0 deletions	10 additions & 10 deletions
APR
MAR
FEB

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

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