chore: Fix types

kristijanhusak · kristijanhusak · commit 4007436cd7a9 · 2023-05-30T12:05:46.000+02:00
diff --git a/lua/orgmode/agenda/init.lua b/lua/orgmode/agenda/init.lua
@@ -10,6 +10,7 @@ local AgendaTodosView = require('orgmode.agenda.views.todos')
 local AgendaTagsView = require('orgmode.agenda.views.tags')
 local AgendaView = require('orgmode.agenda.views.agenda')
 local Menu = require('orgmode.ui.menu')
+local Promise = require('orgmode.utils.promise')
 
 ---@class Agenda
 ---@field content table[]
@@ -406,7 +407,7 @@ function Agenda:_remote_edit(opts)
   end
   local update = Files.update_file(item.file, function(_)
     vim.fn.cursor({ item.file_position, 0 })
-    return utils.promisify(require('orgmode').action(action)):next(function()
+    return Promise.resolve(require('orgmode').action(action)):next(function()
       return Files.get_closest_headline()
     end)
   end)
diff --git a/lua/orgmode/api/headline.lua b/lua/orgmode/api/headline.lua
@@ -5,6 +5,7 @@ local OrgPosition = require('orgmode.api.position')
 local PriorityState = require('orgmode.objects.priority_state')
 local Date = require('orgmode.objects.date')
 local Calendar = require('orgmode.objects.calendar')
+local Promise = require('orgmode.utils.promise')
 
 ---@class OrgHeadline
 ---@field title string headline title without todo keyword, tags and priority. Ex. `* TODO I am a headline  :SOMETAG:` returns `I am a headline`
@@ -218,7 +219,7 @@ function OrgHeadline:_do_action(action)
   return Files.update_file(self.file.filename, function()
     local view = vim.fn.winsaveview()
     vim.fn.cursor({ self.position.start_line, 0 })
-    return utils.promisify(action()):next(function()
+    return Promise.resolve(action()):next(function()
       vim.fn.winrestview(view)
       return self:reload()
     end)
diff --git a/lua/orgmode/capture/templates.lua b/lua/orgmode/capture/templates.lua
@@ -40,7 +40,7 @@ local Templates = {}
 -- TODO Introduce type
 function Templates:new()
   local opts = {}
-  opts.templates = config.org_agenda_templates or config.org_capture_templates
+  opts.templates = config.org_capture_templates
   setmetatable(opts, self)
   self.__index = self
   return opts
@@ -132,6 +132,7 @@ function Templates:_compile_expressions(content)
   for exp in content:gmatch('%%%b()') do
     local snippet = exp:match('%((.*)%)')
     local func = load(snippet)
+    ---@diagnostic disable-next-line: param-type-mismatch
     local ok, response = pcall(func)
     if ok then
       content = content:gsub(vim.pesc(exp), response)
diff --git a/lua/orgmode/clock/init.lua b/lua/orgmode/clock/init.lua
@@ -17,6 +17,9 @@ end
 function Clock:org_clock_in()
   local item = Files.get_closest_headline()
   local last_clocked_headline = Files.get_clocked_headline()
+  if not item then
+    return
+  end
   if item:is_clocked_in() then
     return utils.echo_info(string.format('Clock continues in "%s"', item.title))
   end
@@ -41,6 +44,9 @@ end
 
 function Clock:org_clock_out()
   local item = Files.get_closest_headline()
+  if not item then
+    return
+  end
   if not item:is_clocked_in() then
     return
   end
@@ -51,6 +57,9 @@ end
 
 function Clock:org_clock_cancel()
   local item = Files.get_closest_headline()
+  if not item then
+    return
+  end
   if not item:is_clocked_in() then
     return utils.echo_info('No active clock')
   end
diff --git a/lua/orgmode/clock/report.lua b/lua/orgmode/clock/report.lua
@@ -45,7 +45,7 @@ function ClockReport:draw_for_agenda(start_line)
     table.insert(data, 'hr')
   end
 
-  local clock_table = Table.from_list(data, start_line):compile()
+  local clock_table = Table.from_list(data, start_line, 0):compile()
   self.table = clock_table
   local result = {}
   for i, row in ipairs(clock_table.rows) do
@@ -111,25 +111,25 @@ end
 ---@param to Date
 ---@return ClockReport
 function ClockReport.from_date_range(from, to)
-  local report = {
-    from = from,
-    to = to,
-    total_duration = 0,
-    files = {},
-  }
+  local total_duration = 0
+  local files = {}
   for _, orgfile in ipairs(Files.all()) do
     local file_clocks = orgfile:get_clock_report(from, to)
     if #file_clocks.headlines > 0 then
-      report.total_duration = report.total_duration + file_clocks.total_duration.minutes
-      table.insert(report.files, {
+      total_duration = total_duration + file_clocks.total_duration.minutes
+      table.insert(files, {
         name = orgfile.category .. '.org',
         total_duration = file_clocks.total_duration,
         headlines = file_clocks.headlines,
       })
     end
   end
-  report.total_duration = Duration.from_minutes(report.total_duration)
-  return ClockReport:new(report)
+  return ClockReport:new({
+    from = from,
+    to = to,
+    total_duration = Duration.from_minutes(total_duration),
+    files = files,
+  })
 end
 
 return ClockReport
diff --git a/lua/orgmode/colors/highlights.lua b/lua/orgmode/colors/highlights.lua
@@ -101,7 +101,7 @@ end
 function M.define_org_headline_colors(faces)
   local headline_colors = { 'Title', 'Constant', 'Identifier', 'Statement', 'PreProc', 'Type', 'Special', 'String' }
   local ts_highlights_enabled = config:ts_highlights_enabled()
-  local all_keywords = {}
+  local all_keywords = ''
   if not ts_highlights_enabled then
     local todo_keywords = config:get_todo_keywords()
     all_keywords = table.concat(todo_keywords.ALL, [[\|]])
@@ -117,7 +117,6 @@ function M.define_org_headline_colors(faces)
     vim.cmd([[hi default OrgHideLeadingStars ctermfg=0 guifg=bg]])
     table.insert(contains, 'OrgHideLeadingStars')
   end
-  contains = table.concat(contains, ',')
   for i, color in ipairs(headline_colors) do
     local j = i
     while j < 40 do
@@ -128,7 +127,7 @@ function M.define_org_headline_colors(faces)
             j,
             j,
             all_keywords,
-            contains
+            table.concat(contains, ',')
           )
         )
       end
diff --git a/lua/orgmode/config/init.lua b/lua/orgmode/config/init.lua
@@ -292,6 +292,7 @@ function Config:setup_mappings(category, buffer)
   end
 end
 
+---@return string|nil
 function Config:parse_archive_location(file, archive_loc)
   if self:is_archive_file(file) then
     return nil
diff --git a/lua/orgmode/init.lua b/lua/orgmode/init.lua
@@ -40,7 +40,6 @@ function Org:init()
 end
 
 ---@param file? string
----@return string
 function Org:reload(file)
   self:init()
   return self.files.reload(file)
@@ -122,7 +121,7 @@ local function setup(opts)
 end
 
 ---@param file? string
----@return Org
+---@return Org|nil
 local function reload(file)
   if not instance then
     return
@@ -146,7 +145,7 @@ local function set_dot_repeat(cmd, opts)
 end
 
 ---@param cmd string
----@param opts? table
+---@param opts? any
 local function action(cmd, opts)
   local parts = vim.split(cmd, '.', true)
   if not instance or #parts < 2 then
diff --git a/lua/orgmode/objects/calendar.lua b/lua/orgmode/objects/calendar.lua
@@ -137,10 +137,9 @@ function Calendar.render()
   local content = vim.tbl_map(function(item)
     return ' ' .. table.concat(item, '   ') .. ' '
   end, cal_rows)
-  weekday_row = ' ' .. table.concat(weekday_row, '  ')
 
   -- put it all together
-  table.insert(content, 1, weekday_row)
+  table.insert(content, 1, ' ' .. table.concat(weekday_row, '  '))
   table.insert(content, 1, title)
   -- TODO: redundant, since it's static data
   table.insert(content, ' [<] - prev month  [>] - next month')
diff --git a/lua/orgmode/objects/help.lua b/lua/orgmode/objects/help.lua
@@ -275,7 +275,7 @@ function Help.prepare_content(opts)
 
   local prepare_func = Help['_prepare_' .. t]
   if not prepare_func then
-    return
+    return {}
   end
 
   local content, include_generic = prepare_func(mappings, max_height)
diff --git a/lua/orgmode/objects/priority_state.lua b/lua/orgmode/objects/priority_state.lua
@@ -23,7 +23,7 @@ function PriorityState:new(priority)
   return o
 end
 
----@return string
+---@return string|nil
 function PriorityState:prompt_user()
   local prompt = string.format('Priority %s-%s, <Space> to remove: ', self.high_priority, self.low_priority)
   local choice = vim.fn.input(prompt)
diff --git a/lua/orgmode/org/autocompletion/omni.lua b/lua/orgmode/org/autocompletion/omni.lua
@@ -86,6 +86,7 @@ local headline_contexts = {
   todo_keywords,
 }
 
+---@return table
 local function omni(findstart, base)
   local line = vim.api.nvim_get_current_line():sub(1, vim.api.nvim_call_function('col', { '.' }) - 1)
   local is_headline = line:match('^%*+%s+')
diff --git a/lua/orgmode/org/hyperlinks.lua b/lua/orgmode/org/hyperlinks.lua
@@ -101,7 +101,7 @@ function Hyperlinks.find_by_dedicated_target(ctx)
       table.insert(targets, m)
     end
     for _, content in ipairs(headline.content) do
-      for m in content.line:lower():gmatch(term) do
+      for m in content:lower():gmatch(term) do
         table.insert(targets, m)
       end
     end
diff --git a/lua/orgmode/org/text_objects.lua b/lua/orgmode/org/text_objects.lua
@@ -61,7 +61,10 @@ local function do_selection(ranges, exclude_stars)
 end
 
 local function current_heading(exclude_stars)
-  do_selection(get_current_section_range(), exclude_stars)
+  local range = get_current_section_range()
+  if range then
+    do_selection(range, exclude_stars)
+  end
 end
 
 local function current_subtree(exclude_stars)
diff --git a/lua/orgmode/parser/file.lua b/lua/orgmode/parser/file.lua
@@ -6,7 +6,7 @@ local config = require('orgmode.config')
 local utils = require('orgmode.utils')
 
 ---@class File
----@field tree table
+---@field tree userdata
 ---@field file_content string[]
 ---@field file_content_str string
 ---@field category string
@@ -16,7 +16,7 @@ local utils = require('orgmode.utils')
 ---@field sections_by_line table<number, Section>
 ---@field source_code_filetypes string[]
 ---@field is_archive_file boolean
----@field archive_location string
+---@field archive_location string|nil
 ---@field clocked_headline Section
 ---@field tags string[]
 local File = {}
@@ -108,20 +108,20 @@ function File:get_unfinished_todo_entries()
   end, self.sections)
 end
 
----@param node table
+---@param node userdata
 ---@return string
 function File:get_node_text(node)
   return utils.get_node_text(node, self.file_content)[1] or ''
 end
 
----@param node table
+---@param node userdata
 ---@return string[]
 function File:get_node_text_list(node)
   return utils.get_node_text(node, self.file_content) or {}
 end
 
 ---@param query string
----@param node table|nil
+---@param node userdata|nil
 ---@return table[]
 function File:get_ts_matches(query, node)
   return utils.get_ts_matches(query, node or self.tree:root(), self.file_content, self.file_content_str)
@@ -163,7 +163,7 @@ function File.load(path, callback)
   )
 end
 
----@param content string|table
+---@param content table
 ---@param category? string
 ---@param filename? string
 ---@param is_archive_file? boolean
@@ -247,7 +247,7 @@ end
 
 ---@param search_term string
 ---@param no_escape boolean
----@param ignore_archive_flag boolean
+---@param ignore_archive_flag? boolean
 ---@return Section[]
 function File:find_headlines_matching_search_term(search_term, no_escape, ignore_archive_flag)
   if self.is_archive_file and not ignore_archive_flag then
@@ -295,7 +295,7 @@ function File:get_node_at_cursor(cursor)
 end
 
 ---@param id? string
----@return Section
+---@return Section|nil
 function File:get_closest_headline(id)
   local node = nil
   if not id then
@@ -329,22 +329,22 @@ end
 ---@param to Date
 ---@return table
 function File:get_clock_report(from, to)
-  local result = {
-    total_duration = 0,
-    headlines = {},
-  }
+  local total_duration = 0
+  local headlines = {}
   for _, section in ipairs(self.sections) do
     if section.logbook then
       local minutes = section.logbook:get_total_minutes(from, to)
       if minutes > 0 then
-        table.insert(result.headlines, section)
-        result.total_duration = result.total_duration + minutes
+        table.insert(headlines, section)
+        total_duration = total_duration + minutes
       end
     end
   end
 
-  result.total_duration = Duration.from_minutes(result.total_duration)
-  return result
+  return {
+    headlines = headlines,
+    total_duration = Duration.from_minutes(total_duration),
+  }
 end
 
 ---@param headline Section
@@ -353,7 +353,7 @@ function File:get_headline_lines(headline)
   return self:get_node_text_list(headline.node)
 end
 
----@return string
+---@return string|nil
 function File:get_archive_file_location()
   if self.archive_location then
     return self.archive_location
diff --git a/lua/orgmode/parser/files.lua b/lua/orgmode/parser/files.lua
@@ -180,7 +180,7 @@ function Files.update_file(filename, action)
   local is_same_file = filename == utils.current_file_path()
   local cur_win = vim.api.nvim_get_current_win()
   if is_same_file then
-    return utils.promisify(action(file)):next(function(result)
+    return Promise.resolve(action(file)):next(function(result)
       vim.cmd(':silent! w')
       return result
     end)
@@ -197,7 +197,7 @@ function Files.update_file(filename, action)
     style = 'minimal',
   })
 
