1

Add latex config .indentsettings.yaml

This commit is contained in:
2023-02-06 17:07:26 +01:00
parent 1164314e75
commit c74bd0341a

View File

@ -1,9 +1,10 @@
# defaultSettings.yaml for latexindent.pl, version 3.8.1, 2020-05-05 # defaultSettings.yaml for latexindent.pl, version 3.19.1, 2022-12-04
# a script that aims to # a script that aims to
# beautify .tex, .sty, .cls files # beautify .tex, .sty, .cls files
# #
# (or latexindent.exe if you're on Windows) # (or latexindent.exe if you're on Windows)
# #
#---------------------------------------------------------------------------------------
# This program is free software: you can redistribute it and/or modify # This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by # it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or # the Free Software Foundation, either version 3 of the License, or
@ -19,8 +20,8 @@
# Chris Hughes, 2017 # Chris Hughes, 2017
# #
# For all communication, please visit: https://github.com/cmhughes/latexindent.pl # For all communication, please visit: https://github.com/cmhughes/latexindent.pl
#
#---------------------------------------------------------------------------------------
# You should feel encouraged to change anything you like in these settings, but # You should feel encouraged to change anything you like in these settings, but
# it would probably be better to have your own user settings # it would probably be better to have your own user settings
# files somewhere else - remember that this file may be overwritten # files somewhere else - remember that this file may be overwritten
@ -31,6 +32,8 @@
# for details of how to create and configure your own settings files. # for details of how to create and configure your own settings files.
# #
# Please read the manual (linked from above) first to understand what each switch does. # Please read the manual (linked from above) first to understand what each switch does.
#
#---------------------------------------------------------------------------------------
# latexindent can be called to act on a file without using the file's extension, # latexindent can be called to act on a file without using the file's extension,
# e.g, simply # e.g, simply
@ -89,10 +92,14 @@ logFilePreferences:
showDecorationFinishCodeBlockTrace: 0 showDecorationFinishCodeBlockTrace: 0
endLogFileWith: '--------------' endLogFileWith: '--------------'
showGitHubInfoFooter: 1 showGitHubInfoFooter: 1
PatternLayout: Dumper:
default: "%A%n" Terse: 1
trace: "%A%n" Indent: 1
ttrace: "%A%n" Useqq: 1
Deparse: 1
Quotekeys: 0
Sortkeys: 1
Pair: " => "
# verbatim environments specified # verbatim environments specified
# in this field will not be changed at all! # in this field will not be changed at all!
@ -100,6 +107,7 @@ verbatimEnvironments:
verbatim: 1 verbatim: 1
lstlisting: 1 lstlisting: 1
minted: 1 minted: 1
codeblock: 1 # BSuSP Thesis Listing
# verbatim commands such as \verb! body !, \lstinline$something else$ # verbatim commands such as \verb! body !, \lstinline$something else$
verbatimCommands: verbatimCommands:
@ -113,11 +121,6 @@ noIndentBlock:
noindent: 1 noindent: 1
cmhtest: 1 cmhtest: 1
# remove trailing whitespace from all lines
removeTrailingWhitespace:
beforeProcessing: 0
afterProcessing: 1
# \begin{document} and \end{document} are treated differently # \begin{document} and \end{document} are treated differently
# by latexindent within filecontents environments # by latexindent within filecontents environments
fileContentsEnvironments: fileContentsEnvironments:
@ -142,8 +145,12 @@ lookForPreamble:
preambleCommandsBeforeEnvironments: 0 preambleCommandsBeforeEnvironments: 0
# default value of indentation # default value of indentation
# defaultIndent: "\t" defaultIndent: " " # Changed from \t to double space
defaultIndent: " "
# remove trailing whitespace from all lines
removeTrailingWhitespace:
beforeProcessing: 0
afterProcessing: 1
# name of code blocks that should have their body aligned at ampersand delimiters # name of code blocks that should have their body aligned at ampersand delimiters
lookForAlignDelims: lookForAlignDelims:
@ -160,25 +167,61 @@ lookForAlignDelims:
dontMeasure: 0 dontMeasure: 0
delimiterRegEx: '(?<!\\)(&)' delimiterRegEx: '(?<!\\)(&)'
delimiterJustification: left delimiterJustification: left
lookForChildCodeBlocks: 1
tabularx: tabularx:
delims: 1 delims: 1
longtable: 1 longtable: 1
tabu: 1 tabu: 1
array: 1 array: 1
matrix: 1 matrix: 1
bmatrix: 1 listabla: 1
Bmatrix: 1 # amsmath
pmatrix: 1
vmatrix: 1
Vmatrix: 1
align: 1 align: 1
align*: 1 align*: 1
alignat: 1 alignat: 1
alignat*: 1 alignat*: 1
aligned: 1 aligned: 1
bmatrix: 1
Bmatrix: 1
cases: 1 cases: 1
flalign: 1
flalign*: 1
pmatrix: 1
vmatrix: 1
Vmatrix: 1
# mathtools
cases*: 1
dcases: 1 dcases: 1
listabla: 1 dcases*: 1
rcases: 1
rcases*: 1
drcases: 1
drcases*: 1
# nicematrix
NiceTabular: 1
NiceMatrix: 1
pNiceMatrix: 1
bNiceMatrix: 1
BNiceMatrix: 1
vNiceMatrix: 1
VNiceMatrix: 1
NiceArray: 1
pNiceArrayC: 1
bNiceArrayC: 1
BNiceArrayC: 1
vNiceArrayC: 1
VNiceArrayC: 1
NiceArrayCwithDelims: 1
pNiceArrayRC: 1
bNiceArrayRC: 1
BNiceArrayRC: 1
vNiceArrayRC: 1
VNiceArrayRC: 1
NiceArrayRCwithDelims: 1
# tabularray
tblr: 1
longtblr: 1
talltblr: 1
# if you want the script to look for \item commands # if you want the script to look for \item commands
# and format it, as follows (for example), # and format it, as follows (for example),
@ -191,8 +234,11 @@ lookForAlignDelims:
# then populate indentAfterItems. See also itemNames # then populate indentAfterItems. See also itemNames
indentAfterItems: indentAfterItems:
itemize: 1 itemize: 1
itemize*: 1
enumerate: 1 enumerate: 1
enumerate*: 1
description: 1 description: 1
description*: 1
list: 1 list: 1
# if you want to use other names for your items (for example, \part) # if you want to use other names for your items (for example, \part)
@ -328,11 +374,15 @@ commandCodeBlocks:
- 'decoration' - 'decoration'
- '\+\+' - '\+\+'
- '\-\-' - '\-\-'
- '\#\#\d'
commandNameSpecial: commandNameSpecial:
- -
amalgamate: 1 amalgamate: 1
- '@ifnextchar\[' - '@ifnextchar\['
# change dos line breaks into unix
dos2unixlinebreaks: 0
# modifyLineBreaks will only be searched if the -m # modifyLineBreaks will only be searched if the -m
# switch is active # switch is active
# #
@ -447,9 +497,10 @@ modifyLineBreaks:
preserveBlankLines: 1 preserveBlankLines: 1
condenseMultipleBlankLinesInto: 1 condenseMultipleBlankLinesInto: 1
oneSentencePerLine: oneSentencePerLine:
manipulateSentences: 0 manipulateSentences: 0 # enable oneSentencePerLine
removeSentenceLineBreaks: 1 removeSentenceLineBreaks: 1
textWrapSentences: 0 multipleSpacesToSingle: 1
textWrapSentences: 0 # setting to 1 disables main textWrap routine
sentenceIndent: "" sentenceIndent: ""
sentencesFollow: sentencesFollow:
par: 1 par: 1
@ -471,47 +522,30 @@ modifyLineBreaks:
questionMark: 1 questionMark: 1
other: 0 other: 0
textWrapOptions: textWrapOptions:
columns: 100 columns: 100 # Changed from 0, requires -m option
separator: "" multipleSpacesToSingle: 1
perCodeBlockBasis: 0 removeBlockLineBreaks: 1
all: 0 blocksFollow:
alignAtAmpersandTakesPriority: 1 headings: 1
environments: commentOnPreviousLine: 1
quotation: 0 par: 1
ifElseFi: 0 blankLine: 1
optionalArguments: 0
mandatoryArguments: 0
items: 0
specialBeginEnd: 0
afterHeading: 0
preamble: 0
filecontents: 0
masterDocument: 0
removeParagraphLineBreaks:
all: 0
beforeTextWrap: 0
alignAtAmpersandTakesPriority: 1
environments:
quotation: 0
ifElseFi: 0
optionalArguments: 0
mandatoryArguments: 0
items: 0
specialBeginEnd: 0
afterHeading: 0
preamble: 0
filecontents: 0
masterDocument: 0
paragraphsStopAt:
environments: 1
verbatim: 1 verbatim: 1
commands: 0 filecontents: 1
ifElseFi: 0 other: '\\\]|\\item(?:\h|\[)' # regex
items: 0 blocksBeginWith:
specialBeginEnd: 0 A-Z: 1
heading: 0 a-z: 1
filecontents: 0 0-9: 0
comments: 0 other: '\\textbf' # regex
blocksEndBefore:
commentOnOwnLine: 1
verbatim: 1
filecontents: 1
other: '\\begin\{|\\\[|\\end\{' # regex
huge: overflow # forbid mid-word line breaks
separator: ""
# poly-switches below here
environments: environments:
BeginStartsOnOwnLine: 0 BeginStartsOnOwnLine: 0
BodyStartsOnOwnLine: 0 BodyStartsOnOwnLine: 0
@ -579,7 +613,7 @@ replacements:
- -
this: 'latexindent.pl' this: 'latexindent.pl'
that: 'pl.latexindent' that: 'pl.latexindent'
lookForThis: 1 lookForThis: 0
when: before when: before
# fineTuning allows you to tweak the internal pattern matching that # fineTuning allows you to tweak the internal pattern matching that
@ -588,13 +622,15 @@ fineTuning:
environments: environments:
name: '[a-zA-Z@\*0-9_\\]+' name: '[a-zA-Z@\*0-9_\\]+'
ifElseFi: ifElseFi:
name: '@?if[a-zA-Z@]*?' name: '(?!@?if[a-zA-Z@]*?\{)@?if[a-zA-Z@]*?'
commands: commands:
name: '[+a-zA-Z@\*0-9_\:]+?' name: '[+a-zA-Z@\*0-9_\:]+?'
items:
canBeFollowedBy: '(?:\[[^]]*?\])|(?:<[^>]*?>)'
keyEqualsValuesBracesBrackets: keyEqualsValuesBracesBrackets:
name: '[a-zA-Z@\*0-9_\/.\h\{\}:\#-]+?' name: '[a-zA-Z@\*0-9_\/.:\#-]+[a-zA-Z@\*0-9_\/.\h\{\}:\#-]*?'
follow: '(?:(?<!\\)\{)|,|(?:(?<!\\)\[)' follow: '(?:(?<!\\)\{)|,|(?:(?<!\\)\[)'
NamedGroupingBracesBrackets: namedGroupingBracesBrackets:
name: '[0-9\.a-zA-Z@\*><]+?' name: '[0-9\.a-zA-Z@\*><]+?'
follow: '\h|\R|\{|\[|\$|\)|\(' follow: '\h|\R|\{|\[|\$|\)|\('
UnNamedGroupingBracesBrackets: UnNamedGroupingBracesBrackets:
@ -602,7 +638,36 @@ fineTuning:
arguments: arguments:
before: '(?:#\d\h*;?,?\/?)+|\<.*?\>' before: '(?:#\d\h*;?,?\/?)+|\<.*?\>'
between: '_|\^|\*' between: '_|\^|\*'
trailingComments:
notPreceededBy: '(?<!\\)'
modifyLineBreaks: modifyLineBreaks:
betterFullStop: '(?:\.\)(?!\h*[a-z]))|(?:(?<!(?:(?:e\.g)|(?:i\.e)|(?:etc))))\.(?!(?:[a-z]|[A-Z]|\-|~|\,|[0-9]))'
doubleBackSlash: '\\\\(?:\h*\[\h*\d+\h*[a-zA-Z]+\h*\])?' doubleBackSlash: '\\\\(?:\h*\[\h*\d+\h*[a-zA-Z]+\h*\])?'
comma: ',' comma: ','
betterFullStop: |-
(?x) # ignore spaces in the below
(?: #
\.\) # .)
(?!\h*[a-z]) # not *followed by* a-z
) #
| # OR
(?: #
(?<! # not *preceeded by*
(?: #
(?:[eE]\.[gG]) # e.g OR E.g OR e.G OR E.G
| #
(?:[iI]\.[eE]) # i.e OR I.e OR i.E OR I.E
| #
(?:etc) # etc
) #
) #
) #
\. # .
(?! # not *followed by*
(?: #
[a-zA-Z0-9-~,] #
| #
\), # ),
| #
\)\. # ).
) #
) #