case class Align(allowOverflow: Boolean = false, multiline: Boolean = false, stripMargin: Boolean = true, closeParenSite: Boolean = false, openParenCallSite: Boolean = false, openParenCtrlSite: Boolean = false, openParenDefnSite: Boolean = false, openParenTupleSite: Option[Boolean] = None, tokens: Seq[AlignToken] = Seq(AlignToken.caseArrow), arrowEnumeratorGenerator: Boolean = false, tokenCategory: Map[String, String] = Map(), treeCategory: Map[String, String] = Map( "Defn.Val" -> "given/val/var/def", "Defn.Var" -> "given/val/var/def", "Defn.Def" -> "given/val/var/def", "Defn.GivenAlias" -> "given/val/var/def", "Defn.Class" -> "class/object/trait/enum", "Defn.Object" -> "class/object/trait/enum", "Defn.Trait" -> "class/object/trait/enum", "Defn.Enum" -> "class/object/trait/enum", "Enumerator.Generator" -> "for", "Enumerator.Val" -> "for" )) extends Product with Serializable

stripMargin

If set, indent lines with a strip-margin character in a multiline string constant relative to the opening quotes (or the strip-margin character if present) on the first line; otherwise, indent relative to the beginning of the first line, as usual.

openParenCallSite

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)

openParenCtrlSite

If true, aligns by ( in if/while/for. If false, indents by continuation indent at call site.

openParenDefnSite

Same as openParenCallSite, except definition site.

tokens

The tokens to vertically align by. The "owner" is the scala.meta.Tree.getClass.getName of the deepest tree node that "owns" the token to align by. Examples: align.tokens = ["="] // align = owned by any tree node (not recommended) align.tokens = [ { code = "=", owner = "Param" } // align = when owned by parameter tree nodes ] Pro tip. if you use for example preset = defaultWithAlign and want to add one extra token (for example "|>") to align by, write align.tokens."+" = [ "|> ] NOTE. Adding more alignment tokens may potentially decrease the vertical alignment in formatted output. Customize at your own risk, I recommend you try and stick to the default settings.

arrowEnumeratorGenerator

If true, aligns by <- in for comprehensions.

tokenCategory

Customize which token kinds can align together. By default, only tokens with the same Token.productPrefix align. To for example align = and <-, set the values to: Map("Equals" -> "Assign", "LeftArrow" -> "Assign") Note. Requires mixedTokens to be true.

treeCategory

Customize which tree kinds can align together. By default, only trees with the same Tree.productPrefix align. To for example align Defn.Val and Defn.Var, set the values to: Map("Defn.Var" -> "Assign", "Defn.Val" -> "Assign") Note. Requires mixedOwners to be true.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Align
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Align(allowOverflow: Boolean = false, multiline: Boolean = false, stripMargin: Boolean = true, closeParenSite: Boolean = false, openParenCallSite: Boolean = false, openParenCtrlSite: Boolean = false, openParenDefnSite: Boolean = false, openParenTupleSite: Option[Boolean] = None, tokens: Seq[AlignToken] = Seq(AlignToken.caseArrow), arrowEnumeratorGenerator: Boolean = false, tokenCategory: Map[String, String] = Map(), treeCategory: Map[String, String] = Map( "Defn.Val" -> "given/val/var/def", "Defn.Var" -> "given/val/var/def", "Defn.Def" -> "given/val/var/def", "Defn.GivenAlias" -> "given/val/var/def", "Defn.Class" -> "class/object/trait/enum", "Defn.Object" -> "class/object/trait/enum", "Defn.Trait" -> "class/object/trait/enum", "Defn.Enum" -> "class/object/trait/enum", "Enumerator.Generator" -> "for", "Enumerator.Val" -> "for" ))

    stripMargin

    If set, indent lines with a strip-margin character in a multiline string constant relative to the opening quotes (or the strip-margin character if present) on the first line; otherwise, indent relative to the beginning of the first line, as usual.

    openParenCallSite

    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)

    openParenCtrlSite

    If true, aligns by ( in if/while/for. If false, indents by continuation indent at call site.

    openParenDefnSite

    Same as openParenCallSite, except definition site.

    tokens

    The tokens to vertically align by. The "owner" is the scala.meta.Tree.getClass.getName of the deepest tree node that "owns" the token to align by. Examples: align.tokens = ["="] // align = owned by any tree node (not recommended) align.tokens = [ { code = "=", owner = "Param" } // align = when owned by parameter tree nodes ] Pro tip. if you use for example preset = defaultWithAlign and want to add one extra token (for example "|>") to align by, write align.tokens."+" = [ "|> ] NOTE. Adding more alignment tokens may potentially decrease the vertical alignment in formatted output. Customize at your own risk, I recommend you try and stick to the default settings.

    arrowEnumeratorGenerator

    If true, aligns by <- in for comprehensions.

    tokenCategory

    Customize which token kinds can align together. By default, only tokens with the same Token.productPrefix align. To for example align = and <-, set the values to: Map("Equals" -> "Assign", "LeftArrow" -> "Assign") Note. Requires mixedTokens to be true.

    treeCategory

    Customize which tree kinds can align together. By default, only trees with the same Tree.productPrefix align. To for example align Defn.Val and Defn.Var, set the values to: Map("Defn.Var" -> "Assign", "Defn.Val" -> "Assign") Note. Requires mixedOwners to be true.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val allowOverflow: Boolean
  5. val arrowEnumeratorGenerator: Boolean
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val closeParenSite: Boolean
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getOpenParenTupleSite: Boolean
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val multiline: Boolean
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. val openParenCallSite: Boolean
  19. val openParenCtrlSite: Boolean
  20. val openParenDefnSite: Boolean
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val stripMargin: Boolean
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. val tokenCategory: Map[String, String]
  25. val tokens: Seq[AlignToken]
  26. val treeCategory: Map[String, String]
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped