Enable inserting headlines from document root (#503)

Author: jgollenz

lua/orgmode/config/defaults.lua

@@ -125,11 +125,11 @@ local DefaultConfig = {
       org_do_demote = '>>',
       org_promote_subtree = '<s',
       org_demote_subtree = '>s',
-      org_meta_return = '<Leader><CR>', -- Add heading, item or row
+      org_meta_return = '<Leader><CR>', -- Add heading, item or row (context-dependent)
       org_return = '<CR>',
-      org_insert_heading_respect_content = '<prefix>ih', -- Add new headling after current heading block with same level
-      org_insert_todo_heading = '<prefix>iT', -- Add new todo headling right after current heading with same level
-      org_insert_todo_heading_respect_content = '<prefix>it', -- Add new todo headling after current heading block on same level
+      org_insert_heading_respect_content = '<prefix>ih', -- Add new heading after current heading block (same level)
+      org_insert_todo_heading = '<prefix>iT', -- Add new todo heading right after current heading (same level)
+      org_insert_todo_heading_respect_content = '<prefix>it', -- Add new todo heading after current heading block (same level)
       org_move_subtree_up = '<prefix>K',
       org_move_subtree_down = '<prefix>J',
       org_export = '<prefix>e',

lua/orgmode/org/mappings.lua

@@ -640,9 +640,13 @@ end
 function OrgMappings:insert_heading_respect_content(suffix)
   suffix = suffix or ''
   local item = Files.get_closest_headline()
-  local line = config:respect_blank_before_new_entry({ string.rep('*', item.level) .. ' ' .. suffix })
-  vim.fn.append(item.range.end_line, line)
-  vim.fn.cursor(item.range.end_line + #line, 0)
+  if not item then
+    self:_insert_heading_from_plain_line(suffix)
+  else
+    local line = config:respect_blank_before_new_entry({ string.rep('*', item.level) .. ' ' .. suffix })
+    vim.fn.append(item.range.end_line, line)
+    vim.fn.cursor(item.range.end_line + #line, 0)
+  end
   return vim.cmd([[startinsert!]])
 end
 
@@ -652,8 +656,41 @@ end
 
 function OrgMappings:insert_todo_heading()
   local item = Files.get_closest_headline()
-  vim.fn.cursor(item.range.start_line, 0)
-  return self:handle_return(config:get_todo_keywords().TODO[1] .. ' ')
+  if not item then
+    self:_insert_heading_from_plain_line(config:get_todo_keywords().TODO[1] .. ' ')
+    return vim.cmd([[startinsert!]])
+  else
+    vim.fn.cursor(item.range.start_line, 0)
+    return self:handle_return(config:get_todo_keywords().TODO[1] .. ' ')
+  end
+end
+
+function OrgMappings:_insert_heading_from_plain_line(suffix)
+  suffix = suffix or ''
+  local linenr = vim.fn.line('.')
+  local line = vim.fn.getline(linenr)
+  local heading_prefix = '* ' .. suffix
+
+  if #line == 0 then
+    line = heading_prefix
+    vim.fn.setline(linenr, line)
+    vim.fn.cursor(linenr, 0 + #line)
+  else
+    if vim.fn.col('.') == 1 then
+      -- promote whole line to heading
+      line = heading_prefix .. line
+      vim.fn.setline(linenr, line)
+      vim.fn.cursor(linenr, 0 + #line)
+    else
+      -- split at cursor
+      local left = string.sub(line, 0, vim.fn.col('.') - 1)
+      local right = string.sub(line, vim.fn.col('.'), #line)
+      line = heading_prefix .. right
+      vim.fn.setline(linenr, left)
+      vim.fn.append(linenr, line)
+      vim.fn.cursor(linenr + 1, 0 + #line)
+    end
+  end
 end
 
 function OrgMappings:move_subtree_up()

lua/orgmode/parser/files.lua

@@ -221,7 +221,7 @@ function Files.find_headlines_matching_search_term(term, no_escape, search_extra
 end
 
 ---@param id? number
----@return Section
+---@return Section?
 function Files.get_closest_headline(id)
   local current_file = Files.get_current_file()
   local msg = 'Make sure there are no errors in the document'

tests/plenary/ui/mappings_spec.lua

@@ -899,6 +899,110 @@ describe('Mappings', function()
     end
   )
 
+  it('should insert new todo heading in empty org file', function()
+    helpers.load_file_content({ '' })
+    vim.fn.cursor(1, 1)
+    vim.cmd([[norm ,oiT]])
+    assert.are.same({ '* TODO ' }, vim.api.nvim_buf_get_lines(0, 0, 2, false))
+
+    helpers.load_file_content({ '' })
+    vim.fn.cursor(1, 1)
+    vim.cmd([[norm ,oit]])
+    assert.are.same({ '* TODO ' }, vim.api.nvim_buf_get_lines(0, 0, 2, false))
+
+    helpers.load_file_content({ '' })
+    vim.fn.cursor(1, 1)
+    vim.cmd([[norm ,oih]])
+    assert.are.same({ '* ' }, vim.api.nvim_buf_get_lines(0, 0, 2, false))
+  end)
+
+  it('should insert new todo heading on root level', function()
+    helpers.load_file_content({
+      '',
+      '* TODO heading',
+    })
+
+    vim.fn.cursor(1, 1)
+    vim.cmd([[norm ,oiT]])
+    assert.are.same({
+      '* TODO ',
+      '* TODO heading',
+    }, vim.api.nvim_buf_get_lines(0, 0, 3, false))
+
+    helpers.load_file_content({
+      '',
+      '* TODO heading',
+    })
+
+    vim.fn.cursor(1, 1)
+    vim.cmd([[norm ,oit]])
+    assert.are.same({
+      '* TODO ',
+      '* TODO heading',
+    }, vim.api.nvim_buf_get_lines(0, 0, 3, false))
+
+    helpers.load_file_content({
+      '',
+      '* TODO heading',
+    })
+
+    vim.fn.cursor(1, 1)
+    vim.cmd([[norm ,oih]])
+    assert.are.same({
+      '* ',
+      '* TODO heading',
+    }, vim.api.nvim_buf_get_lines(0, 0, 3, false))
+  end)
+
+  it('should promote line to (TODO) heading', function()
+    helpers.load_file_content({ 'foobar' })
+    vim.fn.cursor(1, 1)
+    vim.cmd([[norm ,oiT]])
+    assert.are.same({
+      '* TODO foobar',
+    }, vim.api.nvim_buf_get_lines(0, 0, 2, false))
+
+    helpers.load_file_content({ 'foobar' })
+    vim.fn.cursor(1, 1)
+    vim.cmd([[norm ,oit]])
+    assert.are.same({
+      '* TODO foobar',
+    }, vim.api.nvim_buf_get_lines(0, 0, 2, false))
+
+    helpers.load_file_content({ 'foobar' })
+    vim.fn.cursor(1, 1)
+    vim.cmd([[norm ,oih]])
+    assert.are.same({
+      '* foobar',
+    }, vim.api.nvim_buf_get_lines(0, 0, 2, false))
+  end)
+
+  it('should promote line left of the cursor to (TODO) heading', function()
+    helpers.load_file_content({ 'foobar' })
+    vim.fn.cursor(1, 4)
+    vim.cmd([[norm ,oiT]])
+    assert.are.same({
+      'foo',
+      '* TODO bar',
+    }, vim.api.nvim_buf_get_lines(0, 0, 2, false))
+
+    helpers.load_file_content({ 'foobar' })
+    vim.fn.cursor(1, 4)
+    vim.cmd([[norm ,oit]])
+    assert.are.same({
+      'foo',
+      '* TODO bar',
+    }, vim.api.nvim_buf_get_lines(0, 0, 2, false))
+
+    helpers.load_file_content({ 'foobar' })
+    vim.fn.cursor(1, 4)
+    vim.cmd([[norm ,oih]])
+    assert.are.same({
+      'foo',
+      '* bar',
+    }, vim.api.nvim_buf_get_lines(0, 0, 2, false))
+  end)
+
   it('should insert new todo heading after current one (org_insert_todo_heading)', function()
     helpers.load_file_content({
       '#TITLE: Test',