abstract class Rule extends AnyRef
- Alphabetic
- By Inheritance
- Rule
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Rule(name: v1.RuleName)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Rule, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def afterComplete(): Unit
Called after all documents have been processed
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def beforeStart(): Unit
Called before the rule starts processing documents
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def description: String
Single sentence explanation of what this rule does.
Single sentence explanation of what this rule does.
Example: Removed unused imports reported by the compiler under -Ywarn-unused
- def ensuring(cond: (Rule) => Boolean, msg: => Any): Rule
- def ensuring(cond: (Rule) => Boolean): Rule
- def ensuring(cond: Boolean, msg: => Any): Rule
- def ensuring(cond: Boolean): Rule
- 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])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def isExperimental: Boolean
Indicates if this rule is incomplete and subject to breaking changes or removal in the future.
Indicates if this rule is incomplete and subject to breaking changes or removal in the future.
Experimental rules are excluded from from tab completions and do not need to be documented on the website.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isLinter: Boolean
If true, allows this rule to be grouped together with other linter rules for documentation purposes.
- def isRewrite: Boolean
If true, allows this rule to be grouped together with other rewrite rules for documentation purposes.
- val name: v1.RuleName
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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()
- def withConfiguration(config: Configuration): Configured[Rule]
Configure this rule according to user .scalafix.conf settings and compiler version.
Configure this rule according to user .scalafix.conf settings and compiler version.
This method is called once per project/module. The same rule instance is used to analyze multiple source files.
- returns
A new version of this rule with loaded configuration or an error message.
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Rule toStringFormat[Rule] 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,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Rule, B)
- Implicit
- This member is added by an implicit conversion from Rule toArrowAssoc[Rule] 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.