Merge pull request #22 from evanthegrayt/21-start-note-with-visual-selection

Start note with visual selection

Author: evanthegrayt

README.md

@@ -169,8 +169,7 @@ let g:noteworthy_delimiter = '-'
 #### Change the default window height for splits
 
 You can change the default window height for splits. The default is to split the
-current window in half. Note that, if `:Snote` is called with a count, this
-variable will be overridden.
+current window in half.
 
 ```vim
 let g:noteworthy_split_size = 30
@@ -179,8 +178,7 @@ let g:noteworthy_split_size = 30
 #### Change the default window width for vsplits
 
 You can change the default window width for vertical splits. The default is to
-split the current window in half. Note that, if `:Vnote` is called with a count,
-this variable will be overridden.
+split the current window in half.
 
 ```vim
 let g:noteworthy_vsplit_size = 80
@@ -213,6 +211,9 @@ You can also use subdirectories, and they will be created if they don't exist.
 Any one of the above commands will open a file called
 `rails/remember_this_about_rails.md` in your current library.
 
+If called with a range (or a visual selection), the corresponding lines of your
+current file will be appended to the note being edited.
+
 Note that `:Snote`, `:Vnote`, and `:Tnote` commands also exist. They behave the
 same as `:Note`, except they open the note in a split, vertical split, and new
 tab, respectively.

autoload/noteworthy.vim

@@ -1,27 +1,29 @@
 ""
 " Open/create a note.
-function! noteworthy#Note(...) abort
-  call s:File('edit', a:000)
+function! noteworthy#Note(line1, line2, ...) abort
+  call s:File('edit', a:000, a:line1, a:line2)
 endfunction
 
 ""
 " Open/create a note in a new tab.
-function! noteworthy#Tnote(...) abort
-  call s:File('tabedit', a:000)
+function! noteworthy#Tnote(line1, line2, ...) abort
+  call s:File('tabedit', a:000, a:line1, a:line2)
 endfunction
 
 ""
 " Open/create a note in a new split.
-function! noteworthy#Snote(size, ...) abort
-  let l:prefix = a:size ? a:size : get(g:, 'noteworthy_split_size', '')
-  call s:File(l:prefix . 'split', a:000)
+function! noteworthy#Snote(line1, line2, ...) abort
+  call s:File(get(
+        \   g:, 'noteworthy_split_size', ''
+        \ ) . 'split', a:000, a:line1, a:line2)
 endfunction
 
 ""
 " Open/create a note in a new vertical split.
-function! noteworthy#Vnote(size, ...) abort
-  let l:prefix = a:size ? a:size : get(g:, 'noteworthy_vsplit_size', '')
-  call s:File(l:prefix . 'vsplit', a:000)
+function! noteworthy#Vnote(line1, line2, ...) abort
+  call s:File(get(
+        \   g:, 'noteworthy_vsplit_size', ''
+        \ ) . 'vsplit', a:000, a:line1, a:line2)
 endfunction
 
 ""
@@ -179,18 +181,22 @@ endfunction
 
 ""
 " Create or open a note in the current library.
-function! s:File(command, segments) abort
+function! s:File(command, segments, line1, line2) abort
   let l:delim = s:GetNoteDelimiter()
   let l:fext = s:GetNoteFileExt()
   let l:file = s:GetFileName(a:segments, l:delim)
   let l:basedir = fnamemodify(l:file, ':h')
+  if a:line1 != 0 | let l:lines = getline(a:line1, a:line2) | endif
   if !isdirectory(l:basedir) | call mkdir(l:basedir, 'p') | endif
   execute a:command l:file
-  if getfsize(l:file) > 0 | return | endif
-  let l:title = substitute(fnamemodify(l:file, ':t:r'), l:delim, ' ', 'g')
-  if !get(g:, 'noteworthy_use_header', 1) | return | endif
-  let l:formatted_title = s:GetFormattedTitle(l:title)
-  call append(0, [l:formatted_title])
+  if get(g:, 'noteworthy_use_header', 1) && getfsize(l:file) <= 0
+    let l:title = substitute(fnamemodify(l:file, ':t:r'), l:delim, ' ', 'g')
+    call append(0, s:GetFormattedTitle(l:title))
+  endif
+  if exists('l:lines')
+    let l:last_line = trim(getline(line('$'))) == '' ? line('$') - 1 : line('$')
+    call append(l:last_line, l:lines)
+  endif
 endfunction
 
 function! s:GetFileName(segments, delim) abort

