Packages

object SyamlImpl

Utility object for YAML AST formatting and reformatting operations.

Responsibility

This object provides implicit extensions for formatting YAML AST parts with proper indentation and whitespace handling. It handles:

  • Formatting YPart elements (YDocument, YMap, YSequence, YMapEntry, YNode, YScalar, YComment)
  • Managing indentation levels during formatting
  • Handling flow vs block style YAML structures
  • Token manipulation for whitespace, line breaks, and indentation
  • Preserving comments during formatting

Flow Style Handling

YAML flow structures (using [] and {}) are left mostly untouched to preserve user formatting preferences. Block style structures are reformatted with proper indentation.

Usage

Import the implicit class to enable .format() method on YPart instances:

import org.mulesoft.als.actions.formatting.SyamlImpl._
val formatted = yDocument.format(indentSize = 2, currentIndentation = 0)

Related Classes

  • org.mulesoft.als.common.edits.YamlEditBuilder - Building TextEdits for YAML modifications
  • org.mulesoft.als.common.YamlUtils - Position-based YAML navigation
  • org.yaml.render.YamlRender - SYAML's built-in rendering (used for scalar values)
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SyamlImpl
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait FlowableFormat[T <: YPart] extends AnyRef

    We decided to leave YAML Flows as untouched as possible because we are not sure how to best format (maintain single line if user wrote so, expand as with yaml with indentation?) When JSON styler is unified (remove from SYAML), we should revisit this topic

  2. implicit sealed class YCommImpl extends AnyRef
  3. implicit sealed class YMapEntryImpl extends AnyRef
  4. implicit sealed class YMapImpl extends FlowableFormat[YMap]
  5. implicit sealed class YNodeImpl extends AnyRef
  6. implicit sealed class YNonContImpl extends AnyRef
  7. implicit class YPartImpl[T <: YPart] extends AnyRef
  8. implicit sealed class YScalarImpl extends AnyRef
  9. implicit sealed class YSeqImpl extends FlowableFormat[YSequence]

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped