dev: automated commit - 2025-11-28 21:56:48

local-bin/.local/bin/nscratch

@@ -0,0 +1,97 @@
+#!/usr/bin/env python3
+# Adapted from the many ideas shared at: https://github.com/YaLTeR/niri/discussions/329
+
+import argparse
+import json
+import os
+import subprocess
+import sys
+
+# the found scratchpad window (id, workspace_id, is_focused, is_floating)
+scratch_window = {}
+# the focused workspace data
+focused_workspace = {}
+# the scratchpad workspace name
+scratch_workspace = os.getenv("NS_WORKSPACE", "scratch")
+
+def niri_cmd(cmd_args):
+    subprocess.run(["niri", "msg", "action"] + cmd_args)
+
+def move_window_to_scratchpad(window_id, animations):
+    niri_cmd(["move-window-to-workspace", "--window-id", str(window_id), scratch_workspace, "--focus=false"])
+    if animations:
+        niri_cmd(["move-window-to-tiling", "--id", str(window_id)])
+
+def bring_scratchpad_window_to_focus(window_id, args):
+    niri_cmd(["move-window-to-workspace", "--window-id", str(window_id), str(focused_workspace["idx"])])
+    if args.animations and not scratch_window["is_floating"]:
+        niri_cmd(["move-window-to-floating", "--id", str(window_id)])
+    niri_cmd(["focus-window", "--id", str(window_id)])
+
+def find_scratch_window(args, windows):
+    for window in windows:
+        if window["app_id"] == args.app_id:
+            scratch_window["id"] = window["id"]
+            scratch_window["workspace_id"] = window["workspace_id"]
+            scratch_window["is_focused"] = window["is_focused"]
+            scratch_window["is_floating"] = window["is_floating"]
+            break
+
+def fetch_focused_workspace():
+    props = subprocess.run(
+        ["niri", "msg", "--json", "workspaces"],
+        capture_output=True,
+        text=True,
+    )
+    workspaces = json.loads(props.stdout)
+
+    # get the focused workspace
+    for workspace in workspaces:
+        if workspace["is_focused"]:
+            focused_workspace["idx"] = workspace["idx"]
+            focused_workspace["output"] = workspace["output"]
+            return workspace["id"]
+
+def ns(parser):
+    args = parser.parse_args()
+
+    props = subprocess.run(
+        ["niri", "msg", "--json", "windows"],
+        capture_output=True,
+        text=True,
+    )
+    windows = json.loads(props.stdout)
+
+    find_scratch_window(args, windows)
+
+    # scratchpad does not yet exist, spawn?
+    if not scratch_window:
+        if args.spawn:
+            niri_cmd(["spawn", "--"] + args.spawn.split(' '))
+            sys.exit(0)
+        else:
+            parser.print_help()
+            sys.exit(1)
+
+    window_id = scratch_window["id"]
+
+    # the scratchpad window exists and it's focused
+    if not scratch_window["is_focused"]:
+        workspace_id = fetch_focused_workspace()
+        # the window is not in the focused workspace
+        if scratch_window["workspace_id"] != workspace_id:
+            bring_scratchpad_window_to_focus(window_id, args)
+            return
+
+    move_window_to_scratchpad(window_id, args.animations)
+
+def main():
+    parser = argparse.ArgumentParser(prog='nscratch', description='Niri Scratchpad support')
+    parser.add_argument('-id', '--app-id', required=True, help='The application identifier')
+    parser.add_argument('-s', '--spawn', help='The process name to spawn when non-existing')
+    parser.add_argument('-a', '--animations', action='store_true', help='Enable animations')
+
+    ns(parser)
+
+if __name__ == "__main__":
+    main()