trait Diagnostic extends AnyRef
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
Diagnostic
class with the appropriate context.
Expensive values such as the message and explanation can be computed on-demand.
- Note
for a Diagnostic that is associated with a specific rule use scalafix.lint.RuleDiagnostic.
- Alphabetic
- By Inheritance
- Diagnostic
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
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
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from Diagnostic to any2stringadd[Diagnostic] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (Diagnostic, B)
- Implicit
- This member is added by an implicit conversion from Diagnostic to ArrowAssoc[Diagnostic] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
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 Diagnostic
- 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
ensuring(cond: (Diagnostic) ⇒ Boolean, msg: ⇒ Any): Diagnostic
- Implicit
- This member is added by an implicit conversion from Diagnostic to Ensuring[Diagnostic] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (Diagnostic) ⇒ Boolean): Diagnostic
- Implicit
- This member is added by an implicit conversion from Diagnostic to Ensuring[Diagnostic] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): Diagnostic
- Implicit
- This member is added by an implicit conversion from Diagnostic to Ensuring[Diagnostic] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): Diagnostic
- Implicit
- This member is added by an implicit conversion from Diagnostic to Ensuring[Diagnostic] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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( ... ) @native()
-
def
→[B](y: B): (Diagnostic, B)
- Implicit
- This member is added by an implicit conversion from Diagnostic to ArrowAssoc[Diagnostic] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Deprecated Value Members
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Diagnostic to StringFormat[Diagnostic] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.