Packages

trait LintMessage 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 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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LintMessage
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def message: String

    The main message of this diagnostic.

  2. abstract def position: scala.meta.Position

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. 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.

  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def explanation: String

    An optional detailed explanation of this message.

  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def severity: LintSeverity

    The severity of this message: error, warning or info

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped