Patch

A data structure that can produce a .patch file.

The best way to build a Patch is with a RuleCtx inside a Rule. For example, Rule.syntactic(ctx => ctx.addLeft(ctx.tree.tokens.head): Patch)

Patches can be composed with Patch.+ and Patch.++. A Seq[Patch] can be combined into a single patch with Seq[Patch](...).asPatch with import scalafix.v0._.

Patches are split into low-level token patches and high-level tree patches. A token patch works on scala.meta.Token and provides surgical precision over how details like formatting are managed by the rule.

NOTE: Patch current only works for a single file, but it may be possible to add support in the future for combining patches for different files with Patch + Patch.

Linear Supertypes

AnyRef, Any

Known Subclasses

TokenPatch, TreePatch

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: Option[Patch]): Patch
def +(other: Patch): Patch
def ++(other: Iterable[Patch]): Patch
def ->[B](y: B): (Patch, B)

Implicit information
This member is added by an implicit conversion from Patch to ArrowAssoc[Patch] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def atomic: Patch

Skip this entire patch if a part of it is disabled with // scalafix:off
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (Patch) ⇒ Boolean, msg: ⇒ Any): Patch

Implicit information
This member is added by an implicit conversion from Patch to Ensuring[Patch] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Patch) ⇒ Boolean): Patch

Implicit information
This member is added by an implicit conversion from Patch to Ensuring[Patch] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Patch

Implicit information
This member is added by an implicit conversion from Patch to Ensuring[Patch] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Patch

Implicit information
This member is added by an implicit conversion from Patch to Ensuring[Patch] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from Patch to StringFormat[Patch] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def isEmpty: Boolean

Returns true if this patch is Patch.empty, false otherwise.
Returns true if this patch is Patch.empty, false otherwise.
Note, may return false for patches that produce empty diffs. For example, a Patch.replaceSymbol returns false even if the symbol from is not referenced in the code resulting in an empty diff.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def nonEmpty: Boolean

See also
Patch.isEmpty
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )
def →[B](y: B): (Patch, B)

Implicit information
This member is added by an implicit conversion from Patch to ArrowAssoc[Patch] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Shadowed Implicit Value Members

def +(other: String): String
Implicit information
This member is added by an implicit conversion from Patch to any2stringadd[Patch] performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(patch: any2stringadd[Patch]).+(other)
Definition Classes
any2stringadd

Related Docs: object Patch | package patch

sealed abstract class Patch extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: Option[Patch]): Patch

def +(other: Patch): Patch

def ++(other: Iterable[Patch]): Patch

def ->[B](y: B): (Patch, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def atomic: Patch

def clone(): AnyRef

def ensuring(cond: (Patch) ⇒ Boolean, msg: ⇒ Any): Patch

def ensuring(cond: (Patch) ⇒ Boolean): Patch

def ensuring(cond: Boolean, msg: ⇒ Any): Patch

def ensuring(cond: Boolean): Patch

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

def isEmpty: Boolean

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

def nonEmpty: Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (Patch, B)

Shadowed Implicit Value Members

def +(other: String): String

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Patch to any2stringadd[Patch]

Inherited by implicit conversion StringFormat from Patch to StringFormat[Patch]

Inherited by implicit conversion Ensuring from Patch to Ensuring[Patch]

Inherited by implicit conversion ArrowAssoc from Patch to ArrowAssoc[Patch]

Ungrouped