latexindent.yaml

# Formatting Settings by Ruben Deisenroth
fileExtensionPreference:
  .tex: 1
  .sty: 2
  .cls: 3
  .bib: 4
  .def: 5

verbatimEnvironments:
  codeBlock: 1

verbatimCommands:
  inlinejava: 1
  inlineracket: 1

# indent preamble
indentPreamble: 1

# default value of indentation
defaultIndent: "    "

# name of code blocks that should have their body aligned at ampersand delimiters
lookForAlignDelims:
  tabular:
    delims: 1
    alignDoubleBackSlash: 1
    spacesBeforeDoubleBackSlash: 1
    multiColumnGrouping: 1
    alignRowsWithoutMaxDelims: 1
    spacesBeforeAmpersand: 1
    spacesAfterAmpersand: 1
    justification: left
    alignFinalDoubleBackSlash: 1
    dontMeasure: 1
    delimiterRegEx: '(?<!\\)(&)'
    delimiterJustification: left
    lookForChildCodeBlocks: 1
  tabularx:
    delims: 1
    alignDoubleBackSlash: 1
    spacesBeforeDoubleBackSlash: 1
    multiColumnGrouping: 1
    alignRowsWithoutMaxDelims: 1
    spacesBeforeAmpersand: 1
    spacesAfterAmpersand: 1
    justification: left
    alignFinalDoubleBackSlash: 1
    dontMeasure: 1
    delimiterRegEx: '(?<!\\)(&)'
    delimiterJustification: left
    lookForChildCodeBlocks: 1
noAdditionalIndent:
  myexample: 0
  mydefinition: 0
  problem: 0
  exercises: 0
  mysolution: 0
  foreach: 0
  widepage: 0
  comment: 0
  document: 1
  frame: 0

indentRules:
  myenvironment: "    "
  anotherenvironment: "    "
  chapter: "    "
  section: "    "
  item: "    "
  myitem: "    "

noAdditionalIndentGlobal:
  environments: 0
  commands: 1
  optionalArguments: 0
  mandatoryArguments: 0
  ifElseFi: 0
  items: 0
  keyEqualsValuesBracesBrackets: 1
  namedGroupingBracesBrackets: 1
  UnNamedGroupingBracesBrackets: 1
  specialBeginEnd: 0
  afterHeading: 0
  filecontents: 0

# change dos line breaks into unix
dos2unixlinebreaks: 1

# you can specify settings on a per-name basis
modifyLineBreaks:
  oneSentencePerLine:
    manipulateSentences: 1
    removeSentenceLineBreaks: 1
    textWrapSentences: 1
  textWrapOptions:
    columns: 130
    huge: overflow # forbid mid-word line breaks
    separator: ""
    perCodeBlockBasis: 0
    beforeFindingChildCodeBlocks: 0
    all: 0
    alignAtAmpersandTakesPriority: 1
    environments:
      quotation: 0
    ifElseFi: 0
    optionalArguments: 0
    mandatoryArguments: 0
    items: 0
    specialBeginEnd: 0
    afterHeading: 0
    preamble: 0
    filecontents: 0
    mainDocument: 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
    mainDocument: 0
    paragraphsStopAt:
      environments: 1
      verbatim: 1
      commands: 0
      ifElseFi: 0
      items: 0
      specialBeginEnd: 0
      heading: 0
      filecontents: 0
      comments: 0
  environments:
    BeginStartsOnOwnLine: 1
    BodyStartsOnOwnLine: 1
    EndStartsOnOwnLine: 1
    EndFinishesWithLineBreak: 1
    # equation*:
    #     BeginStartsOnOwnLine: 1
    #     BodyStartsOnOwnLine: 1
    #     EndStartsOnOwnLine: 1
    #     EndFinishesWithLineBreak: 1
  ifElseFi:
    IfStartsOnOwnLine: 1
    BodyStartsOnOwnLine: 1
    OrStartsOnOwnLine: 1
    OrFinishesWithLineBreak: 1
    ElseStartsOnOwnLine: 1
    ElseFinishesWithLineBreak: 1
    FiStartsOnOwnLine: 1
    FiFinishesWithLineBreak: 1
    ifnum:
      IfStartsOnOwnLine: 1
      BodyStartsOnOwnLine: 1
      OrStartsOnOwnLine: 1
      OrFinishesWithLineBreak: 1
      ElseStartsOnOwnLine: 1
      ElseFinishesWithLineBreak: 1
      FiStartsOnOwnLine: 1
      FiFinishesWithLineBreak: 1
  items:
    ItemStartsOnOwnLine: 1

# fineTuning allows you to tweak the internal pattern matching that
# is central to latexindent.pl
fineTuning:
  namedGroupingBracesBrackets:
    name: "[0-9\\.a-zA-Z@\\*><~\\=\\-]+?"
    follow: "\\h|\\R|\\{|\\[|\\$|\\)|\\("