doc/noteworthy.txt

@@ -251,24 +251,27 @@ In the root of the project, in a file named .vimrc
 COMMANDS                                                   *noteworthy-commands*
 
                                                                   *Note* *:Note*
-:Note {topic} [{, ...}]     Create new {topic} markdown file in the
+:[{range}]Note {topic} [{, ...}]
+                            Create new {topic} markdown file in the
                             |b:noteworthy_current_library|, or open it if it
                             already exists. The file extension can be omitted.
                             Can be multiple words separated by spaces, which
                             will be replaced by underscores in the file name.
+                            If [{range}] is provided (works with visual
+                            selection), the lines of the current file will be
+                            appended to the note.
 
                                                                 *Snote* *:Snote*
-:[N]Snote {topic} [{, ...}] Same as |Note|, but opens in a split. If N is
-                            provided, it will be used as the height of the
-                            window.
+:[{range}]Snote {topic} [{, ...}]
+                            Same as |:Note|, but opens in a split.
 
                                                                 *Vnote* *:Vnote*
-:[N]Vnote {topic} [{, ...}] Same as |Note|, but opens in a vertical split. If N
-                            is provided, it will be used as the width of the
-                            window.
+:[{range}]Vnote {topic} [{, ...}]
+                            Same as |:Note|, but opens in a vertical split.
 
                                                                 *Tnote* *:Tnote*
-:Tnote {topic} [{, ...}]    Same as |Note|, but opens in new tab.
+:[{range}]Tnote {topic} [{, ...}]
+                            Same as |:Note|, but opens in new tab.
 
 
                                                       *NoteSearch* *:NoteSearch*

plugin/noteworthy.vim

@@ -13,28 +13,28 @@ endif
 ""
 " :Note {topic}, ...
 " Create or edit a note. Opens in current window.
-command! -nargs=+ -complete=custom,noteworthy#Completion Note
-      \ call noteworthy#Note(<f-args>)
+command! -nargs=+ -range=0 -complete=custom,noteworthy#Completion Note
+      \ call noteworthy#Note(<range> ? <line1> : 0, <range> ? <line2> : 0, <f-args>)
 
 ""
 " :[N]VNote {topic}, ...
 " Create or edit a note. Opens in vertical split, [N] columns wide (default:
 " split current window in half)
-command! -count -nargs=+ -complete=custom,noteworthy#Completion Vnote
-      \ call noteworthy#Vnote(<count>, <f-args>)
+command! -range=0 -nargs=+ -complete=custom,noteworthy#Completion Vnote
+      \ call noteworthy#Vnote(<range> ? <line1> : 0, <range> ? <line2> : 0, <f-args>)
 
 ""
 " :[N]SNote {topic}, ...
 " Create or edit a note. Opens in split, [N] columns wide (default: split
 " current window in half)
-command! -count -nargs=+ -complete=custom,noteworthy#Completion Snote
-      \ call noteworthy#Snote(<count>, <f-args>)
+command! -range=0 -nargs=+ -complete=custom,noteworthy#Completion Snote
+      \ call noteworthy#Snote(<range> ? <line1> : 0, <range> ? <line2> : 0, <f-args>)
 
 ""
 " :TNote {topic}, ...
 " Create or edit a note. Opens in new tab.
-command! -nargs=+ -complete=custom,noteworthy#Completion Tnote
-      \ call noteworthy#Tnote(<f-args>)
+command! -range=0 -nargs=+ -complete=custom,noteworthy#Completion Tnote
+      \ call noteworthy#Tnote(<range> ? <line1> : 0, <range> ? <line2> : 0, <f-args>)
 
 ""
 " :NoteLibrary [{directory}]