types

Documentation

Index

• type ApplyWorkspaceEditParams
• type Client
• type ClientCapabilities
• type CodeAction
• type CodeActionContext
• type CodeActionOptions
• type CodeActionParams
• type CodeDescription
• type Command
• type DefinitionParams
• type Diagnostic
• type DiagnosticClientCapabilities
• type DiagnosticCode
• type DiagnosticOptions
• type DiagnosticWorkspaceClientCapabilities
• type DocumentFormattingParams
• type DocumentSymbol
• type DocumentSymbolParams
• type ExecuteCommandOptions
• type ExecuteCommandParams
• type FileDiagnostics
• type FileEvent
• type FileOperationFilter
• type FileOperationPattern
• type FileOperationRegistrationOptions
• type FileOperationsServerCapabilities
• type FoldingRange
• type FoldingRangeParams
• type FormattingOptions
• type GeneralClientCapabilities
• type InitializeParams
• type InitializeResult
• type InlayHint
• type InlayHintOptions
• type Location
• type MarkupContent
• type OptionalVersionedTextDocumentIdentifier
• type Position
• type Range
• type ServerCapabilities
• type StaleRequestSupportClientCapabilities
• type TextDocumentClientCapabilities
• type TextDocumentContentChangeEvent
• type TextDocumentDidChangeParams
• type TextDocumentDidOpenParams
• type TextDocumentEdit
• type TextDocumentHoverParams
• type TextDocumentIdentifier
• type TextDocumentInlayHintParams
• type TextDocumentItem
• type TextDocumentSyncOptions
• type TextEdit
• type WindowClientCapabilities
• type WorkspaceClientCapabilities
• type WorkspaceDiagnosticReport
• type WorkspaceDidChangeWatchedFilesParams
• type WorkspaceDidCreateFilesParams
• type WorkspaceDidCreateFilesParamsCreatedFile
• type WorkspaceDidDeleteFilesParams
• type WorkspaceDidDeleteFilesParamsDeletedFile
• type WorkspaceDidRenameFilesParams
• type WorkspaceDidRenameFilesParamsFileRename
• type WorkspaceEdit
• type WorkspaceFolder
• type WorkspaceFullDocumentDiagnosticReport
• type WorkspaceOptions
• type WorkspaceSymbol
• type WorkspaceSymbolParams

Types

type ApplyWorkspaceEditParams

type ApplyWorkspaceEditParams struct {
	Label string        `json:"label"`
	Edit  WorkspaceEdit `json:"edit"`
}

type Client

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

type ClientCapabilities

type ClientCapabilities struct {
	Workspace WorkspaceClientCapabilities    `json:"workspace"`
	Text      TextDocumentClientCapabilities `json:"textDocument"`
	Window    WindowClientCapabilities       `json:"window"`
	General   GeneralClientCapabilities      `json:"general"`
}

type CodeAction

type CodeAction struct {
	Title       string       `json:"title"`
	Kind        string       `json:"kind"`
	Diagnostics []Diagnostic `json:"diagnostics"`
	IsPreferred bool         `json:"isPreferred"`
	Command     Command      `json:"command"`
}

type CodeActionContext

type CodeActionContext struct {
	Diagnostics []Diagnostic `json:"diagnostics"`
}

type CodeActionOptions

type CodeActionOptions struct {
	CodeActionKinds []string `json:"codeActionKinds"`
}

type CodeActionParams

type CodeActionParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	Range        Range                  `json:"range"`
	Context      CodeActionContext      `json:"context"`
}

type CodeDescription

type CodeDescription struct {
	Href string `json:"href"`
}

type Command

type Command struct {
	Title     string `json:"title"`
	Tooltip   string `json:"tooltip"`
	Command   string `json:"command"`
	Arguments []any  `json:"arguments"`
}

type DefinitionParams

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

type Diagnostic

type Diagnostic struct {
	Range           Range           `json:"range"`
	Message         string          `json:"message"`
	Severity        uint            `json:"severity"`
	Source          string          `json:"source"`
	Code            string          `json:"code"`
	CodeDescription CodeDescription `json:"codeDescription"`
}

type DiagnosticClientCapabilities

type DiagnosticClientCapabilities struct {
	DynamicRegistration    bool `json:"dynamicRegistration"`
	RelatedDocumentSupport bool `json:"relatedDocumentSupport"`
}

type DiagnosticCode

type DiagnosticCode struct {
	Value  string `json:"value"`
	Target string `json:"target"`
}

type DiagnosticOptions

type DiagnosticOptions struct {
	Identifier            string `json:"identifier"`
	InterFileDependencies bool   `json:"interFileDependencies"`
	WorkspaceDiagnostics  bool   `json:"workspaceDiagnostics"`
}

type DiagnosticWorkspaceClientCapabilities

