Instance Constructors

1.  new OptIn(configStyleArguments: Boolean = true, breaksInsideChains: Boolean = false, breakChainOnFirstMethodDot: Boolean = true, encloseClassicChains: Boolean = false, selfAnnotationNewline: Boolean = true, annotationNewlines: Boolean = true, forceBlankLineBeforeDocstring: 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

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

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

   encloseClassicChains

   NB: ignored unless newlines.source=classic. Controls what happens if a chain enclosed in parentheses is followed by additional selects. Those additional selects will be considered part of the enclosed chain if and only if this flag is false.

   // 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)

   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.

   annotationNewlines

   • if newlines.source is missing or keep:
     • if true, will keep existing line breaks around annotations
   • if newlines.source is fold:
     • if true, will break before the entity being annotated
     • will not force break between consecutive annotations
   • if newlines.source is unfold:
     • if true, will break between consecutive annotations
     • will always break before the entity being annotated

   forceBlankLineBeforeDocstring

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

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