Add org-log-into-drawer (#531)

Author: Jesse-Bakker

DOCS.md

@@ -241,6 +241,13 @@ Possible values:
 * `note` - adds `CLOSED` date as above, and prompts for closing note via capture window. Confirm note with `org_note_finalize` (Default `<C-c>`), or ignore providing note via `org_note_kill` (Default `<Leader>ok`)
 * `nil|false` - Disable any logging
 
+#### **org_log_into_drawer**
+*type*: `string|nil`<br />
+*default value*: `nil`<br />
+Possible values:
+Log TODO state changes into a drawer with the given name. The recommended value is `LOGBOOK`.
+If `nil`, log into the section body.
+
 #### **org_highlight_latex_and_related**
 *type*: `string|nil`<br />
 *default value*: `nil`<br />

lua/orgmode/config/defaults.lua

@@ -30,6 +30,7 @@ local DefaultConfig = {
   org_hide_emphasis_markers = false,
   org_ellipsis = '...',
   org_log_done = 'time',
+  org_log_into_drawer = nil,
   org_highlight_latex_and_related = nil,
   org_custom_exports = {},
   org_indent_mode = 'indent',

lua/orgmode/org/mappings.lua

@@ -460,7 +460,13 @@ function OrgMappings:_todo_change_state(direction)
       if not note then
         return
       end
-      local append_line = headline:get_append_line()
+      local drawer = config.org_log_into_drawer
+      local append_line
+      if drawer ~= nil then
+        append_line = headline:get_drawer_append_line(drawer)
+      else
+        append_line = headline:get_append_line()
+      end
       vim.api.nvim_buf_set_lines(0, append_line, append_line, false, note)
     end)
 end

lua/orgmode/treesitter/headline.lua

@@ -475,6 +475,41 @@ function Headline:parse(pattern)
   return matching_nodes[1], match
 end
 
+function Headline:get_drawer(name)
+  local section = self.headline:parent()
+  local body = section:field('body')
+  if not body then
+    return nil
+  end
+
+  for node, node_name in body[1]:iter_children() do
+    if node:type() == 'drawer' then
+      local drawer_name = node:field('name')
+      if #drawer_name and string.lower(query.get_node_text(drawer_name[1], 0)) == string.lower(name) then
+        return node
+      end
+    end
+  end
+end
+
+---Return the line number where content can be appended within
+---the drawer with the given name, matched case-insensitively
+---@param name string
+---
+---@return number
+function Headline:get_drawer_append_line(name)
+  local drawer = self:get_drawer(name)
+
+  if not drawer then
+    local append_line = self:get_append_line()
+    local new_drawer = self:_apply_indent({ ':' .. name .. ':', ':END:' })
+    vim.api.nvim_buf_set_lines(0, append_line, append_line, false, new_drawer)
+    drawer = self:refresh():get_drawer(name)
+  end
+  local name_row = drawer:field('name')[1]:end_()
+  return name_row + 1
+end
+
 ---@param type string | "DEADLINE" | "SCHEDULED" | "CLOSED"
 ---@return Date|nil
 function Headline:_get_date(type)

tests/plenary/ui/mappings/todo_spec.lua

@@ -1,5 +1,6 @@
 local helpers = require('tests.plenary.ui.helpers')
 local Date = require('orgmode.objects.date')
+local config = require('orgmode.config')
 
 describe('Todo mappings', function()
   after_each(function()
@@ -71,6 +72,59 @@ describe('Todo mappings', function()
       '* TODO Another task',
     }, vim.api.nvim_buf_get_lines(0, 2, 10, false))
   end)
+  it('should add last repeat property and state change to drawer (org_log_into_drawer)', function()
+    config:extend({
+      org_log_into_drawer = 'LOGBOOK',
+    })
+
+    helpers.load_file_content({
+      '#TITLE: Test',
+      '',
+      '* TODO Test orgmode',
+      '  DEADLINE: <2021-09-07 Tue 12:00 +1w>',
+      '',
+      '* TODO Another task',
+    })
+
+    assert.are.same({
+      '* TODO Test orgmode',
+      '  DEADLINE: <2021-09-07 Tue 12:00 +1w>',
+      '',
+      '* TODO Another task',
+    }, vim.api.nvim_buf_get_lines(0, 2, 6, false))
+    vim.fn.cursor(3, 1)
+    vim.cmd([[norm cit]])
+    vim.wait(50)
+    assert.are.same({
+      '* TODO Test orgmode',
+      '  DEADLINE: <2021-09-14 Tue 12:00 +1w>',
+      '  :PROPERTIES:',
+      '  :LAST_REPEAT: [' .. Date.now():to_string() .. ']',
+      '  :END:',
+      '  :LOGBOOK:',
+      '  - State "DONE" from "TODO" [' .. Date.now():to_string() .. ']',
+      '  :END:',
+      '',
+      '* TODO Another task',
+    }, vim.api.nvim_buf_get_lines(0, 2, 12, false))
+
+    vim.fn.cursor(3, 1)
+    vim.cmd([[norm cit]])
+    vim.wait(200)
+    assert.are.same({
+      '* TODO Test orgmode',
+      '  DEADLINE: <2021-09-21 Tue 12:00 +1w>',
+      '  :PROPERTIES:',
+      '  :LAST_REPEAT: [' .. Date.now():to_string() .. ']',
+      '  :END:',
+      '  :LOGBOOK:',
+      '  - State "DONE" from "TODO" [' .. Date.now():to_string() .. ']',
+      '  - State "DONE" from "TODO" [' .. Date.now():to_string() .. ']',
+      '  :END:',
+      '',
+      '* TODO Another task',
+    }, vim.api.nvim_buf_get_lines(0, 2, 13, false))
+  end)
   it('should change todo state of a headline backward (org_todo_prev)', function()
     helpers.load_file_content({
       '#TITLE: Test',