feat(agenda): Add org-agenda-show-future-repeats

Closes #484

Author: kristijanhusak

docs/configuration.org

@@ -842,6 +842,19 @@ Show time grid in agenda. See [[#org_agenda_time_grid][org_agenda_time_grid]] fo
 Label value for the current time in the agenda time grid.
 See [[#org_agenda_time_grid][org_agenda_time_grid]] for time grid configuration or [[#org_agenda_use_time_grid][org_agenda_use_time_grid]] to disable the grid.
 
+*** org_agenda_show_future_repeats
+:PROPERTIES:
+:CUSTOM_ID: org_agenda_show_future_repeats
+:END:
+- Type: =boolean | number | 'next'=
+- Default: =true=
+How many future repeated tasks to show in agenda.
+Possible values:
+- =true= - Show all future repeats (default)
+- =false= - Do not show future repeats
+- =number= - Show only given number of future repeats
+- ='next'= - Show only the next repeat
+
 
 *** org_capture_templates
 :PROPERTIES:

lua/orgmode/agenda/agenda_item.lua

@@ -40,7 +40,8 @@ function AgendaItem:new(headline_date, headline, date, index)
   opts.repeats_on_date = false
   opts.is_same_day = headline_date:is_same(date, 'day')
   if not opts.is_same_day then
-    opts.repeats_on_date = headline_date:repeats_on(date)
+    local repeat_count = config:get_repeat_count()
+    opts.repeats_on_date = headline_date:repeats_on(date, repeat_count)
     opts.is_same_day = opts.repeats_on_date
   end
   opts.is_in_date_range = headline_date:is_none() and headline_date:is_in_date_range(date)

lua/orgmode/config/_meta.lua

@@ -219,6 +219,7 @@
 ---@field org_agenda_sorting_strategy? table<'agenda' | 'todo' | 'tags', OrgAgendaSortingStrategy[]> Sorting strategy for the agenda view. See docs for default value
 ---@field org_agenda_remove_tags? boolean If true, tags will be removed from the all agenda views. Default: false
 ---@field org_agenda_use_time_grid? boolean If true, Render time grid in agenda as set by org_agenda_time_grid. Default: true
+---@field org_agenda_show_future_repeats? boolean | 'next' If true, show all future repeats. If `next`, show only next repeat. If false, do hnot show any repeats. Default: true
 ---@field org_agenda_time_grid? OrgAgendaTimeGridOpts Agenda time grid configuration. Default: { type = { 'daily', 'today', 'require-timed' }, times = { 800, 1000, 1200, 1400, 1600, 1800, 2000 }, time_separator = '┄┄┄┄┄', time_label = '┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄' }
 ---@field org_agenda_current_time_string? string String to indicate current time on the time grid. Default: '<- now -----------------------------------------------'
 ---@field org_priority_highest? string | number Highest priority level. Default: 'A'

lua/orgmode/config/defaults.lua

@@ -42,6 +42,7 @@ local DefaultConfig = {
   },
   org_agenda_current_time_string = '<- now -----------------------------------------------',
   org_agenda_use_time_grid = true,
+  org_agenda_show_future_repeats = true,
   org_priority_highest = 'A',
   org_priority_default = 'B',
   org_priority_lowest = 'C',

lua/orgmode/config/init.lua

@@ -546,6 +546,34 @@ function Config:use_property_inheritance(property_name)
   end
 end
 
+-- Return repeat count depending on `org_agenda_show_future_repeats` value.
+-- If nil, repeat infinitely.
+-- @return number|nil
+function Config:get_repeat_count()
+  if self.org_agenda_show_future_repeats == true then
+    return nil
+  end
+
+  if self.org_agenda_show_future_repeats == false then
+    return 0
+  end
+
+  if self.org_agenda_show_future_repeats == 'next' then
+    return 1
+  end
+  if type(self.org_agenda_show_future_repeats) == 'number' and self.org_agenda_show_future_repeats >= 0 then
+    return self.org_agenda_show_future_repeats
+  end
+
+  utils.echo_error({
+    'Invalid value for `org_agenda_show_future_repeats`',
+    'Either boolean, positive number or "next" expected',
+    'Defaulting to "true"',
+  })
+
+  return nil
+end
+
 ---@param filetype_name string
 ---@param use_ftmatch? boolean Use vim.filetype.match to detect filetype
 function Config:detect_filetype(filetype_name, use_ftmatch)

lua/orgmode/objects/date.lua

@@ -1007,16 +1007,25 @@ function OrgDate:apply_repeater()
 end
 
 ---@param date OrgDate
+---@param repeat_count number | nil
 ---@return boolean
-function OrgDate:repeats_on(date)
+function OrgDate:repeats_on(date, repeat_count)
   local repeater = self:get_repeater()
   if not repeater then
     return false
   end
+  if repeat_count == 0 then
+    return false
+  end
   repeater = repeater:gsub('^%.', ''):gsub('^%+%+', '+')
   local repeat_date = self:start_of('day')
   local date_start = date:start_of('day')
+  local counter = 0
   while repeat_date.timestamp < date_start.timestamp do
+    if repeat_count and counter >= repeat_count then
+      break
+    end
+    counter = counter + 1
     repeat_date = repeat_date:adjust(repeater)
   end
   return repeat_date:is_same(date, 'day')

tests/plenary/object/date_spec.lua

@@ -472,6 +472,12 @@ describe('Date object', function()
     local friday = Date.from_string('2021-05-14 Fri ++1w')
     assert.is.True(friday:repeats_on(friday:add({ week = 1 })))
     assert.is.False(friday:repeats_on(friday:add({ day = 5 })))
+
+    -- Check it handles the repeat count
+    local thursday = Date.from_string('2021-05-13 +1d')
+    assert.are.same('+1d', thursday:get_repeater())
+    assert.is.True(thursday:repeats_on(thursday:add({ day = 1 }), 1))
+    assert.is.False(thursday:repeats_on(thursday:add({ day = 2 }), 1))
   end)
 
   it('should apply different types of repeaters to the date', function()