debounce the highlight requests

lua/go.lua

@@ -182,6 +182,7 @@ _GO_NVIM_CFG = {
     highlight = false, -- set to true to disable
     queries = nil, -- set to a table of queries to use for comment highlight see comment.lua
     highlight_groups = nil,
+    highlight_debounce = 1000, -- 1000ms
   },
 }
 

lua/go/comment.lua

@@ -311,10 +311,15 @@ local function highlight_go_code_in_comments()
   end
 end
 
+---@diagnostic disable-next-line: unused-local
 local function toggle_go_comment_highlight()
   _GO_NVIM_CFG.comment.highlight = not _GO_NVIM_CFG.comment.highlight
   if _GO_NVIM_CFG.comment.highlight then
-    highlight_go_code_in_comments()
+    highlight = require('go.utils').throttle(
+      highlight_go_code_in_comments,
+      _GO_NVIM_CFG.comment.highlight_debounce
+    )
+    highlight()
   else
     vim.api.nvim_buf_clear_namespace(0, ns_id, 0, -1)
   end
@@ -327,12 +332,17 @@ vim.api.nvim_create_user_command('ToggleGoCommentHighlight', function()
   require('go.comment').toggle_highlight()
 end, {})
 
+local group = vim.api.nvim_create_augroup('gonvim__comment_hl', {})
 vim.api.nvim_create_autocmd(
-  { 'BufEnter', 'BufWritePost', 'WinEnter', 'TextChanged', 'InsertLeave' },
+  { 'BufEnter', 'BufWritePost', 'WinEnter', 'InsertLeave', 'CursorHold' },
   {
     pattern = { '*.go' },
-    callback = function()
+    group = group,
+    callback = function(opts)
       if _GO_NVIM_CFG.comment.highlight then
+        if opts.event == 'CursorHold' then
+          -- can be slow
+        end
         require('go.comment').highlight()
       end
     end,

lua/go/utils.lua

@@ -863,21 +863,6 @@ utils.throttle = function(func, duration)
   return inner, timer
 end
 
--- function M.debounce_trailing(ms, fn)
---   local timer = uv.new_timer()
---   return function(...)
---     local argv = { ... }
---     if timer:is_active() then
---       timer:stop()
---       return
---     end
---     timer:start(ms, 0, function()
---       timer:stop()
---       fn(unpack(argv))
---     end)
---   end
--- end
---
 utils.debounce = function(func, ms)
   local timer = uv.new_timer()
   local function inner(...)
@@ -898,7 +883,7 @@ utils.extract_filepath = function(msg, pkg_path)
   msg = msg or ''
   -- util.log(msg)
   --[[     or [[    findAllSubStr_test.go:234: Error inserting caseResult1: operation error DynamoDB: PutItem, exceeded maximum number of attempts]]
-  -- or 'path/path2/filename.go:50:11: Error invaild
+  -- or 'path/path2/filename.go:50:11: Error invalid
   -- or /home/ray/go/src/github/sample/app/driver.go:342 +0x19e5
   local ma = fn.matchlist(msg, [[\v\s*(\w+.+\.go):(\d+):]])
   ma = ma or fn.matchlist(msg, [[\v\s*(\w+.+\.go):(\d+)]])