c

scalafix.v0

SemanticRule

abstract class SemanticRule extends Rule

Linear Supertypes
Rule, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SemanticRule
  2. Rule
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SemanticRule(index: SemanticdbIndex, name: v0.RuleName)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from SemanticRule toany2stringadd[SemanticRule] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SemanticRule, B)
    Implicit
    This member is added by an implicit conversion from SemanticRule toArrowAssoc[SemanticRule] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. implicit val ImplicitSemanticdbIndex: SemanticdbIndex
  7. final def apply(ctx: RuleCtx, patches: Map[v0.RuleName, v0.Patch]): String
    Definition Classes
    Rule
  8. final def apply(ctx: RuleCtx, patch: v0.Patch): String
    Definition Classes
    Rule
  9. final def apply(input: String): String
    Definition Classes
    Rule
  10. final def apply(input: scala.meta.Input, config: ScalafixConfig = ScalafixConfig.default): String
    Definition Classes
    Rule
  11. final def apply(ctx: RuleCtx): String

    Returns string output of applying this single patch.

    Returns string output of applying this single patch.

    Definition Classes
    Rule
  12. final def applyAndLint(ctx: RuleCtx): (String, List[RuleDiagnostic])
    Definition Classes
    Rule
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def check(ctx: RuleCtx): Seq[v0.Diagnostic]

    Returns linter messages to report violations of this rule.

    Returns linter messages to report violations of this rule.

    Definition Classes
    Rule
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. def description: String

    A single sentence summary of what this rule does.

    A single sentence summary of what this rule does.

    Definition Classes
    Rule
  17. final def diff(ctx: RuleCtx, patch: v0.Patch): String
    Attributes
    protected
    Definition Classes
    Rule
  18. final def diff(ctx: RuleCtx): String

    Returns unified diff from applying this patch

    Returns unified diff from applying this patch

    Definition Classes
    Rule
  19. def ensuring(cond: (SemanticRule) => Boolean, msg: => Any): SemanticRule
    Implicit
    This member is added by an implicit conversion from SemanticRule toEnsuring[SemanticRule] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: (SemanticRule) => Boolean): SemanticRule
    Implicit
    This member is added by an implicit conversion from SemanticRule toEnsuring[SemanticRule] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean, msg: => Any): SemanticRule
    Implicit
    This member is added by an implicit conversion from SemanticRule toEnsuring[SemanticRule] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean): SemanticRule
    Implicit
    This member is added by an implicit conversion from SemanticRule toEnsuring[SemanticRule] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  26. def fix(ctx: RuleCtx): v0.Patch

    Returns a patch to fix violations of this rule.

    Returns a patch to fix violations of this rule.

    Definition Classes
    Rule
  27. def fixWithName(ctx: RuleCtx): Map[v0.RuleName, v0.Patch]
    Attributes
    protected[scalafix]
    Definition Classes
    Rule
  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def init(config: Conf): Configured[Rule]

    Initialize this rule with the given user configuration.

    Initialize this rule with the given user configuration.

    This method is called once by scalafix before rule is called. Use this method to either read custom configuration or to build expensive indices.

    config

    The .scalafix.conf configuration.

    returns

    the initialized rule or an error. If no initialization is needed, return Configured.Ok(this).

    Definition Classes
    Rule
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. final def merge(other: Rule): Rule

    Combine this rule with another rule.

    Combine this rule with another rule.

    Definition Classes
    Rule
  33. final def name: v0.RuleName
    Definition Classes
    Rule
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. def semanticOption: Option[SemanticdbIndex]
    Definition Classes
    SemanticRule → Rule
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. final def toString(): String
    Definition Classes
    Rule → AnyRef → Any
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SemanticRule toStringFormat[SemanticRule] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (SemanticRule, B)
    Implicit
    This member is added by an implicit conversion from SemanticRule toArrowAssoc[SemanticRule] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Rule

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSemanticRule to any2stringadd[SemanticRule]

Inherited by implicit conversion StringFormat fromSemanticRule to StringFormat[SemanticRule]

Inherited by implicit conversion Ensuring fromSemanticRule to Ensuring[SemanticRule]

Inherited by implicit conversion ArrowAssoc fromSemanticRule to ArrowAssoc[SemanticRule]

Ungrouped