package v0
- Alphabetic
- By Inheritance
- v0
- Api
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
implicit
class
XtensionOptionPatch extends AnyRef
- Definition Classes
- Api
-
implicit
class
XtensionScalaFixListInspect[A] extends AnyRef
- Definition Classes
- Api
-
implicit
class
XtensionScalafixProductInspect extends AnyRef
- Definition Classes
- Api
-
implicit
class
XtensionSeqPatch extends AnyRef
- Definition Classes
- Api
-
type
CustomMessage[T] = config.CustomMessage[T]
- Definition Classes
- Api
- final case class Database(documents: Seq[Document]) extends Product with Serializable
- final case class Denotation(flags: Long, name: String, signature: String, names: List[ResolvedName]) extends HasFlags with Product with Serializable
-
type
Diagnostic = lint.Diagnostic
- Definition Classes
- Api
- final case class Document(input: Input, language: String, names: List[ResolvedName], messages: List[Message], symbols: List[ResolvedSymbol], synthetics: List[Synthetic]) extends Product with Serializable
- trait Flags extends AnyRef
- trait HasFlags extends AnyRef
-
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.
-
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.
- final case class Message(position: Position, severity: Severity, text: String) extends Product with Serializable
-
type
Patch = patch.Patch
- Definition Classes
- Api
- final case class ResolvedName(position: Position, symbol: Symbol, isDefinition: Boolean) extends Product with Serializable
- final case class ResolvedSymbol(symbol: Symbol, denotation: Denotation) extends Product with Serializable
- trait RuleCtx extends PatchOps
-
type
RuleName = rule.RuleName
- Definition Classes
- Api
- abstract class SemanticRule extends Rule
-
trait
SemanticdbIndex extends SemanticContext
An index for looking up data in a scala.meta.Database.
- sealed trait Severity extends Product
- sealed trait Signature extends AnyRef
- sealed trait Symbol extends Product
-
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)
- final case class Synthetic(position: Position, text: String, names: List[ResolvedName]) extends Product with Serializable
-
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) } }
- Annotations
- @deprecated
- Deprecated
(Since version 0.9.28) Use scalafix.v1.Rule instead
Value Members
-
val
CustomMessage: config.CustomMessage.type
- Definition Classes
- Api
-
val
Diagnostic: lint.Diagnostic.type
- Definition Classes
- Api
-
val
Patch: patch.Patch.type
- Definition Classes
- Api
-
val
RuleName: rule.RuleName.type
- Definition Classes
- Api
- object Flags extends Flags
- object LintCategory extends Serializable
- object ResolvedName extends Serializable
- object Rule
- object RuleCtx
- object SemanticdbIndex
- object Severity
- object Signature
- object Symbol
- object SymbolMatcher