Skip to content

fix chktex compiler setup and error parsing #2209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Konfekt wants to merge 2 commits into from
Closed

fix chktex compiler setup and error parsing #2209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
395ab49
fix chktex compiler setup and error parsing
Konfekt Oct 16, 2021
ba687da
add doc, make var labels respect vimtex and do not override env. var.
Konfekt Oct 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions compiler/chktex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,26 @@ let current_compiler = 'chktex'
let s:cpo_save = &cpo
set cpo&vim

CompilerSet makeprg=chktex\ --localrc\ --inputfiles\ --quiet\ -v6\ %:S
CompilerSet errorformat="%f",\ line\ %l.%c:\ %m
if exists(":CompilerSet") != 2
command -nargs=* CompilerSet setlocal <args>
endif

let s:compiler = 'chktex'

let s:chktexrc = (empty($XDG_CONFIG_HOME)
\ ? $HOME . '/.config'
\ : $XDG_CONFIG_HOME) . '/chktexrc'
let g:vimtex_lint_chktex_parameters = get(g:, 'vimtex_lint_chktex_parameters',
\ filereadable(s:chktexrc) ? '--localrc ' . shellescape(s:chktexrc) : '')

let g:vimtex_lint_chktex_ignore_warnings = get(g:, 'vimtex_lint_chktex_ignore_warnings', '-n1 -n3 -n8 -n25 -n36')

let &l:makeprg = s:compiler . ' --quiet --verbosity=4 ' . g:vimtex_lint_chktex_parameters . ' ' . g:vimtex_lint_chktex_ignore_warnings
let &l:errorformat = '%A"%f"\, line %l: %m,' .
\ '%-Z%p^,' .
\ '%-C%.%#'
silent CompilerSet makeprg
silent CompilerSet errorformat

let &cpo = s:cpo_save
unlet s:cpo_save
20 changes: 17 additions & 3 deletions doc/vimtex.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4757,6 +4757,7 @@ text for some tips on how one may use this feature.
It is possible to use more automatic linting through dedicated plugins. For
more information, see |vimtex-nf-linting|.

See more details on configuring `chktex` here: |vimtex-lint-chktex|
------------------------------------------------------------------------------

A common workflow is to utilize the |location-list| with |:lmake|:
Expand Down Expand Up @@ -4795,9 +4796,10 @@ Then, add to `~/.vim/after/ftplugin/bib.vim`: >
augroup END

If one minds that Vim becomes unresponsive while linting, then one may utilize
plugins like |vim-dispatch| [4] or |AsyncRun| [5]. With `vim-dispatch`, one
may simply replace the `:lmake` call with `:Make`. For `AsyncRun`, one may
define a `:Make` command such as: >
plugins like |vim-dispatch| [4], |AsyncRun| [5] or |tasks.vim| [6].
With `tasks.vim`, one may simply replace the `:lmake` call by `:LMake`. With
`vim-dispatch`, by `:Make`. For `AsyncRun`, one may define a `:Make` command
such as: >

command! -bang -nargs=* -complete=file Make
\ AsyncRun<bang> -auto=make -program=make
Expand Down Expand Up @@ -4827,6 +4829,18 @@ Finally, for more full-fledged linting in Vim, see the plug-ins mentioned in
[3] https://github.com/plk/biber
[4] https://github.com/tpope/vim-dispatch
[5] https://github.com/skywind3000/asyncrun.vim
[6] https://github.com/mg979/tasks.vim

------------------------------------------------------------------------------
CHKTEX *vimtex-lint-chktex*

Parameters can be passed to `chktex` by the string variable
|g:vimtex_lint_chktex_parameters|. By default, `chktex` will look up a
configuration file in `$XDG_CONFIG_HOME/chktexrc` (if `$XDG_CONFIG_HOME` is
defined, otherwise in `$HOME/.config`).

The string variable |vimtex_lint_chktex_ignore_warnings| lets chktex suppress
certain warning messages, by default those of type '-n1 -n3 -n8 -n25 -n36'.

==============================================================================
GRAMMAR CHECKING *vimtex-grammar*
Expand Down