ScalafmtConfig

Configuration options for scalafmt.

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.

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

NB: failure unless newlines.source=classic 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

NB: ignored unless newlines.source=classic 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 )

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.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new ScalafmtConfig(version: String = org.scalafmt.Versions.stable, maxColumn: Int = 80, docstrings: Docstrings = Docstrings(), comments: Comments = Comments(), 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, verticalMultiline: VerticalMultiline = VerticalMultiline(), verticalAlignMultilineOperators: Boolean = false, onTestFailure: String = "", encoding: Codec = "UTF-8", project: ProjectFiles = ProjectFiles(), fileOverride: Obj = Conf.Obj.empty, xmlLiterals: XmlLiterals = XmlLiterals(), edition: Edition = Edition.Latest)
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.
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
NB: failure unless newlines.source=classic 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
NB: ignored unless newlines.source=classic 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 )
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.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def activeFor(edition: Edition): Boolean
val activeForEdition_2019_11: Boolean
val activeForEdition_2020_01: Boolean
val activeForEdition_2020_03: Boolean
val align: Align
lazy val alignMap: Map[String, java.util.regex.Pattern]
val allErrors: ArrayBuffer[String]
final def asInstanceOf[T0]: T0

Definition Classes
Any
val assumeStandardLibraryStripMargin: Boolean

If true, the margin character | is treated as the new indentation in multiline strings ending with .stripMargin.
val binPack: BinPack
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val comments: Comments
val continuationIndent: ContinuationIndent
val danglingParentheses: DanglingParentheses

If true AND @binPackArguments is true AND @configStyleArguments is false, then this function( longerArg1, longerArg3) is formatted like this function( longerArg1, longerArg3 )
implicit final lazy val decoder: ConfDecoder[ScalafmtConfig]
val docstrings: Docstrings
val edition: Edition
lazy val encloseSelectChains: Boolean
val encoding: Codec
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val fileOverride: Obj
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forSbt: ScalafmtConfig
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getConfigFor(filename: String): ScalafmtConfig
val importSelectors: 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.
val includeCurlyBraceInSelectChains: Boolean

NB: failure unless newlines.source=classic If true, includes curly brace applications in select chains/pipelines.
NB: failure unless newlines.source=classic 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)
```
val includeNoParensInSelectChains: Boolean

NB: ignored unless newlines.source=classic If true, includes applications without parens in select chains/pipelines.
NB: ignored unless newlines.source=classic 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)
```
val indentOperator: IndentOperator
val indentYieldKeyword: Boolean

If true, indents yield by two spaces for (i <- j) yield banana If false, treats yield like else for (i <- j) yield banana
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val lineEndings: 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)
val literals: Literals
val maxColumn: Int

Column limit, any formatting exceeding this field is penalized heavily.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val newlines: Newlines
val newlinesBeforeSingleArgParenLambdaParams: Boolean
val newlinesBetweenCurlyAndCatchFinally: Boolean
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val onTestFailure: String
val optIn: OptIn
val poorMansTrailingCommasInConfigStyle: Boolean
val project: ProjectFiles
val rewrite: RewriteSettings
val rewriteTokens: Map[String, String]

Map of tokens to rewrite.
Map of tokens to rewrite. For example, Map("⇒" -> "=>") will rewrite unicode arrows to regular ascii arrows.
val runner: ScalafmtRunner
val spaces: Spaces
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val trailingCommas: 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.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.
val unindentTopLevelOperators: Boolean

If true, allows no indentation on infix operators in non-top-level functions.
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
val version: String

The version of scalafmt to use for this project.
The version of scalafmt to use for this project. Currently not used, the plan is to use this field for the IntelliJ+sbt integrations.
val verticalAlignMultilineOperators: Boolean
val verticalMultiline: VerticalMultiline
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withDialect(dialect: Dialect): ScalafmtConfig
val xmlLiterals: XmlLiterals

Related Docs: object ScalafmtConfig | package config

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def activeFor(edition: Edition): Boolean

val activeForEdition_2019_11: Boolean

val activeForEdition_2020_01: Boolean

val activeForEdition_2020_03: Boolean

val align: Align

lazy val alignMap: Map[String, java.util.regex.Pattern]

val allErrors: ArrayBuffer[String]

final def asInstanceOf[T0]: T0

val assumeStandardLibraryStripMargin: Boolean

val binPack: BinPack

def clone(): AnyRef

val comments: Comments

val continuationIndent: ContinuationIndent

val danglingParentheses: DanglingParentheses

implicit final lazy val decoder: ConfDecoder[ScalafmtConfig]

val docstrings: Docstrings

val edition: Edition

lazy val encloseSelectChains: Boolean

val encoding: Codec

final def eq(arg0: AnyRef): Boolean

val fileOverride: Obj

def finalize(): Unit

def forSbt: ScalafmtConfig

final def getClass(): Class[_]

def getConfigFor(filename: String): ScalafmtConfig

val importSelectors: ImportSelectors

val includeCurlyBraceInSelectChains: Boolean

val includeNoParensInSelectChains: Boolean

val indentOperator: IndentOperator

val indentYieldKeyword: Boolean

final def isInstanceOf[T0]: Boolean

val lineEndings: LineEndings

val literals: Literals

val maxColumn: Int

final def ne(arg0: AnyRef): Boolean

val newlines: Newlines

val newlinesBeforeSingleArgParenLambdaParams: Boolean

val newlinesBetweenCurlyAndCatchFinally: Boolean

final def notify(): Unit

final def notifyAll(): Unit

val onTestFailure: String

val optIn: OptIn

val poorMansTrailingCommasInConfigStyle: Boolean

val project: ProjectFiles

val rewrite: RewriteSettings

val rewriteTokens: Map[String, String]

val runner: ScalafmtRunner

val spaces: Spaces

final def synchronized[T0](arg0: ⇒ T0): T0

val trailingCommas: TrailingCommas

val unindentTopLevelOperators: Boolean

val version: String

val verticalAlignMultilineOperators: Boolean

val verticalMultiline: VerticalMultiline

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withDialect(dialect: Dialect): ScalafmtConfig

val xmlLiterals: XmlLiterals

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped