ScalafmtStyle

Configuration options for scalafmt.

maxColumn: Column limit, any formatting exceeding this field is penalized heavily.
reformatDocstrings: If true, reformats docstrings according to @scalaDocs.
scalaDocs: Only used if @reformatDocstrings is true. If true, reformats docstrings to use scaladoc style docstring, otherwise use javadoc style.
alignStripMarginStrings: If true, the margin character | is treated as the new indentation in multiline strings ending with .stripMargin.
binPackArguments: If true, will fit as many arguments on each line, only breaking at commas. If false, a function call's arguments will either be all on the same line or will have one line each.
binPackParameters: Same as binPackArguments, except for def/class definition parameters.
configStyleArguments: Call-sites where there is a newline after opening ( and newline before closing ). If true, preserves the newlines and keeps one line per argument.
binPackDotChains: If true, will fit as many arguments on each line, only breaking at dots. If false, a either all selects go on the same line or will have one line each.
noNewlinesBeforeJsNative: If true, a newline will never be placed in front of js.native.
superfluousParensIndent: Indent width inside unnecessary parentheses. For example: (function( baab) && // indent 4 caab)
danglingParentheses: If true AND @binPackArguments is true AND @configStyleArguments is false, then this function( longerArg1, longerArg3) is formatted like this function( longerArg1, longerArg3 )
alignByOpenParenCallSite: If true AND bin-packing is true, then call-site arguments won't be aligned by the opening parenthesis. For example, this output will be disallowed function(a, b, c)
continuationIndentCallSite: Indent width for line continuation at call site.
continuationIndentDefnSite: Indent width for line continuation at definition/declaration site.
allowNewlineBeforeColonInMassiveReturnTypes: If true, scalafmt may choose to put a newline before colon : at defs.
binPackParentConstructors: Parent constructors are C and D in "class A extends B with C and D". If true, scalafmt will fit as many parent constructors on a single line. If false, each parent constructor gets its own line.
spaceAfterTripleEquals: If true, formats ===( as === (
rewriteTokens: Map of tokens to rewrite. For example, Map("⇒" -> "=>") will rewrite unicode arrows to regular ascii arrows.
alignByArrowEnumeratorGenerator: If true, aligns by <- in for comprehensions.
alignByIfWhileOpenParen: If true, aligns by ( in if/while/for. If false, indents by continuationIndentCallSite.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new ScalafmtStyle(maxColumn: Int, reformatDocstrings: Boolean, scalaDocs: Boolean, alignStripMarginStrings: Boolean, binPackArguments: Boolean, binPackParameters: Boolean, configStyleArguments: Boolean, binPackDotChains: Boolean, noNewlinesBeforeJsNative: Boolean, superfluousParensIndent: Int, danglingParentheses: Boolean, alignByOpenParenCallSite: Boolean, alignByOpenParenDefnSite: Boolean, continuationIndentCallSite: Int, continuationIndentDefnSite: Int, alignTokens: Set[AlignToken], spacesInImportCurlyBraces: Boolean, allowNewlineBeforeColonInMassiveReturnTypes: Boolean, binPackParentConstructors: Boolean, spaceAfterTripleEquals: Boolean, rewriteTokens: Map[String, String], alignByArrowEnumeratorGenerator: Boolean, alignByIfWhileOpenParen: Boolean)

maxColumn
Column limit, any formatting exceeding this field is penalized heavily.
reformatDocstrings
If true, reformats docstrings according to @scalaDocs.
scalaDocs
Only used if @reformatDocstrings is true. If true, reformats docstrings to use scaladoc style docstring, otherwise use javadoc style.
alignStripMarginStrings
If true, the margin character | is treated as the new indentation in multiline strings ending with .stripMargin.
binPackArguments
If true, will fit as many arguments on each line, only breaking at commas. If false, a function call's arguments will either be all on the same line or will have one line each.
binPackParameters
Same as binPackArguments, except for def/class definition parameters.
configStyleArguments
Call-sites where there is a newline after opening ( and newline before closing ). If true, preserves the newlines and keeps one line per argument.
binPackDotChains
If true, will fit as many arguments on each line, only breaking at dots. If false, a either all selects go on the same line or will have one line each.
noNewlinesBeforeJsNative
If true, a newline will never be placed in front of js.native.
superfluousParensIndent
Indent width inside unnecessary parentheses. For example: (function( baab) && // indent 4 caab)
danglingParentheses
If true AND @binPackArguments is true AND @configStyleArguments is false, then this function( longerArg1, longerArg3) is formatted like this function( longerArg1, longerArg3 )
alignByOpenParenCallSite
If true AND bin-packing is true, then call-site arguments won't be aligned by the opening parenthesis. For example, this output will be disallowed function(a, b, c)
continuationIndentCallSite
Indent width for line continuation at call site.
continuationIndentDefnSite
Indent width for line continuation at definition/declaration site.
allowNewlineBeforeColonInMassiveReturnTypes
If true, scalafmt may choose to put a newline before colon : at defs.
binPackParentConstructors
Parent constructors are C and D in "class A extends B with C and D". If true, scalafmt will fit as many parent constructors on a single line. If false, each parent constructor gets its own line.
spaceAfterTripleEquals
If true, formats ===( as === (
rewriteTokens
Map of tokens to rewrite. For example, Map("⇒" -> "=>") will rewrite unicode arrows to regular ascii arrows.
alignByArrowEnumeratorGenerator
If true, aligns by <- in for comprehensions.
alignByIfWhileOpenParen
If true, aligns by ( in if/while/for. If false, indents by continuationIndentCallSite.

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
val alignByArrowEnumeratorGenerator: Boolean

If true, aligns by <- in for comprehensions.
val alignByIfWhileOpenParen: Boolean

If true, aligns by ( in if/while/for.
If true, aligns by ( in if/while/for. If false, indents by continuationIndentCallSite.
val alignByOpenParenCallSite: Boolean

If true AND bin-packing is true, then call-site arguments won't be aligned by the opening parenthesis.
If true AND bin-packing is true, then call-site arguments won't be aligned by the opening parenthesis. For example, this output will be disallowed function(a, b, c)
val alignByOpenParenDefnSite: Boolean
lazy val alignMap: Map[String, Regex]
val alignStripMarginStrings: Boolean

If true, the margin character | is treated as the new indentation in multiline strings ending with .stripMargin.
val alignTokens: Set[AlignToken]
val allowNewlineBeforeColonInMassiveReturnTypes: Boolean

If true, scalafmt may choose to put a newline before colon : at defs.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val binPackArguments: Boolean

If true, will fit as many arguments on each line, only breaking at commas.
If true, will fit as many arguments on each line, only breaking at commas. If false, a function call's arguments will either be all on the same line or will have one line each.
val binPackDotChains: Boolean

If true, will fit as many arguments on each line, only breaking at dots.
If true, will fit as many arguments on each line, only breaking at dots. If false, a either all selects go on the same line or will have one line each.
val binPackParameters: Boolean

Same as binPackArguments, except for def/class definition parameters.
val binPackParentConstructors: Boolean

Parent constructors are C and D in "class A extends B with C and D".
Parent constructors are C and D in "class A extends B with C and D". If true, scalafmt will fit as many parent constructors on a single line. If false, each parent constructor gets its own line.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val configStyleArguments: Boolean

Call-sites where there is a newline after opening ( and newline before closing ).
Call-sites where there is a newline after opening ( and newline before closing ). If true, preserves the newlines and keeps one line per argument.
val continuationIndentCallSite: Int

Indent width for line continuation at call site.
val continuationIndentDefnSite: Int

Indent width for line continuation at definition/declaration site.
val danglingParentheses: Boolean

If true AND @binPackArguments is true AND @configStyleArguments is false, then this function( longerArg1, longerArg3) is formatted like this function( longerArg1, longerArg3 )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val maxColumn: Int

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

Definition Classes
AnyRef
val noNewlinesBeforeJsNative: Boolean

If true, a newline will never be placed in front of js.native.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val reformatDocstrings: Boolean

If true, reformats docstrings according to @scalaDocs.
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 scalaDocs: Boolean

Only used if @reformatDocstrings is true.
Only used if @reformatDocstrings is true. If true, reformats docstrings to use scaladoc style docstring, otherwise use javadoc style.
val spaceAfterTripleEquals: Boolean

If true, formats ===( as === (
val spacesInImportCurlyBraces: Boolean
val superfluousParensIndent: Int

Indent width inside unnecessary parentheses.
Indent width inside unnecessary parentheses. For example: (function( baab) && // indent 4 caab)
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )

Related Docs: object ScalafmtStyle | package scalafmt

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val alignByArrowEnumeratorGenerator: Boolean

val alignByIfWhileOpenParen: Boolean

val alignByOpenParenCallSite: Boolean

val alignByOpenParenDefnSite: Boolean

lazy val alignMap: Map[String, Regex]

val alignStripMarginStrings: Boolean

val alignTokens: Set[AlignToken]

val allowNewlineBeforeColonInMassiveReturnTypes: Boolean

final def asInstanceOf[T0]: T0

val binPackArguments: Boolean

val binPackDotChains: Boolean

val binPackParameters: Boolean

val binPackParentConstructors: Boolean

def clone(): AnyRef

val configStyleArguments: Boolean

val continuationIndentCallSite: Int

val continuationIndentDefnSite: Int

val danglingParentheses: Boolean

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val maxColumn: Int

final def ne(arg0: AnyRef): Boolean

val noNewlinesBeforeJsNative: Boolean

final def notify(): Unit

final def notifyAll(): Unit

val reformatDocstrings: Boolean

val rewriteTokens: Map[String, String]

val scalaDocs: Boolean

val spaceAfterTripleEquals: Boolean

val spacesInImportCurlyBraces: Boolean

val superfluousParensIndent: Int

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped