feat: add open_url config option (#403)

Implement functionality discussed in #402.

---------

Co-authored-by: Github Actions <actions@github>

doc/haskell-tools.txt

@@ -91,6 +91,8 @@ haskell-tools.tools.Opts                              *haskell-tools.tools.Opts*
                                                         fast-tags module options.
         {log?}         (haskell-tools.log.Opts)
                                                         haskell-tools logger options.
+        {open_url?}    (fun(url:string))
+                                                        custom action for opening a url
 
 
 haskell-tools.codeLens.Opts                        *haskell-tools.codeLens.Opts*

lua/haskell-tools/config/check.lua

@@ -93,6 +93,13 @@ function Check.validate(cfg)
   if not ok then
     return false, err
   end
+  local open_url = tools.open_url
+  ok, err = validate('tools.open_url', {
+    open_url = { open_url, 'function' },
+  })
+  if not ok then
+    return false, err
+  end
   local repl = tools.repl
   local valid_handlers = { 'builtin', 'toggleterm' }
   local valid_backends = { 'cabal', 'stack' }

lua/haskell-tools/config/init.lua

@@ -67,6 +67,9 @@ vim.g.haskell_tools = vim.g.haskell_tools
 ---
 ---haskell-tools logger options.
 ---@field log? haskell-tools.log.Opts
+---
+---custom action for opening a url
+---@field open_url? fun(url: string)
 
 ---@class haskell-tools.codeLens.Opts
 ---

lua/haskell-tools/config/internal.lua

@@ -117,6 +117,10 @@ local HTDefaultConfig = {
       ---@see vim.log.levels
       level = vim.log.levels.WARN,
     },
+    ---@type fun(url: string) custom action for opening url
+    open_url = function(url)
+      require('haskell-tools.os').open_browser(url)
+    end,
   },
   ---@class haskell-tools.lsp.ClientConfig haskell-language-server client options.
   hls = {

lua/haskell-tools/hoogle/helpers.lua

@@ -12,7 +12,6 @@
 ---@brief ]]
 
 local deps = require('haskell-tools.deps')
-local OS = require('haskell-tools.os')
 local actions = deps.require_telescope('telescope.actions')
 local actions_state = deps.require_telescope('telescope.actions.state')
 local entry_display = deps.require_telescope('telescope.pickers.entry_display')
@@ -34,7 +33,7 @@ function Helpers.hoogle_attach_mappings(buf, map)
   map('i', '<C-b>', function()
     -- Open in browser
     local entry = actions_state.get_selected_entry()
-    OS.open_browser(entry.url)
+    require('haskell-tools.config.internal').tools.open_url(entry.url)
   end)
   map('i', '<C-r>', function()
     -- Replace word under cursor

lua/haskell-tools/hoogle/web.lua

@@ -9,7 +9,6 @@
 
 local log = require('haskell-tools.log.internal')
 local deps = require('haskell-tools.deps')
-local OS = require('haskell-tools.os')
 
 ---@class haskell-tools.hoogle.handler.Web
 local WebHoogleHandler = {}
@@ -122,7 +121,8 @@ function WebHoogleHandler.browser_search(search_term, opts)
   opts = vim.tbl_deep_extend('keep', opts or {}, {
     hoogle = { json = false },
   })
-  OS.open_browser(mk_hoogle_request(search_term, opts))
+  local HTConfig = require('haskell-tools.config.internal')
+  HTConfig.tools.open_url(mk_hoogle_request(search_term, opts))
 end
 
 return WebHoogleHandler

lua/haskell-tools/lsp/hover.lua

@@ -9,7 +9,6 @@
 local log = require('haskell-tools.log.internal')
 local lsp_util = vim.lsp.util
 local HtParser = require('haskell-tools.parser')
-local OS = require('haskell-tools.os')
 local HtProjectHelpers = require('haskell-tools.project.helpers')
 
 local hover = {}
@@ -142,6 +141,7 @@ end
 ---@return number|nil winnr
 function hover.on_hover(_, result, ctx, config)
   local ht = require('haskell-tools')
+  local HTConfig = require('haskell-tools.config.internal')
   config = config or {}
   config.focus_id = ctx.method
   if vim.api.nvim_get_current_buf() ~= ctx.bufnr then
@@ -193,7 +193,7 @@ function hover.on_hover(_, result, ctx, config)
       local uri = string.match(value, '%[Documentation%]%((.+)%)')
       local action = function()
         log.debug { 'Hover: Open documentation in browser', uri }
-        OS.open_browser(uri)
+        HTConfig.tools.open_url(uri)
         close_hover()
       end
       table.insert(_state.commands, action)
@@ -205,7 +205,7 @@ function hover.on_hover(_, result, ctx, config)
       local uri = string.match(value, '%[Source%]%((.+)%)')
       local action = function()
         log.debug { 'Hover: View source in browser', uri }
-        OS.open_browser(uri)
+        HTConfig.tools.open_url(uri)
         close_hover()
       end
       table.insert(_state.commands, action)
@@ -311,7 +311,6 @@ function hover.on_hover(_, result, ctx, config)
     table.insert(markdown_lines, #actions + 1, '')
     table.insert(markdown_lines, #actions + 1, '')
   end
-  local HTConfig = require('haskell-tools.config.internal')
   local opts = HTConfig.tools.hover
   config = vim.tbl_extend('keep', {
     border = opts.border,