feat(launcher): Implement help plugin

Author: mmstick

src/dialog_launcher.ts

@@ -77,54 +77,56 @@ export class Launcher extends search.Search {
 
             const pattern = pat.toLowerCase()
 
-            const needles = pattern.split(' ');
+            if (pat !== '?') {
+                const needles = pattern.split(' ');
 
-            const contains_pattern = (haystack: string, needles: Array<string>): boolean => {
-                const hay = haystack.toLowerCase();
-                return needles.every((n) => hay.includes(n));
-            };
+                const contains_pattern = (haystack: string, needles: Array<string>): boolean => {
+                    const hay = haystack.toLowerCase();
+                    return needles.every((n) => hay.includes(n));
+                };
 
-            // Filter matching windows
-            for (const window of ext.tab_list(Meta.TabList.NORMAL, null)) {
-                const retain = contains_pattern(window.name(ext), needles)
-                    || contains_pattern(window.meta.get_title(), needles);
+                // Filter matching windows
+                for (const window of ext.tab_list(Meta.TabList.NORMAL, null)) {
+                    const retain = contains_pattern(window.name(ext), needles)
+                        || contains_pattern(window.meta.get_title(), needles);
 
-                if (retain) {
-                    windows.push(window_selection(ext, window, this.icon_size()))
+                    if (retain) {
+                        windows.push(window_selection(ext, window, this.icon_size()))
+                    }
                 }
-            }
-
-            // Filter matching desktop apps
-            for (const [where, app] of this.desktop_apps) {
-                const name = app.name()
-                const keywords = app.keywords()
-                const exec = app.exec()
-
-                let app_items = name.split(' ')
-                if (keywords !== null) app_items = app_items.concat(keywords)
-                if (exec !== null) app_items = app_items.concat(exec)
-
-                for (const item of app_items) {
-                    const item_match = item.toLowerCase()
-                    if ( item_match.startsWith(pattern)
-                         || item_match.includes(pattern)
-                         || levenshtein.compare(item_match, pattern) < 3) {
-                        const generic = app.generic_name();
-                        const button = new launch.SearchOption(
-                            name,
-                            generic ? generic + " — " + where : where,
-                            'new-window-symbolic',
-                            { gicon: app.icon() },
-                            this.icon_size(),
-                            { app },
-                            exec,
-                            keywords
-                        )
-
-                        DedicatedGPU.addPopup(app, button.widget)
 
-                        this.options.push(button)
-                        break
+                // Filter matching desktop apps
+                for (const [where, app] of this.desktop_apps) {
+                    const name = app.name()
+                    const keywords = app.keywords()
+                    const exec = app.exec()
+
+                    let app_items = name.split(' ')
+                    if (keywords !== null) app_items = app_items.concat(keywords)
+                    if (exec !== null) app_items = app_items.concat(exec)
+
+                    for (const item of app_items) {
+                        const item_match = item.toLowerCase()
+                        if ( item_match.startsWith(pattern)
+                            || item_match.includes(pattern)
+                            || levenshtein.compare(item_match, pattern) < 3) {
+                            const generic = app.generic_name();
+                            const button = new launch.SearchOption(
+                                name,
+                                generic ? generic + " — " + where : where,
+                                'new-window-symbolic',
+                                { gicon: app.icon() },
+                                this.icon_size(),
+                                { app },
+                                exec,
+                                keywords
+                            )
+
+                            DedicatedGPU.addPopup(app, button.widget)
+
+                            this.options.push(button)
+                            break
+                        }
                     }
                 }
             }

src/dialog_search.ts

@@ -60,7 +60,7 @@ export class Search {
             x_expand: true
         });
 
-        this.entry.set_hint_text('  Type to search apps')
+        this.entry.set_hint_text('  Type to search apps. Press \'?\' for more options')
 
         this.text = this.entry.get_clutter_text();
         (this.text as any).set_use_markup(true)

src/launcher_service.ts

@@ -14,6 +14,21 @@ const { Plugin } = plugins
 
 import * as plugin_scripts from 'plugin_scripts'
 import * as plugin_shell from 'plugin_shell'
+import * as plugin_help from 'plugin_help'
+
+const BUILTIN_HELP: PluginType.Source = {
+    backend: {
+        builtin: new plugin_help.ShellBuiltin()
+    },
+    config: {
+        name: "Shell Help",
+        description: "Show additional prefixes available",
+        pattern: "",
+        exec: "",
+        icon: "system-help-symbolic"
+    },
+    pattern: null
+};
 
 export var BUILTINS: Array<PluginType.Source> = [
     {
@@ -55,7 +70,7 @@ const LOCAL_PLUGINS: string = GLib.get_home_dir() + "/.local/share/pop-shell/lau
 const SYSTEM_PLUGINS: string = "/usr/lib/pop-shell/launcher/"
 
 export class LauncherService {
-    private plugins: Map<string, PluginType.Source> = new Map()
+    plugins: Map<string, PluginType.Source> = new Map()
 
     destroy(ext: Ext) {
         for (const plugin of this.plugins.values()) Plugin.quit(ext, plugin)
@@ -124,6 +139,11 @@ export class LauncherService {
     }
 
     private *match_query(ext: Ext, query: string): IterableIterator<PluginType.Source> {
+        if (query === "?") {
+            yield BUILTIN_HELP;
+            return
+        }
+
         for (const plugin of BUILTINS) {
             if (!plugin.pattern || plugin.pattern.test(query)) {
                 yield plugin

src/plugin_help.ts

@@ -0,0 +1,36 @@
+// @ts-ignore
+const Me = imports.misc.extensionUtils.getCurrentExtension()
+
+import * as plugins from 'launcher_plugins'
+
+import type { Response, Selection } from 'launcher_plugins'
+import type { Ext } from './extension'
+
+export class ShellBuiltin extends plugins.Builtin {
+    init() {}
+
+    query(ext :Ext, _: string): Response.Response {
+        let selections = []
+        let id = 0;
+
+        for (const [name, service] of ext.window_search.service.plugins) {
+            if (service.config.pattern?.length > 0) {
+                selections.push({
+                    id,
+                    name,
+                    description: service.config.description + `: ${service.config.pattern}`,
+                })
+                id += 1;
+            }
+        }
+
+        return {
+            event: "queried",
+            selections
+        }
+    }
+
+    submit(ext: Ext, id: number): Response.Response {
+        return { event: "fill", text: "" }
+    }
+}