feat(agenda): Add option to hide custom agenda views that are empty

See `org_agenda_hide_empty_blocks` in docs.

Author: kristijanhusak

docs/configuration.org

@@ -741,6 +741,14 @@ These arguments are shared between all of the agenda types:
   - =far= - Do not show deadlines that are too far in future (over [[#org_deadline_warning_days][org_deadline_warning_days]])
   - =near= - Do not show deadlines that are too near in future (under [[#org_deadline_warning_days][org_deadline_warning_days]])
 
+*** org_agenda_hide_empty_blocks
+:PROPERTIES:
+:CUSTOM_ID: org_agenda_hide_empty_blocks
+:END:
+- Type: =boolean=
+- Default: =false=
+Should custom agenda commands be hidden if they have no entries to show. Does not work for =agenda= type since it shows days.
+
 *** org_agenda_sorting_strategy
 :PROPERTIES:
 :CUSTOM_ID: org_agenda_sorting_strategy

lua/orgmode/agenda/init.lua

@@ -78,7 +78,7 @@ function Agenda:render()
   local bufnr = self:_open_window()
   for i, view in ipairs(self.views) do
     view:render(bufnr, line)
-    if #self.views > 1 and i < #self.views then
+    if #self.views > 1 and i < #self.views and #view:get_lines() > 0 then
       colors.add_hr(bufnr, vim.api.nvim_buf_line_count(bufnr), config.org_agenda_block_separator)
     end
   end

lua/orgmode/agenda/types/todo.lua

@@ -108,6 +108,13 @@ function OrgAgendaTodosType:render(bufnr)
   local headlines, category_length = self:_get_headlines()
   local agendaView = AgendaView:new({ bufnr = self.bufnr, highlighter = self.highlighter })
 
+  -- If custom view and no headlines, return empty view
+  -- Works only for custom agenda views (has id)
+  if self.id and config.org_agenda_hide_empty_blocks and #headlines == 0 then
+    self.view = agendaView:render()
+    return self.view
+  end
+
   agendaView:add_line(AgendaLine:single_token({
     content = self:_get_header(),
     hl_group = '@org.agenda.header',
@@ -123,9 +130,8 @@ function OrgAgendaTodosType:render(bufnr)
     agendaView:add_line(self:_build_line(headline, { category_length = category_length }))
   end
 
-  local result = agendaView:render()
-  self.view = result
-  return result
+  self.view = agendaView:render()
+  return self.view
 end
 
 ---@private

lua/orgmode/config/_meta.lua

@@ -213,6 +213,7 @@
 ---@field org_agenda_skip_scheduled_if_done? boolean If true, scheduled entries marked as done will not be shown in the agenda. Default: false
 ---@field org_agenda_skip_deadline_if_done? boolean If true, deadline entries marked as done will not be shown in the agenda. Default: false
 ---@field org_agenda_text_search_extra_files? ('agenda-archives')[] Additional files to earch from agenda search prompt. Default: {}
+---@field org_agenda_hide_empty_blocks? boolean Hide empty custom agenda commands in agenda view. Default: false
 ---@field org_agenda_custom_commands? table<string, OrgAgendaCustomCommand> Custom commands for the agenda view. Default: {}
 ---@field org_agenda_block_separator? string Separator for blocks in the agenda view. Default: '-'
 ---@field org_agenda_sorting_strategy? table<'agenda' | 'todo' | 'tags', OrgAgendaSortingStrategy[]> Sorting strategy for the agenda view. See docs for default value

lua/orgmode/config/defaults.lua

@@ -26,6 +26,7 @@ local DefaultConfig = {
   org_agenda_skip_deadline_if_done = false,
   org_agenda_text_search_extra_files = {},
   org_agenda_custom_commands = {},
+  org_agenda_hide_empty_blocks = false,
   org_agenda_block_separator = '-',
   org_agenda_sorting_strategy = {
     agenda = { 'time-up', 'priority-down', 'category-keep' },