feat(statusline): add rudimentary statusline component

Author: NickvanDyke

README.md

@@ -11,8 +11,9 @@ https://github.com/user-attachments/assets/4dd19151-89e4-4272-abac-6710dbc6edc1
 - Select prompts from a library and define your own.
 - Inject relevant editor context (buffer, cursor, selection, diagnostics, ...).
 - Control `opencode` with commands.
-- Respond to `opencode` permission requests.
 - Auto-reload buffers edited by `opencode` in real-time.
+- Respond to `opencode` permission requests.
+- Statusline component.
 - Forward `opencode`'s Server-Sent-Events as Neovim autocmds for automation.
 - Sensible defaults with well-documented, flexible configuration and API to fit your workflow.
 
@@ -79,7 +80,7 @@ vim.g.opencode_opts = {
   ---@type opencode.Provider
   provider = {
     toggle = function(self)
-      -- Called by `require("opencode").toggle()`
+      -- Called by `require("opencode").toggle()`.
     end,
     start = function(self)
       -- Called when sending a prompt or command to `opencode` but no process was found.
@@ -117,7 +118,9 @@ vim.g.opencode_opts = {
 
 Send a prompt to `opencode`.
 
-Replaces placeholders with the corresponding context:
+#### Contexts
+
+Replaces placeholders in the prompt with the corresponding context:
 
 | Placeholder | Context |
 | - | - |
@@ -132,7 +135,9 @@ Replaces placeholders with the corresponding context:
 | `@diff` | Git diff |
 | `@grapple` | [grapple.nvim](https://github.com/cbochs/grapple.nvim) tags |
 
-Or pass a prompt name from `opts.prompts` to review, explain, and improve your code:
+#### Prompts
+
+Reference a prompt by name to review, explain, and improve your code:
 
 | Name                               | Prompt                                                    |
 |------------------------------------|-----------------------------------------------------------|
@@ -182,10 +187,6 @@ Send a [command](https://opencode.ai/docs/keybinds) to `opencode`:
 
 > Supports *all* commands — these are just the most useful ones.
 
-### 💻 Toggle — `require("opencode").toggle()`
-
-Toggle `opencode` via `opts.provider.toggle`. Usually not explicitly needed — `opencode.nvim` automatically starts and shows `opencode` via `opts.provider.start` and `opts.provider.show` when you send a prompt or command.
-
 ### 📝 Select — `require("opencode").select()`
 
 A single entrypoint to all `opencode.nvim` functionality 😄
@@ -213,6 +214,31 @@ vim.api.nvim_create_autocmd("User", {
 })
 ```
 
+### Edits
+
+When `opencode` edits a file, `opencode.nvim` automatically reloads the corresponding buffer.
+
+### Permissions
+
+When `opencode` requests a permission, `opencode.nvim` waits for idle to ask you to approve or deny it.
+
+### Statusline
+
+[lualine](https://github.com/nvim-lualine/lualine.nvim):
+
+```lua
+require("lualine").setup({
+  sections = {
+    lualine_z = {
+      {
+        require("opencode").statusline,
+      },
+    }
+  }
+})
+
+```
+
 ## 🙏 Acknowledgments
 
 - Inspired by [nvim-aider](https://github.com/GeorgesAlkhouri/nvim-aider), [neopencode.nvim](https://github.com/loukotal/neopencode.nvim), and [sidekick.nvim](https://github.com/folke/sidekick.nvim).

lua/opencode.lua

@@ -11,4 +11,6 @@ M.toggle = require("opencode.provider").toggle
 M.start = require("opencode.provider").start
 M.show = require("opencode.provider").show
 
+M.statusline = require("opencode.status").statusline
+
 return M

lua/opencode/config.lua

@@ -107,7 +107,7 @@ local defaults = {
   input = {
     prompt = "Ask opencode: ",
     -- `snacks.input`-only options
-    icon = "󱚣 ",
+    icon = "󰚩 ",
     win = {
       title_pos = "left",
       relative = "cursor",

lua/opencode/provider.lua

@@ -74,8 +74,8 @@ function M.start()
   end
 end
 
----Show `opencode` via `opts.provider`.
----Only called if `provider.toggle` or `provider.start` was previously called.
+---Show `opencode` via `opts.provider`,
+---if `provider.toggle` or `provider.start` was previously called.
 function M.show()
   if started then
     if provider and provider.show then

lua/opencode/status.lua

@@ -0,0 +1,59 @@
+local M = {}
+
+---@alias opencode.Status
+---| "idle"
+---| "error"
+---| "responding"
+---| "requesting_permission"
+
+---@type nil|opencode.Status
+local status = nil
+
+-- TODO: Still seem to not get `session.idle` events reliably... So fallback to a timer.
+-- I wonder if it's because of the SSE `on_stdout` edge case? We silently miss events, and it errors completely for some?
+local idle_timer = vim.uv.new_timer()
+
+function M.update(event)
+  if event.type == "server.connected" or event.type == "session.idle" then
+    status = "idle"
+  elseif
+    event.type == "message.updated"
+    or event.type == "message.part.updated"
+    or event.type == "permission.replied"
+  then
+    status = "responding"
+  elseif event.type == "permission.updated" then
+    status = "requesting_permission"
+  elseif event.type == "session.error" then
+    status = "error"
+  end
+
+  idle_timer:stop()
+  idle_timer:start(
+    1000,
+    0,
+    vim.schedule_wrap(function()
+      if status == "responding" then
+        status = "idle"
+      end
+    end)
+  )
+end
+
+function M.statusline()
+  -- Kinda hard to distinguish these icons, but they're fun... :D
+  -- And a nice one-char solution.
+  if status == "idle" then
+    return "󰚩"
+  elseif status == "responding" then
+    return "󱜙"
+  elseif status == "requesting_permission" then
+    return "󱚟"
+  elseif status == "error" then
+    return "󱚡"
+  else
+    return "󱚧"
+  end
+end
+
+return M

plugin/status.lua

@@ -0,0 +1,8 @@
+vim.api.nvim_create_autocmd("User", {
+  group = vim.api.nvim_create_augroup("OpencodeStatus", { clear = true }),
+  pattern = "OpencodeEvent",
+  callback = function(args)
+    require("opencode.status").update(args.data.event)
+  end,
+  desc = "Update opencode status",
+})