types

Documentation

Overview

Package types contains the Language Server Protocol specification types. See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/.

Index

• type DefinitionParams
• type DidChangeTextDocumentParams
• type DidCloseTextDocumentParams
• type DidOpenTextDocumentParams
• type InitializeParams
• type InitializeResult
• type Location
• type Position
  • func (p Position) String() string
• type Range
  • func (r Range) String() string
• type ReferenceParams
• type RequestID
  • func (r RequestID) MarshalJSON() ([]byte, error)
  • func (r *RequestID) String() string
  • func (r *RequestID) UnmarshalJSON(data []byte) error
• type RequestMessage
• type ResponseMessage
• type ServerCapabilities
• type ServerInfo
• type TextDocumentContentChangeEvent
• type TextDocumentIdentifier
• type TextDocumentItem
• type TextDocumentPositionParams
• type TextDocumentSyncKind
• type TextDocumentSyncOptions

Types

type DefinitionParams

type DefinitionParams struct {
	TextDocumentPositionParams
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#definitionParams.

type DidChangeTextDocumentParams

type DidChangeTextDocumentParams struct {
	TextDocument   TextDocumentIdentifier           `json:"textDocument"`
	ContentChanges []TextDocumentContentChangeEvent `json:"contentChanges"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#didChangeTextDocumentParams.

type DidCloseTextDocumentParams

type DidCloseTextDocumentParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#didCloseTextDocumentParams.

type DidOpenTextDocumentParams

type DidOpenTextDocumentParams struct {
	TextDocument TextDocumentItem `json:"textDocument"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#didOpenTextDocumentParams.

type InitializeParams

type InitializeParams struct {
	ClientInfo struct {
		Name    string `json:"name"`
		Version string `json:"version"`
	} `json:"clientInfo"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initializeParams.

type InitializeResult

type InitializeResult struct {
	Capabilities ServerCapabilities `json:"capabilities"`
	ServerInfo   ServerInfo         `json:"serverInfo"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initializeResult.

type Location

type Location struct {
	URI   string `json:"uri"`
	Range Range  `json:"range"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#location.

type Position

type Position struct {
	Line      int `json:"line"`
	Character int `json:"character"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position.

func (Position) String

func (p Position) String() string

type Range

type Range struct {
	Start Position `json:"start"`
	End   Position `json:"end"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#range.

func (Range) String

func (r Range) String() string

type ReferenceParams

type ReferenceParams struct {
	TextDocumentPositionParams
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#referenceParams.

type RequestID

type RequestID struct {
	IntVal    int
	StringVal string
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#requestMessage.

func (RequestID) MarshalJSON

func (r RequestID) MarshalJSON() ([]byte, error)

func (*RequestID) String

func (r *RequestID) String() string

func (*RequestID) UnmarshalJSON

func (r *RequestID) UnmarshalJSON(data []byte) error

type RequestMessage

type RequestMessage struct {
	JSONRPC string          `json:"jsonrpc"`
	ID      *RequestID      `json:"id"`
	Method  string          `json:"method"`
	Params  json.RawMessage `json:"params"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#requestMessage.

type ResponseMessage

type ResponseMessage struct {
	JSONRPC string     `json:"jsonrpc"`
	ID      *RequestID `json:"id"`
	Result  any        `json:"result"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#responseMessage.

type ServerCapabilities

type ServerCapabilities struct {
	TextDocumentSync   TextDocumentSyncOptions `json:"textDocumentSync"`
	DefinitionProvider bool                    `json:"definitionProvider,omitempty"`
	ReferencesProvider bool                    `json:"referencesProvider,omitempty"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#serverCapabilities.

type ServerInfo

type ServerInfo struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initializeResult.

type TextDocumentContentChangeEvent

type TextDocumentContentChangeEvent struct {
	Text  string `json:"text"`
	Range *Range `json:"range,omitempty"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentContentChangeEvent.

type TextDocumentIdentifier

type TextDocumentIdentifier struct {
	URI string `json:"uri"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentIdentifier.

type TextDocumentItem

type TextDocumentItem struct {
	URI  string `json:"uri"`
	Text string `json:"text"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentItem.

type TextDocumentPositionParams

type TextDocumentPositionParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	Position     Position               `json:"position"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentPositionParams.

type TextDocumentSyncKind

type TextDocumentSyncKind int

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentSyncKind.

const (
	SyncNone        TextDocumentSyncKind = 0
	SyncFull        TextDocumentSyncKind = 1
	SyncIncremental TextDocumentSyncKind = 2
)

type TextDocumentSyncOptions

type TextDocumentSyncOptions struct {
	OpenClose bool                 `json:"openClose,omitempty"`
	Change    TextDocumentSyncKind `json:"change"`
}

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentSyncOptions.