Merge pull request #27 from vitalk/19-optional-mode-keys

Optional mode keys

Author: vitalk

doc/simple-todo.txt

@@ -31,9 +31,15 @@ https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments
 Plugin exposes some <Plug> maps. These maps are available for normal, visual
 and insert modes.
 
-To completely disable default key bindings (which is pretty handy) use:
+All default key bindings (which is pretty handy) can be completely disabled
 >
-let g:simple_todo_map_keys = 0
+    let g:simple_todo_map_keys = 0
+<
+or disabled separately for each mode
+>
+    let g:simple_todo_map_normal_mode_keys = 0
+    let g:simple_todo_map_insert_mode_keys = 0
+    let g:simple_todo_map_visual_mode_keys = 0
 <
                                                      *<Plug>(simple-todo-new)*
 <Plug>(simple-todo-new)
@@ -67,15 +73,13 @@ let g:simple_todo_map_keys = 0
 3. Customization                                   *simple-todo-customization*
 
 The default tick symbol `x` can be changed by defining:
-
 >
-let g:simple_todo_tick_symbol = 'y'
-
+    let g:simple_todo_tick_symbol = 'y'
+<
 You may also change the list symbol `-` by defining:
-
-let g:simple_todo_list_symbol = '*'
+>
+    let g:simple_todo_list_symbol = '*'
 <
-
 ==============================================================================
 4. Contributing                                          *simple-todo-contrib*
 

plugin/simple-todo.vim

@@ -18,6 +18,21 @@ if !exists('g:simple_todo_map_keys')
   let g:simple_todo_map_keys = 1
 endif
 
+" Do enable normal mode keys? (yes)
+if !exists('g:simple_todo_map_normal_mode_keys')
+  let g:simple_todo_map_normal_mode_keys = 1
+endif
+
+" Do enable insert mode keys? (yes)
+if !exists('g:simple_todo_map_insert_mode_keys')
+  let g:simple_todo_map_insert_mode_keys = 1
+endif
+
+" Do enable visual mode keys? (yes)
+if !exists('g:simple_todo_map_visual_mode_keys')
+  let g:simple_todo_map_visual_mode_keys = 1
+endif
+
 if !exists('g:simple_todo_tick_symbol')
     let g:simple_todo_tick_symbol = 'x'
 endif
@@ -77,21 +92,29 @@ inore <silent> <Plug>(simple-todo-mark-as-undone) <Esc>:execute 's/^\(\s*[-+*]\?
 " Key bindings {{{
 
 if g:simple_todo_map_keys
-  nmap <Leader>i <Plug>(simple-todo-new)
-  imap <Leader>i <Plug>(simple-todo-new)
-  imap <Leader>I <Plug>(simple-todo-new-start-of-line)
-  nmap <Leader>I <Plug>(simple-todo-new-start-of-line)
-  vmap <Leader>I <Plug>(simple-todo-new-start-of-line)
-  nmap <Leader>o <Plug>(simple-todo-below)
-  imap <Leader>o <Plug>(simple-todo-below)
-  nmap <Leader>O <Plug>(simple-todo-above)
-  imap <Leader>O <Plug>(simple-todo-above)
-  nmap <Leader>x <Plug>(simple-todo-mark-as-done)
-  vmap <Leader>x <Plug>(simple-todo-mark-as-done)
-  imap <Leader>x <Plug>(simple-todo-mark-as-done)
-  nmap <Leader>X <Plug>(simple-todo-mark-as-undone)
-  vmap <Leader>X <Plug>(simple-todo-mark-as-undone)
-  imap <Leader>X <Plug>(simple-todo-mark-as-undone)
+  if g:simple_todo_map_normal_mode_keys
+    nmap <Leader>i <Plug>(simple-todo-new)
+    nmap <Leader>I <Plug>(simple-todo-new-start-of-line)
+    nmap <Leader>o <Plug>(simple-todo-below)
+    nmap <Leader>O <Plug>(simple-todo-above)
+    nmap <Leader>x <Plug>(simple-todo-mark-as-done)
+    nmap <Leader>X <Plug>(simple-todo-mark-as-undone)
+  endif
+
+  if g:simple_todo_map_insert_mode_keys
+    imap <Leader>i <Plug>(simple-todo-new)
+    imap <Leader>I <Plug>(simple-todo-new-start-of-line)
+    imap <Leader>o <Plug>(simple-todo-below)
+    imap <Leader>O <Plug>(simple-todo-above)
+    imap <Leader>X <Plug>(simple-todo-mark-as-undone)
+    imap <Leader>x <Plug>(simple-todo-mark-as-done)
+  endif
+
+  if g:simple_todo_map_visual_mode_keys
+    vmap <Leader>I <Plug>(simple-todo-new-start-of-line)
+    vmap <Leader>X <Plug>(simple-todo-mark-as-undone)
+    vmap <Leader>x <Plug>(simple-todo-mark-as-done)
+  endif
 endif
 
 " }}}