The asyncrun.vim from grodzik

Preface

This plugin takes the advantage of new apis in Vim 8 (and NeoVim) to enable you to run shell commands in background and read output in the quickfix window in realtime:

Easy to use, just start your background command by :AsyncRun (just like old "!" cmd).
Command is done in the background, no need to wait for the entire process to finish.
Output are displayed in the quickfix window, errors are matched with errorformat.
You can explore the error output immediately or keep working in vim while executing.
Ring the bell or play a sound to notify you job finished while you're focusing on editing.
Fast and lightweight, just a single self-contained asyncrun.vim source file.
Provide corresponding user experience in vim, neovim, gvim and macvim.

If that doesn't excite you, then perhaps this GIF screen capture below will change your mind.

News

2016/11/01 asyncrun.vim can now cooperate with errormarker now.
2016/10/17 Glad to announce that asyncrun.vim supports NeoVim now.
2016/10/15 asyncrun.vim can cooperate with vim-fugitive, see the bottom of the README.

Install

Copy asyncrun.vim to your ~/.vim/plugin or use Vundle to install it from skywind3000/asyncrun.vim .

Example

Tutorials

Async run gcc to compile current file

:AsyncRun gcc % -o %<
:AsyncRun g++ -O3 "%" -o "%<" -lpthread

This command will run gcc in the background and output to the quickfix window in realtime. Macro '%' stands for filename and '%<' represents filename without extension.

Async run make

:AsyncRun make
:AsyncRun make -f makefile

Grep key word

:AsyncRun! grep -R word . 
:AsyncRun! grep -R <cword> .

when ! is included, auto-scroll in quickfix will be disabled. <cword> represents current word under cursor.

Compile go project

:AsyncRun go build "%:p:h"

Macro '%:p:h' stands for current file dir.

Lookup man page

:AsyncRun! man -S 3:2:1 <cword>

Git push

:AsyncRun git push origin master

Setup `<F7>` to compile file

:noremap <F7> :AsyncRun gcc "%" -o "%<" <cr>

File name may contain spaces, therefore, it's safe to quote them.

Manual

There are two vim commands: :AsyncRun and :AsyncStop to control async jobs.

AsyncRun - Run shell command

:AsyncRun[!] [options] {cmd} ...

run shell command in background and output to quickfix. when ! is included, auto-scroll in quickfix will be disabled. Parameters are splited by space, if a parameter contains space, it should be quoted or escaped as backslash + space (unix only).

Parameters accept macros start with '%', '#' or '<' :

%:p     - File name of current buffer with full path
%:t     - File name of current buffer without path
%:p:h   - File path of current buffer without file name
%:e     - File extension of current buffer
%:t:r   - File name of current buffer without path and extension
%       - File name relativize to current directory
%:h:.   - File path relativize to current directory
<cwd>   - Current directory
<cword> - Current word under cursor
<cfile> - Current file name under cursor

Environment variables are set before executing:

$VIM_FILEPATH  - File name of current buffer with full path
$VIM_FILENAME  - File name of current buffer without path
$VIM_FILEDIR   - Full path of current buffer without the file name
$VIM_FILEEXT   - File extension of current buffer
$VIM_FILENOEXT - File name of current buffer without path and extension
$VIM_CWD       - Current directory
$VIM_RELDIR    - File path relativize to current directory
$VIM_RELNAME   - File name relativize to current directory 
$VIM_CWORD     - Current word under cursor
$VIM_CFILE     - Current filename under cursor
$VIM_GUI       - Is running under gui ?
$VIM_VERSION   - Value of v:version
$VIM_COLUMNS   - How many columns in vim's screen
$VIM_LINES     - How many lines in vim's screen
$VIM_SVRNAME   - Value of v:servername for +clientserver usage

These environment variables wrapped by $(...) (eg. $(VIM_FILENAME)) will also be expanded in the parameters.

There can be some options before your [cmd]:

-mode=0/1/2 - start mode: 0(async, default), 1(:make), 2(:!)
-cwd=?      - initial directory, (use current directory if unset)
-save=0/1   - non-zero to save unsaved files before executing
-program=?  - set to `make` to use `&makeprg`, `grep` to use `&grepprg` 
-post=?     - vimscript to exec after this job finished, spaces **must** be escaped to '\ '
-auto=?     - event name to trigger "QuickFixCmdPre/QuickFixCmdPost [name]" autocmd

All options must start with a minus and position before [cmd]. Since no shell command string starts with a minus. So they can be distinguished from shell command easily without any ambiguity.

