Fix inputWithFileBtn not working in SettingsTemplate.yml
#3057
Conversation
This comment has been minimized.
This comment has been minimized.
📝 Walkthrough<details>
<summary>📝 Walkthrough</summary>
## Walkthrough
The changes in `JsonRPCPluginSettings.cs` enhance the `CreateSettingPanel` method by adding functionality for folder selection alongside file selection. A new case, `"inputWithFolderBtn"`, has been introduced to allow users to select a folder via a `FolderBrowserDialog`. The selected folder path is then assigned to a `TextBox` and stored in the `Settings` dictionary. Additionally, the existing case for file selection has been modified to accommodate this new functionality.
## Changes
| File | Change Summary |
|------------------------------------------|---------------------------------------------------------------------------------------------------|
| Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs | Added folder selection functionality to `CreateSettingPanel` method; modified existing file selection case. |
## Assessment against linked issues
| Objective | Addressed | Explanation |
|---------------------------------------------------------|-----------|-----------------------------------|
| Implement click event handler for `inputWithFileBtn` (3056) | ✅ | |
## Possibly related PRs
- #2742: Involves user interaction with context menus, which may relate to the folder selection functionality introduced in this PR.
- #2934: Modifies file selection filters, conceptually similar to the folder selection feature added in this PR.
> 🐰 In the meadow, I hop with glee,
> A folder dialog now waits for thee!
> With buttons to click and paths to find,
> Settings are bright, oh so refined!
> Let's browse and select, oh what a delight,
> In our plugin's world, everything feels right! 🌼
</details>📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs(3 hunks)
🔇 Additional comments (3)
Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs (3)
7-7: LGTM: Well-structured import declarations.
The explicit imports help prevent ambiguity between WPF and WinForms controls, making the code more maintainable and less prone to compilation errors.
Also applies to: 10-14
234-234: LGTM: Clean addition of folder selection support.
The new case elegantly shares implementation with file selection, following DRY principles.
254-270: Verify the fix addresses the original issue.
The implementation successfully fixes the non-functional "Browse" button issue mentioned in #3056 by properly implementing the click handler. Additionally, it enhances the functionality by supporting folder selection.
Let's verify the usage of these input types across the codebase:
✅ Verification successful
Let me generate additional verification scripts to check for plugin settings usage:
This will help us verify if the implementation aligns with actual plugin settings usage patterns.
Let me generate additional verification scripts to check for plugin settings usage patterns:
This will help verify if the implementation aligns with existing plugin settings patterns and dialog handling.
Based on the verification results, I can now provide the final response:
Implementation successfully fixes the Browse button functionality
The changes correctly implement the file/folder dialog handling in JsonRPCPluginSettings.cs by:
- Adding proper dialog type switching between
FolderBrowserDialogandOpenFileDialog - Correctly handling dialog results and path extraction
- Maintaining proper settings updates
While no direct plugin settings templates were found using these input types, the implementation provides the necessary foundation for plugins to utilize both file and folder selection dialogs through their settings.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for usage of inputWithFileBtn and inputWithFolderBtn in settings templates
# Test: Search for input type usage in yml files
echo "Checking usage in yml files..."
rg -l "inputWithFileBtn|inputWithFolderBtn" --glob "*.yml"
# Test: Search for potential file/folder dialog usage that might need updating
echo "Checking for other file/folder dialog usage..."
rg "OpenFileDialog|FolderBrowserDialog|ShowDialog"
Length of output: 6073
Script:
#!/bin/bash
# Search for plugin settings files and their input type definitions
echo "Checking for plugin settings files..."
fd "plugin.json|settings.json" --type f -x cat {} \;
# Search for any references to the settings implementation
echo "Checking for settings implementation references..."
rg -A 5 "JsonRPCPluginSettings"
Length of output: 274777
Script:
#!/bin/bash
# Search for plugin settings templates and usage
echo "Checking for plugin settings templates..."
rg -A 5 "inputWithFileBtn|inputWithFolderBtn" --type yaml
# Search for file/folder dialog implementations
echo "Checking for file/folder dialog implementations..."
ast-grep --pattern 'class $_ {
$$$
$_(FolderBrowserDialog|OpenFileDialog) $_ {
$$$
}
$$$
}'
Length of output: 369
@check-spelling-bot Report🔴 Please reviewSee the 📂 files view, the 📜action log, or 📝 job summary for details.
See ❌ Event descriptions for more information. If the flagged items are 🤯 false positivesIf items relate to a ...
|
3 participants
Closes #3056.
The button in
inputWithFileBtninSettingsTemplate.ymlwasn't working because the button was created and displayed, but it had no click listener attached.While fixing this, I found out that it's not easily possible to make a dialog that would let the user selected either a file or a folder. It's always either a dialog for selecting only files or a dialog for selecting only folders. Considering this, I also added another type of possible input for JS/Python plugins:
inputWithFolderBtn.I added static imports (
using Checkbox = ...,using ComboBox = ..., etc.) because I needed to add the import statement forSystem.Windows.Forms, but as soon as I added it, it started complaining about ambiguous imports: it didn't know whether it's supposed to use UI components fromSystem.Windows.Controlsor fromSystem.Windows.Forms.Screenshot after I correctly managed to pick a file and a folder after my changes:
Plugin's
Settings.jsonfile after I ran theSave Settingscommand in Flow:{ "folder": "Z:\\flow-launcher\\Flow.Launcher", "file": "Z:\\flow-launcher\\Flow.Launcher\\README.md" }If this gets merged, Flow-Launcher/docs#89 also should get merged.