OptIn

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.

breaksInsideChains

If true, then the user can opt out of line breaks inside select chains.

// original
foo
  .map(_ + 1).map(_ + 1)
  .filter(_ > 2)
// if true
foo
  .map(_ + 1).map(_ + 1)
  .filter(_ > 2)
// if false
foo
  .map(_ + 1)
  .map(_ + 1)
  .filter(_ > 2)

breakChainOnFirstMethodDot

If true, keeps the line break before a dot if it already exists.

// original
foo
  .map(_ + 1)
  .filter( > 2)
// if true
foo
  .map(_ + 1)
  .filter( > 2)
// if false
foo.map(_ + 1).filter( > 2)

selfAnnotationNewline

See https://github.com/scalameta/scalafmt/issues/938 If true, will force a line break before a self annotation if there was a line break there before.

blankLineBeforeDocstring

If false, always insert a blank line before docstrings, If true, preserves blank line only if one exists before. Example:

// before
object Foo {
  /** Docstring */
  def foo = 2
}
// after, if blankLineBeforeDocstring=true
object Foo {
  /** Docstring */
  def foo = 2
}
// after, if blankLineBeforeDocstring=false
object Foo {
  /** Docstring */
  def foo = 2
}

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new OptIn(configStyleArguments: Boolean = true, breaksInsideChains: Boolean = false, breakChainOnFirstMethodDot: Boolean = true, selfAnnotationNewline: Boolean = true, annotationNewlines: Boolean = true, blankLineBeforeDocstring: Boolean = false)
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.
breaksInsideChains
If true, then the user can opt out of line breaks inside select chains.
```
// original
foo
  .map(_ + 1).map(_ + 1)
  .filter(_ > 2)
// if true
foo
  .map(_ + 1).map(_ + 1)
  .filter(_ > 2)
// if false
foo
  .map(_ + 1)
  .map(_ + 1)
  .filter(_ > 2)
```
breakChainOnFirstMethodDot
If true, keeps the line break before a dot if it already exists.
```
// original
foo
  .map(_ + 1)
  .filter( > 2)
// if true
foo
  .map(_ + 1)
  .filter( > 2)
// if false
foo.map(_ + 1).filter( > 2)
```
selfAnnotationNewline
See https://github.com/scalameta/scalafmt/issues/938 If true, will force a line break before a self annotation if there was a line break there before.
blankLineBeforeDocstring
If false, always insert a blank line before docstrings, If true, preserves blank line only if one exists before. Example:
```
// before
object Foo {
  /** Docstring */
  def foo = 2
}
// after, if blankLineBeforeDocstring=true
object Foo {
  /** Docstring */
  def foo = 2
}
// after, if blankLineBeforeDocstring=false
object Foo {
  /** Docstring */
  def foo = 2
}
```

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 annotationNewlines: Boolean
final def asInstanceOf[T0]: T0

Definition Classes
Any

val blankLineBeforeDocstring: Boolean

If false, always insert a blank line before docstrings, If true, preserves blank line only if one exists before.

If false, always insert a blank line before docstrings, If true, preserves blank line only if one exists before. Example:

// before
object Foo {
  /** Docstring */
  def foo = 2
}
// after, if blankLineBeforeDocstring=true
object Foo {
  /** Docstring */
  def foo = 2
}
// after, if blankLineBeforeDocstring=false
object Foo {
  /** Docstring */
  def foo = 2
}

val breakChainOnFirstMethodDot: Boolean

If true, keeps the line break before a dot if it already exists.
If true, keeps the line break before a dot if it already exists.
```
// original
foo
  .map(_ + 1)
  .filter( > 2)
// if true
foo
  .map(_ + 1)
  .filter( > 2)
// if false
foo.map(_ + 1).filter( > 2)
```

val breaksInsideChains: Boolean

If true, then the user can opt out of line breaks inside select chains.

// original
foo
  .map(_ + 1).map(_ + 1)
  .filter(_ > 2)
// if true
foo
  .map(_ + 1).map(_ + 1)
  .filter(_ > 2)
// if false
foo
  .map(_ + 1)
  .map(_ + 1)
  .filter(_ > 2)

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.
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit val reader: ConfDecoder[OptIn]
val selfAnnotationNewline: Boolean

See https://github.com/scalameta/scalafmt/issues/938 If true, will force a line break before a self annotation if there was a line break there before.
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 OptIn | package config

case class OptIn(configStyleArguments: Boolean = true, breaksInsideChains: Boolean = false, breakChainOnFirstMethodDot: Boolean = true, selfAnnotationNewline: Boolean = true, annotationNewlines: Boolean = true, blankLineBeforeDocstring: Boolean = false) extends Product with Serializable

Instance Constructors

new OptIn(configStyleArguments: Boolean = true, breaksInsideChains: Boolean = false, breakChainOnFirstMethodDot: Boolean = true, selfAnnotationNewline: Boolean = true, annotationNewlines: Boolean = true, blankLineBeforeDocstring: Boolean = false)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val annotationNewlines: Boolean

final def asInstanceOf[T0]: T0

val blankLineBeforeDocstring: Boolean

val breakChainOnFirstMethodDot: Boolean

val breaksInsideChains: Boolean

def clone(): AnyRef

val configStyleArguments: Boolean

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit val reader: ConfDecoder[OptIn]

val selfAnnotationNewline: Boolean

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