• new feature for oneSentencePerLine: sentencesDoNOTcontain, see issue-419
• bug fix for items, see issue-467

changes to defaults:

• textWrap: Huge now set to overflow by default; this means that words and other strings of characters will not be broken mid-word by the text wrapping routine. Users are encouraged not to change this, but have the option to do so.

enhancements:

• users should see improved performance when the -m switch is active; see
  benchmark details within https://github.com/cmhughes/latexindent.pl/issues/268
• users should see improved behaviour in the alignment at ampersand routine,
  a long standing issue detailed at https://github.com/cmhughes/latexindent.pl/issues/85

example: issue 85

from https://github.com/cmhughes/latexindent.pl/issues/85 starting with

\matrix {
c01 & c02 \\
c_{11} & c12 \\
}

gives, by default

\matrix {
	c01    & c02 \\
	c_{11} & c12 \\
}

example: issue 162

from https://github.com/cmhughes/latexindent.pl/issues/162 starting with

\begin{align}
A & =\begin{array}{cc}
BBB & CCC\\
E & F
\end{array}\\
Z & =\begin{array}{cc}
Y & X\\
W & V
\end{array}
\end{align}

gives, by default,

\begin{align}
	A & =\begin{array}{cc}
		     BBB & CCC \\
		     E   & F
	     \end{array} \\
	Z & =\begin{array}{cc}
		     Y & X \\
		     W & V
	     \end{array}
\end{align}

example: issue 212

from https://github.com/cmhughes/latexindent.pl/issues/212 starting with

\begin{equation}
    \begin{aligned}
        x =& x^2 \mqty[a_{11}  & a_{12} \\ a_{21} & a_{22}] =& f(x) \\
        y =& f(y) =& y^2 \\
        z =& f(z) =& z^2
    \end{aligned}
\end{equation}

gives, by default,

\begin{equation}
	\begin{aligned}
		x = & x^2 \mqty[a_{11} & a_{12} \\ a_{21} & a_{22}] =& f(x) \\
		y = & f(y) =           & y^2    \\
		z = & f(z) =           & z^2
	\end{aligned}
\end{equation}

example: issue 251

from https://github.com/cmhughes/latexindent.pl/issues/251 starting with

\begin{tabular}{ll}
  Testing & Line 1                        \\
  Testing & Line 2                        \\
  Testing & Line 3 \verb|X| \\
  Testing & Line 4                        \\
\end{tabular}

gives, by default,

\begin{tabular}{ll}
	Testing & Line 1          \\
	Testing & Line 2          \\
	Testing & Line 3 \verb|X| \\
	Testing & Line 4          \\
\end{tabular}

enhancements

• logFilePreferences updated with more options, particularly for when -tt switch active https://github.com/cmhughes/latexindent.pl/issues/276
• spacesBeforeAmpersand enhanced with new option for leading blank column behaviour https://github.com/cmhughes/latexindent.pl/issues/275
• fineTuning and noIndentBlock enhanced, demonstrated below https://github.com/cmhughes/latexindent.pl/issues/274
• indentconfig.yaml enhanced with details at https://github.com/cmhughes/latexindent.pl/issues/263 and in documentation
• removeWhiteSpace dos2unixlinebreaks: new switch, documented and details at https://github.com/cmhughes/latexindent.pl/issues/256

bug fix

• https://github.com/cmhughes/latexindent.pl/issues/183, oneSetencePerLine, removeParagraphLineBreaks

demonstration 1: fineTuning trailing comments

starting with

some before text
 \href{Handbook%20for%30Spoken%40document.pdf}{my document}
some after text 

and using

modifyLineBreaks:
    textWrapOptions:
        columns: 80
        huge: overflow
        all: 1
        perCodeBlockBasis: 1
    removeParagraphLineBreaks:
        all: 1

fineTuning:
    trailingComments:
      notPreceededBy: '(?:(?<!Handbook)(?<!for)(?<!Spoken))'

then the output is (using -m switch):

some before text \href{Handbook%20for%30Spoken%40document.pdf}{my document} some after text

demonstration 2: noIndentBlock with begin and end

starting with

some before text
        this code
                won't
     be touched
                    by
             latexindent.pl!
some after text 

and using

noIndentBlock:
    demo:
        begin: 'some\hbefore'
        body: '.*?'
        end: 'some\hafter\htext'
        lookForThis: 1

gives the output

some before text
        this code
                won't
     be touched
                    by
             latexindent.pl!
some after text

Note that lookForThis is optional in the noIndentBlock field; default is 1.

demonstration 3: spacesBeforeAmpersand

Starting with

\begin{equation}
    \begin{aligned}
    & a = b, \\
    & c = d.
    \end{aligned}
\end{equation}

\begin{equation}
    \begin{aligned}
    a & = b, \\
    c & = d.
    \end{aligned}
