lsp

Documentation

Index

• type ChangeAnnotationIdentifier
• type ClientCapabilities
• type CodeActionContext
• type CodeActionKind
• type CodeActionOptions
• type CodeActionParams
• type CodeLensOptions
• type Command
• type CompletionContext
• type CompletionItem
• type CompletionItemKind
• type CompletionItemTag
• type CompletionList
• type CompletionOptions
• type CompletionParams
• type Definition
• type DefinitionParams
• type Diagnostic
• type DiagnosticRelatedInformation
• type DidChangeConfigurationParams
• type DidChangeTextDocumentParams
• type DidCloseTextDocumentParams
• type DidOpenTextDocumentParams
• type DidSaveTextDocumentParams
• type DocumentFormattingOptions
• type DocumentFormattingParams
• type DocumentLinkOptions
• type DocumentOnTypeFormattingOptions
• type DocumentRangeFormattingOptions
• type DocumentRangeFormattingParams
• type DocumentURI
• type ExecuteCommandOptions
• type ExecuteCommandParams
• type FileRename
• type FormattingOptions
• type Hover
• type HoverParams
• type InitializeOptions
• type InitializeParams
• type InitializeResult
• type InsertTextFormat
• type Location
• type LspMessenger
  • func (m *LspMessenger) ShowError(ctx context.Context, message string) error
  • func (m *LspMessenger) ShowInfo(ctx context.Context, message string) error
  • func (m *LspMessenger) ShowLog(ctx context.Context, message string) error
  • func (m *LspMessenger) ShowWarning(ctx context.Context, message string) error
• type MarkupContent
• type MarkupKind
• type MessageActionItem
• type MessageType
• type Messenger
  • func NewLspMessenger(conn *jsonrpc2.Conn) Messenger
• type OptionalVersionedTextDocumentIdentifier
• type ParameterInformation
• type PartialResultParams
• type Position
• type PrepareSupportDefaultBehavior
• type Range
• type RenameClientCapabilities
• type RenameFile
• type RenameFileOptions
• type RenameFilesParams
• type RenameOptions
• type RenameParams
• type ResourceOperation
• type ServerCapabilities
• type ShowMessageParams
• type ShowMessageRequestParams
• type SignatureHelp
• type SignatureHelpClientCapabilities
• type SignatureHelpContext
• type SignatureHelpOptions
• type SignatureHelpParams
• type SignatureHelpTriggerKind
• type SignatureInformation
• type TextDocumentContentChangeEvent
• type TextDocumentEdit
• type TextDocumentIdentifier
• type TextDocumentItem
• type TextDocumentPositionParams
• type TextDocumentSyncKind
• type TextEdit
• type TypeDefinitionParams
• type VersionedTextDocumentIdentifier
• type WorkDoneProgressOptions
• type WorkDoneProgressParams
• type WorkspaceEdit

Types

type ChangeAnnotationIdentifier

type ChangeAnnotationIdentifier = string

type ClientCapabilities

type ClientCapabilities struct {
}

type CodeActionContext

type CodeActionContext struct {
	Diagnostics []Diagnostic     `json:"diagnostics"`
	Only        []CodeActionKind `json:"only,omitempty"`
}

type CodeActionKind

type CodeActionKind string

type CodeActionOptions

type CodeActionOptions struct {
	CodeActionKinds []CodeActionKind
}

type CodeActionParams

type CodeActionParams struct {
	WorkDoneProgressParams
	PartialResultParams

	TextDocument TextDocumentIdentifier `json:"textDocument"`
	Range        Range                  `json:"range"`
	Context      CodeActionContext      `json:"context"`
}

type CodeLensOptions

type CodeLensOptions struct{}

type Command

type Command struct {
	Title     string        `json:"title"`
	Command   string        `json:"command"`
	Arguments []interface{} `json:"arguments,omitempty"`
}

type CompletionContext

type CompletionContext struct {
	TriggerKind      int     `json:"triggerKind"`
	TriggerCharacter *string `json:"triggerCharacter"`
}

type CompletionItem

