Agenda help improvements (#463)

closes #445

Author: jgollenz

lua/orgmode/agenda/init.lua

@@ -33,33 +33,35 @@ function Agenda:new(opts)
 end
 
 ---@param View table
+---@param type string
 ---@param opts? table
-function Agenda:open_agenda_view(View, opts)
+function Agenda:open_agenda_view(View, type, opts)
   self:open_window()
   self.win_width = utils.winwidth()
   local view = View:new(vim.tbl_deep_extend('force', opts or {}, {
     filters = self.filters,
     win_width = self.win_width,
   })):build()
   self.views = { view }
+  vim.b.org_agenda_type = type
   return self:_render()
 end
 
 function Agenda:agenda(opts)
-  self:open_agenda_view(AgendaView, opts)
+  self:open_agenda_view(AgendaView, 'agenda', opts)
 end
 
 -- TODO: Introduce searching ALL/DONE
 function Agenda:todos()
-  self:open_agenda_view(AgendaTodosView)
+  self:open_agenda_view(AgendaTodosView, 'todos')
 end
 
 function Agenda:search()
-  self:open_agenda_view(AgendaSearchView)
+  self:open_agenda_view(AgendaSearchView, 'search')
 end
 
 function Agenda:tags(opts)
-  self:open_agenda_view(AgendaTagsView, opts)
+  self:open_agenda_view(AgendaTagsView, 'tags', opts)
 end
 
 function Agenda:tags_todo()

lua/orgmode/objects/help.lua

@@ -57,37 +57,41 @@ local helps = {
     { key = 'org_toggle_heading', description = 'Toggle current line to headline and vice versa' },
   },
   orgagenda = {
-    { key = 'org_agenda_later', description = 'Go forward one span' },
-    { key = 'org_agenda_earlier', description = 'Go backward one span' },
-    { key = 'org_agenda_goto_today', description = "Go to today's span" },
-    { key = 'org_agenda_goto_date', description = 'Jump to specific date' },
-    { key = 'org_agenda_day_view', description = 'Show day view' },
-    { key = 'org_agenda_week_view', description = 'Show week view' },
-    { key = 'org_agenda_month_view', description = 'Show month view' },
-    { key = 'org_agenda_year_view', description = 'Show year view' },
-    { key = 'org_agenda_switch_to', description = 'Open in current window' },
-    { key = 'org_agenda_goto', description = 'Open in another window' },
-    { key = 'org_agenda_redo', description = 'Reload org files and redraw' },
-    { key = 'org_agenda_todo', description = 'Change TODO state of an item' },
-    { key = 'org_agenda_clock_in', description = 'Clock in item under cursor' },
-    { key = 'org_agenda_clock_out', description = 'Clock out currently active clocked item' },
-    { key = 'org_agenda_clock_cancel', description = 'Cancel clocking on currently active clocked item' },
-    { key = 'org_agenda_clock_goto', description = 'Jump to currently active clock item' },
-    { key = 'org_agenda_set_effort', description = 'Set effort estimate for item under cursor' },
-    { key = 'org_agenda_clockreport_mode', description = 'Toggle clock report for current agenda time range' },
-    {
-      key = 'org_agenda_filter',
-      description = 'Open prompt that allows filtering by category, tags and title(vim regex)',
+    agenda_specific = {
+      { key = 'org_agenda_later', description = 'Go forward one span' },
+      { key = 'org_agenda_earlier', description = 'Go backward one span' },
+      { key = 'org_agenda_goto_today', description = "Go to today's span" },
+      { key = 'org_agenda_goto_date', description = 'Jump to specific date' },
+      { key = 'org_agenda_day_view', description = 'Show day view' },
+      { key = 'org_agenda_week_view', description = 'Show week view' },
+      { key = 'org_agenda_month_view', description = 'Show month view' },
+      { key = 'org_agenda_year_view', description = 'Show year view' },
+    },
+    generic = {
+      { key = 'org_agenda_switch_to', description = 'Open in current window' },
+      { key = 'org_agenda_goto', description = 'Open in another window' },
+      { key = 'org_agenda_redo', description = 'Reload org files and redraw' },
+      { key = 'org_agenda_todo', description = 'Change TODO state of an item' },
+      { key = 'org_agenda_clock_in', description = 'Clock in item under cursor' },
+      { key = 'org_agenda_clock_out', description = 'Clock out currently active clocked item' },
+      { key = 'org_agenda_clock_cancel', description = 'Cancel clocking on currently active clocked item' },
+      { key = 'org_agenda_clock_goto', description = 'Jump to currently active clock item' },
+      { key = 'org_agenda_set_effort', description = 'Set effort estimate for item under cursor' },
+      { key = 'org_agenda_clockreport_mode', description = 'Toggle clock report for current agenda time range' },
+      {
+        key = 'org_agenda_filter',
+        description = 'Open prompt that allows filtering by category, tags and title(vim regex)',
+      },
+      { key = 'org_agenda_priority', description = 'Set priority for current item' },
+      { key = 'org_agenda_priority_up', description = 'Increase priority for current item' },
+      { key = 'org_agenda_priority_down', description = 'Decrease priority for current item' },
+      { key = 'org_agenda_toggle_archive_tag', description = 'Toggle "ARCHIVE" tag on current headline' },
+      { key = 'org_agenda_set_tags', description = 'Change tags of current headline' },
+      { key = 'org_agenda_deadline', description = 'Insert/Update deadline date on current headline' },
+      { key = 'org_agenda_schedule', description = 'Insert/Update scheduled date on current headline' },
+      { key = 'org_agenda_quit', description = 'Close agenda' },
+      { key = 'org_agenda_show_help', description = 'Show this help' },
     },
-    { key = 'org_agenda_priority', description = 'Set priority for current item' },
-    { key = 'org_agenda_priority_up', description = 'Increase priority for current item' },
-    { key = 'org_agenda_priority_down', description = 'Decrease priority for current item' },
-    { key = 'org_agenda_toggle_archive_tag', description = 'Toggle "ARCHIVE" tag on current headline' },
-    { key = 'org_agenda_set_tags', description = 'Change tags of current headline' },
-    { key = 'org_agenda_deadline', description = 'Insert/Update deadline date on current headline' },
-    { key = 'org_agenda_schedule', description = 'Insert/Update scheduled date on current headline' },
-    { key = 'org_agenda_quit', description = 'Close agenda' },
-    { key = 'org_agenda_show_help', description = 'Show this help' },
   },
   capture = {
     { key = 'org_capture_finalize', description = 'Save to default notes file and close the window' },
@@ -165,7 +169,10 @@ function Help._prepare_orgcapture(mappings, max_height)
       maps = table.concat(maps, ', ')
     end
 
-    table.insert(content, string.format('  `%-12s` - %s', maps, item.description))
+    table.insert(
+      content,
+      string.format('  `%-12s` - %s', string.gsub(maps, '<prefix>', mappings.prefix), item.description)
+    )
   end
 
   table.insert(content, '  __Org__')
@@ -186,7 +193,10 @@ function Help._prepare_orgnote(mappings, max_height)
       maps = table.concat(maps, ', ')
     end
 
-    table.insert(content, string.format('  `%-12s` - %s', maps, item.description))
+    table.insert(
+      content,
+      string.format('  `%-12s` - %s', string.gsub(maps, '<prefix>', mappings.prefix), item.description)
+    )
   end
 
   table.insert(content, '  __Org__')
@@ -195,19 +205,34 @@ function Help._prepare_orgnote(mappings, max_height)
 end
 
 function Help._prepare_orgagenda(mappings, max_height)
+  local agenda_mappings = vim.deepcopy(helps.orgagenda.generic)
+  local height = #helps.orgagenda.generic
+
+  local agenda_type_text = ''
+  if vim.b.org_agenda_type == 'agenda' then
+    agenda_mappings = utils.concat(vim.deepcopy(helps.orgagenda.agenda_specific), agenda_mappings)
+    height = height + #helps.orgagenda.agenda_specific
+  else
+    agenda_type_text = ' ' .. vim.b.org_agenda_type
+  end
+
   local scroll_more_text = ''
-  if #helps.orgagenda > max_height then
+  if height > max_height then
     scroll_more_text = ' (Scroll down for more)'
   end
 
-  local content = { string.format(' **Orgmode mappings - Agenda%s:**', scroll_more_text), '' }
-  for _, item in ipairs(helps.orgagenda) do
+  local content = { string.format(' **Orgmode mappings - Agenda%s%s:**', agenda_type_text, scroll_more_text), '' }
+
+  for _, item in ipairs(agenda_mappings) do
     local maps = mappings.agenda[item.key]
     if type(maps) == 'table' then
       maps = table.concat(maps, ', ')
     end
 
-    table.insert(content, string.format('  `%-12s` - %s', maps, item.description))
+    table.insert(
+      content,
+      string.format('  `%-12s` - %s', string.gsub(maps, '<prefix>', mappings.prefix), item.description)
+    )
   end
 
   table.insert(content, '')
@@ -230,7 +255,10 @@ function Help._prepare_edit_src(mappings, max_height)
       maps = table.concat(maps, ', ')
     end
 
-    table.insert(content, string.format('  `%-12s` - %s', maps, item.description))
+    table.insert(
+      content,
+      string.format('  `%-12s` - %s', string.gsub(maps, '<prefix>', mappings.prefix), item.description)
+    )
   end
 
   return content, true
@@ -261,9 +289,14 @@ function Help.prepare_content(opts)
       maps = table.concat(maps, ', ')
     end
 
-    table.insert(content, string.format('  `%-12s` - %s', maps, item.description))
+    table.insert(
+      content,
+      string.format('  `%-12s` - %s', string.gsub(maps, '<prefix>', mappings.prefix), item.description)
+    )
   end
 
+  table.insert(content, '  __Text Objects__')
+
   for _, item in ipairs(helps.text_objects) do
     local maps = mappings.text_objects[item.key]
     table.insert(content, string.format('  `%-12s` - %s', maps, item.description))