E5009 error in :checkhealth vimtex compiler check

[sadid]

Description

The :checkhealth nvim gives an error while everything else seems to be working, including compilation ( ,ll), the viewer, and Synctex. The error happens in the running buffer and not the health report.

I have the same error on macos as well.

Steps to reproduce

1. nvim (this happen even on default nvim buffer)
2. issue :checkhealth

Expected behavior

no error show up while running checkhealth

Actual behavior

E5009: Invalid $VIMRUNTIME: /usr/share/nvim/runtime
Error executing lua: function health#vimtex#check[8]..<SNR>194_check_compiler, line 3: Vim(if):E1174: String required for argument 1
stack traceback:
        [C]: in function 'call'
        /usr/share/nvim/runtime/lua/vim/health.lua:429: in function '_check'
        [string "<nvim>"]:1: in main chunk

Do you use a latexmkrc file?

No

VimtexInfo

System info:
  OS: Linux 6.13.7-zen1-1-zen
  Vim version: NVIM v0.10.4
  Has clientserver: true
  Servername: /run/user/1000/nvim.2142322.0

VimTeX project: test
  base: test.tex
  root: /home/sadid/Desktop/test/latexify
  tex: /home/sadid/Desktop/test/latexify/test.tex
  main parser: fallback current file
  document class: 
  compiler: latexmk
    engine: -pdf
    options:
      -verbose
      -file-line-error
      -synctex=1
      -interaction=nonstopmode
    callback: 1
    continuous: 1
    executable: latexmk
  viewer: Zathura
    xwin id: 0
  qf method: LaTeX logfile

[lervag]

I can't reproduce this problem. It works fine for me both with my personal configuration and with minimal configuration.

Can you please test with a minimal configuration? Let me know if you need help with it.

[thanosgeo18]

On my setup this is caused by the vim.g.vimtex_syntax_conceal command.

[lervag]

On my setup this is caused by the vim.g.vimtex_syntax_conceal command.

This is a very random comment that does not make sense. vim.g.vimtex_syntax_conceal is not a command, it is the name of a global variable and an option for VimTeX. Setting it will not cause any error (unless you are setting it to something that does not make sense) and is definitely not relevant to the issue raised by @sadid.

[thanosgeo18]

I'm sorry, I'm new to Neovim and GitHub, so please excuse my lack of relevant knowledge.

I get a similar error that is fixed when I remove vim.g.vimtex_syntax_conceal = 1 from my init.lua, and I thought that since the error number and this:

stack traceback:
        [C]: in function 'call'
        /usr/share/nvim/runtime/lua/vim/health.lua:429: in function '_check'
        [string "<nvim>"]:1: in main chunk

were the same, it must be the same error. I now read it more carefully and it's not. My bad.

[lervag]

It's OK. I don't understand why removing that should fix the error you observe, and as far as I can see there is no reference to VimTeX in that traceback. Do you get something similar to what was reported by @sadid first, e.g. this?

E5009: Invalid $VIMRUNTIME: /usr/share/nvim/runtime
Error executing lua: function health#vimtex#check[8]..<SNR>194_check_compiler, line 3: Vim(if):E1174: String required for argument 1

[thanosgeo18]

I get this:

E5009: Invalid 'runtimepath'
Error executing lua: function health#vimtex#check[1]..vimtex#options#init[330]..<SNR>42_init_option[5]..vimtex#util#extend_recursive, line 7: Vim(if):E1206: Dictionary required for argument 1
stack traceback:
    [C]: in function 'call'
    .../neovim/nvim-win64/share/nvim/runtime/lua/vim/health.lua:429: in function '_check'
    [string "<nvim>"]:1: in main chunk

Should I open a separate issue?

[lervag]

Should I open a separate issue?

No need. Your problem is what I assumed above - you are setting the variable to something that does not make sense. If you read :help vimtex_syntax_conceal, it says:

*g:vimtex_syntax_conceal*
  A dictionary ...

  ...

  Default value: >vim

    let g:vimtex_syntax_conceal = {
          \ 'accents': 1,
          \ ...
          \}

You are trying to set it to an integer value 1, which does not make sense. And it explains why removing the line fixes things for you. :)

