Merge pull request #198 from jgollenz/feature/toggle-heading

Author: kristijanhusak

DOCS.md

@@ -637,6 +637,9 @@ Cycle todo keyword backward on current headline.
 #### **org_toggle_checkbox**
 *mapped to*: `<C-Space>`<br />
 Toggle current line checkbox state
+#### **org_toggle_heading**
+*mapped to*: `<Leader>o*`<br />
+Toggle current line to headline and vice versa. Checkboxes will turn into TODO headlines.
 #### **org_open_at_point**
 *mapped to*: `<Leader>oo`<br />
 Open hyperlink or date under cursor.<br />

README.md

@@ -295,6 +295,7 @@ set concealcursor=nc
   * Change headline TODO state: forward<kbd>cit</kbd> or backward<kbd>ciT</kbd>
   * Open hyperlink or date under cursor: <kbd>\<Leader\>oo</kbd>
   * Toggle checkbox: <kbd>\<C-space\></kbd>
+  * Toggle current line to headline and vice versa: <kbd>\<Leader\>o*</kbd>
   * Toggle folding of current headline: <kbd>\<TAB\></kbd>
   * Toggle folding in whole file: <kbd>\<S-TAB\></kbd>
   * Archive headline: <kbd>\<Leader\>o$</kbd>

lua/orgmode/config/defaults.lua

@@ -102,6 +102,7 @@ return {
       org_todo = 'cit',
       org_todo_prev = 'ciT',
       org_toggle_checkbox = '<C-Space>',
+      org_toggle_heading = '<Leader>o*',
       org_open_at_point = '<Leader>oo',
       org_edit_special = [[<Leader>o']],
       org_cycle = '<TAB>',

lua/orgmode/config/mappings.lua

@@ -48,6 +48,7 @@ return {
     org_priority_down = { 'org_mappings.priority_down' },
     org_todo_prev = { 'org_mappings.todo_prev_state' },
     org_toggle_checkbox = { 'org_mappings.toggle_checkbox' },
+    org_toggle_heading = { 'org_mappings.toggle_heading' },
     org_open_at_point = { 'org_mappings.open_at_point' },
     org_edit_special = { 'org_mappings.edit_special' },
     org_cycle = { 'org_mappings.cycle' },

lua/orgmode/org/mappings.lua

@@ -296,6 +296,36 @@ function OrgMappings:todo_prev_state()
   self:_todo_change_state('prev')
 end
 
+function OrgMappings:toggle_heading()
+  local line = vim.fn.getline('.')
+  local parent = Files.get_closest_headline()
+  if not parent then
+    line = '* ' .. line
+    vim.fn.setline('.', line)
+    return
+  end
+
+  if parent.line_number == vim.api.nvim_win_get_cursor(0)[1] then
+    line = line:gsub('^%*+%s', '')
+  else
+    line = line:gsub('^(%s*)', '')
+    if line:match('^[%*-]%s') then -- handle lists
+      line = line:gsub('^[%*-]%s', '') -- strip bullet
+      line = line:gsub('^%[([X%s])%]%s', function(checkbox_state)
+        if checkbox_state == 'X' then
+          return config:get_todo_keywords().DONE[1] .. ' '
+        else
+          return config:get_todo_keywords().TODO[1] .. ' '
+        end
+      end)
+    end
+
+    line = string.rep('*', parent.level + 1) .. ' ' .. line
+  end
+
+  vim.fn.setline('.', line)
+end
+
 function OrgMappings:_todo_change_state(direction)
   local item = Files.get_closest_headline()
   local was_done = item:is_done()

tests/plenary/ui/mappings_spec.lua

@@ -322,6 +322,53 @@ describe('Mappings', function()
     assert.are.same('  - [ ] The checkbox 2', vim.fn.getline(3))
   end)
 
+  it('should toggle the current line into a headline and vice versa', function()
+    helpers.load_file_content({
+      'top level line',
+      '* top level heading',
+      '  simple line',
+      '  - list item',
+      '  * [ ] unfinished checkbox item',
+      '  - [X] finished checkbox item',
+    })
+
+    assert.are.same('top level line', vim.fn.getline(1))
+    assert.are.same('  simple line', vim.fn.getline(3))
+    assert.are.same('  - list item', vim.fn.getline(4))
+    assert.are.same('  * [ ] unfinished checkbox item', vim.fn.getline(5))
+    assert.are.same('  - [X] finished checkbox item', vim.fn.getline(6))
+
+    vim.fn.cursor(1, 1)
+    vim.cmd([[norm ,o*]])
+    assert.are.same('* top level line', vim.fn.getline(1))
+    vim.cmd([[norm ,o*]])
+    assert.are.same('top level line', vim.fn.getline(1))
+
+    vim.fn.cursor(3, 1)
+    vim.cmd([[norm ,o*]])
+    assert.are.same('** simple line', vim.fn.getline(3))
+    vim.cmd([[norm ,o*]])
+    assert.are.same('simple line', vim.fn.getline(3))
+
+    vim.fn.cursor(4, 1)
+    vim.cmd([[norm ,o*]])
+    assert.are.same('** list item', vim.fn.getline(4))
+    vim.cmd([[norm ,o*]])
+    assert.are.same('list item', vim.fn.getline(4))
+
+    vim.fn.cursor(5, 1)
+    vim.cmd([[norm ,o*]])
+    assert.are.same('** TODO unfinished checkbox item', vim.fn.getline(5))
+    vim.cmd([[norm ,o*]])
+    assert.are.same('TODO unfinished checkbox item', vim.fn.getline(5))
+
+    vim.fn.cursor(6, 1)
+    vim.cmd([[norm ,o*]])
+    assert.are.same('** DONE finished checkbox item', vim.fn.getline(6))
+    vim.cmd([[norm ,o*]])
+    assert.are.same('DONE finished checkbox item', vim.fn.getline(6))
+  end)
+
   it('should toggle archive tag on headline (org_toggle_archive_tag)', function()
     helpers.load_file_content({
       '#TITLE: Test',