feat: add type annotations for modules

lewis6991 · Nov 14, 2024 · ac5aba6 · ac5aba6
1 parent 9521fe8
commit ac5aba6
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 1 deletion.
diff --git a/lua/gitsigns.lua b/lua/gitsigns.lua
@@ -7,6 +7,7 @@ local config = Config.config
 local api = vim.api
 local uv = vim.uv or vim.loop
 
+--- @class gitsigns.main
 local M = {}
 
 local cwd_watcher ---@type uv.uv_fs_event_t?
@@ -222,7 +223,8 @@ function M.setup(cfg)
   setup_cwd_head()
 end
 
-return setmetatable(M, {
+--- @type gitsigns.main|gitsigns.actions|gitsigns.attach|gitsigns.debug
+M = setmetatable(M, {
   __index = function(_, f)
     local attach = require('gitsigns.attach')
     if attach[f] then
@@ -242,3 +244,5 @@ return setmetatable(M, {
     end
   end,
 })
+
+return M
diff --git a/lua/gitsigns/actions.lua b/lua/gitsigns/actions.lua
@@ -14,6 +14,7 @@ local cache = require('gitsigns.cache').cache
 local api = vim.api
 local current_buf = api.nvim_get_current_buf
 
+--- @class gitsigns.actions
 local M = {}
 
 --- @class Gitsigns.CmdParams.Smods

diff --git a/lua/gitsigns/attach.lua b/lua/gitsigns/attach.lua
@@ -15,6 +15,7 @@ local throttle_by_id = require('gitsigns.debounce').throttle_by_id
 local api = vim.api
 local uv = vim.loop
 
+--- @class gitsigns.attach
 local M = {}
 
 --- @param name string

diff --git a/lua/gitsigns/debug.lua b/lua/gitsigns/debug.lua
@@ -1,5 +1,6 @@
 local log = require('gitsigns.debug.log')
 
+--- @class gitsigns.debug
 local M = {}
 
 --- @param raw_item any