abstract class SemanticRule extends Rule
- Alphabetic
- By Inheritance
- SemanticRule
- Rule
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SemanticRule(index: SemanticdbIndex, name: v0.RuleName)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- implicit val ImplicitSemanticdbIndex: SemanticdbIndex
- final def apply(ctx: RuleCtx, patches: Map[v0.RuleName, v0.Patch]): String
- Definition Classes
- Rule
- final def apply(ctx: RuleCtx, patch: v0.Patch): String
- Definition Classes
- Rule
- final def apply(input: String): String
- Definition Classes
- Rule
- final def apply(input: scala.meta.Input, config: ScalafixConfig = ScalafixConfig.default): String
- Definition Classes
- Rule
- 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
- final def applyAndLint(ctx: RuleCtx): (String, List[RuleDiagnostic])
- Definition Classes
- Rule
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def description: String
A single sentence summary of what this rule does.
A single sentence summary of what this rule does.
- Definition Classes
- Rule
- final def diff(ctx: RuleCtx, patch: v0.Patch): String
- Attributes
- protected
- Definition Classes
- Rule
- final def diff(ctx: RuleCtx): String
Returns unified diff from applying this patch
Returns unified diff from applying this patch
- Definition Classes
- Rule
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- 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
- def fixWithName(ctx: RuleCtx): Map[v0.RuleName, v0.Patch]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def merge(other: Rule): Rule
Combine this rule with another rule.
Combine this rule with another rule.
- Definition Classes
- Rule
- final def name: v0.RuleName
- Definition Classes
- Rule
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def semanticOption: Option[SemanticdbIndex]
- Definition Classes
- SemanticRule → Rule
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toString(): String
- Definition Classes
- Rule → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.