type CompletionItem struct {
	Label               string              `json:"label"`
	Kind                CompletionItemKind  `json:"kind,omitempty"`
	Tags                []CompletionItemTag `json:"tags,omitempty"`
	Detail              string              `json:"detail,omitempty"`
	Documentation       MarkupContent       `json:"documentation,omitempty"` // string | MarkupContent
	Deprecated          bool                `json:"deprecated,omitempty"`
	Preselect           bool                `json:"preselect,omitempty"`
	SortText            string              `json:"sortText,omitempty"`
	FilterText          string              `json:"filterText,omitempty"`
	InsertText          string              `json:"insertText,omitempty"`
	InsertTextFormat    InsertTextFormat    `json:"insertTextFormat,omitempty"`
	TextEdit            *TextEdit           `json:"textEdit,omitempty"`
	AdditionalTextEdits []TextEdit          `json:"additionalTextEdits,omitempty"`
	CommitCharacters    []string            `json:"commitCharacters,omitempty"`
	Command             *Command            `json:"command,omitempty"`
	Data                interface{}         `json:"data,omitempty"`
}

type CompletionItemKind

type CompletionItemKind int

const (
	TextCompletion          CompletionItemKind = 1
	MethodCompletion        CompletionItemKind = 2
	FunctionCompletion      CompletionItemKind = 3
	ConstructorCompletion   CompletionItemKind = 4
	FieldCompletion         CompletionItemKind = 5
	VariableCompletion      CompletionItemKind = 6
	ClassCompletion         CompletionItemKind = 7
	InterfaceCompletion     CompletionItemKind = 8
	ModuleCompletion        CompletionItemKind = 9
	PropertyCompletion      CompletionItemKind = 10
	UnitCompletion          CompletionItemKind = 11
	ValueCompletion         CompletionItemKind = 12
	EnumCompletion          CompletionItemKind = 13
	KeywordCompletion       CompletionItemKind = 14
	SnippetCompletion       CompletionItemKind = 15
	ColorCompletion         CompletionItemKind = 16
	FileCompletion          CompletionItemKind = 17
	ReferenceCompletion     CompletionItemKind = 18
	FolderCompletion        CompletionItemKind = 19
	EnumMemberCompletion    CompletionItemKind = 20
	ConstantCompletion      CompletionItemKind = 21
	StructCompletion        CompletionItemKind = 22
	EventCompletion         CompletionItemKind = 23
	OperatorCompletion      CompletionItemKind = 24
	TypeParameterCompletion CompletionItemKind = 25
)

type CompletionItemTag

type CompletionItemTag int

type CompletionList

type CompletionList struct {
	IsIncomplete bool             `json:"isIncomplete"`
	Items        []CompletionItem `json:"items"`
}

type CompletionOptions

type CompletionOptions struct {
	ResolveProvider   bool     `json:"resolveProvider,omitempty"`
	TriggerCharacters []string `json:"triggerCharacters"`
}

type CompletionParams

type CompletionParams struct {
	TextDocumentPositionParams
	CompletionContext CompletionContext `json:"contentChanges"`
}

type Definition

type Definition = []Location

type DefinitionParams

type DefinitionParams struct {
	TextDocumentPositionParams
	WorkDoneProgressParams
	PartialResultParams
}

type Diagnostic

type Diagnostic struct {
	Range              Range                          `json:"range"`
	Severity           int                            `json:"severity,omitempty"`
	Code               *string                        `json:"code,omitempty"`
	Source             *string                        `json:"source,omitempty"`
	Message            string                         `json:"message"`
	RelatedInformation []DiagnosticRelatedInformation `json:"relatedInformation,omitempty"`
}

type DiagnosticRelatedInformation

type DiagnosticRelatedInformation struct {
	Location Location `json:"location"`
	Message  string   `json:"message"`
}

type DidChangeConfigurationParams

type DidChangeConfigurationParams struct {
	Settings struct {
		SQLS *config.Config `json:"sqls"`
	} `json:"settings"`
}

type DidChangeTextDocumentParams

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

type DidCloseTextDocumentParams

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

type DidOpenTextDocumentParams

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

type DidSaveTextDocumentParams

