LintMessage

A linter message reporting a code style violation.

It's idiomatic to implement a custom class that extends this trait for each unique category of linting messages. For example, if you have an "unused code" linter then you might want to create a class UnusedCode extends LintMessage class with the appropriate context.

Expensive values such as the message and explanation can be computed on-demand.

Note: for a LintMessage that is associated with a specific rule use scalafix.lint.LintDiagnostic.

Linear Supertypes

AnyRef, Any

Known Subclasses

EagerLintMessage

Abstract Value Members

abstract def message: String

The main message of this diagnostic.
abstract def position: scala.meta.Position

The source code location where this violation appears, Position.None if not available

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def categoryID: String

String ID for the category of this lint message.
String ID for the category of this lint message.
A linter diagnostic is keyed by two unique values: - the rule name (which is not available in a LintMessage - the category ID (this value)
The categoryID may be empty, in which case the category of this message will be uniquely defined by the rule name. If a linter rule reports multiple different kinds of diagnostics then it's recommended to provide non-empty categoryID.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def explanation: String

An optional detailed explanation of this message.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def severity: LintSeverity

The severity of this message: error, warning or info
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object LintMessage | package lint

trait LintMessage extends AnyRef

Abstract Value Members

abstract def message: String

abstract def position: scala.meta.Position

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def categoryID: String

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def explanation: String

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def severity: LintSeverity

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped