chore(types): add some type annotations

Author: broken-pen

lua/orgmode/events/types/headline_demoted_event.lua

@@ -8,6 +8,7 @@ local HeadlineDemotedEvent = {
 
 ---@param headline OrgHeadline
 ---@param old_level number
+---@return OrgHeadlineDemotedEvent
 function HeadlineDemotedEvent:new(headline, old_level)
   local obj = setmetatable({}, self)
   self.__index = self

lua/orgmode/events/types/headline_promoted_event.lua

@@ -7,6 +7,7 @@ local HeadlinePromotedEvent = {
 
 ---@param headline OrgHeadline
 ---@param old_level number
+---@return OrgHeadlinePromotedEvent
 function HeadlinePromotedEvent:new(headline, old_level)
   local obj = setmetatable({}, self)
   self.__index = self

lua/orgmode/events/types/todo_changed_event.lua

@@ -10,6 +10,7 @@ local TodoChangedEvent = {
 ---@param headline OrgHeadline
 ---@param old_todo_state? string
 ---@param was_done? boolean
+---@return OrgTodoChangedEvent
 function TodoChangedEvent:new(headline, old_todo_state, was_done)
   local obj = setmetatable({}, self)
   self.__index = self

lua/orgmode/org/links/init.lua

@@ -67,7 +67,7 @@ function OrgLinks:store_link_to_headline(headline)
 end
 
 ---@param headline OrgHeadline
----@return string
+---@return string url
 function OrgLinks:get_link_to_headline(headline)
   local title = headline:get_title()
 
@@ -82,7 +82,7 @@ function OrgLinks:get_link_to_headline(headline)
 end
 
 ---@param file OrgFile
----@return string
+---@return string url
 function OrgLinks:get_link_to_file(file)
   local title = file:get_title()
 

lua/orgmode/org/links/types/id.lua

@@ -56,7 +56,7 @@ end
 
 ---@private
 ---@param link string
----@return string
+---@return string | nil
 function OrgLinkId:_parse(link)
   return link:match('^id:(.+)$')
 end

lua/orgmode/ui/menu.lua

@@ -23,6 +23,7 @@ local config = require('orgmode.config')
 local Menu = {}
 
 ---@param data OrgMenuOpts
+---@return OrgMenu
 function Menu:new(data)
   self:_validate_data(data)
 

lua/orgmode/utils/fs.lua

@@ -38,6 +38,7 @@ function M.get_real_path(filepath)
   return real or false
 end
 
+---@return string
 function M.get_current_file_dir()
   local current_file = utils.current_file_path()
   local current_dir = vim.fn.fnamemodify(current_file, ':p:h')

lua/orgmode/utils/init.lua

@@ -53,6 +53,9 @@ function utils.readfile(file, opts)
   end)
 end
 
+---@param file string
+---@param data string|string[]
+---@return OrgPromise<integer> bytes
 function utils.writefile(file, data)
   return Promise.new(function(resolve, reject)
     uv.fs_open(file, 'w', 438, function(err1, fd)
@@ -502,6 +505,7 @@ function utils.is_list(value)
   if vim.islist then
     return vim.islist(value)
   end
+  ---@diagnostic disable-next-line deprecated
   return vim.tbl_islist(value)
 end