c

scalafix.internal.v0

LegacySemanticRule

class LegacySemanticRule extends v1.SemanticRule

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

Instance Constructors

  1. new LegacySemanticRule(name: rule.RuleName, fn: (v0.SemanticdbIndex) ⇒ v0.Rule)

Value Members

  1. def afterComplete(): Unit

    Called after all documents have been processed

    Called after all documents have been processed

    Definition Classes
    Rule
  2. def beforeStart(): Unit

    Called before the rule starts processing documents

    Called before the rule starts processing documents

    Definition Classes
    Rule
  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

    Definition Classes
    LegacySemanticRule → Rule
  4. def fix(implicit sdoc: SemanticDocument): patch.Patch
    Definition Classes
    LegacySemanticRule → SemanticRule
  5. 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.

    Definition Classes
    Rule
  6. def isLinter: Boolean

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

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

    Definition Classes
    Rule
  7. def isRewrite: Boolean

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

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

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

    Definition Classes
    LegacySemanticRule → Rule