Add magic comment to switch on/off the "error" highlighting of underscores

[Rmano]

Underscores are marked as errors (in this case, I have hi Error guifg=black guibg=orange gui=none set up because the standard error highlighting in my colortheme is too bland):

which is good. But sometimes you are defining, for example, pieces of codes in a \newcommand or similar:

 %%
\newcommand\npnblock[5]{% block to draw the BJT.
    % #1 -> label
    % #2 -> volts in
    % #3 -> Ib
    % #4 -> Vce
    % #5 -> Ic
    node[left]{\qty{#2}{V}} to[R=$R_B$, o-, f_=\qty{#3}{\mA}]
        ++(1.5,0) node[npn, anchor=B](Q#1){}
        (Q#1.E) node[ground]{}
        ([xshift=0.5cm]Q#1.C) to[open, v=\qty{#4}{V}] ([xshift=0.5cm]Q#1.E)
        (Q#1.C) to[generic=$R_L$, f<_=\qty{#5}{\mA}] ++(0,2)
        node[vcc]{$+V_{CC}$}
    }
%%
%%

...and you have this:

Clearly, there is no way to automatically differentiate the two cases (unless removing the error in every macro replacement text, which I think is not correct).

Maybe there could be a kind of magic %text underscore begin/end (or whatever name, don't trust me on naming things) to switch the highlighting, similar to #3080 ?

[lervag]

It turns out that this is actually hard. The texError group is matched inside many things, and I don't know any way to "remove" it.

I believe the other alternative would be to make the texError group be "optional"?

[Rmano]

If it's difficult, don't spend time on it. It's a minor nuisance. I'd like vim/nvim having some mechanism like magic comments or whatever to switch hilighting off in zones (spell check is also a nuisance sometimes, especially in part of TikZ. )

On the other hand, the texError is useful, so I'll never switch it off globally for a file... :-;

[lervag]

If it's difficult, don't spend time on it.

Yes, it is difficult. It is somewhat hard to explain, but the point is e.g. \foobar{arg} may define a region for the argument, e.g. \texFoobarArg, and that this argument group will typically, if not generally, include the "TOP" syntax and thus the texError.

As far as I know, it is impossible to define a region inside which we say that every subregion should not include what was specified in the subregion syntax definitions.

It's a minor nuisance. I'd like vim/nvim having some mechanism like magic comments or whatever to switch hilighting off in zones (spell check is also a nuisance sometimes, especially in part of TikZ. )

On the other hand, the texError is useful, so I'll never switch it off globally for a file... :-;

Ok, then I think the conclusion is that this is a no-go. Sorry.

A possibility is to create a group that is sort of "trivial". E.g.

%basiczone begin
\newcommand\npnblock[5]{% block to draw the BJT.
    % #1 -> label
    % #2 -> volts in
    % #3 -> Ib
    % #4 -> Vce
    % #5 -> Ic
    node[left]{\qty{#2}{V}} to[R=$R_B$, o-, f_=\qty{#3}{\mA}]
        ++(1.5,0) node[npn, anchor=B](Q#1){}
        (Q#1.E) node[ground]{}
        ([xshift=0.5cm]Q#1.C) to[open, v=\qty{#4}{V}] ([xshift=0.5cm]Q#1.E)
        (Q#1.C) to[generic=$R_L$, f<_=\qty{#5}{\mA}] ++(0,2)
        node[vcc]{$+V_{CC}$}
    }
%basiczone end

where this basiczone will only highlight the \command part and possibly the #n and things without any more nesting or advanced treatment. That is simple to implement and might be a nice pragmatic compromise?

[Rmano]

If this is easy and low-maintenance, maybe it's worth adding (also for other strange cases not discovered yet). I'll use it if it is added, yes.

[lervag]

I already had this, but I forgot. I improved it now, please update and see :help vimtex-synignore - I believe the docs should show how to use it. Let me know what you think!

[Rmano]

It works beautifully.

For whatever reasons, the :h vimtex-synignore does not shows up:

but searching for it in the help does work

Thanks, that's very useful!

[lervag]

It works beautifully.

Great, I'm glad to hear it!

For whatever reasons, the :h vimtex-synignore does not shows up: …

My bad, I didn't notice that the tag was not correct (it was missing the ending *). It is fixed now.