Updates unpublished plugin before removing.

Author: coderifous

vim/unpublished/working-set/doc/working-set.txt

@@ -15,7 +15,7 @@ CONTENTS                                                 *working-set-contents*
 INTRO                                                       *working-set-intro*
 
 Working Set is an programming editor companion that makes searching, and using
-search results for jumping around, super nice.
+search results for navigation, super nice.
 
 This is the vim plugin that integrates vim with Working Set.  If you're using
 vim 8, then the async features will be used, and the integration is smoother.
@@ -46,15 +46,15 @@ COMMANDS                                                 *working-set-commands*
 
 All interaction with Working Set can be driven by commands in ex mode.
 
-    WS {term}        - does a search in Working Set.
+    :WS {term}        - does a search in Working Set.
 
-    WSSync           - jumps to currently selected location.
+    :WSSync           - jumps to currently selected location.
 
-    WSSelectNextItem - selects next match in Working Set, then syncs.
+    :WSSelectNextItem - selects next match in Working Set, then syncs.
 
-    WSSelectPrevItem - selects previous match in Working Set, then syncs.
+    :WSSelectPrevItem - selects previous match in Working Set, then syncs.
 
-    WSSearchCurrentWord - does a word-boundary search on the word under the
+    :WSSearchCurrentWord - does a word-boundary search on the word under the
                           cursor.
 
 Examples:
@@ -81,6 +81,67 @@ commands.
   <Leader>* This does a word match on the word under the cursor in vim (like *)
             followed by :WSSearchCurrentWord.
 
+Note: If you don't want the default mappings, you can disable them by setting
+"g:WorkingSetSkipMappings" to any value before loading the plugin.
+
+===============================================================================
+USAGE GUIDE                                           *working-set-usage-guide*
+
+Working Set (the standalone program) is intended to run separately, alongside
+your editor.  Your editor will communicate with Working Set via a file socket,
+sending and receiving commands.  Those commands will run searches, display
+results, facilitate navigation and other operations.
+
+Working Set works best running in a terminal window that is tall, and placed
+juxtaposed to the side of your editor.  If you use Tmux, this is a perfect time
+to use split panes.
+
+For example, on a laptop, I would suggest running your terminal full screen with
+Vim taking most of the space on the left, and Working Set running in a pane that
+takes up a smaller space on the right.
+
+                              Laptop Screen
+               +----------------------------+----------+
+               |                            |          |
+               |                            |          |
+               |                            |          |
+               |                            |          |
+               |                            |          |
+               |            Vim             | Working  |
+               |                            |   Set    |
+               |                            |          |
+               |                            |          |
+               |                            |          |
+               |                            |          |
+               +----------------------------+----------+
+
+On a larger desktop or multi-monitor setup, you could be more creative, running
+Working Set in a separate window, even on a separate monitor.
+
+With that in mind, here's the steps:
+
+1) Install Working Set (gem install working_set)
+
+2) Install working-set.vim plugin
+   - don't forget to install socat
+
+3) Change to your project's directory and run `working_set`
+
+  $ working_set [whatever options you want]
+
+  By default, Working Set will create a hidden socket file in that directory
+  that the vim plugin will use for communication.
+
+4) In another terminal, change to your project's directory and open vim.
+
+  $ vim
+
+5) Use "<leader>*" in normal mode, or the :WS commands to drive searches.
+
+Working Set has an ncurses based interface with various keybindings that will
+feel natural to vim users.  Checkout Working Set's help to learn more about what
+you can do with it.
+
 ===============================================================================
 CONTRIBUTING                                         *working-set-contributing*
 
@@ -100,5 +161,6 @@ Git repository: https://github.com/coderifous/working-set.vim
 ===============================================================================
 CHANGELOG                                               *working-set-changelog*
 
-2016/12/25: First Public Release.
+2020/09/02: Actual first public release.
+2016/12/25: First public release.
 

vim/unpublished/working-set/plugin/working-set-vim7.vim

@@ -143,9 +143,11 @@ command! WSSelectPrevItem call s:WS_select_prev_item()
 command! WSSearchCurrentWord call s:WS_search_current_word()
 command! WSWaitForSync call s:WS_wait_for_sync()
 
-nnoremap <silent> <C-n> :WSSelectNextItem<CR>
-nnoremap <silent> <C-p> :WSSelectPrevItem<CR>
-nnoremap <silent> <Leader>* *N:WSSearchCurrentWord<CR>
-nnoremap <silent> <Leader><Leader> :WSWaitForSync<CR>
+if !exists('g:WorkingSetSkipMappings')
+  nnoremap <silent> <C-n> :WSSelectNextItem<CR>
+  nnoremap <silent> <C-p> :WSSelectPrevItem<CR>
+  nnoremap <silent> <Leader>* *N:WSSearchCurrentWord<CR>
+  nnoremap <silent> <Leader><Leader> :WSWaitForSync<CR>
+endif
 
 endif

vim/unpublished/working-set/plugin/working-set-vim8.vim

@@ -22,9 +22,7 @@ func! s:Connect(socketfile)
   let g:WSjob = job_start("socat - UNIX-CONNECT:" . a:socketfile, { "err_cb": function("s:ErrorHandler"), "out_cb": function("s:BasicInputHandler") })
   let g:WSchannel = job_getchannel(g:WSjob)
 
-  if ch_status(g:WSchannel) == "open"
-    echomsg "WS connected."
-  else
+  if ch_status(g:WSchannel) != "open"
     echomsg "Unable to connect to .working_set_socket"
   endif
 endfunc
@@ -127,10 +125,12 @@ command! WSSelectNextItem call s:SelectNextItem()
 command! WSSelectPrevItem call s:SelectPrevItem()
 command! WSSearchCurrentWord call s:SearchCurrentWord()
 
-nnoremap <silent> <C-n>     :WSSelectNextItem<CR>
-nnoremap <silent> <C-p>     :WSSelectPrevItem<CR>
-nnoremap <silent> <Leader>* *N:WSSearchCurrentWord<CR>
-nnoremap <silent> <Leader>p :WSGrab p<CR>
-nnoremap <silent> <Leader>P :WSGrab P<CR>
+if !exists('g:WorkingSetSkipMappings')
+  nnoremap <silent> <C-n>     :WSSelectNextItem<CR>
+  nnoremap <silent> <C-p>     :WSSelectPrevItem<CR>
+  nnoremap <silent> <Leader>* *N:WSSearchCurrentWord<CR>
+  nnoremap <silent> <Leader>p :WSGrab p<CR>
+  nnoremap <silent> <Leader>P :WSGrab P<CR>
+endif
 
 endif

vim/unpublished/working-set/plugin/working-set.vim

@@ -0,0 +1,2 @@
+let g:WorkingSetVersion = "1.0.0"
+