summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/scripts/latexindent/defaultSettings.yaml
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-01-01 20:33:08 +0000
committerKarl Berry <karl@freefriends.org>2023-01-01 20:33:08 +0000
commit50f06dfb39538412ac53208846b25f243cd5b6f4 (patch)
tree7fedb48a15a8249fd561133c148c19aad7b15b34 /Master/texmf-dist/scripts/latexindent/defaultSettings.yaml
parent35311fd4a540d53f0a3626adf611e21fade0cb06 (diff)
latexindent (1jan23)
git-svn-id: svn://tug.org/texlive/trunk@65427 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/scripts/latexindent/defaultSettings.yaml')
-rwxr-xr-xMaster/texmf-dist/scripts/latexindent/defaultSettings.yaml296
1 files changed, 150 insertions, 146 deletions
diff --git a/Master/texmf-dist/scripts/latexindent/defaultSettings.yaml b/Master/texmf-dist/scripts/latexindent/defaultSettings.yaml
index c61de167a91..032735e6fd3 100755
--- a/Master/texmf-dist/scripts/latexindent/defaultSettings.yaml
+++ b/Master/texmf-dist/scripts/latexindent/defaultSettings.yaml
@@ -1,4 +1,4 @@
-# defaultSettings.yaml for latexindent.pl, version 3.19.1, 2022-12-04
+# defaultSettings.yaml for latexindent.pl, version 3.20, 2023-01-01
# a script that aims to
# beautify .tex, .sty, .cls files
#
@@ -164,7 +164,7 @@ lookForAlignDelims:
justification: left
alignFinalDoubleBackSlash: 0
dontMeasure: 0
- delimiterRegEx: '(?<!\\)(&)'
+ delimiterRegEx: (?<!\\)(&)
delimiterJustification: left
lookForChildCodeBlocks: 1
tabularx:
@@ -252,16 +252,16 @@ itemNames:
# there's no restrictions
specialBeginEnd:
displayMath:
- begin: '\\\['
- end: '\\\]'
- lookForThis: 1
+ begin: (?<!\\)\\\[ # \[ but *not* \\[
+ end: \\\] # \]
+ lookForThis: 1
inlineMath:
- begin: '(?<!\$)(?<!\\)\$(?!\$)'
- end: '(?<!\\)\$(?!\$)'
+ begin: (?<!\$)(?<!\\)\$(?!\$) # $ but *not* \$ or $$
+ end: (?<!\\)\$(?!\$) # $ but *not* \$ or $$
lookForThis: 1
displayMathTeX:
- begin: '\$\$'
- end: '\$\$'
+ begin: \$\$ # $$
+ end: \$\$ # $$
lookForThis: 1
specialBeforeCommand: 0
@@ -332,34 +332,34 @@ indentRules:
# set noAdditionalIndent globally for codeblocks
noAdditionalIndentGlobal:
- environments: 0
- commands: 1
- optionalArguments: 0
- mandatoryArguments: 0
- ifElseFi: 0
- items: 0
- keyEqualsValuesBracesBrackets: 0
- namedGroupingBracesBrackets: 0
- UnNamedGroupingBracesBrackets: 0
- specialBeginEnd: 0
- afterHeading: 0
- filecontents: 0
+ environments: 0 # 0/1
+ commands: 1 # 0/1
+ optionalArguments: 0 # 0/1
+ mandatoryArguments: 0 # 0/1
+ ifElseFi: 0 # 0/1
+ items: 0 # 0/1
+ keyEqualsValuesBracesBrackets: 0 # 0/1
+ namedGroupingBracesBrackets: 0 # 0/1
+ UnNamedGroupingBracesBrackets: 0 # 0/1
+ specialBeginEnd: 0 # 0/1
+ afterHeading: 0 # 0/1
+ filecontents: 0 # 0/1
# set indentRules globally for codeblocks; these need
# to be horizontal spaces, if they are to be used
indentRulesGlobal:
- environments: 0
- commands: 0
- optionalArguments: 0
- mandatoryArguments: 0
- ifElseFi: 0
- items: 0
- keyEqualsValuesBracesBrackets: 0
- namedGroupingBracesBrackets: 0
- UnNamedGroupingBracesBrackets: 0
- specialBeginEnd: 0
- afterHeading: 0
- filecontents: 0
+ environments: 0 # 0/1
+ commands: 0 # 0/1
+ optionalArguments: 0 # 0/1
+ mandatoryArguments: 0 # 0/1
+ ifElseFi: 0 # 0/1
+ items: 0 # 0/1
+ keyEqualsValuesBracesBrackets: 0 # 0/1
+ namedGroupingBracesBrackets: 0 # 0/1
+ UnNamedGroupingBracesBrackets: 0 # 0/1
+ specialBeginEnd: 0 # 0/1
+ afterHeading: 0 # 0/1
+ filecontents: 0 # 0/1
# command code block details
commandCodeBlocks:
@@ -367,13 +367,13 @@ commandCodeBlocks:
stringsAllowedBetweenArguments:
-
amalgamate: 1
- - 'node'
- - 'at'
- - 'to'
- - 'decoration'
- - '\+\+'
- - '\-\-'
- - '\#\#\d'
+ - node
+ - at
+ - to
+ - decoration
+ - \+\+
+ - \-\-
+ - \#\#\d
commandNameSpecial:
-
amalgamate: 1
@@ -493,125 +493,129 @@ dos2unixlinebreaks: 0
#
# you can specify settings on a per-name basis
modifyLineBreaks:
- preserveBlankLines: 1
- condenseMultipleBlankLinesInto: 1
+ preserveBlankLines: 1 # 0/1
+ condenseMultipleBlankLinesInto: 1 # 0/1
oneSentencePerLine:
- manipulateSentences: 0
- removeSentenceLineBreaks: 1
- multipleSpacesToSingle: 1
- textWrapSentences: 0 # setting to 1 disables main textWrap routine
+ manipulateSentences: 0 # 0/1
+ removeSentenceLineBreaks: 1 # 0/1
+ multipleSpacesToSingle: 1 # 0/1
+ textWrapSentences: 0 # 1 disables main textWrap
sentenceIndent: ""
sentencesFollow:
- par: 1
- blankLine: 1
- fullStop: 1
- exclamationMark: 1
- questionMark: 1
- rightBrace: 1
- commentOnPreviousLine: 1
- other: 0
- sentencesBeginWith:
- A-Z: 1
- a-z: 0
- other: 0
+ par: 1 # 0/1
+ blankLine: 1 # 0/1
+ fullStop: 1 # 0/1
+ exclamationMark: 1 # 0/1
+ questionMark: 1 # 0/1
+ rightBrace: 1 # 0/1
+ commentOnPreviousLine: 1 # 0/1
+ other: 0 # regex
+ sentencesBeginWith:
+ A-Z: 1 # 0/1
+ a-z: 0 # 0/1
+ other: 0 # regex
sentencesEndWith:
- basicFullStop: 0
- betterFullStop: 1
- exclamationMark: 1
- questionMark: 1
- other: 0
+ basicFullStop: 0 # 0/1
+ betterFullStop: 1 # 0/1
+ exclamationMark: 1 # 0/1
+ questionMark: 1 # 0/1
+ other: 0 # regex
textWrapOptions:
columns: 0
- multipleSpacesToSingle: 1
+ multipleSpacesToSingle: 1
removeBlockLineBreaks: 1
+ when: before # before/after
+ comments:
+ wrap: 0 # 0/1
+ inheritLeadingSpace: 0 # 0/1
blocksFollow:
- headings: 1
- commentOnPreviousLine: 1
- par: 1
- blankLine: 1
- verbatim: 1
- filecontents: 1
- other: '\\\]|\\item(?:\h|\[)' # regex
+ headings: 1 # 0/1
+ commentOnPreviousLine: 1 # 0/1
+ par: 1 # 0/1
+ blankLine: 1 # 0/1
+ verbatim: 1 # 0/1
+ filecontents: 1 # 0/1
+ other: \\\]|\\item(?:\h|\[) # regex
blocksBeginWith:
- A-Z: 1
- a-z: 1
- 0-9: 0
- other: 0 # regex
+ A-Z: 1 # 0/1
+ a-z: 1 # 0/1
+ 0-9: 0 # 0/1
+ other: 0 # regex
blocksEndBefore:
- commentOnOwnLine: 1
- verbatim: 1
- filecontents: 1
- other: '\\begin\{|\\\[|\\end\{' # regex
- huge: overflow # forbid mid-word line breaks
+ commentOnOwnLine: 1 # 0/1
+ verbatim: 1 # 0/1
+ filecontents: 1 # 0/1
+ other: \\begin\{|\\\[|\\end\{ # regex
+ huge: overflow # forbid mid-word line breaks
separator: ""
- # poly-switches below here
- environments:
- BeginStartsOnOwnLine: 0
- BodyStartsOnOwnLine: 0
- EndStartsOnOwnLine: 0
- EndFinishesWithLineBreak: 0
- equation*:
- BeginStartsOnOwnLine: 0
- BodyStartsOnOwnLine: 0
- EndStartsOnOwnLine: 0
- EndFinishesWithLineBreak: 0
+ # poly-switches below here # -1: remove, 0: off, 1: add, 2: comment+add, 3: add blank line, 4: add blank line
+ environments:
+ BeginStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ BodyStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ EndStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ EndFinishesWithLineBreak: 0 # -1,0,1,2,3,4
+ equation*:
+ BeginStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ BodyStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ EndStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ EndFinishesWithLineBreak: 0 # -1,0,1,2,3,4
ifElseFi:
- IfStartsOnOwnLine: 0
- BodyStartsOnOwnLine: 0
- OrStartsOnOwnLine: 0
- OrFinishesWithLineBreak: 0
- ElseStartsOnOwnLine: 0
- ElseFinishesWithLineBreak: 0
- FiStartsOnOwnLine: 0
- FiFinishesWithLineBreak: 0
+ IfStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ BodyStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ OrStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ OrFinishesWithLineBreak: 0 # -1,0,1,2,3,4
+ ElseStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ ElseFinishesWithLineBreak: 0 # -1,0,1,2,3,4
+ FiStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ FiFinishesWithLineBreak: 0 # -1,0,1,2,3,4
ifnum:
- IfStartsOnOwnLine: 0
- BodyStartsOnOwnLine: 0
- OrStartsOnOwnLine: 0
- OrFinishesWithLineBreak: 0
- ElseStartsOnOwnLine: 0
- ElseFinishesWithLineBreak: 0
- FiStartsOnOwnLine: 0
- FiFinishesWithLineBreak: 0
+ IfStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ BodyStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ OrStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ OrFinishesWithLineBreak: 0 # -1,0,1,2,3,4
+ ElseStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ ElseFinishesWithLineBreak: 0 # -1,0,1,2,3,4
+ FiStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ FiFinishesWithLineBreak: 0 # -1,0,1,2,3,4
commands:
- CommandStartsOnOwnLine: 0
+ CommandStartsOnOwnLine: 0
CommandNameFinishesWithLineBreak: 0
optionalArguments:
- LSqBStartsOnOwnLine: 0
- OptArgBodyStartsOnOwnLine: 0
- RSqBStartsOnOwnLine: 0
- RSqBFinishesWithLineBreak: 0
- mandatoryArguments:
- LCuBStartsOnOwnLine: 0
- MandArgBodyStartsOnOwnLine: 0
- RCuBStartsOnOwnLine: 0
- RCuBFinishesWithLineBreak: 0
+ LSqBStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ OptArgBodyStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ RSqBStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ RSqBFinishesWithLineBreak: 0 # -1,0,1,2,3,4
+ mandatoryArguments:
+ LCuBStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ MandArgBodyStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ RCuBStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ RCuBFinishesWithLineBreak: 0 # -1,0,1,2,3,4
keyEqualsValuesBracesBrackets:
- KeyStartsOnOwnLine: 0
- EqualsStartsOnOwnLine: 0
- EqualsFinishesWithLineBreak: 0
- items:
- ItemStartsOnOwnLine: 0
- ItemFinishesWithLineBreak: 0
+ KeyStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ EqualsStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ EqualsFinishesWithLineBreak: 0 # -1,0,1,2,3,4
+ items:
+ ItemStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ ItemFinishesWithLineBreak: 0 # -1,0,1,2,3,4
namedGroupingBracesBrackets:
- NameStartsOnOwnLine: 0
- NameFinishesWithLineBreak: 0
+ NameStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ NameFinishesWithLineBreak: 0 # -1,0,1,2,3,4
specialBeginEnd:
- SpecialBeginStartsOnOwnLine: 0
- SpecialBodyStartsOnOwnLine: 0
- SpecialEndStartsOnOwnLine: 0
- SpecialEndFinishesWithLineBreak: 0
+ SpecialBeginStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ SpecialBodyStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ SpecialEndStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ SpecialEndFinishesWithLineBreak: 0 # -1,0,1,2,3,4
verbatim:
- VerbatimBeginStartsOnOwnLine: 0
- VerbatimEndFinishesWithLineBreak: 0
+ VerbatimBeginStartsOnOwnLine: 0 # -1,0,1,2,3,4
+ VerbatimEndFinishesWithLineBreak: 0 # -1,0,1,2,3,4
# replacements, only active when either -r or -rr switches are active
replacements:
-
amalgamate: 1
-
- this: 'latexindent.pl'
- that: 'pl.latexindent'
+ this: latexindent.pl
+ that: pl.latexindent
lookForThis: 0
when: before
@@ -619,28 +623,28 @@ replacements:
# is central to latexindent.pl
fineTuning:
environments:
- name: '[a-zA-Z@\*0-9_\\]+'
+ name: [a-zA-Z@\*0-9_\\]+
ifElseFi:
- name: '(?!@?if[a-zA-Z@]*?\{)@?if[a-zA-Z@]*?'
+ name: (?!@?if[a-zA-Z@]*?\{)@?if[a-zA-Z@]*?
commands:
- name: '[+a-zA-Z@\*0-9_\:]+?'
+ name: [+a-zA-Z@\*0-9_\:]+?
items:
- canBeFollowedBy: '(?:\[[^]]*?\])|(?:<[^>]*?>)'
+ canBeFollowedBy: (?:\[[^]]*?\])|(?:<[^>]*?>)
keyEqualsValuesBracesBrackets:
- name: '[a-zA-Z@\*0-9_\/.:\#-]+[a-zA-Z@\*0-9_\/.\h\{\}:\#-]*?'
- follow: '(?:(?<!\\)\{)|,|(?:(?<!\\)\[)'
+ name: [a-zA-Z@\*0-9_\/.:\#-]+[a-zA-Z@\*0-9_\/.\h\{\}:\#-]*?
+ follow: (?:(?<!\\)\{)|,|(?:(?<!\\)\[)
namedGroupingBracesBrackets:
- name: '[0-9\.a-zA-Z@\*><]+?'
- follow: '\h|\R|\{|\[|\$|\)|\('
+ name: [0-9\.a-zA-Z@\*><]+?
+ follow: \h|\R|\{|\[|\$|\)|\(
UnNamedGroupingBracesBrackets:
- follow: '\{|\[|,|&|\)|\(|\$'
+ follow: \{|\[|,|&|\)|\(|\$
arguments:
- before: '(?:#\d\h*;?,?\/?)+|\<.*?\>'
- between: '_|\^|\*'
+ before: (?:#\d\h*;?,?\/?)+|\<.*?\>
+ between: _|\^|\*
trailingComments:
- notPreceededBy: '(?<!\\)'
+ notPreceededBy: (?<!\\)
modifyLineBreaks:
- doubleBackSlash: '\\\\(?:\h*\[\h*\d+\h*[a-zA-Z]+\h*\])?'
+ doubleBackSlash: \\\\(?:\h*\[\h*\d+\h*[a-zA-Z]+\h*\])?
comma: ','
betterFullStop: |-
(?x) # ignore spaces in the below