Add a plugin to open Zed Workspaces

albert_zed_workspaces/README.md

@@ -0,0 +1,20 @@
+# Albert Launcher Zed Projects Plugin
+
+Quickly find and open your Zed workspaces right from your favourite launcher.
+
+### Install
+
+To install, copy or symlink this directory to `~/.local/share/albert/python/plugins/albert_zed_workspaces/`
+
+Or just run `git clone https://github.com/HarshNarayanJha/albert_zed_workspaces ~/.local/share/albert/python/plugins/albert_zed_workspaces/`
+
+### Development Setup
+
+I use the Zed Editor (naturally). Python Developement includes `pyright` as `lsp` and `ruff` as `linter`.
+
+Copy the `albert.pyi` file from `~/.local/share/albert/python/plugins/albert.pyi` to this directory for type definitions and completions!
+
+### References
+
+- The official jetbrains plugin - https://github.com/albertlauncher/python/tree/main/jetbrains_projects
+- Zed Editor - https://zed.dev

albert_zed_workspaces/__init__.py

@@ -0,0 +1,195 @@
+# Copyright (c) 2024 Harsh Narayan Jha
+
+"""
+This plugin allows you to quickly open workspaces in Zed Editor
+
+Disclaimer: This plugin has no affiliation with Zed Industries.. The icons are used under the terms specified there.
+"""
+
+import sqlite3
+from dataclasses import dataclass
+from pathlib import Path
+from shutil import which
+from sys import platform
+from typing import Any, Union
+
+from albert import (  # type: ignore
+    Action,
+    Item,
+    Matcher,
+    PluginInstance,
+    Query,
+    StandardItem,
+    TriggerQueryHandler,
+    runDetachedProcess,
+)
+from dateutil.parser import isoparse
+
+md_iid = '2.3'
+md_version = "0.2"
+md_name = "Zed Workspaces"
+md_description = "Open your Zed workspaces"
+md_license = "MIT"
+md_url = "https://github.com/HarshNarayanJha/albert_zed_workspaces"
+md_authors = ["@HarshNarayanJha"]
+
+
+@dataclass
+class Workspace:
+    id: str
+    name: str
+    path: str
+    last_opened: int
+
+@dataclass
+class Editor:
+    name: str
+    icon: Path
+    icon_system: str
+    config_dir_prefix: str
+    binary: Union[str, None]
+
+    def __init__(self, name: str, icon: Path, icon_system: str, config_dir_prefix: str, binaries: list[str]):
+        self.name = name
+        self.icon = icon
+        self.icon_system = icon_system
+        self.config_dir_prefix = config_dir_prefix
+        self.binary = self._find_binary(binaries)
+
+    def _find_binary(self, binaries: list[str]) -> Union[str, None]:
+        for binary in binaries:
+            if which(binary):
+                return binary
+        return None
+
+    def list_workspaces(self) -> list[Workspace]:
+        config_dir = Path.home() / ".local/share/"
+        if platform == "darwin":
+            config_dir = Path.home() / "Library" / "Application Support"
+
+        dirs = list(config_dir.glob(f"{self.config_dir_prefix}*/"))
+        if not dirs:
+            return []
+        latest = sorted(dirs)[-1]
+        return self._parse_recent_workspaces(Path(latest) / "db.sqlite")
+
+    def _parse_recent_workspaces(self, recent_workspaces_file: Path) -> list[Workspace]:
+        try:
+            workspaces = []
+            with sqlite3.connect(recent_workspaces_file) as conn:
+
+                cursor = conn.cursor()
+                cursor.execute(
+                    "SELECT workspace_id, local_paths, timestamp FROM workspaces"
+                )
+                for row in cursor:
+                    if not row[1]:
+                        continue
+
+                    w_id = row[0]
+                    local_path = '/' + '/'.join(row[1].decode().split('/')[1:])
+                    timestamp = int(isoparse(row[2]).timestamp())
+
+                    w_name = local_path.split('/')[-1]
+
+                    workspaces.append(Workspace(id=w_id, name=w_name, path=local_path, last_opened=timestamp))
+
+            return workspaces
+
+        except (FileNotFoundError):
+            return []
+
+
+class Plugin(PluginInstance, TriggerQueryHandler):
+
+    executables = []
+
+    def __init__(self):
+        PluginInstance.__init__(self)
+        TriggerQueryHandler.__init__(
+            self, self.id, self.name, self.description,
+            defaultTrigger='zd '
+        )
+
+        self._systemicon: bool | Any = self.readConfig('systemicon', bool)
+
+        plugin_dir = Path(__file__).parent
+        zed_dir_name = "zed"
+        if platform == "darwin":
+            zed_dir_name = "Zed"
+
+        editors = [
+            Editor(
+                name="Zed Editor",
+                icon=plugin_dir / "icons" / "zed-stable.png",
+                icon_system="xdg:zed",
+                config_dir_prefix=f"{zed_dir_name}/db/0-stable",
+                binaries=["zed", "zeditor", "zedit", "zed-cli"]),
+            Editor(
+                name="Zed Editor (Preview)",
+                icon=plugin_dir / "icons" / "zed-preview.png",
+                icon_system="xdg:zed-preview",
+                config_dir_prefix=f"{zed_dir_name}/db/0-preview",
+                binaries=["zed", "zeditor", "zedit", "zed-cli"])
+        ]
+        self.editors = [e for e in editors if e.binary is not None]
+
+    def handleTriggerQuery(self, query: Query):
+        editor_workspace_pairs = []
+
+        m = Matcher(query.string)
+        for editor in self.editors:
+            workspaces = editor.list_workspaces()
+            workspaces = [p for p in workspaces if Path(p.path).exists()]
+            workspaces = [p for p in workspaces if m.match(p.name) or m.match(p.path)]
+            editor_workspace_pairs.extend([(editor, p) for p in workspaces])
+
+        # sort by last opened
+        editor_workspace_pairs.sort(key=lambda pair: pair[1].last_opened, reverse=True)
+
+        query.add([self._make_item(editor, workspace, query) for editor, workspace in editor_workspace_pairs])
+
+    def _make_item(self, editor: Editor, workspace: Workspace, query: Query) -> Item:
+        return StandardItem(
+            id=str(workspace.id),
+            text=workspace.name,
+            subtext=workspace.path,
+            inputActionText=query.trigger + workspace.name,
+            iconUrls=[editor.icon_system if self._systemicon else f"file:{editor.icon}"],
+            actions=[
+                Action(
+                    "Open",
+                    "Open in %s" % editor.name,
+                    lambda selected_workspace=workspace.path: runDetachedProcess(
+                        # Binary has to be valid here
+                        [editor.binary, selected_workspace] # type: ignore
+                    ),
+                )
+            ],
+        )
+
+    @property
+    def systemicon(self) -> bool:
+        return self._systemicon
+
+    @systemicon.setter
+    def systemicon(self, value: bool) -> None:
+        self._systemicon = value
+        self.writeConfig('systemicon', value)
+
+    def configWidget(self):
+        return [
+            {
+                'type': 'label',
+                'text': str(__doc__).strip(),
+                'widget_properties': {
+                    'textFormat': 'Qt::MarkdownText'
+                }
+            },
+            {
+                'type': 'checkbox',
+                'property': 'systemicon',
+                'label': 'Use System Icon for Zed',
+                'default': True
+            },
+        ]