\end{equation}

and using

defaultIndent: ' '

noAdditionalIndent:
  aligned: 1

lookForAlignDelims:
   aligned: 
      spacesBeforeAmpersand: 
        default: 2
        leadingBlankColumn: 0

then the result is

\begin{equation}
 \begin{aligned}
 & a = b, \\
 & c = d.
 \end{aligned}
\end{equation}

\begin{equation}
 \begin{aligned}
 a  & = b, \\
 c  & = d.
 \end{aligned}
\end{equation}

The fields default and leadingBlankColumn both take integer values that represent the spaces to be added before ampersands. They are both optional.

A minor release that updates log file creation https://github.com/cmhughes/latexindent.pl/issues/145; in particular, users can specify, for example,

latexindent.pl -g /dev/null myfile.tex

so that the log file will not be created. Prior to this release, latexindent.pl would fail if the log file could not be created.

The other minor tweak to the logging procedure is that the FATAL method has been created, for situations in which latexindent is called to act on files that do not exist.

A minor release to include the bugfix for the noindent block bug reported at #266

Minor updates to documentation, details at https://github.com/cmhughes/latexindent.pl/issues/255 and https://github.com/cmhughes/latexindent.pl/issues/259

Minor updates to fineTuning:

• keyEqualsValuesBracesBrackets, https://github.com/cmhughes/latexindent.pl/issues/257 which means that, by default, keyEqualsValuesBracesBrackets no longer begin with braces.
• namedGroupingBracesBrackets, https://github.com/cmhughes/latexindent.pl/issues/258 now starts with a lower-case 'n' in fineTuning so as to be consistent with its appearance elsewhere in defaultSettings.yaml. As this was my mistake, LatexIndent/NamedGroupingBracesBrackets.pm will read from NamedGroupingBracesBrackets (note the upper-case 'N') and a warning is given to the logfile. I plan to support both fineTuning:namedGroupingBracesBrackets and fineTuning:NamedGroupingBracesBrackets for V3.*, but if V4.0 is created, then only namedGroupingBracesBrackets will be supported. I recommend users migrate to namedGroupingBracesBrackets

V3.9, March 14, 2021

• https://github.com/cmhughes/latexindent.pl/issues/229, Log4Perl module removed, logging is now perhaps too simple, but hopefully eases installation and use for all. See Latexindent/Logger.pm for implementation.

Small enhancements:

• https://github.com/cmhughes/latexindent.pl/issues/242, update to -l switch so that instead of only looking for localSettings.yaml, it will also look for (in order): latexindent.yaml, .localSettings.yaml and .latexindent.yaml. Note that you don't need to have all 4, and that for most uses, just 1 of these files should be enough. As previously, using -l=myfile.yaml will only load myfile.yaml and now using -l=myfile.yaml+ will assume that you want to load as many of the following that exist: myfile.yaml, localSettings.yaml, latexindent.yaml, .localSettings.yaml, .latexindent.yaml
• https://github.com/cmhughes/latexindent.pl/issues/239, update to commandCodeBlocks

bug fixes:

• https://github.com/cmhughes/latexindent.pl/issues/243, bug with -y switch, also documented in fineTuning section
• https://github.com/cmhughes/latexindent.pl/issues/249, bug with item indentation resolved
• https://github.com/cmhughes/latexindent.pl/issues/250, bug with ifElseFi resolved so that the main regex for the ifElseFi routine obeys the settings in fineTuning

This is a minor release that implements fixes for the following issues:

• https://github.com/cmhughes/latexindent.pl/issues/209, EndFinishesWithLineBreak + lookForAlignDelims adds extra blank line
• https://github.com/cmhughes/latexindent.pl/issues/217, Spaces Are Converted to Tabs in the Middle of Line
• https://github.com/cmhughes/latexindent.pl/issues/223, Formatting TikZ stuff?

The documentation has been updated with appropriate examples, including details of how to produce alignment such as the following:

\begin{tikzpicture}
	\path (A) edge              node {0,1,L}(B)
	          edge              node {1,1,R} (C)
	      (B) edge [loop above] node {1,1,L}(B)
	          edge              node {0,1,L}(C)
	      (C) edge              node {0,1,L}(D)
	          edge [bend left]  node {1,0,R}(E)
	      (D) edge [loop below] node {1,1,R}(D)
	          edge              node {0,1,R}(A)
	      (E) edge [bend left]  node {1,0,R} (A);
\end{tikzpicture}

and a patch to the textWrap routine, so that spaces are preserved (or not) according to the new field tabstop

x       y

Settings

modifyLineBreaks:
    textWrapOptions:
        columns: 80
        tabstop: 9

Pull request, for reference: https://github.com/cmhughes/latexindent.pl/pull/227

Bug fix addressing the issue at https://github.com/cmhughes/latexindent.pl/issues/207