Instance Constructors

1.  new ScalafmtConfig(version: String = org.scalafmt.Versions.stable, maxColumn: Int = 80, docstrings: Docstrings = Docstrings.ScalaDoc, optIn: OptIn = OptIn(), binPack: BinPack = BinPack(), continuationIndent: ContinuationIndent = ContinuationIndent(), align: Align = Align(), spaces: Spaces = Spaces(), literals: Literals = Literals(), lineEndings: LineEndings = LineEndings.unix, rewriteTokens: Map[String, String] = Map.empty[String, String], rewrite: RewriteSettings = RewriteSettings(), indentOperator: IndentOperator = IndentOperator(), newlines: Newlines = Newlines(), runner: ScalafmtRunner = ScalafmtRunner.default, indentYieldKeyword: Boolean = true, importSelectors: ImportSelectors = ImportSelectors.noBinPack, unindentTopLevelOperators: Boolean = false, includeCurlyBraceInSelectChains: Boolean = true, includeNoParensInSelectChains: Boolean = false, assumeStandardLibraryStripMargin: Boolean = false, danglingParentheses: DanglingParentheses = DanglingParentheses(true, true), poorMansTrailingCommasInConfigStyle: Boolean = false, trailingCommas: TrailingCommas = TrailingCommas.never, verticalMultilineAtDefinitionSite: Boolean = false, verticalMultilineAtDefinitionSiteArityThreshold: Int = 100, verticalMultiline: VerticalMultiline = VerticalMultiline(), verticalAlignMultilineOperators: Boolean = false, onTestFailure: String = "", encoding: Codec = "UTF-8", project: ProjectFiles = ProjectFiles())
   version

   The version of scalafmt to use for this project. Currently not used, the plan is to use this field for the IntelliJ+sbt integrations.

   maxColumn

   Column limit, any formatting exceeding this field is penalized heavily.

   docstrings

   Several options:

   • ScalaDoc: format as Scala docs
   • JavaDocs: format as Java docs
   • preserve: keep existing formatting

   lineEndings

   If LineEndings.unix, output will include only unix line endings If LineEndings.windows, output will include only windows line endings If LineEndings.preserve, output will include endings included in original file (windows if there was at least one windows line ending, unix if there was zero occurrences of windows line endings)

   rewriteTokens

   Map of tokens to rewrite. For example, Map("⇒" -> "=>") will rewrite unicode arrows to regular ascii arrows.

   indentYieldKeyword

   If true, indents yield by two spaces for (i <- j) yield banana If false, treats yield like else for (i <- j) yield banana

   importSelectors

   Controls formatting of import selectors with multiple names from the same package; If org.scalafmt.config.ImportSelectors.binPack, import selectors are arranged to fit within the maximum line width If org.scalafmt.config.ImportSelectors.noBinPack, import selectors are broken to one per line If org.scalafmt.config.ImportSelectors.singleLine, import selectors are kept on a single line The default setting is currently noBinPack.

   unindentTopLevelOperators

   If true, allows no indentation on infix operators in non-top-level functions. For example, function( a && b ) If false, only allows 0 space indentation for top-level statements a && b function( a && b ) Context: https://github.com/scala-js/scala-js/blob/master/CODINGSTYLE.md#long-expressions-with-binary-operators

   includeCurlyBraceInSelectChains

   If true, includes curly brace applications in select chains/pipelines.

   // If true
   List(1)
     .map { x =>
       x + 2
     }
     .filter(_ > 2)
   // If false
   List(1).map { x =>
       x + 2
   }.filter(_ > 2)

   includeNoParensInSelectChains

   If true, includes applications without parens in select chains/pipelines.

   // If true
   List(1)
     .toIterator
     .buffered
     .map(_ + 2)
     .filter(_ > 2)
   // If false
   List(1).toIterator.buffered
     .map(_ + 2)
     .filter(_ > 2)

   assumeStandardLibraryStripMargin

   If true, the margin character | is treated as the new indentation in multiline strings ending with .stripMargin.

   danglingParentheses

   If true AND @binPackArguments is true AND @configStyleArguments is false, then this function( longerArg1, longerArg3) is formatted like this function( longerArg1, longerArg3 )

   poorMansTrailingCommasInConfigStyle

   (experimental, may be removed) If true, formats config style like this: function( a , b , c )

   trailingCommas

   If org.scalafmt.config.TrailingCommas.always, trailing commas are added everywhere a newline is followed by a right parens, brace or bracket. If org.scalafmt.config.TrailingCommas.never, trailing commas are removed whenever they appear. If org.scalafmt.config.TrailingCommas.preserve, existing trailing commas will be preserved, and no new ones will be added.