fix(typings): make it useful for diagnoistics

chrishrb · Aug 6, 2024 · a65e6cc · a65e6cc
1 parent d921f21
commit a65e6cc
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 12 deletions.
diff --git a/lua/gx/handler.lua b/lua/gx/handler.lua
@@ -12,6 +12,9 @@ local search_handler = require("gx.handlers.search")
 
 local M = {}
 
+---@param handlers table<string, boolean|GxHandler>
+---@param handler boolean|GxHandler
+---@param active boolean
 local function add_handler(handlers, handler, active)
   if
     active == false
@@ -23,7 +26,7 @@ local function add_handler(handlers, handler, active)
   handlers[#handlers + 1] = handler
 end
 
----@param handlers { [string]: (boolean | GxHandler)[] }
+---@param handlers table<string, boolean|GxHandler>
 ---@return GxHandler[]
 local function resolve_handlers(handlers)
   local resolved = {}
@@ -55,8 +58,9 @@ end
 -- handler function
 ---@param mode string
 ---@param line string
----@param configured_handlers { [string]: (boolean | GxHandler)[] }
----@return { [number]: GxSelection }
+---@param configured_handlers table<string, boolean|GxHandler>
+---@param handler_options GxHandlerOptions
+---@return GxSelection[]
 function M.get_url(mode, line, configured_handlers, handler_options)
   local detected_urls_set = {}
   local detected_urls = {}

diff --git a/lua/gx/handlers/brewfile.lua b/lua/gx/handlers/brewfile.lua
@@ -1,5 +1,6 @@
 local helper = require("gx.helper")
 
+---@type GxHandler
 local M = {
   -- only Brewfile
   name = "brewfile",

diff --git a/lua/gx/handlers/commit.lua b/lua/gx/handlers/commit.lua
@@ -1,5 +1,6 @@
 local helper = require("gx.helper")
 
+---@type GxHandler
 local M = {
   -- every filetype and filename
   name = "commit",
@@ -20,7 +21,7 @@ function M.handle(mode, line, handler_options)
     remotes = remotes(vim.fn.expand("%:p"))
   end
 
-  local push = handler_options.push
+  local push = handler_options.git_remote_push
   if type(push) == "function" then
     push = push(vim.fn.expand("%:p"))
   end

diff --git a/lua/gx/handlers/cve.lua b/lua/gx/handlers/cve.lua
@@ -1,5 +1,6 @@
 local helper = require("gx.helper")
 
+---@type GxHandler
 local M = {
   -- every filetype and filename
   name = "cve",

diff --git a/lua/gx/handlers/github.lua b/lua/gx/handlers/github.lua
@@ -1,5 +1,6 @@
 local helper = require("gx.helper")
 
+---@type GxHandler
 local M = {
   -- every filetype and filename
   name = "github",
@@ -26,7 +27,7 @@ function M.handle(mode, line, handler_options)
     remotes = remotes(vim.fn.expand("%:p"))
   end
 
-  local push = handler_options.push
+  local push = handler_options.git_remote_push
   if type(push) == "function" then
     push = push(vim.fn.expand("%:p"))
   end

diff --git a/lua/gx/handlers/go.lua b/lua/gx/handlers/go.lua
@@ -1,3 +1,4 @@
+---@type GxHandler
 local M = {
   -- every filetype and filename
   name = "go",

diff --git a/lua/gx/handlers/markdown.lua b/lua/gx/handlers/markdown.lua
@@ -1,5 +1,6 @@
 local helper = require("gx.helper")
 
+---@type GxHandler
 local M = {
   -- every filetype and filename
   name = "markdown",

diff --git a/lua/gx/handlers/package_json.lua b/lua/gx/handlers/package_json.lua
@@ -1,5 +1,6 @@
 local helper = require("gx.helper")
 
+---@type GxHandler
 local M = {
   -- only package.json
   name = "package_json",

diff --git a/lua/gx/init.lua b/lua/gx/init.lua
@@ -6,22 +6,24 @@ local M = {}
 
 ---@class GxHandlerOptions
 ---@field search_engine string
----@field select_for_search string
+---@field select_for_search boolean
+---@field git_remotes string[]
+---@field git_remote_push boolean
 
 ---@class GxHandler
 ---@field name string
----@field filetypes string[] | nil
----@field filename string | nil
----@field handle fun(mode: string, line: string, handler_options: GxHandlerOptions | nil)
+---@field filetype string[]?
+---@field filename string?
+---@field handle fun(mode: string, line: string, handler_options: GxHandlerOptions): string?
 
 ---@class GxOptions
 ---@field open_browser_app string
 ---@field open_browser_args string[]
----@field handlers (boolean | GxHandler)[]
----@field handler_options GxHandlerOptions | nil
+---@field handlers table<string, boolean|GxHandler>
+---@field handler_options GxHandlerOptions
 
 ---@class GxSelection
----@field name string | nil
+---@field name string?
 ---@field url string
 
 -- search for url with handler
@@ -87,6 +89,7 @@ local function get_open_browser_args()
   return args
 end
 
+---@param options GxOptions
 local function with_defaults(options)
   options = options or {}
   options.handler_options = options.handler_options or {}