Add shortcut to calendar to clear the currently active date. Closes #397

Author: kristijanhusak

lua/orgmode/api/headline.lua

@@ -132,12 +132,17 @@ function OrgHeadline:set_deadline(date)
     local headline = ts_org.closest_headline()
     local deadline_date = headline:deadline()
     if not date then
-      return Calendar.new({ date = deadline_date or Date.today() }).open():next(function(new_date)
-        if not new_date then
-          return
-        end
-        return headline:set_deadline_date(new_date)
-      end)
+      return Calendar.new({ date = deadline_date or Date.today(), clearable = true })
+        .open()
+        :next(function(new_date, cleared)
+          if cleared then
+            return headline:remove_deadline_date()
+          end
+          if not new_date then
+            return
+          end
+          return headline:set_deadline_date(new_date)
+        end)
     end
 
     if type(date) == 'string' then
@@ -167,12 +172,17 @@ function OrgHeadline:set_scheduled(date)
     local headline = ts_org.closest_headline()
     local scheduled_date = headline:scheduled()
     if not date then
-      return Calendar.new({ date = scheduled_date or Date.today() }).open():next(function(new_date)
-        if not new_date then
-          return
-        end
-        return headline:set_scheduled_date(new_date)
-      end)
+      return Calendar.new({ date = scheduled_date or Date.today(), clearable = true })
+        .open()
+        :next(function(new_date, cleared)
+          if cleared then
+            return headline:remove_scheduled_date()
+          end
+          if not new_date then
+            return
+          end
+          return headline:set_scheduled_date(new_date)
+        end)
     end
 
     if type(date) == 'string' then

lua/orgmode/objects/calendar.lua

@@ -16,6 +16,7 @@ local Calendar = {
   namespace = vim.api.nvim_create_namespace('org_calendar'),
   date = nil,
   month = Date.today():start_of('month'),
+  clearable = false,
 }
 
 vim.cmd([[hi OrgCalendarToday gui=reverse cterm=reverse]])
@@ -27,14 +28,15 @@ function Calendar.new(data)
     Calendar.date = data.date
     Calendar.month = data.date:set({ day = 1 })
   end
+  Calendar.clearable = data.clearable
   return Calendar
 end
 
 function Calendar.open()
   local opts = {
     relative = 'editor',
     width = 36,
-    height = 10,
+    height = Calendar.clearable and 11 or 10,
     style = 'minimal',
     border = 'single',
     row = vim.o.lines / 2 - 4,
@@ -76,6 +78,9 @@ function Calendar.open()
   vim.keymap.set('n', '.', '<cmd>lua require("orgmode.objects.calendar").reset()<CR>', map_opts)
   vim.keymap.set('n', 'q', ':call nvim_win_close(win_getid(), v:true)<CR>', map_opts)
   vim.keymap.set('n', '<Esc>', ':call nvim_win_close(win_getid(), v:true)<CR>', map_opts)
+  if Calendar.clearable then
+    vim.keymap.set('n', 'r', '<cmd>lua require("orgmode.objects.calendar").clear_date()<CR>', map_opts)
+  end
   local search_day = Date.today():format('%d')
   if Calendar.date then
     search_day = Calendar.date:format('%d')
@@ -124,9 +129,15 @@ function Calendar.render()
   table.insert(value, 1, month)
   table.insert(value, ' [<] - prev month  [>] - next month')
   table.insert(value, ' [.] - today   [Enter] - select day')
+  if Calendar.clearable then
+    table.insert(value, ' [r] Clear date')
+  end
 
   vim.api.nvim_buf_set_lines(Calendar.buf, 0, -1, true, value)
   vim.api.nvim_buf_clear_namespace(Calendar.buf, Calendar.namespace, 0, -1)
+  if Calendar.clearable then
+    vim.api.nvim_buf_add_highlight(Calendar.buf, Calendar.namespace, 'Comment', #value - 3, 0, -1)
+  end
   vim.api.nvim_buf_add_highlight(Calendar.buf, Calendar.namespace, 'Comment', #value - 2, 0, -1)
   vim.api.nvim_buf_add_highlight(Calendar.buf, Calendar.namespace, 'Comment', #value - 1, 0, -1)
   if is_today_month then
@@ -262,4 +273,12 @@ function Calendar.dispose()
   end
 end
 
+function Calendar.clear_date()
+  local cb = Calendar.callback
+  Calendar.callback = nil
+  vim.cmd([[echon]])
+  vim.api.nvim_win_close(0, true)
+  cb(nil, true)
+end
+
 return Calendar

lua/orgmode/org/mappings.lua

@@ -763,25 +763,35 @@ end
 function OrgMappings:org_deadline()
   local headline = ts_org.closest_headline()
   local deadline_date = headline:deadline()
-  return Calendar.new({ date = deadline_date or Date.today() }).open():next(function(new_date)
-    if not new_date then
-      return
-    end
-    headline:remove_closed_date()
-    headline:set_deadline_date(new_date)
-  end)
+  return Calendar.new({ date = deadline_date or Date.today(), clearable = true })
+    .open()
+    :next(function(new_date, cleared)
+      if cleared then
+        return headline:remove_deadline_date()
+      end
+      if not new_date then
+        return
+      end
+      headline:remove_closed_date()
+      headline:set_deadline_date(new_date)
+    end)
 end
 
 function OrgMappings:org_schedule()
   local headline = ts_org.closest_headline()
   local scheduled_date = headline:scheduled()
-  return Calendar.new({ date = scheduled_date or Date.today() }).open():next(function(new_date)
-    if not new_date then
-      return
-    end
-    headline:remove_closed_date()
-    headline:set_scheduled_date(new_date)
-  end)
+  return Calendar.new({ date = scheduled_date or Date.today(), clearable = true })
+    .open()
+    :next(function(new_date, cleared)
+      if cleared then
+        return headline:remove_scheduled_date()
+      end
+      if not new_date then
+        return
+      end
+      headline:remove_closed_date()
+      headline:set_scheduled_date(new_date)
+    end)
 end
 
 ---@param inactive boolean