Add option to use custom window cmd for agenda and capture and align tags to the right

Author: kristijanhusak

DOCS.md

@@ -74,6 +74,33 @@ NOTE: Make sure fast access keys do not overlap. If that happens, first entry in
 *default value*: `true`<br />
 Should error diagnostics be shown. If you are using Neovim 0.6.0 or higher, these will be shown via `vim.diagnostic`.<br />
 
+#### **win_split_mode**
+*type*: `string`<br />
+*default value*: `horizontal`<br />
+Available options:
+* horizontal - Always split horizontally
+* vertical - Always split vertically
+* auto - Determine between horizontal and vertical split depending on the current window size
+
+This option determines how to open agenda and capture window.<br />
+If none of the options above suit your needs, you can provide custom command (see `:help <mods>`). Here are few examples:<br />
+
+Always open in tab:
+```
+win_split_mode = 'tabnew'
+```
+
+Always open vertically:
+```
+win_split_mode = 'tabnew'
+```
+
+Always open horizontally with specific height of 20 lines:
+```
+win_split_mode = '20split'
+```
+
+
 #### **org_todo_keyword_faces**
 *type*: `table<string, string>`<br />
 *default value*: `{}`<br />

lua/orgmode/agenda/init.lua

@@ -32,36 +32,55 @@ function Agenda:new(opts)
 end
 
 function Agenda:agenda()
+  self:open_window()
   local view = AgendaView:new({ filters = self.filters }):build()
   self.views = { view }
   return self:_render()
 end
 
 -- TODO: Introduce searching ALL/DONE
 function Agenda:todos()
+  self:open_window()
   local view = AgendaTodosView:new({ filters = self.filters }):build()
   self.views = { view }
   return self:_render()
 end
 
 function Agenda:search()
+  self:open_window()
   local view = AgendaSearchView:new({ filters = self.filters }):build()
   self.views = { view }
   return self:_render()
 end
 
 function Agenda:tags()
+  self:open_window()
   local view = AgendaTagsView:new({ filters = self.filters }):build()
   self.views = { view }
   return self:_render()
 end
 
 function Agenda:tags_todo()
+  self:open_window()
   local view = AgendaTagsView:new({ todo_only = true, filters = self.filters }):build()
   self.views = { view }
   return self:_render()
 end
 