Don't worry if you do have a shell command starting with '-', Just put a placeholder @ before your command to tell asyncrun explicitly: "stop parsing options now, the following string is all my command".

AsyncStop - Stop the running job

:AsyncStop[!]

stop the running job, when "!" is included, job will be stopped by signal KILL

Settings:

g:asyncrun_exit - script will be executed after finished
g:asyncrun_bell - non-zero to ring a bell after finished
g:asyncrun_mode - 0:async(require vim 7.4.1829) 1:sync 2:shell
g:asyncrun_encs - set shell encoding if it's different from &encoding, see encoding
g:asyncrun_trim - non-zero to trim the empty lines in the quickfix window.
g:asyncrun_auto - event name to trigger QuickFixCmdPre/QuickFixCmdPost, see FAQ
g:asyncrun_timer - how many messages should be inserted into quickfix every 100ms interval.

Variables:

g:asyncrun_code - exit code
g:asyncrun_status - 'running', 'success' or 'failure'

Autocmd:

autocmd User AsyncRunPre   - triggered before executing
autocmd User AsyncRunStart - triggered after starting successfully
autocmd User AsyncRunStop  - triggered when job finished

Note, AsyncRunPre is always likely to be invoked, but AsyncRunStart and AsyncRunStop will only be invoked if the job starts successfully.

When previous job is still running or vim job slot is full, AsyncRun may fail. In this circumstance, AsyncRunPre will be invoked but AsyncRunStart and AsyncRunStop will have no chance to trigger.

Requirements:

Vim 7.4.1829 is minimal version to support async mode. If you are use older versions, g:asyncrun_mode will fall back from 0/async to 1/sync. NeoVim 0.1.4 or later is also supported.

Recommend to use Vim 8.0 or later.

Cooperate with vim-fugitive:

asyncrun.vim can cooperate with vim-fugitive, see here.

Don't forget to read the Frequently Asked Questions.

Cooperate with other Plugins

Name	Description
vim-fugitive	perfect cooperation, asyncrun gets Gfetch/Gpush running in background
errormarker	perfect cooperation, errormarker will display the signs on the error or warning lines
airline	very well, airline will display status of background jobs
sprint	nice plugin who uses asyncrun to provide an IDE's run button to runs your code
netrw	netrw can save remote files on background now. Experimental, take your own risk

See: Cooperate with famous plugins

History

1.3.9 (2016-12-23): minor bugs fixed, improve performance and compatibility.
1.3.8 (2016-11-17): new autocmd AsyncRunPre/AsyncRunStart/AsyncRunStop, fixed cmd line window conflict.
1.3.7 (2016-11-13): new option 'g:asyncrun_timer' to prevent gui freeze by massive output.
1.3.6 (2016-11-08): improve performance in quickfix_toggle, fixed small issue in bell ringing.
1.3.5 (2016-11-02): new option "g:asyncrun_auto" to trigger QuickFixCmdPre/QuickFixCmdPost.
1.3.4 (2016-10-28): new option "g:asyncrun_local" to use local value of errorformat rather the global value.
1.3.3 (2016-10-21): prevent job who reads stdin from getting hanging, fixed an issue in fast exiting jobs.
1.3.2 (2016-10-19): new "-post" option to run a vimscript after the job finished
1.3.1 (2016-10-18): fixed few issues of arguments passing in different modes
1.3.0 (2016-10-17): add support to neovim, better CJK characters handling.
1.2.0 (2016-10-16): refactor, correct arguments parsing, cmd options and &makeprg supports
1.1.1 (2016-10-13): use the vim native &shell and &shellcmdflag config to execute commands.
1.1.0 (2016-10-12): quickfix window scroll only if cursor is on the last line
1.0.3 (2016-10-10): reduce quickfix output latency.
1.0.2 (2016-10-09): fixed an issue in replacing macros in parameters.
1.0.1 (2016-10-07): Add a convenient way to toggle quickfix window (asyncrun#quickfix_toggle)
1.0.0 (2016-09-21): can fall back to sync mode to compatible older vim versions.
0.0.3 (2016-09-15): new arguments now accept environment variables wrapped by $(...)
0.0.2 (2016-09-12): some improvements and more documents for a tiny tutorial.
0.0.1 (2016-09-08): improve arguments parsing
0.0.0 (2016-08-24): initial version

Credits

Trying best to provide the most simply and convenience experience in the asynchronous-jobs.

Author: skywind3000 Please vote it if you like it: http://www.vim.org/scripts/script.php?script_id=5431

grodzik / asyncrun.vim Goto Github PK

asyncrun.vim's Introduction