type DiagnosticWorkspaceClientCapabilities struct {
	RefreshSupport bool `json:"refreshSupport"`
}

type DocumentFormattingParams

type DocumentFormattingParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	Options      FormattingOptions      `json:"options"`
}

type DocumentSymbol

type DocumentSymbol struct {
	Name           string             `json:"name"`
	Detail         *string            `json:"detail,omitempty"`
	Kind           symbols.SymbolKind `json:"kind"`
	Range          Range              `json:"range"`
	SelectionRange Range              `json:"selectionRange"`
	Children       *[]DocumentSymbol  `json:"children,omitempty"`
}

type DocumentSymbolParams

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

type ExecuteCommandOptions

type ExecuteCommandOptions struct {
	Commands []string `json:"commands"`
}

type ExecuteCommandParams

type ExecuteCommandParams struct {
	Command   string `json:"command"`
	Arguments []any  `json:"arguments"`
}

type FileDiagnostics

type FileDiagnostics struct {
	URI   string       `json:"uri"`
	Items []Diagnostic `json:"diagnostics"`
}

type FileEvent

type FileEvent struct {
	Type uint   `json:"type"`
	URI  string `json:"uri"`
}

type FileOperationFilter

type FileOperationFilter struct {
	Scheme  string               `json:"scheme"`
	Pattern FileOperationPattern `json:"pattern"`
}

type FileOperationPattern

type FileOperationPattern struct {
	Glob string `json:"glob"`
}

type FileOperationRegistrationOptions

type FileOperationRegistrationOptions struct {
	Filters []FileOperationFilter `json:"filters"`
}

type FileOperationsServerCapabilities

type FileOperationsServerCapabilities struct {
	DidCreate FileOperationRegistrationOptions `json:"didCreate"`
	DidRename FileOperationRegistrationOptions `json:"didRename"`
	DidDelete FileOperationRegistrationOptions `json:"didDelete"`
}

type FoldingRange

type FoldingRange struct {
	StartLine      uint   `json:"startLine"`
	StartCharacter *uint  `json:"startCharacter,omitempty"`
	EndLine        uint   `json:"endLine"`
	EndCharacter   *uint  `json:"endCharacter,omitempty"`
	Kind           string `json:"kind"`
}

type FoldingRangeParams

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

type FormattingOptions

type FormattingOptions struct {
	TabSize                uint `json:"tabSize"`
	InsertSpaces           bool `json:"insertSpaces"`
	TrimTrailingWhitespace bool `json:"trimTrailingWhitespace"`
	InsertFinalNewline     bool `json:"insertFinalNewline"`
	TrimFinalNewlines      bool `json:"trimFinalNewlines"`
}

type GeneralClientCapabilities

type GeneralClientCapabilities struct {
	StaleRequestSupport StaleRequestSupportClientCapabilities `json:"staleRequestSupport"`
}

type InitializeParams

type InitializeParams struct {
	ProcessID        int                `json:"processId"`
	ClientInfo       Client             `json:"clientInfo"`
	Locale           string             `json:"locale"`
	RootPath         string             `json:"rootPath"`
	RootURI          string             `json:"rootUri"`
	Capabilities     ClientCapabilities `json:"capabilities"`
	Trace            string             `json:"trace"`
	WorkspaceFolders []WorkspaceFolder  `json:"workspaceFolders"`
}

type InitializeResult

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

type InlayHint

type InlayHint struct {
	Position     Position      `json:"position"`
	Label        string        `json:"label"`
	Kind         uint          `json:"kind"`
	PaddingLeft  bool          `json:"paddingLeft"`
	PaddingRight bool          `json:"paddingRight"`
	Tooltip      MarkupContent `json:"tooltip"`
}

type InlayHintOptions

type InlayHintOptions struct {
	ResolveProvider bool `json:"resolveProvider"`
}

type Location

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

type MarkupContent

type MarkupContent struct {
	Kind  string `json:"kind"`
	Value string `json:"value"`
}

type OptionalVersionedTextDocumentIdentifier

type OptionalVersionedTextDocumentIdentifier struct {
	URI string `json:"uri"`
	// Version is optional (i.e. it can be null), but it cannot be undefined when used in some requests
	// (see workspace/applyEdit).
	Version *uint `json:"version"`
}

type Position

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

type Range

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

type ServerCapabilities

type ServerCapabilities struct {
	TextDocumentSyncOptions    TextDocumentSyncOptions `json:"textDocumentSync"`
	DiagnosticProvider         DiagnosticOptions       `json:"diagnosticProvider"`
	Workspace                  WorkspaceOptions        `json:"workspace"`
	InlayHintProvider          InlayHintOptions        `json:"inlayHintProvider"`
	HoverProvider              bool                    `json:"hoverProvider"`
	CodeActionProvider         CodeActionOptions       `json:"codeActionProvider"`
	ExecuteCommandProvider     ExecuteCommandOptions   `json:"executeCommandProvider"`
	DocumentFormattingProvider bool                    `json:"documentFormattingProvider"`
	FoldingRangeProvider       bool                    `json:"foldingRangeProvider"`
	DocumentSymbolProvider     bool                    `json:"documentSymbolProvider"`
	WorkspaceSymbolProvider    bool                    `json:"workspaceSymbolProvider"`
	DefinitionProvider         bool                    `json:"definitionProvider"`
}

