feat(permissions): wait for idle, add opts for enabled and delay

#60

Author: NickvanDyke

lua/opencode/config.lua

@@ -40,9 +40,12 @@ vim.g.opencode_opts = vim.g.opencode_opts
 ---Supports [snacks.picker](https://github.com/folke/snacks.nvim/blob/main/docs/picker.md).
 ---@field select? snacks.picker.ui_select.Opts
 ---
+---Options for `opencode` permission requests.
+---@field permissions? opencode.permissions.Opts
+---
 ---Embedded terminal options for `toggle()`.
 ---Supports [snacks.terminal](https://github.com/folke/snacks.nvim/blob/main/docs/terminal.md).
----@field terminal? opencode.Opts.terminal
+---@field terminal? opencode.terminal.Opts
 ---
 ---Called when no `opencode` process is found so you can start it.
 ---After calling this function, `opencode.nvim` will poll for a couple seconds to see if an `opencode` process appears.
@@ -108,7 +111,14 @@ local defaults = {
       },
     },
   },
-  ---@class opencode.Opts.terminal : snacks.terminal.Opts
+  ---@class opencode.permissions.Opts
+  ---@field enabled boolean Whether to show permission requests.
+  ---@field idle_delay_ms number Amount of user idle time before showing permission requests.
+  permissions = {
+    enabled = true,
+    idle_delay_ms = 1000,
+  },
+  ---@class opencode.terminal.Opts : snacks.terminal.Opts
   ---@field cmd string The command to run in the embedded terminal. See [here](https://opencode.ai/docs/cli) for options.
   terminal = {
     cmd = "opencode",

plugin/permissions.lua

@@ -1,15 +1,47 @@
+---Waits for user to be idle (no keypresses) for `timeout` milliseconds, then calls `callback`.
+---@param callback function Function to call when user is idle.
+---@param timeout number Time in milliseconds to wait for idle.
+local function wait_for_user_idle(callback, timeout)
+  local idle_timer = vim.uv.new_timer()
+  local key_listener_id = nil
+
+  local function on_idle()
+    idle_timer:stop()
+    idle_timer:close()
+    vim.on_key(nil, key_listener_id)
+
+    callback()
+  end
+
+  local function reset_idle_timer()
+    idle_timer:stop()
+    idle_timer:start(timeout, 0, vim.schedule_wrap(on_idle))
+  end
+
+  key_listener_id = vim.on_key(function()
+    reset_idle_timer()
+  end)
+
+  -- Start the initial timer
+  reset_idle_timer()
+end
+
 local is_permission_request_open = false
 vim.api.nvim_create_autocmd("User", {
   group = vim.api.nvim_create_augroup("OpencodePermissions", { clear = true }),
   pattern = "OpencodeEvent",
   callback = function(args)
+    if not require("opencode.config").opts.permissions.enabled then
+      return
+    end
+
     local event = args.data.event
     ---@type number
     local port = args.data.port
 
     if event.type == "permission.updated" then
       --[[
-      --{
+      `event.properties` example: {
         callID = "call_UgJGOepAJ5vQ7rkfGI5LNTaQ",
         id = "per_9fe806323001XBhIAz9OrYTrgl",
         messageID = "msg_9fe805f7700166572ZsmpxllBH",
@@ -26,20 +58,29 @@ vim.api.nvim_create_autocmd("User", {
         type = "bash"
       }
       --]]
-      is_permission_request_open = true
-      vim.ui.select({ "Once", "Always", "Reject" }, {
-        prompt = 'opencode requesting permission: "' .. event.properties.title .. '": ',
-        format_item = function(item)
-          return item
-        end,
-      }, function(choice)
-        is_permission_request_open = false
-        if choice then
-          local session_id = event.properties.sessionID
-          local permission_id = event.properties.id
-          require("opencode.cli.client").permit(port, session_id, permission_id, choice:lower())
-        end
-      end)
+
+      local idle_delay_ms = require("opencode.config").opts.permissions.idle_delay_ms
+      vim.notify(
+        "`opencode` requested permission — awaiting idle…",
+        vim.log.levels.INFO,
+        { title = "opencode", timeout = idle_delay_ms }
+      )
+      wait_for_user_idle(function()
+        is_permission_request_open = true
+        vim.ui.select({ "Once", "Always", "Reject" }, {
+          prompt = 'opencode requesting permission: "' .. event.properties.title .. '": ',
+          format_item = function(item)
+            return item
+          end,
+        }, function(choice)
+          is_permission_request_open = false
+          if choice then
+            local session_id = event.properties.sessionID
+            local permission_id = event.properties.id
+            require("opencode.cli.client").permit(port, session_id, permission_id, choice:lower())
+          end
+        end)
+      end, idle_delay_ms)
     elseif event.type == "permission.replied" and is_permission_request_open then
       -- Close our permission dialog, in case user responded in the TUI
       -- TODO: Hmm, we don't seem to process the event while built-in select is open...