type DidSaveTextDocumentParams struct {
	Text         string                 `json:"text"`
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

type DocumentFormattingOptions

type DocumentFormattingOptions struct {
	WorkDoneProgressOptions
}

type DocumentFormattingParams

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

type DocumentLinkOptions

type DocumentLinkOptions struct{}

type DocumentOnTypeFormattingOptions

type DocumentOnTypeFormattingOptions struct{}

type DocumentRangeFormattingOptions

type DocumentRangeFormattingOptions struct {
	WorkDoneProgressOptions
}

type DocumentRangeFormattingParams

type DocumentRangeFormattingParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	Range        Range                  `json:"range"`
	Options      FormattingOptions      `json:"options"`
	WorkDoneProgressParams
}

type DocumentURI

type DocumentURI string

type ExecuteCommandOptions

type ExecuteCommandOptions struct{}

type ExecuteCommandParams

type ExecuteCommandParams struct {
	WorkDoneProgressParams

	Command   string        `json:"command"`
	Arguments []interface{} `json:"arguments,omitempty"`
	// sqls specific option for query execute range
	Range *Range `json:"range,omitempty"`
}

type FileRename

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

type FormattingOptions

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

type Hover

type Hover struct {
	Contents MarkupContent `json:"contents"`
	Range    Range         `json:"range,omitempty"`
}

type HoverParams

type HoverParams struct {
	TextDocumentPositionParams
	WorkDoneProgressParams
}

type InitializeOptions

type InitializeOptions struct {
	// Allow the LSP client to choose a database configuration.
	// If set, the LSP server will ignore all other configuration
	// sources, including the workspace and user configuration files.
	ConnectionConfig *database.DBConfig `json:"connectionConfig,omitempty"`
}

type InitializeParams

type InitializeParams struct {
	ProcessID             int                `json:"processId,omitempty"`
	RootPath              string             `json:"rootPath,omitempty"`
	RootURI               string             `json:"rootUri,omitempty"`
	InitializationOptions InitializeOptions  `json:"initializationOptions,omitempty"`
	Capabilities          ClientCapabilities `json:"capabilities,omitempty"`
	Trace                 string             `json:"trace,omitempty"`
}

type InitializeResult

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

type InsertTextFormat

type InsertTextFormat int

const (
	PlainTextTextFormat InsertTextFormat = 1
	SnippetTextFormat   InsertTextFormat = 2
)

type Location

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

type LspMessenger

type LspMessenger struct {
	// contains filtered or unexported fields
}

func (*LspMessenger) ShowError

func (m *LspMessenger) ShowError(ctx context.Context, message string) error

func (*LspMessenger) ShowInfo

func (m *LspMessenger) ShowInfo(ctx context.Context, message string) error

func (*LspMessenger) ShowLog

func (m *LspMessenger) ShowLog(ctx context.Context, message string) error

func (*LspMessenger) ShowWarning

func (m *LspMessenger) ShowWarning(ctx context.Context, message string) error

type MarkupContent

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

type MarkupKind

type MarkupKind string

const (
	PlainText MarkupKind = "plaintext"
	Markdown  MarkupKind = "markdown"
)

type MessageActionItem

type MessageActionItem struct {
	Title string `json:"title"`
}

type MessageType

type MessageType float64

var (
	Error   MessageType = 1
	Warning MessageType = 2
	Info    MessageType = 3
	Log     MessageType = 4
)

type Messenger

type Messenger interface {
	ShowLog(context.Context, string) error
	ShowInfo(context.Context, string) error
	ShowWarning(context.Context, string) error
	ShowError(context.Context, string) error
}

func NewLspMessenger

func NewLspMessenger(conn *jsonrpc2.Conn) Messenger

type OptionalVersionedTextDocumentIdentifier

type OptionalVersionedTextDocumentIdentifier struct {
	Version int32 `json:"version"`
	TextDocumentIdentifier
}

type ParameterInformation

type ParameterInformation struct {
	Label         string `json:"label"`
	Documentation string `json:"documentation,omitempty"`
}

type PartialResultParams

type PartialResultParams struct {
	PartialResultToken interface{} `json:"partialResultToken"`
}