type StaleRequestSupportClientCapabilities

type StaleRequestSupportClientCapabilities struct {
	Cancel                  bool     `json:"cancel"`
	RetryOnContentModifieds []string `json:"retryOnContentModified"`
}

type TextDocumentClientCapabilities

type TextDocumentClientCapabilities struct {
	Diagnostic DiagnosticClientCapabilities `json:"diagnostic"`
}

type TextDocumentContentChangeEvent

type TextDocumentContentChangeEvent struct {
	Text string `json:"text"`
}

type TextDocumentDidChangeParams

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

type TextDocumentDidOpenParams

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

type TextDocumentEdit

type TextDocumentEdit struct {
	// TextDocument is the document to change. Not that this could be versioned,
	// (OptionalVersionedTextDocumentIdentifier) but we currently don't use that.
	TextDocument OptionalVersionedTextDocumentIdentifier `json:"textDocument"`
	Edits        []TextEdit                              `json:"edits"`
}

type TextDocumentHoverParams

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

type TextDocumentIdentifier

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

type TextDocumentInlayHintParams

type TextDocumentInlayHintParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	Range        Range                  `json:"range"`
}

type TextDocumentItem

type TextDocumentItem struct {
	LanguageID string `json:"languageId"`
	Text       string `json:"text"`
	URI        string `json:"uri"`
	Version    uint   `json:"version"`
}

type TextDocumentSyncOptions

type TextDocumentSyncOptions struct {
	OpenClose bool `json:"openClose"`
	Change    uint `json:"change"`
}

type TextEdit

type TextEdit struct {
	Range   Range  `json:"range"`
	NewText string `json:"newText"`
}

type WindowClientCapabilities

type WindowClientCapabilities struct {
	WorkDoneProgress bool `json:"workDoneProgress"`
}

type WorkspaceClientCapabilities

type WorkspaceClientCapabilities struct {
	Diagnostics DiagnosticWorkspaceClientCapabilities `json:"diagnostics"`
}

type WorkspaceDiagnosticReport

type WorkspaceDiagnosticReport struct {
	Items []WorkspaceFullDocumentDiagnosticReport `json:"items"`
}

type WorkspaceDidChangeWatchedFilesParams

type WorkspaceDidChangeWatchedFilesParams struct {
	Changes []FileEvent `json:"changes"`
}

type WorkspaceDidCreateFilesParams

type WorkspaceDidCreateFilesParams struct {
	Files []WorkspaceDidCreateFilesParamsCreatedFile `json:"files"`
}

type WorkspaceDidCreateFilesParamsCreatedFile

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

type WorkspaceDidDeleteFilesParams

type WorkspaceDidDeleteFilesParams struct {
	Files []WorkspaceDidDeleteFilesParamsDeletedFile `json:"files"`
}

type WorkspaceDidDeleteFilesParamsDeletedFile

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

type WorkspaceDidRenameFilesParams

type WorkspaceDidRenameFilesParams struct {
	Files []WorkspaceDidRenameFilesParamsFileRename `json:"files"`
}

type WorkspaceDidRenameFilesParamsFileRename

type WorkspaceDidRenameFilesParamsFileRename struct {
	NewURI string `json:"newUri"`
	OldURI string `json:"oldUri"`
}

type WorkspaceEdit

type WorkspaceEdit struct {
	DocumentChanges []TextDocumentEdit `json:"documentChanges"`
}

type WorkspaceFolder

type WorkspaceFolder struct {
	URI  string `json:"uri"`
	Name string `json:"name"`
}

type WorkspaceFullDocumentDiagnosticReport

type WorkspaceFullDocumentDiagnosticReport struct {
	URI     string       `json:"uri"`
	Version *uint        `json:"version"`
	Kind    string       `json:"kind"` // full, or incremental. We always use full
	Items   []Diagnostic `json:"items"`
}

type WorkspaceOptions

type WorkspaceOptions struct {
	FileOperations FileOperationsServerCapabilities `json:"fileOperations"`
}

type WorkspaceSymbol

type WorkspaceSymbol struct {
	Name          string             `json:"name"`
	Kind          symbols.SymbolKind `json:"kind"`
	Location      Location           `json:"location"`
	ContainerName *string            `json:"containerName,omitempty"`
}

type WorkspaceSymbolParams

type WorkspaceSymbolParams struct {
	Query string `json:"query"`
}