A unique identifier for one kind of a linter message.

An observation of a LintCategory at a particular position

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)

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)
  }
}