Output of `latexindent` isn't stable (specialBeginEnd)

arodomanov commented 11 months ago

Hi,

I'm trying to make latexindent automatically indent the text inside any (round) parentheses (in other words, to treat ( and ) as the beginning and end, respectively, of a certain environment).

To achieve this, I've tried to declare a specialBeginEnd block (see the latexindent.yaml file below).

At first, this seemed to work fine and produced the result I wanted. However, I then noticed that the result isn't stable. Specifically, the output changes if you run latexindent again (one or several times) without changing anything. In particular, I managed to obtain two different outputs after running latexindent several times on the same file with the same settings and by using the same command (see below).

From my limited understanding (after inspecting the log file), it looks as if the problem is that each run of latexindent joins the settings from specialBeginEnd in an arbitrary order which results in different internal regular expressions.

Please confirm if it's a bug, or if I'm misusing the specialBeginEnd feature.

Original .tex code (`source.tex`)

$
  a
  +
  (
    b + c
  )
  =
  d
$
and
$
  e + f = g
$

yaml settings (`latexindent.yaml`)

defaultIndent: "  "

specialBeginEnd:
  specialBeforeCommand: 1

  parentheses:
    begin: \(
    end: \)
    lookForThis: 1

The command used to run `latexindent`

latexindent -l latexindent.yaml -o=+-mod.tex source.tex

Actual output 1 [good] (`source-mod.tex`)

$
  a
  +
  (
    b + c
  )
  =
  d
$
and
$
  e + f = g
$

Actual output 2 [bad] (`source-mod.tex`)

$
  a
  +
  (
    b + c
  )
  =
  d
  $
    and
  $
  e + f = g
$

Desired or expected output

The desired output is output 1 [good] presented above.