Preferences: search the installed plugins (#5585)

The Plugins page filters its list by name, id, description, and version.
This commit is contained in:
Thodoris Tsagkogeorgas
2026-10-25 17:41:16 +00:00
committed by GitHub
parent 1ee65cf70a
commit 669e14b3bf
5 changed files with 49 additions and 5 deletions
+2
View File
@@ -2913,7 +2913,9 @@
"ui.plugins": "Plugins",
"ui.plugins_desktop": "Plugins are available in the desktop app.",
"ui.plugins_empty": "No plugins installed.",
"ui.plugins_none": "No plugins match this search.",
"ui.plugins_note": "Each plugin is a folder inside {path} with a plugin.json. SolidCraft reads that file and does not run any code from the folder. Turning a plugin off keeps it installed.",
"ui.plugins_search": "Search plugins",
"ui.plugins_skipped": "{count} folder(s) could not be read.",
"ui.plugins_version": "{version}",
"ui.point": "Point",
+2
View File
@@ -2913,7 +2913,9 @@
"ui.plugins": "プラグイン",
"ui.plugins_desktop": "プラグインはデスクトップ版で使えます。",
"ui.plugins_empty": "プラグインは入っていません。",
"ui.plugins_none": "検索に一致するプラグインはありません。",
"ui.plugins_note": "プラグインは {path} の中のフォルダで、plugin.json を置きます。SolidCraft はそのファイルを読むだけで、フォルダのコードは実行しません。オフにしてもインストールは残ります。",
"ui.plugins_search": "プラグインを検索",
"ui.plugins_skipped": "{count} 個のフォルダを読めませんでした。",
"ui.plugins_version": "{version}",
"ui.point": "点",
+2
View File
@@ -2913,7 +2913,9 @@
"ui.plugins": "插件",
"ui.plugins_desktop": "插件仅在桌面版中可用。",
"ui.plugins_empty": "尚未安装插件。",
"ui.plugins_none": "没有符合搜索的插件。",
"ui.plugins_note": "每个插件是 {path} 里的一个文件夹,其中有 plugin.json。SolidCraft 只读取该文件,不运行文件夹里的代码。关闭插件仍会保留安装。",
"ui.plugins_search": "搜索插件",
"ui.plugins_skipped": "有 {count} 个文件夹无法读取。",
"ui.plugins_version": "{version}",
"ui.point": "点",
+41 -5
View File
@@ -1,8 +1,9 @@
//! Preferences › Plugins: packages installed under the per-user data folder.
//!
//! A plugin is a directory of `{data}/plugins/<id>/plugin.json`. This page reads that file and
//! records which ids are turned off. It does not load or run anything from the folder. Running a
//! plugin (the wasm host in docs/plugins.md) is a later step; it will honour `disabled_plugins`.
//! A plugin is a directory of `{data}/plugins/<id>/plugin.json`. The page searches that list.
//! It reads `plugin.json` and records which ids are turned off. It does not load or run anything
//! from the folder. Running a plugin (the wasm host in docs/plugins.md) is a later step; it will
//! honour `disabled_plugins`.
use std::path::{Path, PathBuf};
@@ -129,6 +130,17 @@ pub fn enabled(app: &SolveApp, id: &str) -> bool {
!app.preferences.disabled_plugins.contains(id)
}
fn matches_query(plugin: &Plugin, query: &str) -> bool {
let query = query.trim();
if query.is_empty() {
return true;
}
let query = query.to_lowercase();
[plugin.name.as_str(), plugin.id.as_str(), plugin.description.as_str(), plugin.version.as_str()]
.iter()
.any(|text| text.to_lowercase().contains(&query))
}
/// The Plugins page. Desktop only: the browser build has no per-user plugin folder.
pub fn page(app: &mut SolveApp, ui: &mut egui::Ui) {
let t = crate::theme::Tokens::get();
@@ -140,6 +152,8 @@ pub fn page(app: &mut SolveApp, ui: &mut egui::Ui) {
ui.label(crate::i18n::tr("ui.plugins_desktop"));
return;
};
crate::ui_kit::search_field(ui, ui.id().with("plugins_search"), &mut app.prefs_window.plugin_query, crate::i18n::tr("ui.plugins_search"));
ui.add_space(8.0);
let path = dir.display().to_string();
ui.add(egui::Label::new(RichText::new(crate::i18n::format("ui.plugins_note", &[("path", &path)])).size(t.font_small).color(t.text_dim)).wrap());
ui.add_space(8.0);
@@ -154,10 +168,13 @@ pub fn page(app: &mut SolveApp, ui: &mut egui::Ui) {
}
ui.add_space(8.0);
let (plugins, skipped) = scan(&dir);
let query = app.prefs_window.plugin_query.clone();
if plugins.is_empty() {
ui.label(crate::i18n::tr("ui.plugins_empty"));
}
for plugin in &plugins {
let mut shown = 0usize;
for plugin in plugins.iter().filter(|plugin| matches_query(plugin, &query)) {
shown += 1;
let mut on = enabled(app, &plugin.id);
ui.horizontal(|ui| {
let check = crate::ui_kit::checkbox(ui, "", &mut on);
@@ -181,7 +198,10 @@ pub fn page(app: &mut SolveApp, ui: &mut egui::Ui) {
});
ui.separator();
}
if !skipped.is_empty() {
if !plugins.is_empty() && shown == 0 {
ui.label(crate::i18n::tr("ui.plugins_none"));
}
if query.trim().is_empty() && !skipped.is_empty() {
ui.add_space(6.0);
ui.label(
RichText::new(crate::i18n::format("ui.plugins_skipped", &[("count", &skipped.len().to_string())])).size(t.font_small).color(t.text_dim),
@@ -257,4 +277,20 @@ mod tests {
assert!(enabled(&app, "ftc-frc-parts"));
assert!(crate::prefs::control(&mut app, &json!({"open": "NoSuch"})).is_err());
}
#[test]
fn search_matches_the_name_the_id_and_the_description() {
let plugin = Plugin {
id: "ftc-frc-parts".into(),
name: "FTC and FRC parts".into(),
version: "0.1.0".into(),
description: "Commercial robot parts.".into(),
};
assert!(matches_query(&plugin, ""));
assert!(matches_query(&plugin, " frc "));
assert!(matches_query(&plugin, "FTC-FRC"));
assert!(matches_query(&plugin, "commercial"));
assert!(matches_query(&plugin, "0.1"));
assert!(!matches_query(&plugin, "bearing"));
}
}
+2
View File
@@ -724,6 +724,8 @@ pub struct PrefsWindow {
applied_up: Option<String>,
/// The search text of the interface font list.
font_filter: String,
/// Search text on the Plugins page.
pub(crate) plugin_query: String,
}
/// Open the dialog at a page.