feat!: event API

README.md

@@ -49,7 +49,7 @@ ft('lang'):fmt('format-tool-1')
           :lint('lint-tool-1')
           :extra(extra_args)
 
--- change this anywhere in your config, these are the defaults
+-- change this anywhere in your config (or not), these are the defaults
 vim.g.guard_config = {
     -- format on write to buffer
     fmt_on_save = true,
@@ -58,7 +58,9 @@ vim.g.guard_config = {
     -- whether or not to save the buffer after formatting
     save_on_fmt = true,
     -- automatic linting
-    auto_lint = true
+    auto_lint = true,
+    -- how frequently can linters be called
+    lint_interval = 500
 }
 ```
 

lua/guard/events.lua

@@ -18,7 +18,7 @@ local function debounced_lint(opt)
   end
   ---@diagnostic disable-next-line: undefined-field
   debounce_timer = assert(uv.new_timer()) --[[uv_timer_t]]
-  debounce_timer:start(500, 0, function()
+  debounce_timer:start(util.getopt('lint_interval'), 0, function()
     debounce_timer:stop()
     debounce_timer:close()
     debounce_timer = nil
@@ -172,7 +172,7 @@ end
 
 ---@param ft string
 ---@param formatters FmtConfig[]
-function M.fmt_watch_ft(ft, formatters)
+function M.fmt_on_ft(ft, formatters)
   -- check if all cmds executable before registering formatter
   iter(formatters):any(function(config)
     if type(config) == 'table' and config.cmd and vim.fn.executable(config.cmd) ~= 1 then
@@ -208,7 +208,7 @@ function M.maybe_default_to_lsp(config, ft, buf)
         pattern = ft,
       }) == 0
     then
-      M.fmt_watch_ft(ft, config.formatter)
+      M.fmt_on_ft(ft, config.formatter)
     end
     M.try_attach_fmt_to_buf(buf)
   end
@@ -234,7 +234,7 @@ end
 
 ---@param ft string
 ---@param events string[]
-function M.lint_watch_ft(ft, events)
+function M.lint_on_ft(ft, events)
   iter(require('guard.filetype')[ft].linter):any(function(config)
     if config.cmd and vim.fn.executable(config.cmd) ~= 1 then
       report_error(config.cmd .. ' not executable')

lua/guard/filetype.lua

@@ -78,7 +78,7 @@ local function box(ft)
         -- use user's custom events
         events.fmt_attach_custom(it, config.events)
       else
-        events.fmt_watch_ft(it, self.formatter)
+        events.fmt_on_ft(it, self.formatter)
         events.fmt_attach_to_existing(it)
       end
     end
@@ -105,7 +105,7 @@ local function box(ft)
         -- use user's custom events
         events.lint_attach_custom(it, config)
       else
-        events.lint_watch_ft(it, evs)
+        events.lint_on_ft(it, evs)
         events.lint_attach_to_existing(it, evs)
       end
     end

lua/guard/util.lua

@@ -174,6 +174,7 @@ function M.getopt(opt)
     lsp_as_default_formatter = false,
     save_on_fmt = true,
     auto_lint = true,
+    lint_interval = 500,
   }
   if
     not vim.g.guard_config