package rule
Ordering
- Alphabetic
Visibility
- Public
- All
Type Members
-
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[LintMessage] = ctx.tree.collect { case nil @ q"null" => error.at(nil.pos) } }
- trait RuleCtx extends PatchOps
-
final
case class
RuleIdentifier
(value: String, deprecated: Option[Deprecated]) extends Product with Serializable
A thin wrapper around a string name and optional deprecation warning.
-
final
case class
RuleName
(identifiers: List[RuleIdentifier]) extends Product with Serializable
A thin wrapper around a list of RuleIdentifier.
- abstract class SemanticRule extends Rule
Value Members
- object Rule
- object RuleCtx
- object RuleIdentifier extends Serializable
- object RuleName extends Serializable
- object ScalafixRules