VimTeX 2.13

This is a relatively large release that brings several features/improvements and bug fixes, as well as some performance improvements and improved documentation.

There are a few breaking changes. The most important one is likely the change from build_dir to out_dir. Users who specify this option should update their configuration. For example:

" This is now wrong!
let g:vimtex_compiler_latexmk = {
      \ 'build_dir': ...
      \}

" Instead, do this:
let g:vimtex_compiler_latexmk = {
      \ 'out_dir': ...
      \}

Features

• Commands
  • Breaking change! Change default command parser (#2628)
  • Add g:vimtex_parser_cmd_separator_check to allow more flexibility for the command parser (#2628)
  • Allow cmd-create (default mapped to <f7>) to work with stars (#2612)
• Viewers
  • Breaking change (minor)! Add job.signal_hup and use it to update mupdf (#2676)
  • Add viewer zathura_simple, a Zathura viewer that should work well on MacOS (#2639, #2046)
  • Add viewer TeXShop (#2387, #2672)
  • Add g:vimtex_view_sioyek_options (#2621, #2468)
• Compilers
  • Breaking change! The .build_dir option of g:vimtex_compiler_METHOD is changed to .out_dir (#2534, #2677)
  • Add support for setting g:vimtex_compiler_latexmk.aux_dir for latexmk (#2534, #2677)
  • :VimtexClean for generic viewers should also remove .xdv files (#2713)
  • Allow more dynamic configuration of g:vimtex_compiler_method (#2721)
• Completion
  • Add g:vimtex_complete_bib.info_fmt (#2606)
• Syntax
  • Add g:vimtex_syntax_custom_cmds_with_concealed_delims (#2634, #2641, #2666)
  • Match ~, \ and \@ as texSpecialChar (#2654, #2655)
  • Add support for empheq package (#2643)
  • Improve conceals for math delimiters, e.g. \\{ and \\} (#2645)
  • Add spacing conceal for \phantom{arg} and \hphantom{arg} (#2642)
  • Add spacing conceal for \> (#2649)
  • Add conceal support for \texorpdfstring (#2648)
  • Some improvements to amsmath package, e.g. conceal for matrix environments (#2650)
  • Conceal \citep with ()s (#2658)
  • Support ieeeconf and ieeetran (#2675)
• Other
  • Add option g:vimtex_mappings_prefix to allow customization of the default mapping prefix (#2611)
  • Improve biblatex errorformat (quickfix parser) (#2663)
  • Improve pplatex errorformat (quickfix parser) (#2703)

Performance

• Postpone gathering the source list during initialization (#2617)
• Use caching for vimtex#parser#preamble (#2617)
• Improve performance of latexlog quickfix parser (use index instead of match) (#2691)
• Avoid expensive parsing on too large log files (#2691)
• Minor improvement to indentexpr

Bug Fixes

• Viewers
  • Update Skim check (#2669)
  • Dont detach the general viewer on Windows (#2401, #2627, #2706, #2717)
• Syntax
  • Apply g:vimtex_syntax_custom_cmds after any additional syntax packages are sourced (#2629)
  • only conceal second \cite option group if it is empty (#2658)
  • Comment environment should be texComment (#2626)
  • vimtex#syntax#in_mathzone should ignore \tag{arg} (#2644)
  • Minor mathdelim bug (#2656)
  • Use correct conceal character for \[lr]brace (#2657)
  • Remove unnecessary keepend for section conceal (#2648)
  • Don't match tex delims in comments (#2697)
  • Ensure that VimTeX syntax options are not overriden (#2698)
  • Wrap syntax foldlevel behind try-catch (#2708)
  • Ignore luaParen and luaParenError (#2711)
• Other
  • Only apply buffer options for filetypes (#1937)
  • Increase range of support for tex2unicode (#2596)
  • Avoid qf_autoclose_check if command-line window open (#2637)
  • Get right debug info on ios (#2647)
  • Relax check for Treesitter conflict (#2469)
  • Fix typo in fold/markers.vim (#2668)
  • Use double quotes for filename in tectonic compiler (#2664)
  • Properly handle nested itemize indents (#2670)
  • Fix regression bug for indentexpr for rnoweb (#2695, #759)
  • Ensure cache has validate data on write
  • Add validation to bib completion cache (#2712)
  • Fix bad compiler/_template.clean function (#2715)

Documentation

• Apply more consistent formatting and use nested highlighting support for neovim with Treesitter.
• Add description of GIF creation process (#2686, #2685)
• Add more compiler engine alternatives in examples for g:vimtex_compiler_latexmk_engines (#2705, #2683)
• Add missing default value (#2623)
• Fix a bug in nvim-cmp configuration example (#2653)
• Some minor improvements

Acknowledgements

As before I would like to give a special thanks to everyone who contributes with PRs: @Aster89 (#2612), @wintermute-cell (#2611), @clason (#2669), @michaelliebling (#2387, #2672), @ejmastnak (#2686), @ehudbehar (#2705), and @doronbehar (#2713).