struct

LSP::Diagnostic

Inherits JSON::Serializable < Struct < Value < Object

Constructors

new(range : LSP::Range, message : String, source : Nil | String = nil, severity : LSP::DiagnosticSeverity | Nil = nil, code : Int32 | String | Nil = nil, code_description : LSP::CodeDescription | Nil = nil, tags : Nil | Array(LSP::DiagnosticTag) = nil, related_information : Nil | Array(LSP::DiagnosticRelatedInformation) = nil, data : JSON::Any | Nil = nil)

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

code

The diagnostic's code, which might appear in the user interface.

code=(code : Int32 | String | Nil)

The diagnostic's code, which might appear in the user interface.

code_description

An optional property to describe the error code

code_description=(code_description : CodeDescription | Nil)

An optional property to describe the error code

data

A data entry field that is preserved between a textDocument/publishDiagnostics notification and textDocument/codeAction request.

data=(data : JSON::Any | Nil)

A data entry field that is preserved between a textDocument/publishDiagnostics notification and textDocument/codeAction request.

message

The diagnostic's message.

message=(message : String)

The diagnostic's message.

range

The range at which the message applies.

range=(range : Range)

The range at which the message applies.

related_information

An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.

related_information=(related_information : Array(DiagnosticRelatedInformation) | Nil)

An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.

severity

The diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.

severity=(severity : DiagnosticSeverity | Nil)

The diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.

source

A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.

source=(source : String | Nil)

A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.

tags

Additional metadata about the diagnostic.

tags=(tags : Array(DiagnosticTag) | Nil)

Additional metadata about the diagnostic.