Compatibility of compiler plugins with vim-dispatch

[moetayuko]

Issue
To perform grammar check with YaLafi, the documented way is:

:compiler vlty
:make
:copen

This works quite well and properly fills the quickfix window like this:

But with Tim Pope's vim-dispatch plugin, after either:

:compiler vlty
:Make

or :Dispatch -compiler=vlty, I got additional boilerplate outputs as follows:

I failed to find the explanation from neither vimtex's nor vim-dispatch's doc, how to make vim-dispatch produce the same output as vim's built-in :make command?

Cc: @matze-dd

[lervag]

Interesting and good question; I hope @matze-dd can look into it and help. I don't really know so much about this stuff myself.

[matze-dd]

Thanks for reporting ...

This works quite well and properly fills the quickfix window like this:

... and for the positive feedback!

The problem you describe is very probably due to a non-correct errorformat setting in compiler vlty. I will need some more time to propose a PR, but this quick fix did work for me in .../vimtex/compiler/vlty.vim (the commented lines starting with " are the ones to be replaced by the following ones).

if s:vlty.show_suggestions == 0
" let &l:errorformat .= '%ZMessage: %m,%-G%.%#'
  let &l:errorformat .= '%ZMessage: %m,%-G%.%#,%-G%.%#'
else
" let &l:errorformat .= '%CMessage: %m,%Z%m,%-G%.%#'
  let &l:errorformat .= '%CMessage: %m,%Z%m,%-G%.%#,%-G%.%#'
endif

It seems that the current errorformat does not consume enough of the message returned by YaLafi, so that vim-dispatch tries to assign it somehow.

BTW: It appears that you do not want to wait while the proofreader is running. Did you already try this option?

let g:vimtex_grammar_vlty.server = 'my'

The started LanguageTool server is faster thanks to the omitted start-up work at each check, and thanks to its internal sentence caching mechanism.

[moetayuko]

if s:vlty.show_suggestions == 0
" let &l:errorformat .= '%ZMessage: %m,%-G%.%#'
  let &l:errorformat .= '%ZMessage: %m,%-G%.%#,%-G%.%#'
else
" let &l:errorformat .= '%CMessage: %m,%Z%m,%-G%.%#'
  let &l:errorformat .= '%CMessage: %m,%Z%m,%-G%.%#,%-G%.%#'
endif

It seems that the current errorformat does not consume enough of the message returned by YaLafi, so that vim-dispatch tries to assign it somehow.

It works as expected after changing errorformat, thanks.

BTW: It appears that you do not want to wait while the proofreader is running. Did you already try this option?

let g:vimtex_grammar_vlty.server = 'my'

The started LanguageTool server is faster thanks to the omitted start-up work at each check, and thanks to its internal sentence caching mechanism.

Yes I took most of the options from https://github.com/matze-dd/YaLafi#plugin-vimtex

[matze-dd]

See PR #1856. Does this work for you, @dianlujitao?

[moetayuko]

See PR #1856. Does this work for you, @dianlujitao?

Warnings such as

|| *** yalafi.shell: warning:
|| *** could not load module 'yalafi.packages.hyperref'

are not consumed while the others are gone.

[matze-dd]

Thanks for testing!

Unfortunately, I cannot reproduce that. With :make, these warnings appear in the terminal (written to stderr), but they are not in the quickfix list, neither with :make, nor with :Make.

Could you please provide a minimum example? Which Vim do you use?

[moetayuko]

Thanks for testing!

Unfortunately, I cannot reproduce that. With :make, these warnings appear in the terminal (written to stderr), but they are not in the quickfix list, neither with :make, nor with :Make.

Could you please provide a minimum example? Which Vim do you use?

They are not in the quickfix list with :make here but they are with :Make and :Dispatch -compiler=vlty.

I'm able to reproduce the issue with https://github.com/MCG-NKU/CVPR_Template/blob/master/cvpr.tex

My vim version is as follows:

VIM - Vi IMproved 8.2 (2019 Dec 12, compiled Nov 15 2020 16:37:08)
Included patches: 1-1989
Compiled by Arch Linux
Huge version with GTK3 GUI.  Features included (+) or not (-):
+acl               -farsi             +mouse_sgr         +tag_binary
+arabic            +file_in_path      -mouse_sysmouse    -tag_old_static
+autocmd           +find_in_path      +mouse_urxvt       -tag_any_white
+autochdir         +float             +mouse_xterm       +tcl/dyn
-autoservername    +folding           +multi_byte        +termguicolors
+balloon_eval      -footer            +multi_lang        +terminal
+balloon_eval_term +fork()            -mzscheme          +terminfo
+browse            +gettext           +netbeans_intg     +termresponse
++builtin_terms    -hangul_input      +num64             +textobjects
+byte_offset       +iconv             +packages          +textprop
+channel           +insert_expand     +path_extra        +timers
+cindent           +ipv6              +perl/dyn          +title
+clientserver      +job               +persistent_undo   +toolbar
+clipboard         +jumplist          +popupwin          +user_commands
+cmdline_compl     +keymap            +postscript        +vartabs
+cmdline_hist      +lambda            +printer           +vertsplit
+cmdline_info      +langmap           +profile           +virtualedit
+comments          +libcall           +python/dyn        +visual
+conceal           +linebreak         +python3/dyn       +visualextra
+cryptv            +lispindent        +quickfix          +viminfo
+cscope            +listcmds          +reltime           +vreplace
+cursorbind        +localmap          +rightleft         +wildignore
+cursorshape       +lua/dyn           +ruby/dyn          +wildmenu
+dialog_con_gui    +menu              +scrollbind        +windows
+diff              +mksession         +signs             +writebackup
+digraphs          +modify_fname      +smartindent       +X11
+dnd               +mouse             +sound             -xfontset
-ebcdic            +mouseshape        +spell             +xim
+emacs_tags        +mouse_dec         +startuptime       -xpm
+eval              +mouse_gpm         +statusline        +xsmp_interact
+ex_extra          -mouse_jsbterm     -sun_workshop      +xterm_clipboard
+extra_search      +mouse_netterm     +syntax            -xterm_save
   system vimrc file: "/etc/vimrc"
     user vimrc file: "$HOME/.vimrc"
 2nd user vimrc file: "~/.vim/vimrc"
      user exrc file: "$HOME/.exrc"
  system gvimrc file: "/etc/gvimrc"
    user gvimrc file: "$HOME/.gvimrc"
2nd user gvimrc file: "~/.vim/gvimrc"
       defaults file: "$VIMRUNTIME/defaults.vim"
    system menu file: "$VIMRUNTIME/menu.vim"
  fall-back for $VIM: "/usr/share/vim"
Compilation: gcc -c -I. -Iproto -DHAVE_CONFIG_H -DFEAT_GUI_GTK  -I/usr/include/gtk-3.0 -I/usr/include/pango-1.0 -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -I/usr/include/harfbuzz -I/usr/include/freetype2 -I/usr/include/libpng16 -I/usr/include/libmount -I/usr/include/blkid -I/usr/include/fribidi -I/usr/include/cairo -I/usr/include/pixman-1 -I/usr/include/gdk-pixbuf-2.0 -I/usr/include/gio-unix-2.0 -I/usr/include/cloudproviders -I/usr/include/atk-1.0 -I/usr/include/at-spi2-atk/2.0 -I/usr/include/dbus-1.0 -I/usr/lib/dbus-1.0/include -I/usr/include/at-spi-2.0 -pthread    -march=x86-64 -mtune=generic -O2 -pipe -fno-plt -D_REENTRANT  -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=1
Linking: gcc   -L. -Wl,-O1,--sort-common,--as-needed,-z,relro,-z,now -fstack-protector-strong -rdynamic -Wl,-export-dynamic -Wl,-E -Wl,-rpath,/usr/lib/perl5/5.32/core_perl/CORE  -Wl,-O1,--sort-common,--as-needed,-z,relro,-z,now -L/usr/local/lib -Wl,--as-needed -o vim   -lgtk-3 -lgdk-3 -lz -lpangocairo-1.0 -lpango-1.0 -lharfbuzz -latk-1.0 -lcairo-gobject -lcairo -lgdk_pixbuf-2.0 -lgio-2.0 -lgobject-2.0 -lglib-2.0  -lSM -lICE -lXt -lX11 -lXdmcp -lSM -lICE  -lm -ltinfo -lelf    -lcanberra  -lacl -lattr -lgpm -ldl   -Wl,-E -Wl,-rpath,/usr/lib/perl5/5.32/core_perl/CORE -Wl,-O1,--sort-common,--as-needed,-z,relro,-z,now -fstack-protector-strong -L/usr/local/lib  -L/usr/lib/perl5/5.32/core_perl/CORE -lperl -lpthread -ldl -lm -lcrypt -lutil -lc   -L/usr/lib -ltclstub8.6 -ldl -lz -lpthread -lm

[matze-dd]

Thanks!

We might have a problem with different Linux distributions. On my Lubuntu, neither Vim in a terminal window nor Gvim with GTK3 GUI do show the *** ... messages with your cvpr.tex example. Unfortunately, I only have access to an Arch Linux next week.

Perhaps, anybody else can comment on the problem? I have the impression that YaLafi's output to stderr is somehow mixed with its messages to stdout (only under Arch Linux?).

Does the problem also occur with Vim in a terminal window?

[moetayuko]

Thanks!

We might have a problem with different Linux distributions. On my Lubuntu, neither Vim in a terminal window nor Gvim with GTK3 GUI do show the *** ... messages with your cvpr.tex example. Unfortunately, I only have access to an Arch Linux next week.

Perhaps, anybody else can comment on the problem? I have the impression that YaLafi's output to stderr is somehow mixed with its messages to stdout (only under Arch Linux?).

Does the problem also occur with Vim in a terminal window?

Oops the problem only occurs in tmux, with a normal Konsole window it works fine.

[matze-dd]

Oops the problem only occurs in tmux, with a normal Konsole window it works fine.

Sounds good, I'm relieved. Now that we know what's going on, I'd propose to include these *** ... messages into the errorformat.

Can do and test that next week. Could you please keep the PR open, @lervag?

[lervag]

Yes, of course. :)

[matze-dd]

Sorry for the noise, the problem did not let me rest.

Here is the reason, why the initial "dirty hack" from above does work. It indeed seems to be the recommended solution!

[lervag]

Ah, it's always nice to get to the bottom of things! I'll be glad if we can also understand why @dianlujitao still experiences issues inside tmux.

[moetayuko]

Ah, it's always nice to get to the bottom of things! I'll be glad if we can also understand why @dianlujitao still experiences issues inside tmux.

The initial "hack" which appends ,%-G%.%# to the current format indeed worked for me, with both vanilla terminal and tmux.