type Position

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

type PrepareSupportDefaultBehavior

type PrepareSupportDefaultBehavior = interface{}

type Range

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

type RenameClientCapabilities

type RenameClientCapabilities struct {
	DynamicRegistration           bool                          `json:"dynamicRegistration,omitempty"`
	PrepareSupport                bool                          `json:"prepareSupport,omitempty"`
	PrepareSupportDefaultBehavior PrepareSupportDefaultBehavior `json:"prepareSupportDefaultBehavior,omitempty"`
	HonorsChangeAnnotations       bool                          `json:"honorsChangeAnnotations,omitempty"`
}

type RenameFile

type RenameFile struct {
	Kind    string            `json:"kind"`
	OldURI  DocumentURI       `json:"oldUri"`
	NewURI  DocumentURI       `json:"newUri"`
	Options RenameFileOptions `json:"options,omitempty"`
	ResourceOperation
}

type RenameFileOptions

type RenameFileOptions struct {
	Overwrite      bool `json:"overwrite,omitempty"`
	IgnoreIfExists bool `json:"ignoreIfExists,omitempty"`
}

type RenameFilesParams

type RenameFilesParams struct {
	Files []FileRename `json:"files"`
}

type RenameOptions

type RenameOptions struct {
	PrepareProvider bool `json:"prepareProvider,omitempty"`
	WorkDoneProgressOptions
}

type RenameParams

type RenameParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	Position     Position               `json:"position"`
	NewName      string                 `json:"newName"`
	WorkDoneProgressParams
}

type ResourceOperation

type ResourceOperation struct {
	Kind         string                     `json:"kind"`
	AnnotationID ChangeAnnotationIdentifier `json:"annotationId,omitempty"`
}

type ServerCapabilities

type ServerCapabilities struct {
	TextDocumentSync                 TextDocumentSyncKind             `json:"textDocumentSync,omitempty"`
	HoverProvider                    bool                             `json:"hoverProvider,omitempty"`
	CompletionProvider               *CompletionOptions               `json:"completionProvider,omitempty"`
	SignatureHelpProvider            *SignatureHelpOptions            `json:"signatureHelpProvider,omitempty"`
	DefinitionProvider               bool                             `json:"definitionProvider,omitempty"`
	TypeDefinitionProvider           bool                             `json:"typeDefinitionProvider,omitempty"`
	ImplementationProvider           bool                             `json:"implementationProvider,omitempty"`
	ReferencesProvider               bool                             `json:"referencesProvider,omitempty"`
	DocumentHighlightProvider        bool                             `json:"documentHighlightProvider,omitempty"`
	DocumentSymbolProvider           bool                             `json:"documentSymbolProvider,omitempty"`
	WorkspaceSymbolProvider          bool                             `json:"workspaceSymbolProvider,omitempty"`
	CodeActionProvider               interface{}                      `json:"codeActionProvider,omitempty"`
	CodeLensProvider                 *CodeLensOptions                 `json:"codeLensProvider,omitempty"`
	DocumentFormattingProvider       bool                             `json:"documentFormattingProvider,omitempty"`
	DocumentRangeFormattingProvider  bool                             `json:"documentRangeFormattingProvider,omitempty"`
	DocumentOnTypeFormattingProvider *DocumentOnTypeFormattingOptions `json:"documentOnTypeFormattingProvider,omitempty"`
	RenameProvider                   bool                             `json:"renameProvider,omitempty"`
	DocumentLinkProvider             *DocumentLinkOptions             `json:"documentLinkProvider,omitempty"`
	ColorProvider                    bool                             `json:"colorProvider,omitempty"`
	FoldingRangeProvider             bool                             `json:"foldingRangeProvider,omitempty"`
	DeclarationProvider              bool                             `json:"declarationProvider,omitempty"`
	ExecuteCommandProvider           *ExecuteCommandOptions           `json:"executeCommandProvider,omitempty"`
}

type ShowMessageParams

type ShowMessageParams struct {
	Type    MessageType `json:"type"`
	Message string      `json:"message"`
}

type ShowMessageRequestParams

