Implement g:jsonpath_register option

Author: mogelbrod

README.md

@@ -8,6 +8,20 @@ A Vim plugin which provides ways of navigating JSON document buffers.
 
 More information is available via `:help jsonpath`.
 
+## Quick Start
+
+```vim
+" Install plugin (in this example using vim-plug)
+Plug 'mogelbrod/vim-jsonpath'
+
+" Optionally copy path to a named register (* in this case) when calling :JsonPath
+let g:jsonpath_register = '*'
+
+" Define mappings for json buffers
+au FileType json noremap <buffer> <silent> <expr> <leader>p jsonpath#echo()
+au FileType json noremap <buffer> <silent> <expr> <leader>g jsonpath#goto()
+```
+
 ## Mappings
 
 Mappings are not provided by default but can easily be added to your `.vimrc`.
@@ -24,8 +38,17 @@ Mappings are not provided by default but can easily be added to your `.vimrc`.
   noremap <silent> <expr> <leader>g jsonpath#goto()
   ```
 
+## Configuration
+
+See `:help jsonpath-configuration` for the available configuration options.
+
 ## Installation
 
-Use [Vundle](https://github.com/VundleVim/Vundle.vim),
-[pathogen.vim](https://github.com/tpope/vim-pathogen) or another Vim package
-manager.
+Use [vim-plug](https://github.com/junegunn/vim-plug),
+[Vundle](https://github.com/VundleVim/Vundle.vim),
+[pathogen.vim](https://github.com/tpope/vim-pathogen)
+or another Vim package manager.
+
+```vim
+Plug 'mogelbrod/vim-jsonpath' " example using vim-plug
+```

autoload/jsonpath.vim

@@ -210,7 +210,15 @@ endfunction "}}}
 function! jsonpath#echo() "{{{
   echo 'Parsing buffer...' | redraw
   let path = jsonpath#scan_buffer([], line('.'), col('.'))
-  echo len(path) ? 'Path: ' . join(path, g:jsonpath_delimeter) : 'Empty path'
+  let joined = join(path, g:jsonpath_delimeter)
+  if len(path)
+    if exists('g:jsonpath_register')
+      call setreg(g:jsonpath_register, joined)
+    endif
+    echo 'Path: ' . joined
+  else
+    echo 'Empty path'
+  endif
 endfunction "}}}
 
 " Entry point for the :JsonPath command

doc/jsonpath.txt

@@ -53,6 +53,16 @@ Override using >
     let g:jsonpath_delimeter = ':'
 <
 
+|g:jsonpath_register|                                    *g:jsonpath_register*
+Type: |string|
+Default: None
+
+If assigned to a valid register name (for example `*` or `+`) that register
+will be set to the path output whenever `jsonpath#echo()` is called.
+Set using >
+    let g:jsonpath_register = '*'
+<
+
 ==============================================================================
 COMMANDS                                                   *jsonpath-commands*
 
@@ -62,6 +72,7 @@ COMMANDS                                                   *jsonpath-commands*
         placing the cursor on it if found.
     If omitted: |jsonpath-echo|
         Outputs the path to the identifier under the cursor using |:echo|.
+        Also copies the path to a register if |g:jsonpath_register| is set.
 
 
 ==============================================================================
@@ -76,6 +87,7 @@ The plugin provides two functions that can be invoked using |:JsonPath| or via
 
 `jsonpath#echo()`                                              *jsonpath-echo*
     Outputs the path to the identifier under the cursor using |:echo|.
+    Also copies the path to a register if |g:jsonpath_register| is set.
 
 
 ==============================================================================