Merge branch 'master' into renovate/configure

Author: harshad1

README.md

@@ -107,10 +107,34 @@ let g:bullets_custom_mappings = [
   \ ]
 ```
 
-Enable/disable deleting the last empty bullet when hitting `<cr>` (insert mode) or `o` (normal mode):
+Enable/disable deleting or promoting the last empty bullet when hitting `<cr>` (insert mode) or `o` (normal mode):
 
 ```vim
-let g:bullets_delete_last_bullet_if_empty = 0 " default = 1
+" Example (| is cursor):
+" - text
+"   - text
+"   - |
+
+let g:bullets_delete_last_bullet_if_empty = 1 " default = 1
+" - text
+"   - text
+" |
+
+let g:bullets_delete_last_bullet_if_empty = 0
+" - text
+"   - text
+"   - 
+"   |
+
+let g:bullets_delete_last_bullet_if_empty = 2
+" - text
+"   - text
+" - |
+"
+" again:
+" - text
+"   - text
+" |
 ```
 
 Line spacing between bullets (1 = no blank lines, 2 = one blank line, etc.):
@@ -295,7 +319,7 @@ let g:bullets_checkbox_partials_toggle = 0
 * Promote a bullet (unindent it and increase the bullet level):
   + NORMAL mode: `<<`
   + INSERT mode: `<C-d>`
-  + VISUAL mode: `>`
+  + VISUAL mode: `<`
 
 Disable default mappings:
 

doc/bullets.txt

@@ -83,6 +83,11 @@ GENERAL COMMANDS                            *bullets-commands*
                        A blank line before/after the first/last bullet denotes
                        the end of the list.
 
+                                            *bullets-:RecomputeCheckboxes*
+:RecomputeCheckboxes   Recomputes all partial checkboxes in the current list.
+                       Preserves state for all checkboxes with no children and
+                       recomputes all checkboxes up to the top of the list.
+
                                             *bullets-:BulletDemote*
 :BulletDemote          Demotes the current bullet by indenting it and changing
                        its bullet type to the next level defined in 
@@ -148,7 +153,7 @@ To add a leader key to all mappings set the following:
 This will set the <space> key as leader to all default mappings.
 
 
-Disabling empty bullet deletion
+Empty bullet deletion
 -------------------------------
 By default bullets.vim will delete trailing empty bullets when the return key
 is pressed, just like modern word processors.
@@ -157,6 +162,10 @@ If you would like to turn this feature off add the following to your .vimrc
 
   `let g:bullets_delete_last_bullet_if_empty = 0`
 
+If you would like to promote bullet instead of deleting it, add the following to your .vimrc
+
+  `let g:bullets_delete_last_bullet_if_empty = 2`
+
 
 Maintain right padding on bullets
 ---------------------------------

plugin/bullets.vim

@@ -72,6 +72,12 @@ while s:power >= 0
   let s:power -= 1
 endwhile
 
+if !exists('g:bullets_list_item_styles')
+  " A list of regex patterns that are recognized as bullet points for
+  " bullet items.
+  let g:bullets_list_item_styles = ['-', '\*+', '\.+', '#\.', '\+', '\\item']
+endif
+
 if !exists('g:bullets_outline_levels')
   " Capitalization matters: all caps will make the symbol caps, lower = lower
   " Standard bullets should include the marker symbol after 'std'
@@ -161,7 +167,7 @@ fun! s:parse_bullet_text(line_text)
   if s:bullet_cache isnot v:null
     let l:cached = get(s:bullet_cache, a:line_text, v:null)
     if l:cached isnot v:null
-      " Return a copy so as not to break the referene
+      " Return a copy so as not to break the reference
       return copy(l:cached)
     endif
   endif
@@ -177,11 +183,11 @@ fun! s:parse_bullet_text(line_text)
   let l:roman = empty(l:bullet) && empty(l:num) ? s:match_roman_list_item(a:line_text) : {}
 
   let l:kinds = s:filter([l:bullet, l:check, l:num, l:alpha, l:roman], '!empty(v:val)')
-  
+
   if s:bullet_cache isnot v:null
     let s:bullet_cache[a:line_text] = l:kinds
   endif
-    
+
   return l:kinds
 endfun
 
@@ -324,7 +330,9 @@ fun! s:match_checkbox_bullet_item(input_text)
 endfun
 
 fun! s:match_bullet_list_item(input_text)
-  let l:std_bullet_regex  = '\v(^(\s*)(-|\*+|\.+|#\.|\+|\\item)(\s+))(.*)'
+  let l:std_bullet_regex  = '\v(^(\s*)('
+        \ . join(g:bullets_list_item_styles, '|')
+        \ . ')(\s+))(.*)'
   let l:matches           = matchlist(a:input_text, l:std_bullet_regex)
 
   if empty(l:matches)
@@ -574,7 +582,11 @@ fun! s:insert_new_bullet()
       " We don't want to create a new bullet if the previous one was not used,
       " instead we want to delete the empty bullet - like word processors do
       if g:bullets_delete_last_bullet_if_empty
-        call setline(l:curr_line_num, '')
+        if g:bullets_delete_last_bullet_if_empty == 1
+          call setline(l:curr_line_num, '')
+        elseif g:bullets_delete_last_bullet_if_empty == 2
+          call <SID>change_bullet_level(1, 0)
+        endif
         let l:send_return = 0
       endif
     elseif !(l:bullet.bullet_type ==# 'abc' && s:abc2dec(l:bullet.bullet) + 1 > s:abc_max)
@@ -775,6 +787,85 @@ fun! s:set_child_checkboxes(lnum, checked)
   endif
 endfun
 
+" Recompute partial checkboxes of a full checkbox tree given the root lnum
+fun! s:recompute_checkbox_tree(lnum)
+  if !g:bullets_nested_checkboxes
+    return
+  endif
+
+  let l:indent = indent(a:lnum)
+  let l:bullet = s:closest_bullet_types(a:lnum, l:indent)
+  let l:bullet = s:resolve_bullet_type(l:bullet)
+
+  if l:bullet.bullet_type !=# 'chk'
+    return
+  endif
+
+  " recursively recompute checkbox tree for all children, then finally self
+
+  let l:children = s:get_children_line_numbers(a:lnum)
+  for l:child_nr in l:children
+    " nb: this skips 'grandchildren' checkboxes (i.e., children who aren't
+    " checkboxes but have checkbox children themselves), but those grandkids
+    " will be targeted by s:recompute_checkboxes_in_range anyway
+    call s:recompute_checkbox_tree(l:child_nr)
+  endfor
+
+
+  if empty(l:children)
+    " if no children, preserve previous checked state
+    " partially completed checkboxes become unchecked
+    if empty(l:bullet) || !has_key(l:bullet, 'checkbox_marker')
+      return
+    endif
+
+    let l:checkbox_markers = split(g:bullets_checkbox_markers, '\zs')
+    let l:partial_markers = join(l:checkbox_markers[1:-2], '')
+
+    if l:bullet.checkbox_marker =~# '\v[' . l:partial_markers . ']'
+      call s:set_checkbox(a:lnum, l:checkbox_markers[0])
+    endif
+  else
+    " if children exist, recompute this checkbox status
+    let l:first_child = l:children[0]
+    let l:completion_marker = s:sibling_checkbox_status(l:first_child)
+    call s:set_checkbox(a:lnum, l:completion_marker)
+  endif
+endfun
+
+fun! s:recompute_checkboxes_in_range(start, end)
+  if !g:bullets_nested_checkboxes
+    return
+  endif
+
+  call s:enable_bullet_cache()
+  for l:nr in range(a:start, a:end)
+    " find all bullets who do not have a checkbox parent
+    let l:parent = s:get_parent(l:nr)
+    if !empty(l:parent) && l:parent.bullet_type ==# 'chk'
+      continue
+    end
+
+    call s:recompute_checkbox_tree(l:nr)
+  endfor
+  call s:disable_bullet_cache()
+endfun
+
+" Recomputes checkboxes for the whole list containing the cursor.
+fun! s:recompute_checkboxes()
+  if !g:bullets_nested_checkboxes
+    return
+  endif
+
+  call s:enable_bullet_cache()
+  let l:first_line = s:first_bullet_line(line('.'))
+  let l:last_line = s:last_bullet_line(line('.'))
+  if l:first_line > 0 && l:last_line > 0
+    call s:recompute_checkboxes_in_range(l:first_line, l:last_line)
+  endif
+  call s:disable_bullet_cache()
+endfun
+
 command! SelectCheckboxInside call <SID>select_checkbox(1)
 command! SelectCheckbox call <SID>select_checkbox(0)
 command! ToggleCheckbox call <SID>toggle_checkboxes_nested()
@@ -957,6 +1048,7 @@ endfun
 
 command! -range=% RenumberSelection call <SID>renumber_selection()
 command! RenumberList call <SID>renumber_whole_list()
+command! RecomputeCheckboxes call <SID>recompute_checkboxes()
 
 " --------------------------------------------------------- }}}
 
@@ -967,7 +1059,7 @@ fun! s:change_line_bullet_level(direction, lnum)
   if a:direction == 1
     if l:curr_line != [] && indent(a:lnum) == 0
       " Promoting a bullet at the highest level will delete the bullet
-      call setline(a:lnum, l:curr_line[0].text_after_bullet)
+      call setline(a:lnum, l:curr_line[-1].text_after_bullet)
       return
     else
       execute a:lnum . 'normal! <<'
@@ -1103,6 +1195,9 @@ nnoremap <silent> <Plug>(bullets-renumber) :RenumberList<cr>
 " Toggle checkbox
 nnoremap <silent> <Plug>(bullets-toggle-checkbox) :ToggleCheckbox<cr>
 
+" Recompute checkbox list
+nnoremap <silent> <Plug>(bullets-recompute-checkboxes) :RecomputeCheckboxes<cr>
+
 " Promote and Demote outline level
 inoremap <silent> <Plug>(bullets-demote) <C-o>:BulletDemote<cr>
 nnoremap <silent> <Plug>(bullets-demote) :BulletDemote<cr>

spec/bullets_spec.rb

@@ -271,6 +271,31 @@
         TEXT
       end
 
+      it 'promote the last bullet when configured to' do
+        filename = "#{SecureRandom.hex(6)}.txt"
+        write_file(filename, <<-TEXT)
+          # Hello there
+          - this is the first bullet
+            - this is the second bullet
+        TEXT
+
+        vim.command 'let g:bullets_delete_last_bullet_if_empty = 2'
+        vim.edit filename
+        vim.type 'GA'
+        vim.feedkeys '\<cr>'
+        vim.feedkeys '\<cr>'
+        vim.write
+
+        file_contents = IO.read(filename)
+
+        expect(file_contents.strip).to eq normalize_string_indent(<<-TEXT)
+          # Hello there
+          - this is the first bullet
+            - this is the second bullet
+          -
+        TEXT
+      end
+
       it 'does not delete the last bullet when configured not to' do
         filename = "#{SecureRandom.hex(6)}.txt"
         write_file(filename, <<-TEXT)