Trait/Object

scalafix.lint

Diagnostic

Related Docs: object Diagnostic | package lint

Permalink

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.

Linear Supertypes
AnyRef, Any
Known Subclasses
LintMessage, SemanticdbDiagnostic
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Diagnostic
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def message: String

    Permalink

    The main message of this diagnostic.

  2. abstract def position: scala.meta.Position

    Permalink

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Diagnostic to any2stringadd[Diagnostic] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Diagnostic, B)

    Permalink
    Implicit information
    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()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def categoryID: String

    Permalink

    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.

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def ensuring(cond: (Diagnostic) ⇒ Boolean, msg: ⇒ Any): Diagnostic

    Permalink
    Implicit information
    This member is added by an implicit conversion from Diagnostic to Ensuring[Diagnostic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (Diagnostic) ⇒ Boolean): Diagnostic

    Permalink
    Implicit information
    This member is added by an implicit conversion from Diagnostic to Ensuring[Diagnostic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): Diagnostic

    Permalink
    Implicit information
    This member is added by an implicit conversion from Diagnostic to Ensuring[Diagnostic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): Diagnostic

    Permalink
    Implicit information
    This member is added by an implicit conversion from Diagnostic to Ensuring[Diagnostic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def explanation: String

    Permalink

    An optional detailed explanation of this message.

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Diagnostic to StringFormat[Diagnostic] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. def severity: LintSeverity

    Permalink

    The severity of this message: error, warning or info

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

    Permalink
    Definition Classes
    AnyRef

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. def →[B](y: B): (Diagnostic, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Diagnostic to ArrowAssoc[Diagnostic] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Diagnostic to any2stringadd[Diagnostic]

Inherited by implicit conversion StringFormat from Diagnostic to StringFormat[Diagnostic]

Inherited by implicit conversion Ensuring from Diagnostic to Ensuring[Diagnostic]

Inherited by implicit conversion ArrowAssoc from Diagnostic to ArrowAssoc[Diagnostic]

Ungrouped