-  return utils.promisify(action(file)):next(function(result)
+  return Promise.resolve(action(file)):next(function(result)
     vim.cmd('silent! wq!')
     vim.api.nvim_set_current_win(cur_win)
     return result
diff --git a/lua/orgmode/parser/section.lua b/lua/orgmode/parser/section.lua
@@ -14,7 +14,7 @@ local config = require('orgmode.config')
 ---@field id string
 ---@field line_number number
 ---@field level number
----@field node table
+---@field node userdata
 ---@field root File
 ---@field parent Section
 ---@field line string
@@ -36,6 +36,9 @@ local Section = {}
 
 ---@class SectionProperties
 ---@field items table<string, string>
+---@field range Range
+---@field node userdata
+---@field valid boolean
 
 ---@class SectionTodoKeyword
 ---@field node unknown
@@ -48,7 +51,7 @@ local Section = {}
 ---@field level number
 ---@field line string
 ---@field logbook Logbook
----@field node table
+---@field node userdata
 ---@field own_tags string[]
 ---@field parent Section
 ---@field priority string
diff --git a/lua/orgmode/parser/types.lua b/lua/orgmode/parser/types.lua
diff --git a/lua/orgmode/utils/init.lua b/lua/orgmode/utils/init.lua
diff --git a/lua/orgmode/utils/promise.lua b/lua/orgmode/utils/promise.lua
