Restrict `cmd` parsing to actual commands

[handcart2034]

Description

Currently any strings that starts with a \ are parsed as a cmd, which is not ideal for vimtex-cmd-toggle-star-agn. For example inside an equation when we try toggling to equation*, sometimes the \pi under the cursor gets toggled to \pi* instead, which doesn't exist at all. This also applies to the ubiquitous \frac, \sin, \left etc.

Personally the few actual commands with starred versions that I encounter are

• \section, \subsection, etc
• \cite, \citeauthor, etc
• \ref, \autoref, etc

There are much fewer of those than the literals above, so maybe a whitelist works? But I am not sure about other users.

Steps to reproduce

No response

Expected behavior

No response

Actual behavior

No response

Do you use a latexmkrc file?

No

VimtexInfo

Not needed.

[lervag]

For clarity, could you provide a concrete example of this bug? I.e. some small tex snippet and the command you use, as well as the observed and expected output?

[handcart2034]

Sure, here is an example

\begin{equation*}
  \left( \frac{1}{2} \right)
\end{equation*}

Say the cursor is on line 2, when we call vimtex-cmd-toggle-star-agn obviously we want the \equation environment without star.
However when the cursor is inside the \frac, it will toggle to \frac*{1}{2};
When it's outside the \frac, the \left( ... \right) will get toggled to \left*( ... \right).

Actually this also applies to vimtex-cmd-toggle-star, say we write

\section*{Proof of~\( \sin \pi = 0 \)}

When we call vimtex-cmd-toggle-star or vimtex-cmd-toggle-star-agn we want the \section without star. However if we toggle inside the math the \sin becomes \sin* or \pi becomes \pi* depending on the location of the cursor.

[lervag]

The VimTeX vimtex-cmd-toggle-star will toggle a star in the current command - the command under the cursor. It doesn't care what the command is. Thus what you are observing is the expected behaviour.

The -agn variant (for agnostic) is similar, except it will toggle the "closest" environment or command, based on the current cursor position.

Thus, it seems you are actually requesting an update to the vimtex-cmd-toggle-star command to either ignore certain commands or only apply to a whitelisted list of commands.

[lervag]

To be more clear: I think the root issue you are raising is that vimtex-cmd-toggle-star will toggle the star of any command.

One possibility here is to add a whitelist option, where any commands not in the whitelist would be ignored for the effect of vimtex-cmd-toggle-star.

How would we set the default whitelist? It could be empty which we would interpret as allow all.