Allow argstyle keyword in vimtex_syntax_custom_cmds to accept name of highlight group

[maxmahlke]

Is your feature request related to a problem? Please describe it.
In PR #2033 you extended the list of accepted argstyle values in the vimtex_syntax_custom_cmds setting to include different combinations of bold, italics, and underline. I would like to go even further in the customization, allowing the whole range of options that the highlight command provides (foreground colour, background colour, etc.).

Describe the solution you'd like
From PR #2033, it seems that you define custom highlight groups for the existing argstyle values and expose those to the user. A more flexible solution could be that user passes the name of a highlight group directly, which they define prior to the setting:

highlight def texMyCommandStyle gui=italic guifg=ref guibg=white

let g.vimtex_syntax_custom_cmds = [
          \ {'name': 'MyCommand', 'argstyle': 'texMyCommandStyle'},
\]

I'm not sure that this is possible but it would allow an even greater level of customization. In particular because I'm not a fan of bold or italic fonts in my buffers :-)

[lervag]

In PR #2033 you extended the list of accepted argstyle values in the vimtex_syntax_custom_cmds setting to include different combinations of bold, italics, and underline. I would like to go even further in the customization, allowing the whole range of options that the highlight command provides (foreground colour, background colour, etc.).

You already can. The argstyle is meant as a simple way to link the created match group to one of the existing texStyle* highlight groups. But you are free to instead create your own highlight rules.

Given

let g:vimtex_syntax_custom_cmds = [
      \ {'name': 'foo', 'mathmode': 1, 'argstyle': 'bold'},
      \ {'name': 'bar'},
      \]

This will create these match groups:

• texMathCmdCFoo: The command part, i.e. \foo
• texMathCFooOpt: The option group, i.e. \foo[HERE]
• texMathCFooArg: The argument group, i.e. \foo[...]{HERE}
• texCmdCBar: The command part, i.e. \bar
• texCBarOpt: The option group, i.e. \bar[HERE]
• texCBarArg: The argument group, i.e. \bar[...]{HERE}

The argstyle option just implies that texMathCFooArg is linked to texStyleBold. But you are perfectly free to define the highlightings as you want.

[maxmahlke]

Great, that works, thank you! I see that this is explained at the end of help vimtex-syntax-core, maybe it would be good to reference this at the explanation of the argstyle argument in help g:vimtex_syntax_custom_cmds? Something like To apply styles not offered by 'argstyle', refer to **vimtex-syntax-core**.

[lervag]

Thanks, I agree. I've updated the docs; let me know what you think.

[maxmahlke]

That covers it perfectly. I've been customizing my vimtex syntax in the meantime, this plugin is just a dream come true. Thank you!

[lervag]

I'm glad to hear you like it! :) <3