Adding custom user-defined text commands inside math environments (like align) to be recognized

[kwand]

Description

Apologies for opening up an issue for this, but I've been looking around for a while and tried various things in the docs/mentioned in issues here, but couldn't seem to be able to find a solution to this. (I don't really understand vimscript either, so also apologies if I'm missing an obvious solution here.)

I have a custom command \mathnote{...} (lifted from TeX StackExchange, which is basically a \marginnote{...} command, but works inside math environments like align) which I want to be treated like \text{...}, so it syntactically looks proper and, most importantly, doesn't cause my auto-expanding snippets to trigger while typing text.

My current workaround is pretty crude: I've basically just modified the core.vim file to recognize 'mathnote':

" Text Inside Math regions
for l:re_cmd in [
      \ 'text%(normal|rm|up|tt|sf|sc)?',
      \ 'intertext',
      \ '[mf]box',
      \ 'mathnote',
      \]
  execute 'syntax match texMathCmdText'
        \ '"\v\\' . l:re_cmd . '>"'
        \ 'contained skipwhite nextgroup=texMathTextArg'
endfor
call vimtex#syntax#core#new_arg('texMathTextArg')

This, of course, doesn't really work well when you need to update VimTex.

I suspect there is a way to do this via the vimrc or some sort of custom tex.vim file that I can place in my dotfiles? (Or at least something better than hacking the plugin files)

[kwand]

Also, apologies for the 'bug' label. Looks like I opened the wrong type of issue.

[lervag]

There's the option g:vimtex_syntax_custom_cmds which is quite close. I could image something like this:

let g:vimtex_syntax_custom_cmds = [
      \ {'name': 'mathnote', 'mathmode': 1, 'nextgroup': 'texMathTextArg'},
      \]

This should create the group texMathCmdCMathnote that matches \mathnote and continuous to match the {...} as texMathTextArg.

[lervag]

I've implemented this. I believe you can get your desired functionality with my prevoiusly listed configuration option.

[kwand]

Awesome! It works perfectly. Thanks!

[lervag]

Glad to hear it :)