mirror of
https://github.com/laravel-ls/protocol.git
synced 2026-06-16 03:54:56 +02:00
121 lines
3.6 KiB
Go
121 lines
3.6 KiB
Go
package protocol
|
||
|
||
import (
|
||
"encoding/json"
|
||
"fmt"
|
||
)
|
||
|
||
const (
|
||
MethodTextDocumentDiagnostic = "textDocument/diagnostic"
|
||
MethodTextDocumentPublishDiagnostics = "textDocument/publishDiagnostics"
|
||
)
|
||
|
||
// DocumentDiagnosticParams - Parameters of the document diagnostic request.
|
||
//
|
||
// @since 3.17.0
|
||
//
|
||
// See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#documentDiagnosticParams
|
||
type DocumentDiagnosticParams struct {
|
||
WorkDoneProgressParams
|
||
PartialResultParams
|
||
|
||
// The text document to request diagnostics for.
|
||
TextDocument TextDocumentIdentifier `json:"textDocument"`
|
||
|
||
// The additional identifier provided during registration.
|
||
Identifier string `json:"identifier,omitempty"`
|
||
|
||
// The current version of the document.
|
||
// If provided, servers can avoid computing diagnostics again if the document version hasn’t changed.
|
||
PreviousResultID string `json:"previousResultId,omitempty"`
|
||
}
|
||
|
||
// PublishDiagnosticsParams - The parameters of a publish diagnostics notification.
|
||
//
|
||
// @since 3.0.0
|
||
//
|
||
// See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#publishDiagnosticsParams
|
||
type PublishDiagnosticsParams struct {
|
||
// The URI for which diagnostic information is reported.
|
||
URI DocumentURI `json:"uri"`
|
||
|
||
// Optional the version number of the document the diagnostics are published for.
|
||
//
|
||
// @since 3.15.0
|
||
Version int `json:"version,omitempty"`
|
||
|
||
// An array of diagnostic information items.
|
||
Diagnostics []Diagnostic `json:"diagnostics"`
|
||
}
|
||
|
||
// DocumentDiagnosticReport is either a full or an unchanged diagnostic report.
|
||
//
|
||
// @since 3.17.0
|
||
// See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#documentDiagnosticReport
|
||
type DocumentDiagnosticReport struct {
|
||
Full *FullDocumentDiagnosticReport
|
||
Unchanged *UnchangedDocumentDiagnosticReport
|
||
}
|
||
|
||
// FullDocumentDiagnosticReport - A full diagnostic report with a full set of problems.
|
||
//
|
||
// @since 3.17.0
|
||
//
|
||
// See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#fullDocumentDiagnosticReport
|
||
type FullDocumentDiagnosticReport struct {
|
||
Kind string `json:"kind"` // Should always be "full"
|
||
ResultID string `json:"resultId,omitempty"`
|
||
Items []Diagnostic `json:"items"`
|
||
}
|
||
|
||
// UnchangedDocumentDiagnosticReport - An unchanged diagnostic report indicating nothing has changed.
|
||
//
|
||
// @since 3.17.0
|
||
//
|
||
// See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#unchangedDocumentDiagnosticReport
|
||
type UnchangedDocumentDiagnosticReport struct {
|
||
Kind string `json:"kind"` // Should always be "unchanged"
|
||
ResultID string `json:"resultId"`
|
||
}
|
||
|
||
func (r DocumentDiagnosticReport) MarshalJSON() ([]byte, error) {
|
||
if r.Full != nil {
|
||
return json.Marshal(r.Full)
|
||
}
|
||
if r.Unchanged != nil {
|
||
return json.Marshal(r.Unchanged)
|
||
}
|
||
return nil, fmt.Errorf("either the Full or Unchanged field needs to be set")
|
||
}
|
||
|
||
func (r *DocumentDiagnosticReport) UnmarshalJSON(data []byte) error {
|
||
// reset object first.
|
||
*r = DocumentDiagnosticReport{}
|
||
|
||
var temp struct {
|
||
Kind string `json:"kind"`
|
||
}
|
||
|
||
if err := json.Unmarshal(data, &temp); err != nil {
|
||
return err
|
||
}
|
||
|
||
switch temp.Kind {
|
||
case "full":
|
||
var full FullDocumentDiagnosticReport
|
||
if err := json.Unmarshal(data, &full); err != nil {
|
||
return err
|
||
}
|
||
r.Full = &full
|
||
case "unchanged":
|
||
var unchanged UnchangedDocumentDiagnosticReport
|
||
if err := json.Unmarshal(data, &unchanged); err != nil {
|
||
return err
|
||
}
|
||
r.Unchanged = &unchanged
|
||
default:
|
||
return fmt.Errorf("unknown document diagnostic report kind: %s", temp.Kind)
|
||
}
|
||
|
||
return nil
|
||
}
|