Job diagnostics in :GoDiag

Also:

- Use :echo instead of :echom for :GoDiag. There's no reason that needs to be
  added to the message log as far as I can see. Probably just used :echom out of
  habit.

- Clean up some TODOs.

Author: arp242

autoload/gopher/diag.vim

@@ -53,10 +53,20 @@ fun! gopher#diag#do(to_clipboard, ...) abort
 
   " List all config variables.
   let l:state = add(l:state, 'VARIABLES')
-  " TODO: wrap very long variable names a bit more nicely.
+  " TODO: wrap very long variable values a bit more nicely.
   let l:state += s:indent(filter(split(execute('let'), "\n"), { i, v -> l:v =~# '^gopher_' }))
   let l:state = add(l:state, ' ')
 
+  " List running jobs.
+  if len(gopher#system#jobs()) > 0
+    let l:state = add(l:state, 'JOBS')
+    for l:j in gopher#system#jobs()
+      let l:info = job_info(l:j)
+      let l:state = add(l:state, printf('    %s PID %d: %s', l:info['status'], l:info['process'], l:info['cmd']))
+    endfor
+    let l:state = add(l:state, ' ')
+  endif
+
   " List command history (if any).
   let l:state = add(l:state, 'COMMAND HISTORY (newest on top)')
   for l:h in gopher#system#history()
@@ -86,7 +96,7 @@ fun! gopher#diag#do(to_clipboard, ...) abort
   endif
 
   for l:line in l:state
-    echom l:line
+    echo l:line
   endfor
 endfun
 

autoload/gopher/guru.vim

@@ -16,9 +16,9 @@ fun! gopher#guru#complete(lead, cmdline, cursor) abort
   return gopher#compl#filter(a:lead, l:list)
 endfun
 
-" TODO: commands need range: freevars
 fun! gopher#guru#do(...) abort
   " Prepend -scope flag unless given in the command.
+  " TODO: commands need range: freevars
   let l:flags = a:000
   if index(l:flags, '-scope') is -1
     let l:flags = ['-scope', get(g:, 'gopher_guru_scope', gopher#go#package())] + l:flags

autoload/gopher/rename.vim

@@ -1,6 +1,28 @@
 " rename.vim: Implement :GoRename.
 
 " TODO: There is command-line support for 'gopls rename'
+"
+"   $ gopls rename './site.go:#1029' XXX
+"   admin.go:
+"   package foo
+"   [..]
+"   init.go:
+"   package foo
+"   [..]
+"
+" Can also use -w to write immediately:
+"
+"     $ gopls rename -w './site.go:#1029' XXX
+"     /home/martin/code/goatcounter/admin.go
+"     /home/martin/code/goatcounter/init.go
+"     /home/martin/code/goatcounter/site.go
+"     /home/martin/code/goatcounter/site_test.go
+"     /home/martin/code/goatcounter/test.go
+"     /home/martin/code/goatcounter/user.go
+"
+" Note: will clobber work tree with .orig files.
+" Limitation: only current package, not e.g. ./handlers subpackage.
+"
 
 " Commandline completion: original, unexported camelCase, and exported
 " CamelCase.

autoload/gopher/system.vim

@@ -3,6 +3,7 @@
 let s:root    = expand('<sfile>:p:h:h:h') " Root dir of this plugin.
 let s:gotools = s:root . '/tools'         " Our Go tools.
 let s:gobin   = s:gotools . '/bin'
+let s:jobs    = []                        " List of running jobs.
 
 " Command history; every item is a list with the exit code, time it took to run,
 " command that was run, its output, and a boolean to signal it was run from
@@ -55,6 +56,12 @@ fun! gopher#system#history() abort
   return s:history
 endfun
 
+" Get a list of currently running jobs. Use job_info() to get more information
+" about a job.
+fun! gopher#system#jobs() abort
+  return s:jobs
+endfun
+
 " Restore an environment variable back to its original value.
 fun! gopher#system#restore_env(name, val) abort
   if a:val is -1
@@ -183,7 +190,6 @@ endfun
 "
 " TODO: Don't run multiple jobs that modify the buffer at the same time. For
 " some tools (like gorename) we need a global lock.
-" TODO: allow inspecting which jobs are running (in :GoDiag?)
 fun! gopher#system#job(done, cmd) abort
   if type(a:cmd) isnot v:t_list
     return gopher#error('must pass a list')
@@ -206,11 +212,14 @@ fun! gopher#system#job(done, cmd) abort
           \ })
   endif
 
-  return job_start(a:cmd, {
+  let l:job = job_start(a:cmd, {
         \ 'callback': function('s:j_out_cb',   [], l:state),
         \ 'exit_cb':  function('s:j_exit_cb',  [], l:state),
         \ 'close_cb': function('s:j_close_cb', [], l:state),
         \})
+
+  call add(s:jobs, l:job)
+  return l:job
 endfun
 
 " Wait for a job to finish. Note that the exit_cb or close_cb may still be
@@ -359,6 +368,13 @@ fun! s:j_exit_cb(job, exit, ...) abort dict
 
   if self.closed
     call gopher#system#_hist_(self.cmd, self.start, self.exit, self.out, 1)
+    for l:i in range(0, len(s:jobs) - 1)
+      if s:jobs[l:i] is a:job
+        call remove(s:jobs, l:i)
+        break
+      endif
+    endfor
+
     call self.done(self.exit, self.out)
   endif
 endfun

compiler/go.vim

@@ -5,22 +5,10 @@ let g:current_compiler = 'go'
 let s:save_cpo = &cpoptions
 set cpoptions-=C
 
-" TODO: can probably automate the gopher_install_package better with some "go
-" list"-fu.
 let &l:makeprg = printf('go install %s %s',
       \ gopher#system#join(get(g:, 'gopher_build_flags', [])),
       \ get(g:, 'gopher_install_package', ''))
 
-" TODO: this error isn't recognized:
-" # a
-" runtime.main_main·f: function main is undeclared in the main package
-
-" TODO: this error isn't recognized:
-"
-" go: finding zgo.at/goatcounter/stripe latest
-" go: zgo.at/goatcounter/[email protected]: parsing go.mod: unexpected module path "zgo.at/goatcounter"
-" go: error loading module requirements
-
 setl errorformat =%-G#\ %.%#                   " Ignore lines beginning with '#' ('# command-line-arguments' line sometimes appears?)
 setl errorformat+=%-G%.%#panic:\ %m            " Ignore lines containing 'panic: message'
 setl errorformat+=%Ecan\'t\ load\ package:\ %m " Start of multiline error string is 'can\'t load package'