Skip to content

Latest commit

 

History

History
144 lines (91 loc) · 3.41 KB

README.rst

File metadata and controls

144 lines (91 loc) · 3.41 KB
Raw

VIM-SHOUT

Run and Capture Shell Command Output

Note

Should work with Vim9 (compiled with HUGE features).

I always wanted a simpler way to run an arbitrary shell command with the output being captured into some throwaway buffer. Mostly for the simple scripting (press a button, script is executed and the output is immediately visible).

I have used (and still use) relevant builtin commands (:make, :!cmd, :r !cmd and all the jazz with quickfix/location-list windows) but ... I didn't feel it worked my way.

This works my way though.

Mappings

In a [shout] buffer:

Enter
  • While on line 1, re-execute the command.
  • Switch (open) to the file under cursor.
Space + Enter
Open file under cursor in a new tabpage.
CTRL-C
Kill the shell command.
]]
Goto next error.
[[
Goto previous error.
[{
Goto first error.
]}
Goto last error.

Commands

:Sh {command}

Start {command} in background, open existing [shout] buffer or create a new one and print output of stdout and stderr there. Put cursor to the end of buffer.

:Sh ls -lah
:Sh make
:Sh python
:Sh! {command}

Same as Sh but keep cursor on line 1.

:Sh! rg -nS --column "\b(TODO|FIXME|XXX):" .
:Shut
Close shout window.

Examples of User Commands

:Rg searchpattern, search using ripgrep:

command! -nargs=1 Rg Sh! rg -nS --column "<args>" .

:Todo, search for all TODOs, FIXMEs and XXXs using ripgrep:

command! Todo Sh! rg -nS --column "\b(TODO|FIXME|XXX):" .

Examples of User Mappings

Search word under cursor:

nnoremap <space>8 <scriptcmd>exe "Rg" expand("<cword>")<cr>

Run python script (put into ~/.vim/after/ftplugin/python.vim):

nnoremap <buffer> <F5> <scriptcmd>exe "Sh python" expand("%:p")<cr>

Build and run rust project (put into ~/.vim/after/ftplugin/rust.vim):

nnoremap <buffer> <F5> <scriptcmd>Sh cargo run<cr>
nnoremap <buffer> <F6> <scriptcmd>Sh cargo build<cr>
nnoremap <buffer> <F7> <scriptcmd>Sh cargo build --release<cr>

Build and run a single c-file without Makefile or project with Makefile (put into ~/.vim/after/ftplugin/c.vim):

vim9script

def Make()
    if filereadable("Makefile")
        Sh make
    else
        var fname = expand("%:p:r")
        exe $"Sh make {fname} && chmod +x {fname} && {fname}"
    endif
enddef

nnoremap <buffer><F5> <scriptcmd>Make()<cr>

Options, Variables

g:shout_print_exit_code
Add empty line followed by "Exit code: X" line to the end of [shout] buffer if set to true: Default is true.
b:shout_exit_code
Buffer local varibale. Contains exit code of the latest executed command. Could be useful in custom statuslines.
b:shout_cmd
Buffer local variable. Contains latest executed command. Could be useful in custom statuslines.