Now, if you have further issues or want more help, feel free to open a new issue. Let's get the current issue back on topic and let's wait to see if @sadid has a reply to my first comment.

[sadid]

I can't reproduce this problem. It works fine for me both with my personal configuration and with minimal configuration.

Can you please test with a minimal configuration? Let me know if you need help with it.

Well in my case, after tinkering with a MWE to reproduce, I narrowed the issue down to a specific configuration in my Vimtex Lua settings (which I completely overawed):

vim.g.vimtex_compiler_method = function(mainfile)
  if vim.fn.filereadable(mainfile) == 1 then
    local lines = vim.fn.readfile(mainfile, "", 5)
    for _, line in ipairs(lines) do
      if string.match(line, "^.*arara") then
        return "arara"
      end
    end
  end

  return "latexmk"
end

I've been using this function to (dynamically) select the compiler based on the presence of arara directives at the beginning of the file. Apparently, this interferes with Vimtex's tests, and I'm unsure how to resolve the conflict other than not obssessed with nvim regular health checks :)

Here is not so minimal example that can be used to reproduce the issue. The script creates a test directory and sets the XDG directories to isolate it from the user's configuration. After running the script, executing :checkhealth will reveal the problem. Although, I believe the reason for the failure is already clear to you.

#!/bin/zsh

export XDG_CONFIG_HOME="$HOME/nvim-minimal-test/config"
export XDG_DATA_HOME="$HOME/nvim-minimal-test/local/share"
export XDG_CACHE_HOME="$HOME/nvim-minimal-test/cache"
mkdir -p "$HOME/nvim-minimal-test/config/nvim/lua/comm/"
mkdir -p "$HOME/nvim-minimal-test/local/share"
mkdir -p "$HOME/nvim-minimal-test/cache/"

cd "$HOME/nvim-minimal-test"

echo '
local vim = vim
vim.o.syntax = "enable"
local python3_path = vim.fn.executable("python3") and vim.fn.system("which python3"):match("([^%s]+)")

-- providers
if python3_path then
  vim.g.python3_host_prog = python3_path
else
  print("python3 not found. Please ensure it is installed and in your PATH.")
end

vim.g.loaded_perl_provider = 0
vim.g.loaded_ruby_provider = 0
----------

require "comm"
' >  "$XDG_CONFIG_HOME/nvim/init.lua"

echo '
local fn = vim.fn
local install_path = fn.stdpath "data" .. "/site/pack/packer/start/packer.nvim"
if fn.empty(fn.glob(install_path)) > 0 then
  local PACKER_BOOTSTRAP = fn.system {
    "git",
    "clone",
    "--depth",
    "1",
    "https://github.com/wbthomason/packer.nvim",
    install_path,
  }
  print "Installing packer close and reopen Neovim..."
  vim.cmd [[packadd packer.nvim]]
end

local status_ok, packer = pcall(require, "packer")
if not status_ok then
  return
end

return packer.startup(function(use)
  use "lervag/vimtex"
end)
' > "$XDG_CONFIG_HOME/nvim/lua/comm/plugins.lua"

echo '
require "comm.plugins"
require "comm.vimtex"
' > "$XDG_CONFIG_HOME/nvim/lua/comm/init.lua"

echo '
vim.g.vimtex_compiler_method = function(mainfile)
  if vim.fn.filereadable(mainfile) == 1 then
    local lines = vim.fn.readfile(mainfile, "", 5)
    for _, line in ipairs(lines) do
      if string.match(line, "^.*arara") then
        return "arara"
      end
    end
  end

  return "latexmk"
end
' > "$XDG_CONFIG_HOME/nvim/lua/comm/vimtex.lua"

echo '\\documentclass{article}
\\begin{document}
Hello, world!
\\end{document}' > test.tex

nvim -u "$XDG_CONFIG_HOME/nvim/init.lua" -i NONE -c 'PackerSync'
# Manually run :checkhealth after vimtex installed

[lervag]

You were right, there was a bug - I'd forgotten to update the health.vim checks for a function valued g:vimtex_compiler_method. I believe this is fixed now, please update and test.