abstract class Rule extends AnyRef

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Rule
  2. AnyRef
  3. 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 Rule(name: v1.RuleName)

Value Members

  1. def afterComplete(): Unit

    Called after all documents have been processed

  2. def beforeStart(): Unit

    Called before the rule starts processing documents

  3. 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

  4. 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.

  5. def isLinter: Boolean

    If true, allows this rule to be grouped together with other linter rules for documentation purposes.

  6. def isRewrite: Boolean

    If true, allows this rule to be grouped together with other rewrite rules for documentation purposes.

  7. val name: v1.RuleName
  8. def toString(): String
    Definition Classes
    Rule → AnyRef → Any
  9. 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.