feat(hooks): hooks for edit filed, session loaded

Fixes #97

Author: cameronr

lua/opencode/config.lua

@@ -182,6 +182,10 @@ M.defaults = {
     show_ids = false,
   },
   prompt_guard = nil,
+  hooks = {
+    on_file_edited = nil,
+    on_session_loaded = nil,
+  },
 }
 
 M.values = vim.deepcopy(M.defaults)

lua/opencode/types.lua

@@ -135,8 +135,12 @@
 ---@field capture_streamed_events boolean
 ---@field show_ids boolean
 
---- @class OpencodeProviders
---- @field [string] string[]
+---@class OpencodeHooks
+---@field on_file_edited? fun(file: string): nil
+---@field on_session_loaded? fun(session: Session): nil
+
+---@class OpencodeProviders
+---@field [string] string[]
 
 ---@class OpencodeConfigModule
 ---@field defaults OpencodeConfig
@@ -156,6 +160,7 @@
 ---@field context OpencodeContextConfig
 ---@field debug OpencodeDebugConfig
 ---@field prompt_guard? fun(mentioned_files: string[]): boolean
+---@field hooks OpencodeHooks
 ---@field legacy_commands boolean
 
 ---@class MessagePartState

lua/opencode/ui/renderer.lua

@@ -166,6 +166,10 @@ function M._render_full_session_data(session_data)
     M._set_model_from_messages()
   end
   M.scroll_to_bottom()
+
+  if config.hooks and config.hooks.on_session_loaded then
+    pcall(config.hooks.on_session_loaded, state.active_session)
+  end
 end
 
 ---Render lines as the entire output buffer
@@ -805,8 +809,11 @@ function M.on_permission_replied(properties)
   end
 end
 
-function M.on_file_edited(_)
+function M.on_file_edited(properties)
   vim.cmd('checktime')
+  if config.hooks and config.hooks.on_file_edited then
+    pcall(config.hooks.on_file_edited, properties.file)
+  end
 end
 
 ---@param properties RestorePointCreatedEvent

tests/unit/hooks_spec.lua

@@ -0,0 +1,110 @@
+local renderer = require('opencode.ui.renderer')
+local config = require('opencode.config')
+local state = require('opencode.state')
+local helpers = require('tests.helpers')
+local ui = require('opencode.ui.ui')
+
+describe('hooks', function()
+  before_each(function()
+    helpers.replay_setup()
+    config.hooks = {
+      on_file_edited = nil,
+      on_session_loaded = nil,
+    }
+  end)
+
+  after_each(function()
+    if state.windows then
+      ui.close_windows(state.windows)
+    end
+    config.hooks = {
+      on_file_edited = nil,
+      on_session_loaded = nil,
+    }
+  end)
+
+  describe('on_file_edited', function()
+    it('should call hook when file is edited', function()
+      local called = false
+      local file_path = nil
+
+      config.hooks.on_file_edited = function(file)
+        called = true
+        file_path = file
+      end
+
+      local test_event = { file = '/test/file.lua' }
+      renderer.on_file_edited(test_event)
+
+      assert.is_true(called)
+      assert.are.equal('/test/file.lua', file_path)
+    end)
+
+    it('should not error when hook is nil', function()
+      config.hooks.on_file_edited = nil
+
+      local test_event = { file = '/test/file.lua' }
+      assert.has_no.errors(function()
+        renderer.on_file_edited(test_event)
+      end)
+    end)
+
+    it('should not crash when hook throws error', function()
+      config.hooks.on_file_edited = function()
+        error('test error')
+      end
+
+      local test_event = { file = '/test/file.lua' }
+      assert.has_no.errors(function()
+        renderer.on_file_edited(test_event)
+      end)
+    end)
+  end)
+
+  describe('on_session_loaded', function()
+    it('should call hook when session is loaded', function()
+      local called = false
+      local session_data = nil
+
+      config.hooks.on_session_loaded = function(session)
+        called = true
+        session_data = session
+      end
+
+      local events = helpers.load_test_data('tests/data/simple-session.json')
+      state.active_session = helpers.get_session_from_events(events, true)
+      local loaded_session = helpers.load_session_from_events(events)
+
+      renderer._render_full_session_data(loaded_session)
+
+      assert.is_true(called)
+      assert.are.same(state.active_session, session_data)
+    end)
+
+    it('should not error when hook is nil', function()
+      config.hooks.on_session_loaded = nil
+
+      local events = helpers.load_test_data('tests/data/simple-session.json')
+      state.active_session = helpers.get_session_from_events(events, true)
+      local loaded_session = helpers.load_session_from_events(events)
+
+      assert.has_no.errors(function()
+        renderer._render_full_session_data(loaded_session)
+      end)
+    end)
+
+    it('should not crash when hook throws error', function()
+      config.hooks.on_session_loaded = function()
+        error('test error')
+      end
+
+      local events = helpers.load_test_data('tests/data/simple-session.json')
+      state.active_session = helpers.get_session_from_events(events, true)
+      local loaded_session = helpers.load_session_from_events(events)
+
+      assert.has_no.errors(function()
+        renderer._render_full_session_data(loaded_session)
+      end)
+    end)
+  end)
+end)