xesearch error dealing with itemize (\item)

Question

I figured out a minimal working example. If \item good has the same starting word in the search list, the document doesn't compile.

If I write something like \item foo, the document compiles.

\documentclass{article}
\usepackage{xesearch}

\begin{document}
\SearchList{l}{Better}{good job}

\begin{itemize}
\item good
\end{itemize}

happy good job

\end{document}

The error message is

! LaTeX Error: Something's wrong--perhaps a missing \item.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H   for immediate help.
 ...

l.17 \end{itemize}

Is there any way to fix the issue? My real file has a lot of itemize environments and I hope to run xesearch on arbitary text outside of the itemize environments.

I'm also happy to know how to debug this error, like what the text looks like after the search and replacement.

Answer 1

The xesearch package provides the commands \StopSearching and \StartSearching, which you can hook to the itemize environment. However, there seems to be a bug with these commands as well, as this leads to an error that the internal macro \xs@String is not defined. Defining this somewhere in the code allows for successful compilation:

\documentclass{article}
\usepackage{xesearch}
\makeatletter
\def\xs@String{}
\makeatother
\AddToHook{env/itemize/begin}{\StopSearching}
\AddToHook{env/itemize/end}{\StartSearching}
\begin{document}
\SearchList{l}{Better}{good job}
\begin{itemize}
\item good
\end{itemize}
happy good job

\end{document}

Result:

Note that the end hook is actually not necessary, the begin hook restricts the scope of \StopSearching to the environment. However, for symmetry I have left it in.