type ShowMessageRequestParams struct {
	Type    MessageType         `json:"type"`
	Message string              `json:"message"`
	Actions []MessageActionItem `json:"actions,omitempty"`
}

type SignatureHelp

type SignatureHelp struct {
	Signatures      []SignatureInformation `json:"signatures"`
	ActiveSignature float64                `json:"activeSignature"`
	ActiveParameter float64                `json:"activeParameter"`
}

type SignatureHelpClientCapabilities

type SignatureHelpClientCapabilities struct {
	DynamicRegistration  bool `json:"dynamicRegistration,omitempty"`
	SignatureInformation struct {
		DocumentationFormat  []MarkupKind `json:"documentationFormat,omitempty"`
		ParameterInformation struct {
			LabelOffsetSupport bool `json:"labelOffsetSupport,omitempty"`
		} `json:"parameterInformation,omitempty"`
		ActiveParameterSupport bool `json:"activeParameterSupport,omitempty"`
	} `json:"signatureInformation,omitempty"`
	ContextSupport bool `json:"contextSupport,omitempty"`
}

type SignatureHelpContext

type SignatureHelpContext struct {
	TriggerKind         SignatureHelpTriggerKind `json:"triggerKind"`
	TriggerCharacter    string                   `json:"triggerCharacter,omitempty"`
	IsRetrigger         bool                     `json:"isRetrigger"`
	ActiveSignatureHelp SignatureHelp            `json:"activeSignatureHelp,omitempty"`
}

type SignatureHelpOptions

type SignatureHelpOptions struct {
	TriggerCharacters   []string `json:"triggerCharacters,omitempty"`
	RetriggerCharacters []string `json:"retriggerCharacters,omitempty"`
	WorkDoneProgressOptions
}

type SignatureHelpParams

type SignatureHelpParams struct {
	Context SignatureHelpContext `json:"context,omitempty"`
	TextDocumentPositionParams
	WorkDoneProgressParams
}

type SignatureHelpTriggerKind

type SignatureHelpTriggerKind float64

type SignatureInformation

type SignatureInformation struct {
	Label           string                 `json:"label"`
	Documentation   string                 `json:"documentation,omitempty"`
	Parameters      []ParameterInformation `json:"parameters,omitempty"`
	ActiveParameter float64                `json:"activeParameter,omitempty"`
}

type TextDocumentContentChangeEvent

type TextDocumentContentChangeEvent struct {
	Range       Range  `json:"range"`
	RangeLength int    `json:"rangeLength"`
	Text        string `json:"text"`
}

type TextDocumentEdit

type TextDocumentEdit struct {
	TextDocument OptionalVersionedTextDocumentIdentifier `json:"textDocument"`
	Edits        []TextEdit                              `json:"edits"`
}

type TextDocumentIdentifier

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

type TextDocumentItem

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

type TextDocumentPositionParams

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

type TextDocumentSyncKind

type TextDocumentSyncKind int

const (
	TDSKNone        TextDocumentSyncKind = 0
	TDSKFull        TextDocumentSyncKind = 1
	TDSKIncremental TextDocumentSyncKind = 2
)

type TextEdit

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

type TypeDefinitionParams

type TypeDefinitionParams struct {
	TextDocumentPositionParams
	WorkDoneProgressParams
	PartialResultParams
}

type VersionedTextDocumentIdentifier

type VersionedTextDocumentIdentifier struct {
	URI     string `json:"uri"`
	Version int    `json:"version"`
}

type WorkDoneProgressOptions

type WorkDoneProgressOptions struct {
	WorkDoneProgress bool `json:"workDoneProgress,omitempty"`
}

type WorkDoneProgressParams

type WorkDoneProgressParams struct {
	WorkDoneToken interface{} `json:"workDoneToken"`
}

type WorkspaceEdit

type WorkspaceEdit struct {
	Changes           map[string][]TextEdit                 `json:"changes,omitempty"`
	DocumentChanges   []TextDocumentEdit                    `json:"documentChanges,omitempty"`
	ChangeAnnotations map[string]ChangeAnnotationIdentifier `json:"changeAnnotations,omitempty"`
}