v0

Type Members

1. type CustomMessage[T] = config.CustomMessage[T]

   

   Definition Classes

   Api

2. final case class Database(documents: Seq[Document]) extends Product with Serializable

   

3. final case class Denotation(flags: Long, name: String, signature: String, names: List[ResolvedName]) extends HasFlags with Product with Serializable

   

4. type Diagnostic = lint.Diagnostic

   

   Definition Classes

   Api

5. final case class Document(input: Input, language: String, names: List[ResolvedName], messages: List[Message], symbols: List[ResolvedSymbol], synthetics: List[Synthetic]) extends Product with Serializable

   

6. trait Flags extends AnyRef

   

7. trait HasFlags extends AnyRef

   

8. final case class LintCategory(id: String, explanation: String, severity: LintSeverity) extends Product with Serializable

   

   A unique identifier for one kind of a linter message.

   A unique identifier for one kind of a linter message.

   id

   a string ID for this message, typically the name of the assigned variable. If id is empty, then the name of the rewrite reporting this LintCategory is used as id.

   explanation

   An optional explanation for this kind of message.

   severity

   The default category this message should get reported to. Note that users can configure/override the default category.

9. final case class LintMessage(message: String, position: scala.meta.Position, category: LintCategory) extends Diagnostic with Product with Serializable

   

   An observation of a LintCategory at a particular position

   An observation of a LintCategory at a particular position

   message

   The message to display to the user. If empty, LintID.explanation is used instead.

   position

   Optionally place a caret under a location in a source file. For an empty position use Position.None.

   category

   the LintCategory associated with this message.

10. final case class Message(position: Position, severity: Severity, text: String) extends Product with Serializable

    

11. type Patch = patch.Patch

    

    Definition Classes

    Api

12. final case class ResolvedName(position: Position, symbol: Symbol, isDefinition: Boolean) extends Product with Serializable

    

13. final case class ResolvedSymbol(symbol: Symbol, denotation: Denotation) extends Product with Serializable

    

14. abstract class Rule extends AnyRef

    

    A Scalafix Rule.

    A Scalafix Rule.

    To provide automatic fixes for this rule, override the fix method. Example:

    object ReverseNames extends Rule("ReverseNames") {
      override def fix(ctx: RuleCtx) =
        ctx.tree.collect {
          case name @ Name(value) => ctx.replaceTree(name, value.reverse)
        }.asPatch
    }

    To report violations of this rule (without automatic fix), override the check method. Example:

    // example syntactic linter
    object NoNulls extends Rule("NoNulls") {
      val error = LintCategory.error("Nulls are not allowed.")
      override def check(ctx: RuleCtx): List[Diagnostic] = ctx.tree.collect {
        case nil @ q"null" => error.at(nil.pos)
      }
    }

15. trait RuleCtx extends PatchOps

    

16. type RuleName = rule.RuleName

    

    Definition Classes

    Api

17. abstract class SemanticRule extends Rule

    

18. trait SemanticdbIndex extends SemanticContext

    

    An index for looking up data in a scala.meta.Database.

19. sealed trait Severity extends Product

    

20. sealed trait Signature extends AnyRef

    

21. sealed trait Symbol extends Product

    

22. final class SymbolMatcher extends AnyRef

    

    Utility to match against a particular symbol.

    Utility to match against a particular symbol.

    Can be used both in pattern matching and regular condition testing.

    val myMethod = SymbolMatcher(Symbol("_root_.myMethod"))
    myMethod.matches(Tree)
    Tree match {
      case myMethod(_) => // act on tree
    }
    myMethod.matches(Tree)

23. final case class Synthetic(position: Position, text: String, names: List[ResolvedName]) extends Product with Serializable

    

24. implicit class XtensionOptionPatch extends AnyRef

    

    Definition Classes

    Api

25. implicit class XtensionScalafixProductInspect extends AnyRef

    

    Definition Classes

    Api

26. implicit class XtensionSeqPatch extends AnyRef

    

    Definition Classes

    Api