+function Agenda:open_window()
+  local opened = self:is_opened()
+  if opened then
+    return
+  end
+
+  utils.open_window('orgagenda', math.max(34, config.org_agenda_min_height), config.win_split_mode)
+
+  vim.cmd([[setf orgagenda]])
+  vim.cmd([[setlocal buftype=nofile bufhidden=wipe nobuflisted nolist noswapfile nowrap nospell]])
+  vim.w.org_window_pos = vim.fn.win_screenpos(0)
+  config:setup_mappings('agenda')
+end
+
 function Agenda:prompt()
   self.filters:reset()
   return utils.menu('Press key for an agenda command', {
@@ -115,15 +134,12 @@ function Agenda:_render(skip_rebuild)
     end
   end
   local opened = self:is_opened()
-  local win_height = math.max(math.min(34, #self.content), config.org_agenda_min_height)
   if not opened then
-    vim.cmd(string.format('%dsplit orgagenda', win_height))
-    vim.cmd([[setf orgagenda]])
-    vim.cmd([[setlocal buftype=nofile bufhidden=wipe nobuflisted nolist noswapfile nowrap nospell]])
-    vim.w.org_window_pos = vim.fn.win_screenpos(0)
-    config:setup_mappings('agenda')
-  else
-    vim.cmd(vim.fn.win_id2win(opened) .. 'wincmd w')
+    self:open_window()
+  end
+  vim.cmd(vim.fn.win_id2win(opened) .. 'wincmd w')
+  if vim.w.org_window_split_mode == 'horizontal' then
+    local win_height = math.max(math.min(34, #self.content), config.org_agenda_min_height)
     if vim.w.org_window_pos and vim.deep_equal(vim.fn.win_screenpos(0), vim.w.org_window_pos) then
       vim.cmd(string.format('resize %d', win_height))
       vim.w.org_window_pos = vim.fn.win_screenpos(0)

lua/orgmode/agenda/views/agenda.lua

@@ -280,10 +280,12 @@ function AgendaView.build_agenda_item_content(agenda_item, longest_category, lon
   todo_keyword = todo_padding .. todo_keyword
   local line = string.format('%s%s%s %s', category, date, todo_keyword, headline.title)
   local todo_keyword_pos = string.format('%s%s%s', category, date, todo_padding):len()
+  local winwidth = utils.winwidth()
   if #headline.tags > 0 then
-    local padding_length = math.max(0, 99 - vim.api.nvim_strwidth(line))
+    local tags_string = headline:tags_to_string()
+    local padding_length = math.max(1, winwidth - vim.api.nvim_strwidth(line) - vim.api.nvim_strwidth(tags_string))
     local indent = string.rep(' ', padding_length)
-    line = string.format('%s%s %s', line, indent, headline:tags_to_string())
+    line = string.format('%s%s%s', line, indent, tags_string)
   end
 
   local item_highlights = {}

lua/orgmode/agenda/views/todos.lua

@@ -78,8 +78,12 @@ function AgendaTodosView.generate_todo_item(headline, longest_category, line_nr)
   local todo_keyword = headline.todo_keyword.value
   local todo_keyword_padding = todo_keyword ~= '' and ' ' or ''
   local line = string.format('  %s%s%s %s', category, todo_keyword_padding, todo_keyword, headline.title)
+  local winwidth = utils.winwidth()
   if #headline.tags > 0 then
-    line = string.format('%-99s %s', line, headline:tags_to_string())
+    local tags_string = headline:tags_to_string()
+    local padding_length = math.max(1, winwidth - vim.api.nvim_strwidth(line) - vim.api.nvim_strwidth(tags_string))
+    local indent = string.rep(' ', padding_length)
+    line = string.format('%s%s%s', line, indent, tags_string)
   end
   local todo_keyword_pos = category:len() + 4
   local highlights = {}

lua/orgmode/capture/init.lua

@@ -68,7 +68,7 @@ end
 ---@param template table
 function Capture:open_template(template)
   local content = self.templates:compile(template)
-  vim.cmd('16split ' .. vim.fn.tempname())
+  utils.open_window(vim.fn.tempname(), 16, config.win_split_mode)
   vim.cmd([[setf org]])
   vim.cmd([[setlocal bufhidden=wipe nobuflisted nolist noswapfile nofoldenable]])
   vim.api.nvim_buf_set_lines(0, 0, -1, true, content)

lua/orgmode/config/defaults.lua

@@ -39,6 +39,7 @@ return {
   org_src_window_setup = 'top 16new',
   org_edit_src_content_indentation = 0,
   diagnostics = true,
+  win_split_mode = 'horizontal',
   notifications = {
     enabled = false,
     cron_enabled = true,

lua/orgmode/objects/date.lua

@@ -517,7 +517,7 @@ function Date:is_between(from, to, span)
 end
 
 ---@param date Date
----@param span string
+---@param span? string
 ---@return boolean
 function Date:is_before(date, span)
   return not self:is_same_or_after(date, span)

lua/orgmode/utils/init.lua

@@ -499,4 +499,41 @@ function utils.current_file_path()
   return vim.api.nvim_buf_get_name(0)
 end
 
+---@param winnr? number
+function utils.winwidth(winnr)
+  winnr = winnr or 0
+  local winwidth = vim.api.nvim_win_get_width(winnr)
+  local window_numbers = vim.api.nvim_win_get_option(winnr, 'number')
+  local window_relnumbers = vim.api.nvim_win_get_option(winnr, 'relativenumber')
+  if window_numbers or window_relnumbers then
+    winwidth = winwidth - vim.wo.numberwidth
+  end
+  return winwidth
+end
+
+---@param name string
+---@param height number
+function utils.open_window(name, height, split_mode)
+  local cmd_by_split_mode = {
+    horizontal = string.format('%dsplit %s', height, name),
+    vertical = string.format('vsplit %s', name),
+  }
+
+  if cmd_by_split_mode[split_mode] then
+    vim.cmd(cmd_by_split_mode[split_mode])
+    vim.w.org_window_split_mode = split_mode
+  elseif split_mode == 'auto' then
+    local winwidth = utils.winwidth()
+    if (winwidth / 2) >= 80 then
+      vim.cmd(cmd_by_split_mode.vertical)
+      vim.w.org_window_split_mode = 'vertical'
+    else
+      vim.cmd(cmd_by_split_mode.horizontal)
+      vim.w.org_window_split_mode = 'horizontal'
+    end
+  else
+    vim.cmd(string.format('%s %s', split_mode, name))
+  end
+end
+
 return utils