feat: add a history attribute to plugin config as described in #110 (#112)

* feat: add a history attribute to plugin config as described in #110

closes #110

* fix: Correct grammar mistake in comment

Co-authored-by: Jacob Kauffmann <[email protected]>

Author: oknozor

README.md

@@ -54,7 +54,7 @@ A plugin's metadata is defined `pop-launcher/plugins/{plugin}/plugin.ron`.
     description: "Plugin Description: Example",
     bin: (
         path: "name-of-executable-in-plugin-folder",
-    )
+    ),
     icon: Name("icon-name-or-path"),
     // Optional
     query: (
@@ -65,7 +65,9 @@ A plugin's metadata is defined `pop-launcher/plugins/{plugin}/plugin.ron`.
         // Optional -- avoid sorting results from this plugin
         no_sort: true,
         // Optional -- pattern that a query must have to be sent to plugin
-        regex: "pattern"
+        regex: "pattern",
+        // Optional -- the launcher should keep a history for this plugin
+        history: true,
     )
 )
 ```

plugins/src/calc/plugin.ron

@@ -8,5 +8,6 @@
         isolate_with: "^(=).*",
     ),
     bin: (path: "calc"),
-    icon: Name("x-office-spreadsheet")
+    icon: Name("x-office-spreadsheet"),
+    history: false,
 )

plugins/src/desktop_entries/plugin.ron

@@ -3,4 +3,5 @@
     description: "Query applications by their .desktop entries",
     bin: (path: "desktop-entries"),
     icon: Name("new-window-symbolic"),
+    history: true,
 )

plugins/src/files/plugin.ron

@@ -8,5 +8,5 @@
         no_sort: true,
     ),
     bin: (path: "files"),
-    icon: Name("system-file-manager")
+    icon: Name("system-file-manager"),
 )

plugins/src/find/plugin.ron

@@ -7,5 +7,5 @@
         isolate: true,
     ),
     bin: (path: "find"),
-    icon: Name("system-file-manager")
+    icon: Name("system-file-manager"),
 )

plugins/src/terminal/plugin.ron

@@ -8,4 +8,5 @@
     ),
     bin: (path: "terminal"),
     icon: Name("utilities-terminal"),
+    history: true,
 )

plugins/src/web/plugin.ron

@@ -4,4 +4,5 @@
     query: (help: "ddg ", priority: High),
     bin: (path: "web"),
     icon: Name("system-search"),
+    history: true,
 )

service/src/plugins/config.rs

@@ -27,6 +27,9 @@ pub struct PluginConfig {
 
     #[serde(default)]
     pub query: PluginQuery,
+
+    #[serde(default)]
+    pub history: bool,
 }
 
 #[derive(Debug, Default, Deserialize)]

service/src/plugins/help.rs

@@ -23,6 +23,7 @@ pub const CONFIG: PluginConfig = PluginConfig {
         regex: None,
     },
     icon: Some(IconSource::Name(Cow::Borrowed("system-help-symbolic"))),
+    history: false
 };
 pub struct HelpPlugin {
     pub id: usize,