Documentation ¶
Overview ¶
Package protocol contains the structs that map directly to the request and response messages of the Language Server Protocol.
It is a literal transcription, with unmodified comments, and only the changes required to make it go code. Names are uppercased to export them. All fields have JSON tags added to correct the names. Fields marked with a ? are also marked as "omitempty" Fields that are "|| null" are made pointers Fields that are string or number are left as string Fields that are type "number" are made float64
Index ¶
- Constants
- Variables
- func ApplyEdits(m *Mapper, edits []TextEdit) ([]byte, []diff.Edit, error)
- func Call(ctx context.Context, conn jsonrpc2.Conn, method string, params interface{}, ...) error
- func CancelHandler(handler jsonrpc2.Handler) jsonrpc2.Handler
- func ClientHandler(client Client, handler jsonrpc2.Handler) jsonrpc2.Handler
- func ClientHandlerV2(client Client) jsonrpc2_v2.Handler
- func CompareLocation(x, y Location) int
- func ComparePosition(a, b Position) int
- func CompareRange(a, b Range) int
- func EditsToDiffEdits(m *Mapper, edits []TextEdit) ([]diff.Edit, error)
- func Handlers(handler jsonrpc2.Handler) jsonrpc2.Handler
- func Intersect(x, y Range) bool
- func LogEvent(ctx context.Context, ev core.Event, lm label.Map, mt MessageType) context.Context
- func LoggingStream(str jsonrpc2.Stream, w io.Writer) jsonrpc2.Stream
- func NonNilSlice[T comparable](x []T) []T
- func SemMods(n int) []string
- func SemType(n int) string
- func SemanticModifiers() []string
- func SemanticTypes() []string
- func ServerHandler(server Server, handler jsonrpc2.Handler) jsonrpc2.Handler
- func ServerHandlerV2(server Server) jsonrpc2_v2.Handler
- func UTF16Len(s []byte) int
- func UnmarshalJSON(msg json.RawMessage, v any) error
- func WithClient(ctx context.Context, client Client) context.Context
- type AnnotatedTextEdit
- type ApplyWorkspaceEditParams
- type ApplyWorkspaceEditResult
- type BaseSymbolInformation
- type CallHierarchyClientCapabilities
- type CallHierarchyIncomingCall
- type CallHierarchyIncomingCallsParams
- type CallHierarchyItem
- type CallHierarchyOptions
- type CallHierarchyOutgoingCall
- type CallHierarchyOutgoingCallsParams
- type CallHierarchyPrepareParams
- type CallHierarchyRegistrationOptions
- type CancelParams
- type ChangeAnnotation
- type ChangeAnnotationIdentifier
- type ChangeAnnotationsSupportOptions
- type Client
- type ClientCapabilities
- type ClientCloser
- type ClientCodeActionKindOptions
- type ClientCodeActionLiteralOptions
- type ClientCodeActionResolveOptions
- type ClientCodeLensResolveOptions
- type ClientCompletionItemInsertTextModeOptions
- type ClientCompletionItemOptions
- type ClientCompletionItemOptionsKind
- type ClientCompletionItemResolveOptions
- type ClientDiagnosticsTagOptions
- type ClientFoldingRangeKindOptions
- type ClientFoldingRangeOptions
- type ClientInfo
- type ClientInlayHintResolveOptions
- type ClientSemanticTokensRequestFullDelta
- type ClientSemanticTokensRequestOptions
- type ClientShowMessageActionItemOptions
- type ClientSignatureInformationOptions
- type ClientSignatureParameterInformationOptions
- type ClientSymbolKindOptions
- type ClientSymbolResolveOptions
- type ClientSymbolTagOptions
- type CodeAction
- type CodeActionClientCapabilities
- type CodeActionContext
- type CodeActionDisabled
- type CodeActionKind
- type CodeActionKindDocumentation
- type CodeActionOptions
- type CodeActionParams
- type CodeActionRegistrationOptions
- type CodeActionTriggerKind
- type CodeDescription
- type CodeLens
- type CodeLensClientCapabilities
- type CodeLensOptions
- type CodeLensParams
- type CodeLensRegistrationOptions
- type CodeLensWorkspaceClientCapabilities
- type Color
- type ColorInformation
- type ColorPresentation
- type ColorPresentationParams
- type Command
- type CompletionClientCapabilities
- type CompletionContext
- type CompletionItem
- type CompletionItemDefaults
- type CompletionItemKind
- type CompletionItemLabelDetails
- type CompletionItemTag
- type CompletionItemTagOptions
- type CompletionList
- type CompletionListCapabilities
- type CompletionOptions
- type CompletionParams
- type CompletionRegistrationOptions
- type CompletionTriggerKind
- type ConfigurationItem
- type ConfigurationParams
- type CreateFile
- type CreateFileOptions
- type CreateFilesParams
- type Declaration
- type DeclarationClientCapabilities
- type DeclarationLink
- type DeclarationOptions
- type DeclarationParams
- type DeclarationRegistrationOptions
- type Definition
- type DefinitionClientCapabilities
- type DefinitionLink
- type DefinitionOptions
- type DefinitionParams
- type DefinitionRegistrationOptions
- type DeleteFile
- type DeleteFileOptions
- type DeleteFilesParams
- type Diagnostic
- type DiagnosticClientCapabilities
- type DiagnosticOptions
- type DiagnosticRegistrationOptions
- type DiagnosticRelatedInformation
- type DiagnosticServerCancellationData
- type DiagnosticSeverity
- type DiagnosticTag
- type DiagnosticWorkspaceClientCapabilities
- type DiagnosticsCapabilities
- type DidChangeConfigurationClientCapabilities
- type DidChangeConfigurationParams
- type DidChangeConfigurationRegistrationOptions
- type DidChangeNotebookDocumentParams
- type DidChangeTextDocumentParams
- type DidChangeWatchedFilesClientCapabilities
- type DidChangeWatchedFilesParams
- type DidChangeWatchedFilesRegistrationOptions
- type DidChangeWorkspaceFoldersParams
- type DidCloseNotebookDocumentParams
- type DidCloseTextDocumentParams
- type DidOpenNotebookDocumentParams
- type DidOpenTextDocumentParams
- type DidSaveNotebookDocumentParams
- type DidSaveTextDocumentParams
- type DocumentChange
- type DocumentColorClientCapabilities
- type DocumentColorOptions
- type DocumentColorParams
- type DocumentColorRegistrationOptions
- type DocumentDiagnosticParams
- type DocumentDiagnosticReport
- type DocumentDiagnosticReportKind
- type DocumentDiagnosticReportPartialResult
- type DocumentFilter
- type DocumentFormattingClientCapabilities
- type DocumentFormattingOptions
- type DocumentFormattingParams
- type DocumentFormattingRegistrationOptions
- type DocumentHighlight
- type DocumentHighlightClientCapabilities
- type DocumentHighlightKind
- type DocumentHighlightOptions
- type DocumentHighlightParams
- type DocumentHighlightRegistrationOptions
- type DocumentLink
- type DocumentLinkClientCapabilities
- type DocumentLinkOptions
- type DocumentLinkParams
- type DocumentLinkRegistrationOptions
- type DocumentOnTypeFormattingClientCapabilities
- type DocumentOnTypeFormattingOptions
- type DocumentOnTypeFormattingParams
- type DocumentOnTypeFormattingRegistrationOptions
- type DocumentRangeFormattingClientCapabilities
- type DocumentRangeFormattingOptions
- type DocumentRangeFormattingParams
- type DocumentRangeFormattingRegistrationOptions
- type DocumentRangesFormattingParams
- type DocumentSelector
- type DocumentSymbol
- type DocumentSymbolClientCapabilities
- type DocumentSymbolOptions
- type DocumentSymbolParams
- type DocumentSymbolRegistrationOptions
- type DocumentURI
- type EditRangeWithInsertReplace
- type ErrorCodes
- type ExecuteCommandClientCapabilities
- type ExecuteCommandOptions
- type ExecuteCommandParams
- type ExecuteCommandRegistrationOptions
- type ExecutionSummary
- type FailureHandlingKind
- type FileChangeType
- type FileCreate
- type FileDelete
- type FileEvent
- type FileOperationClientCapabilities
- type FileOperationFilter
- type FileOperationOptions
- type FileOperationPattern
- type FileOperationPatternKind
- type FileOperationPatternOptions
- type FileOperationRegistrationOptions
- type FileRename
- type FileSystemWatcher
- type FoldingRange
- type FoldingRangeClientCapabilities
- type FoldingRangeKind
- type FoldingRangeOptions
- type FoldingRangeParams
- type FoldingRangeRegistrationOptions
- type FoldingRangeWorkspaceClientCapabilities
- type FormattingOptions
- type FullDocumentDiagnosticReport
- type GeneralClientCapabilities
- type GlobPattern
- type Hover
- type HoverClientCapabilities
- type HoverOptions
- type HoverParams
- type HoverRegistrationOptions
- type ImplementationClientCapabilities
- type ImplementationOptions
- type ImplementationParams
- type ImplementationRegistrationOptions
- type InitializeError
- type InitializeParams
- type InitializeResult
- type InitializedParams
- type InlayHint
- type InlayHintClientCapabilities
- type InlayHintKind
- type InlayHintLabelPart
- type InlayHintOptions
- type InlayHintParams
- type InlayHintRegistrationOptions
- type InlayHintWorkspaceClientCapabilities
- type InlineCompletionClientCapabilities
- type InlineCompletionContext
- type InlineCompletionItem
- type InlineCompletionList
- type InlineCompletionOptions
- type InlineCompletionParams
- type InlineCompletionRegistrationOptions
- type InlineCompletionTriggerKind
- type InlineValue
- type InlineValueClientCapabilities
- type InlineValueContext
- type InlineValueEvaluatableExpression
- type InlineValueOptions
- type InlineValueParams
- type InlineValueRegistrationOptions
- type InlineValueText
- type InlineValueVariableLookup
- type InlineValueWorkspaceClientCapabilities
- type InsertReplaceEdit
- type InsertTextFormat
- type InsertTextMode
- type LSPAny
- type LSPArray
- type LSPErrorCodes
- type LSPObject
- type LanguageKind
- type LinkedEditingRangeClientCapabilities
- type LinkedEditingRangeOptions
- type LinkedEditingRangeParams
- type LinkedEditingRangeRegistrationOptions
- type LinkedEditingRanges
- type Lit_ClientSemanticTokensRequestOptions_range_Item1
- type Location
- type LocationLink
- type LocationUriOnly
- type LogMessageParams
- type LogTraceParams
- type MappedRange
- type Mapper
- func (m *Mapper) LineCol8Position(line, col8 int) (Position, error)
- func (m *Mapper) NodeMappedRange(tf *token.File, node ast.Node) (MappedRange, error)
- func (m *Mapper) NodeRange(tf *token.File, node ast.Node) (Range, error)
- func (m *Mapper) OffsetLineCol8(offset int) (int, int)
- func (m *Mapper) OffsetLocation(start, end int) (Location, error)
- func (m *Mapper) OffsetMappedRange(start, end int) (MappedRange, error)
- func (m *Mapper) OffsetPosition(offset int) (Position, error)
- func (m *Mapper) OffsetRange(start, end int) (Range, error)
- func (m *Mapper) PosLocation(tf *token.File, start, end token.Pos) (Location, error)
- func (m *Mapper) PosMappedRange(tf *token.File, start, end token.Pos) (MappedRange, error)
- func (m *Mapper) PosPosition(tf *token.File, pos token.Pos) (Position, error)
- func (m *Mapper) PosRange(tf *token.File, start, end token.Pos) (Range, error)
- func (m *Mapper) PositionOffset(p Position) (int, error)
- func (m *Mapper) RangeLocation(rng Range) Location
- func (m *Mapper) RangeOffsets(r Range) (int, int, error)
- type MarkdownClientCapabilities
- type MarkedString
- type MarkedStringWithLanguage
- type MarkupContent
- type MarkupKind
- type MessageActionItem
- type MessageType
- type Moniker
- type MonikerClientCapabilities
- type MonikerKind
- type MonikerOptions
- type MonikerParams
- type MonikerRegistrationOptions
- type NotebookCell
- type NotebookCellArrayChange
- type NotebookCellKind
- type NotebookCellLanguage
- type NotebookCellTextDocumentFilter
- type NotebookDocument
- type NotebookDocumentCellChangeStructure
- type NotebookDocumentCellChanges
- type NotebookDocumentCellContentChanges
- type NotebookDocumentChangeEvent
- type NotebookDocumentClientCapabilities
- type NotebookDocumentFilter
- type NotebookDocumentFilterNotebookType
- type NotebookDocumentFilterPattern
- type NotebookDocumentFilterScheme
- type NotebookDocumentFilterWithCells
- type NotebookDocumentFilterWithNotebook
- type NotebookDocumentIdentifier
- type NotebookDocumentSyncClientCapabilities
- type NotebookDocumentSyncOptions
- type NotebookDocumentSyncRegistrationOptions
- type OptionalVersionedTextDocumentIdentifier
- type OrPLocation_workspace_symbol
- type OrPSection_workspace_didChangeConfiguration
- type OrPTooltipPLabel
- type OrPTooltip_textDocument_inlayHint
- type Or_CancelParams_id
- type Or_ClientSemanticTokensRequestOptions_full
- type Or_ClientSemanticTokensRequestOptions_range
- type Or_CompletionItemDefaults_editRange
- type Or_CompletionItem_documentation
- type Or_CompletionItem_textEdit
- type Or_Definition
- type Or_Diagnostic_code
- type Or_DocumentDiagnosticReport
- type Or_DocumentDiagnosticReportPartialResult_relatedDocuments_Value
- type Or_DocumentFilter
- type Or_GlobPattern
- type Or_Hover_contents
- type Or_InlayHint_label
- type Or_InlineCompletionItem_insertText
- type Or_InlineValue
- type Or_MarkedString
- type Or_NotebookCellTextDocumentFilter_notebook
- type Or_NotebookDocumentFilter
- type Or_NotebookDocumentFilterWithCells_notebook
- type Or_NotebookDocumentFilterWithNotebook_notebook
- type Or_NotebookDocumentSyncOptions_notebookSelector_Elem
- type Or_RelatedFullDocumentDiagnosticReport_relatedDocuments_Value
- type Or_RelatedUnchangedDocumentDiagnosticReport_relatedDocuments_Value
- type Or_Result_textDocument_codeAction_Item0_Elem
- type Or_Result_textDocument_inlineCompletion
- type Or_SemanticTokensOptions_full
- type Or_SemanticTokensOptions_range
- type Or_ServerCapabilities_callHierarchyProvider
- type Or_ServerCapabilities_codeActionProvider
- type Or_ServerCapabilities_colorProvider
- type Or_ServerCapabilities_declarationProvider
- type Or_ServerCapabilities_definitionProvider
- type Or_ServerCapabilities_diagnosticProvider
- type Or_ServerCapabilities_documentFormattingProvider
- type Or_ServerCapabilities_documentHighlightProvider
- type Or_ServerCapabilities_documentRangeFormattingProvider
- type Or_ServerCapabilities_documentSymbolProvider
- type Or_ServerCapabilities_foldingRangeProvider
- type Or_ServerCapabilities_hoverProvider
- type Or_ServerCapabilities_implementationProvider
- type Or_ServerCapabilities_inlayHintProvider
- type Or_ServerCapabilities_inlineCompletionProvider
- type Or_ServerCapabilities_inlineValueProvider
- type Or_ServerCapabilities_linkedEditingRangeProvider
- type Or_ServerCapabilities_monikerProvider
- type Or_ServerCapabilities_notebookDocumentSync
- type Or_ServerCapabilities_referencesProvider
- type Or_ServerCapabilities_renameProvider
- type Or_ServerCapabilities_selectionRangeProvider
- type Or_ServerCapabilities_semanticTokensProvider
- type Or_ServerCapabilities_textDocumentSync
- type Or_ServerCapabilities_typeDefinitionProvider
- type Or_ServerCapabilities_typeHierarchyProvider
- type Or_ServerCapabilities_workspaceSymbolProvider
- type Or_SignatureInformation_documentation
- type Or_TextDocumentEdit_edits_Elem
- type Or_TextDocumentFilter
- type Or_TextDocumentSyncOptions_save
- type Or_WorkspaceDocumentDiagnosticReport
- type Or_WorkspaceEdit_documentChanges_Elem
- type Or_WorkspaceOptions_textDocumentContent
- type Or_textDocument_declaration
- type PRangeESemanticTokensOptions
- type ParamConfiguration
- type ParamInitialize
- type ParameterInformation
- type PartialResultParams
- type Pattern
- type Position
- type PositionEncodingKind
- type PrepareRenameDefaultBehavior
- type PrepareRenameParams
- type PrepareRenamePlaceholder
- type PrepareRenameResult
- type PrepareSupportDefaultBehavior
- type PreviousResultID
- type PreviousResultId
- type ProgressParams
- type ProgressToken
- type PublishDiagnosticsClientCapabilities
- type PublishDiagnosticsParams
- type Range
- type ReferenceClientCapabilities
- type ReferenceContext
- type ReferenceOptions
- type ReferenceParams
- type ReferenceRegistrationOptions
- type Registration
- type RegistrationParams
- type RegularExpressionEngineKind
- type RegularExpressionsClientCapabilities
- type RelatedFullDocumentDiagnosticReport
- type RelatedUnchangedDocumentDiagnosticReport
- type RelativePattern
- type RenameClientCapabilities
- type RenameFile
- type RenameFileOptions
- type RenameFilesParams
- type RenameOptions
- type RenameParams
- type RenameRegistrationOptions
- type ResourceOperation
- type ResourceOperationKind
- type SaveOptions
- type SelectedCompletionInfo
- type SelectionRange
- type SelectionRangeClientCapabilities
- type SelectionRangeOptions
- type SelectionRangeParams
- type SelectionRangeRegistrationOptions
- type SemanticTokenModifiers
- type SemanticTokenTypes
- type SemanticTokens
- type SemanticTokensClientCapabilities
- type SemanticTokensDelta
- type SemanticTokensDeltaParams
- type SemanticTokensDeltaPartialResult
- type SemanticTokensEdit
- type SemanticTokensFullDelta
- type SemanticTokensLegend
- type SemanticTokensOptions
- type SemanticTokensParams
- type SemanticTokensPartialResult
- type SemanticTokensRangeParams
- type SemanticTokensRegistrationOptions
- type SemanticTokensWorkspaceClientCapabilities
- type Server
- type ServerCapabilities
- type ServerCompletionItemOptions
- type ServerInfo
- type SetTraceParams
- type ShowDocumentClientCapabilities
- type ShowDocumentParams
- type ShowDocumentResult
- type ShowMessageParams
- type ShowMessageRequestClientCapabilities
- type ShowMessageRequestParams
- type SignatureHelp
- type SignatureHelpClientCapabilities
- type SignatureHelpContext
- type SignatureHelpOptions
- type SignatureHelpParams
- type SignatureHelpRegistrationOptions
- type SignatureHelpTriggerKind
- type SignatureInformation
- type SnippetTextEdit
- type StaleRequestSupportOptions
- type StaticRegistrationOptions
- type StringValue
- type SymbolInformation
- type SymbolKind
- type SymbolTag
- type TextDocumentChangeRegistrationOptions
- type TextDocumentClientCapabilities
- type TextDocumentContentChangeEvent
- type TextDocumentContentChangePartial
- type TextDocumentContentChangeWholeDocument
- type TextDocumentContentClientCapabilities
- type TextDocumentContentOptions
- type TextDocumentContentParams
- type TextDocumentContentRefreshParams
- type TextDocumentContentRegistrationOptions
- type TextDocumentEdit
- type TextDocumentFilter
- type TextDocumentFilterLanguage
- type TextDocumentFilterPattern
- type TextDocumentFilterScheme
- type TextDocumentIdentifier
- type TextDocumentItem
- type TextDocumentPositionParams
- type TextDocumentRegistrationOptions
- type TextDocumentSaveReason
- type TextDocumentSaveRegistrationOptions
- type TextDocumentSyncClientCapabilities
- type TextDocumentSyncKind
- type TextDocumentSyncOptions
- type TextEdit
- type TokenFormat
- type TraceValue
- type TypeDefinitionClientCapabilities
- type TypeDefinitionOptions
- type TypeDefinitionParams
- type TypeDefinitionRegistrationOptions
- type TypeHierarchyClientCapabilities
- type TypeHierarchyItem
- type TypeHierarchyOptions
- type TypeHierarchyPrepareParams
- type TypeHierarchyRegistrationOptions
- type TypeHierarchySubtypesParams
- type TypeHierarchySupertypesParams
- type UIntCommaUInt
- type URI
- type UnchangedDocumentDiagnosticReport
- type UniquenessLevel
- type UnmarshalError
- type Unregistration
- type UnregistrationParams
- type VersionedNotebookDocumentIdentifier
- type VersionedTextDocumentIdentifier
- type WatchKind
- type WillSaveTextDocumentParams
- type WindowClientCapabilities
- type WorkDoneProgressBegin
- type WorkDoneProgressCancelParams
- type WorkDoneProgressCreateParams
- type WorkDoneProgressEnd
- type WorkDoneProgressOptions
- type WorkDoneProgressOptionsAndTextDocumentRegistrationOptions
- type WorkDoneProgressParams
- type WorkDoneProgressReport
- type WorkspaceClientCapabilities
- type WorkspaceDiagnosticParams
- type WorkspaceDiagnosticReport
- type WorkspaceDiagnosticReportPartialResult
- type WorkspaceDocumentDiagnosticReport
- type WorkspaceEdit
- type WorkspaceEditClientCapabilities
- type WorkspaceEditMetadata
- type WorkspaceFolder
- type WorkspaceFolders5Gn
- type WorkspaceFoldersChangeEvent
- type WorkspaceFoldersInitializeParams
- type WorkspaceFoldersServerCapabilities
- type WorkspaceFullDocumentDiagnosticReport
- type WorkspaceOptions
- type WorkspaceSymbol
- type WorkspaceSymbolClientCapabilities
- type WorkspaceSymbolOptions
- type WorkspaceSymbolParams
- type WorkspaceSymbolRegistrationOptions
- type WorkspaceUnchangedDocumentDiagnosticReport
- type XInitializeParams
Constants ¶
const ( // A set of predefined code action kinds // Empty kind. Empty CodeActionKind = "" // Base kind for quickfix actions: 'quickfix' QuickFix CodeActionKind = "quickfix" // Base kind for refactoring actions: 'refactor' Refactor CodeActionKind = "refactor" // Base kind for refactoring extraction actions: 'refactor.extract' // // Example extract actions: // // // - Extract method // - Extract function // - Extract variable // - Extract interface from class // - ... RefactorExtract CodeActionKind = "refactor.extract" // Base kind for refactoring inline actions: 'refactor.inline' // // Example inline actions: // // // - Inline function // - Inline variable // - Inline constant // - ... RefactorInline CodeActionKind = "refactor.inline" // Base kind for refactoring move actions: `refactor.move` // // Example move actions: // // // - Move a function to a new file // - Move a property between classes // - Move method to base class // - ... // // @since 3.18.0 // @proposed RefactorMove CodeActionKind = "refactor.move" // Base kind for refactoring rewrite actions: 'refactor.rewrite' // // Example rewrite actions: // // // - Convert JavaScript function to class // - Add or remove parameter // - Encapsulate field // - Make method static // - Move method to base class // - ... RefactorRewrite CodeActionKind = "refactor.rewrite" // Base kind for source actions: `source` // // Source code actions apply to the entire file. Source CodeActionKind = "source" // Base kind for an organize imports source action: `source.organizeImports` SourceOrganizeImports CodeActionKind = "source.organizeImports" // Base kind for auto-fix source actions: `source.fixAll`. // // Fix all actions automatically fix errors that have a clear fix that do not require user input. // They should not suppress errors or perform unsafe fixes such as generating new types or classes. // // @since 3.15.0 SourceFixAll CodeActionKind = "source.fixAll" // Base kind for all code actions applying to the entire notebook's scope. CodeActionKinds using // this should always begin with `notebook.` // // @since 3.18.0 Notebook CodeActionKind = "notebook" // The reason why code actions were requested. // // @since 3.17.0 // Code actions were explicitly requested by the user or by an extension. CodeActionInvoked CodeActionTriggerKind = 1 // Code actions were requested automatically. // // This typically happens when current selection in a file changes, but can // also be triggered when file content changes. CodeActionAutomatic CodeActionTriggerKind = 2 // The kind of a completion entry. 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 // Completion item tags are extra annotations that tweak the rendering of a completion // item. // // @since 3.15.0 // Render a completion as obsolete, usually using a strike-out. ComplDeprecated CompletionItemTag = 1 // How a completion was triggered // Completion was triggered by typing an identifier (24x7 code // complete), manual invocation (e.g Ctrl+Space) or via API. Invoked CompletionTriggerKind = 1 // Completion was triggered by a trigger character specified by // the `triggerCharacters` properties of the `CompletionRegistrationOptions`. TriggerCharacter CompletionTriggerKind = 2 // Completion was re-triggered as current completion list is incomplete TriggerForIncompleteCompletions CompletionTriggerKind = 3 // The diagnostic's severity. // Reports an error. SeverityError DiagnosticSeverity = 1 // Reports a warning. SeverityWarning DiagnosticSeverity = 2 // Reports an information. SeverityInformation DiagnosticSeverity = 3 // Reports a hint. SeverityHint DiagnosticSeverity = 4 // The diagnostic tags. // // @since 3.15.0 // Unused or unnecessary code. // // Clients are allowed to render diagnostics with this tag faded out instead of having // an error squiggle. Unnecessary DiagnosticTag = 1 // Deprecated or obsolete code. // // Clients are allowed to rendered diagnostics with this tag strike through. Deprecated DiagnosticTag = 2 // The document diagnostic report kinds. // // @since 3.17.0 // A diagnostic report with a full // set of problems. DiagnosticFull DocumentDiagnosticReportKind = "full" // A report indicating that the last // returned report is still accurate. DiagnosticUnchanged DocumentDiagnosticReportKind = "unchanged" // A document highlight kind. // A textual occurrence. Text DocumentHighlightKind = 1 // Read-access of a symbol, like reading a variable. Read DocumentHighlightKind = 2 // Write-access of a symbol, like writing to a variable. Write DocumentHighlightKind = 3 // Predefined error codes. ParseError ErrorCodes = -32700 InvalidRequest ErrorCodes = -32600 MethodNotFound ErrorCodes = -32601 InvalidParams ErrorCodes = -32602 InternalError ErrorCodes = -32603 // Error code indicating that a server received a notification or // request before the server has received the `initialize` request. ServerNotInitialized ErrorCodes = -32002 UnknownErrorCode ErrorCodes = -32001 // Applying the workspace change is simply aborted if one of the changes provided // fails. All operations executed before the failing operation stay executed. Abort FailureHandlingKind = "abort" // All operations are executed transactional. That means they either all // succeed or no changes at all are applied to the workspace. Transactional FailureHandlingKind = "transactional" // If the workspace edit contains only textual file changes they are executed transactional. // If resource changes (create, rename or delete file) are part of the change the failure // handling strategy is abort. TextOnlyTransactional FailureHandlingKind = "textOnlyTransactional" // The client tries to undo the operations already executed. But there is no // guarantee that this is succeeding. Undo FailureHandlingKind = "undo" // The file event type // The file got created. Created FileChangeType = 1 // The file got changed. Changed FileChangeType = 2 // The file got deleted. Deleted FileChangeType = 3 // A pattern kind describing if a glob pattern matches a file a folder or // both. // // @since 3.16.0 // The pattern matches a file only. FilePattern FileOperationPatternKind = "file" // The pattern matches a folder only. FolderPattern FileOperationPatternKind = "folder" // A set of predefined range kinds. // Folding range for a comment Comment FoldingRangeKind = "comment" // Folding range for an import or include Imports FoldingRangeKind = "imports" // Folding range for a region (e.g. `#region`) Region FoldingRangeKind = "region" // Inlay hint kinds. // // @since 3.17.0 // An inlay hint that for a type annotation. Type InlayHintKind = 1 // An inlay hint that is for a parameter. Parameter InlayHintKind = 2 // Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered. // // @since 3.18.0 // @proposed // Completion was triggered explicitly by a user gesture. InlineInvoked InlineCompletionTriggerKind = 1 // Completion was triggered automatically while editing. InlineAutomatic InlineCompletionTriggerKind = 2 // Defines whether the insert text in a completion item should be interpreted as // plain text or a snippet. // The primary text to be inserted is treated as a plain string. PlainTextTextFormat InsertTextFormat = 1 // The primary text to be inserted is treated as a snippet. // // A snippet can define tab stops and placeholders with `$1`, `$2` // and `${3:foo}`. `$0` defines the final tab stop, it defaults to // the end of the snippet. Placeholders with equal identifiers are linked, // that is typing in one will update others too. // // See also: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#snippet_syntax SnippetTextFormat InsertTextFormat = 2 // How whitespace and indentation is handled during completion // item insertion. // // @since 3.16.0 // The insertion or replace strings is taken as it is. If the // value is multi line the lines below the cursor will be // inserted using the indentation defined in the string value. // The client will not apply any kind of adjustments to the // string. AsIs InsertTextMode = 1 // The editor adjusts leading whitespace of new lines so that // they match the indentation up to the cursor of the line for // which the item is accepted. // // Consider a line like this: <2tabs><cursor><3tabs>foo. Accepting a // multi line completion item is indented using 2 tabs and all // following lines inserted will be indented using 2 tabs as well. AdjustIndentation InsertTextMode = 2 // A request failed but it was syntactically correct, e.g the // method name was known and the parameters were valid. The error // message should contain human readable information about why // the request failed. // // @since 3.17.0 RequestFailed LSPErrorCodes = -32803 // The server cancelled the request. This error code should // only be used for requests that explicitly support being // server cancellable. // // @since 3.17.0 ServerCancelled LSPErrorCodes = -32802 // The server detected that the content of a document got // modified outside normal conditions. A server should // NOT send this error code if it detects a content change // in it unprocessed messages. The result even computed // on an older state might still be useful for the client. // // If a client decides that a result is not of any use anymore // the client should cancel the request. ContentModified LSPErrorCodes = -32801 // The client has canceled a request and a server has detected // the cancel. RequestCancelled LSPErrorCodes = -32800 // Predefined Language kinds // @since 3.18.0 // @proposed LangABAP LanguageKind = "abap" LangWindowsBat LanguageKind = "bat" LangBibTeX LanguageKind = "bibtex" LangClojure LanguageKind = "clojure" LangCoffeescript LanguageKind = "coffeescript" LangC LanguageKind = "c" LangCPP LanguageKind = "cpp" LangCSharp LanguageKind = "csharp" LangCSS LanguageKind = "css" // @since 3.18.0 // @proposed LangD LanguageKind = "d" // @since 3.18.0 // @proposed LangDelphi LanguageKind = "pascal" LangDiff LanguageKind = "diff" LangDart LanguageKind = "dart" LangDockerfile LanguageKind = "dockerfile" LangElixir LanguageKind = "elixir" LangErlang LanguageKind = "erlang" LangFSharp LanguageKind = "fsharp" LangGitCommit LanguageKind = "git-commit" LangGitRebase LanguageKind = "rebase" LangGo LanguageKind = "go" LangGroovy LanguageKind = "groovy" LangHandlebars LanguageKind = "handlebars" LangHaskell LanguageKind = "haskell" LangHTML LanguageKind = "html" LangIni LanguageKind = "ini" LangJava LanguageKind = "java" LangJavaScript LanguageKind = "javascript" LangJavaScriptReact LanguageKind = "javascriptreact" LangJSON LanguageKind = "json" LangLaTeX LanguageKind = "latex" LangLess LanguageKind = "less" LangLua LanguageKind = "lua" LangMakefile LanguageKind = "makefile" LangMarkdown LanguageKind = "markdown" LangObjectiveC LanguageKind = "objective-c" LangObjectiveCPP LanguageKind = "objective-cpp" // @since 3.18.0 // @proposed LangPascal LanguageKind = "pascal" LangPerl LanguageKind = "perl" LangPerl6 LanguageKind = "perl6" LangPHP LanguageKind = "php" LangPowershell LanguageKind = "powershell" LangPug LanguageKind = "jade" LangPython LanguageKind = "python" LangR LanguageKind = "r" LangRazor LanguageKind = "razor" LangRuby LanguageKind = "ruby" LangRust LanguageKind = "rust" LangSCSS LanguageKind = "scss" LangSASS LanguageKind = "sass" LangScala LanguageKind = "scala" LangShaderLab LanguageKind = "shaderlab" LangShellScript LanguageKind = "shellscript" LangSQL LanguageKind = "sql" LangSwift LanguageKind = "swift" LangTypeScript LanguageKind = "typescript" LangTypeScriptReact LanguageKind = "typescriptreact" LangTeX LanguageKind = "tex" LangVisualBasic LanguageKind = "vb" LangXML LanguageKind = "xml" LangXSL LanguageKind = "xsl" LangYAML LanguageKind = "yaml" // Describes the content type that a client supports in various // result literals like `Hover`, `ParameterInfo` or `CompletionItem`. // // Please note that `MarkupKinds` must not start with a `$`. This kinds // are reserved for internal usage. // Plain text is supported as a content format PlainText MarkupKind = "plaintext" // Markdown is supported as a content format Markdown MarkupKind = "markdown" // The message type // An error message. Error MessageType = 1 // A warning message. Warning MessageType = 2 // An information message. Info MessageType = 3 // A log message. Log MessageType = 4 // A debug message. // // @since 3.18.0 // @proposed Debug MessageType = 5 // The moniker kind. // // @since 3.16.0 // The moniker represent a symbol that is imported into a project Import MonikerKind = "import" // The moniker represents a symbol that is exported from a project Export MonikerKind = "export" // The moniker represents a symbol that is local to a project (e.g. a local // variable of a function, a class not visible outside the project, ...) Local MonikerKind = "local" // A notebook cell kind. // // @since 3.17.0 // A markup-cell is formatted source that is used for display. Markup NotebookCellKind = 1 // A code-cell is source code. Code NotebookCellKind = 2 // A set of predefined position encoding kinds. // // @since 3.17.0 // Character offsets count UTF-8 code units (e.g. bytes). UTF8 PositionEncodingKind = "utf-8" // Character offsets count UTF-16 code units. // // This is the default and must always be supported // by servers UTF16 PositionEncodingKind = "utf-16" // Character offsets count UTF-32 code units. // // Implementation note: these are the same as Unicode codepoints, // so this `PositionEncodingKind` may also be used for an // encoding-agnostic representation of character offsets. UTF32 PositionEncodingKind = "utf-32" // The client's default behavior is to select the identifier // according the to language's syntax rule. Identifier PrepareSupportDefaultBehavior = 1 // Supports creating new files and folders. Create ResourceOperationKind = "create" // Supports renaming existing files and folders. Rename ResourceOperationKind = "rename" // Supports deleting existing files and folders. Delete ResourceOperationKind = "delete" // A set of predefined token modifiers. This set is not fixed // an clients can specify additional token types via the // corresponding client capabilities. // // @since 3.16.0 ModDeclaration SemanticTokenModifiers = "declaration" ModDefinition SemanticTokenModifiers = "definition" ModReadonly SemanticTokenModifiers = "readonly" ModStatic SemanticTokenModifiers = "static" ModDeprecated SemanticTokenModifiers = "deprecated" ModAbstract SemanticTokenModifiers = "abstract" ModAsync SemanticTokenModifiers = "async" ModModification SemanticTokenModifiers = "modification" ModDocumentation SemanticTokenModifiers = "documentation" ModDefaultLibrary SemanticTokenModifiers = "defaultLibrary" // A set of predefined token types. This set is not fixed // an clients can specify additional token types via the // corresponding client capabilities. // // @since 3.16.0 NamespaceType SemanticTokenTypes = "namespace" // Represents a generic type. Acts as a fallback for types which can't be mapped to // a specific type like class or enum. TypeType SemanticTokenTypes = "type" ClassType SemanticTokenTypes = "class" EnumType SemanticTokenTypes = "enum" InterfaceType SemanticTokenTypes = "interface" StructType SemanticTokenTypes = "struct" TypeParameterType SemanticTokenTypes = "typeParameter" ParameterType SemanticTokenTypes = "parameter" VariableType SemanticTokenTypes = "variable" PropertyType SemanticTokenTypes = "property" EnumMemberType SemanticTokenTypes = "enumMember" EventType SemanticTokenTypes = "event" FunctionType SemanticTokenTypes = "function" MethodType SemanticTokenTypes = "method" MacroType SemanticTokenTypes = "macro" KeywordType SemanticTokenTypes = "keyword" ModifierType SemanticTokenTypes = "modifier" CommentType SemanticTokenTypes = "comment" StringType SemanticTokenTypes = "string" NumberType SemanticTokenTypes = "number" RegexpType SemanticTokenTypes = "regexp" OperatorType SemanticTokenTypes = "operator" // @since 3.17.0 DecoratorType SemanticTokenTypes = "decorator" // @since 3.18.0 LabelType SemanticTokenTypes = "label" // How a signature help was triggered. // // @since 3.15.0 // Signature help was invoked manually by the user or by a command. SigInvoked SignatureHelpTriggerKind = 1 // Signature help was triggered by a trigger character. SigTriggerCharacter SignatureHelpTriggerKind = 2 // Signature help was triggered by the cursor moving or by the document content changing. SigContentChange SignatureHelpTriggerKind = 3 // A symbol kind. File SymbolKind = 1 Module SymbolKind = 2 Namespace SymbolKind = 3 Package SymbolKind = 4 Class SymbolKind = 5 Method SymbolKind = 6 Property SymbolKind = 7 Field SymbolKind = 8 Constructor SymbolKind = 9 Enum SymbolKind = 10 Interface SymbolKind = 11 Function SymbolKind = 12 Variable SymbolKind = 13 Constant SymbolKind = 14 String SymbolKind = 15 Number SymbolKind = 16 Boolean SymbolKind = 17 Array SymbolKind = 18 Object SymbolKind = 19 Key SymbolKind = 20 Null SymbolKind = 21 EnumMember SymbolKind = 22 Struct SymbolKind = 23 Event SymbolKind = 24 Operator SymbolKind = 25 TypeParameter SymbolKind = 26 // Symbol tags are extra annotations that tweak the rendering of a symbol. // // @since 3.16 // Render a symbol as obsolete, usually using a strike-out. DeprecatedSymbol SymbolTag = 1 // Represents reasons why a text document is saved. // Manually triggered, e.g. by the user pressing save, by starting debugging, // or by an API call. Manual TextDocumentSaveReason = 1 // Automatic after a delay. AfterDelay TextDocumentSaveReason = 2 // When the editor lost focus. FocusOut TextDocumentSaveReason = 3 // Defines how the host (editor) should sync // document changes to the language server. // Documents should not be synced at all. None TextDocumentSyncKind = 0 // Documents are synced by always sending the full content // of the document. Full TextDocumentSyncKind = 1 // Documents are synced by sending the full content on open. // After that only incremental updates to the document are // send. Incremental TextDocumentSyncKind = 2 Relative TokenFormat = "relative" // Turn tracing off. Off TraceValue = "off" // Trace messages only. Messages TraceValue = "messages" // Verbose message tracing. Verbose TraceValue = "verbose" // Moniker uniqueness level to define scope of the moniker. // // @since 3.16.0 // The moniker is only unique inside a document Document UniquenessLevel = "document" // The moniker is unique inside a project for which a dump got created Project UniquenessLevel = "project" // The moniker is unique inside the group to which a project belongs Group UniquenessLevel = "group" // The moniker is unique inside the moniker scheme. Scheme UniquenessLevel = "scheme" // The moniker is globally unique Global UniquenessLevel = "global" // Interested in create events. WatchCreate WatchKind = 1 // Interested in change events WatchChange WatchKind = 2 // Interested in delete events WatchDelete WatchKind = 4 )
Variables ¶
var ( // RequestCancelledError should be used when a request is cancelled early. RequestCancelledError = jsonrpc2.NewError(-32800, "JSON RPC cancelled") RequestCancelledErrorV2 = jsonrpc2_v2.NewError(-32800, "JSON RPC cancelled") )
Functions ¶
func ApplyEdits ¶
ApplyEdits applies the patch (edits) to m.Content and returns the result. It also returns the edits converted to diff-package form.
func ClientHandlerV2 ¶
func ClientHandlerV2(client Client) jsonrpc2_v2.Handler
func CompareLocation ¶
CompareLocation defines a three-valued comparison over locations, lexicographically ordered by (URI, Range).
func ComparePosition ¶
ComparePosition returns -1 if a is before b, 0 if a == b, and 1 if a is after b.
func CompareRange ¶
CompareRange returns -1 if a is before b, 0 if a == b, and 1 if a is after b.
A range a is defined to be 'before' b if a.Start is before b.Start, or a.Start == b.Start and a.End is before b.End.
func EditsToDiffEdits ¶
EditsToDiffEdits converts LSP TextEdits to diff.Edits. See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textEditArray
func Intersect ¶
Intersect reports whether x and y intersect.
Two non-empty half-open integer intervals intersect iff:
y.start < x.end && x.start < y.end
Mathematical conventional views an interval as a set of integers. An empty interval is the empty set, so its intersection with any other interval is empty, and thus an empty interval does not intersect any other interval.
However, this function uses a looser definition appropriate for text selections: if either x or y is empty, it uses <= operators instead, so an empty range within or abutting a non-empty range is considered to overlap it, and an empty range overlaps itself.
This handles the common case in which there is no selection, but the cursor is at the start or end of an expression and the caller wants to know whether the cursor intersects the range of the expression. The answer in this case should be yes, even though the selection is empty. Similarly the answer should also be yes if the cursor is properly within the range of the expression. But a non-empty selection abutting the expression should not be considered to intersect it.
func LoggingStream ¶
LoggingStream returns a stream that does LSP protocol logging too
func NonNilSlice ¶
func NonNilSlice[T comparable](x []T) []T
NonNilSlice returns x, or an empty slice if x was nil.
(Many slice fields of protocol structs must be non-nil to avoid being encoded as JSON "null".)
func SemanticModifiers ¶
func SemanticModifiers() []string
SemanticModifiers to use in case there is no client.
func SemanticTypes ¶
func SemanticTypes() []string
SemanticTypes to use in case there is no client, as in the command line, or tests.
func ServerHandlerV2 ¶
func ServerHandlerV2(server Server) jsonrpc2_v2.Handler
func UnmarshalJSON ¶
func UnmarshalJSON(msg json.RawMessage, v any) error
UnmarshalJSON unmarshals msg into the variable pointed to by params. In JSONRPC, optional messages may be "null", in which case it is a no-op.
Types ¶
type AnnotatedTextEdit ¶
type AnnotatedTextEdit struct { // The actual identifier of the change annotation AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"` TextEdit }
A special text edit with an additional change annotation.
@since 3.16.0.
type ApplyWorkspaceEditParams ¶
type ApplyWorkspaceEditParams struct { // An optional label of the workspace edit. This label is // presented in the user interface for example on an undo // stack to undo the workspace edit. Label string `json:"label,omitempty"` // The edits to apply. Edit WorkspaceEdit `json:"edit"` // Additional data about the edit. // // @since 3.18.0 // @proposed Metadata *WorkspaceEditMetadata `json:"metadata,omitempty"` }
The parameters passed via an apply workspace edit request.
type ApplyWorkspaceEditResult ¶
type ApplyWorkspaceEditResult struct { // Indicates whether the edit was applied or not. Applied bool `json:"applied"` // An optional textual description for why the edit was not applied. // This may be used by the server for diagnostic logging or to provide // a suitable error for a request that triggered the edit. FailureReason string `json:"failureReason,omitempty"` // Depending on the client's failure handling strategy `failedChange` might // contain the index of the change that failed. This property is only available // if the client signals a `failureHandlingStrategy` in its client capabilities. FailedChange uint32 `json:"failedChange,omitempty"` }
The result returned from the apply workspace edit request.
@since 3.17 renamed from ApplyWorkspaceEditResponse
type BaseSymbolInformation ¶
type BaseSymbolInformation struct { // The name of this symbol. Name string `json:"name"` // The kind of this symbol. Kind SymbolKind `json:"kind"` // Tags for this symbol. // // @since 3.16.0 Tags []SymbolTag `json:"tags,omitempty"` // The name of the symbol containing this symbol. This information is for // user interface purposes (e.g. to render a qualifier in the user interface // if necessary). It can't be used to re-infer a hierarchy for the document // symbols. ContainerName string `json:"containerName,omitempty"` }
A base for all symbol information.
type CallHierarchyClientCapabilities ¶
type CallHierarchyClientCapabilities struct { // Whether implementation supports dynamic registration. If this is set to `true` // the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` // return value for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
@since 3.16.0
type CallHierarchyIncomingCall ¶
type CallHierarchyIncomingCall struct { // The item that makes the call. From CallHierarchyItem `json:"from"` // The ranges at which the calls appear. This is relative to the caller // denoted by {@link CallHierarchyIncomingCall.from `this.from`}. FromRanges []Range `json:"fromRanges"` }
Represents an incoming call, e.g. a caller of a method or constructor.
@since 3.16.0
type CallHierarchyIncomingCallsParams ¶
type CallHierarchyIncomingCallsParams struct { Item CallHierarchyItem `json:"item"` WorkDoneProgressParams PartialResultParams }
The parameter of a `callHierarchy/incomingCalls` request.
@since 3.16.0
type CallHierarchyItem ¶
type CallHierarchyItem struct { // The name of this item. Name string `json:"name"` // The kind of this item. Kind SymbolKind `json:"kind"` // Tags for this item. Tags []SymbolTag `json:"tags,omitempty"` // More detail for this item, e.g. the signature of a function. Detail string `json:"detail,omitempty"` // The resource identifier of this item. URI DocumentURI `json:"uri"` // The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code. Range Range `json:"range"` // The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function. // Must be contained by the {@link CallHierarchyItem.range `range`}. SelectionRange Range `json:"selectionRange"` // A data entry field that is preserved between a call hierarchy prepare and // incoming calls or outgoing calls requests. Data interface{} `json:"data,omitempty"` }
Represents programming constructs like functions or constructors in the context of call hierarchy.
@since 3.16.0
type CallHierarchyOptions ¶
type CallHierarchyOptions struct {
WorkDoneProgressOptions
}
Call hierarchy options used during static registration.
@since 3.16.0
type CallHierarchyOutgoingCall ¶
type CallHierarchyOutgoingCall struct { // The item that is called. To CallHierarchyItem `json:"to"` // The range at which this item is called. This is the range relative to the caller, e.g the item // passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`} // and not {@link CallHierarchyOutgoingCall.to `this.to`}. FromRanges []Range `json:"fromRanges"` }
Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
@since 3.16.0
type CallHierarchyOutgoingCallsParams ¶
type CallHierarchyOutgoingCallsParams struct { Item CallHierarchyItem `json:"item"` WorkDoneProgressParams PartialResultParams }
The parameter of a `callHierarchy/outgoingCalls` request.
@since 3.16.0
type CallHierarchyPrepareParams ¶
type CallHierarchyPrepareParams struct { TextDocumentPositionParams WorkDoneProgressParams }
The parameter of a `textDocument/prepareCallHierarchy` request.
@since 3.16.0
type CallHierarchyRegistrationOptions ¶
type CallHierarchyRegistrationOptions struct { TextDocumentRegistrationOptions CallHierarchyOptions StaticRegistrationOptions }
Call hierarchy options used during static or dynamic registration.
@since 3.16.0
type CancelParams ¶
type CancelParams struct {
// The request id to cancel.
ID interface{} `json:"id"`
}
type ChangeAnnotation ¶
type ChangeAnnotation struct { // A human-readable string describing the actual change. The string // is rendered prominent in the user interface. Label string `json:"label"` // A flag which indicates that user confirmation is needed // before applying the change. NeedsConfirmation bool `json:"needsConfirmation,omitempty"` // A human-readable string which is rendered less prominent in // the user interface. Description string `json:"description,omitempty"` }
Additional information that describes document changes.
@since 3.16.0
type ChangeAnnotationIdentifier ¶
type ChangeAnnotationIdentifier = string // (alias)
An identifier to refer to a change annotation stored with a workspace edit.
type ChangeAnnotationsSupportOptions ¶
type ChangeAnnotationsSupportOptions struct { // Whether the client groups edits with equal labels into tree nodes, // for instance all edits labelled with "Changes in Strings" would // be a tree node. GroupsOnLabel bool `json:"groupsOnLabel,omitempty"` }
@since 3.18.0
type Client ¶
type Client interface { // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#logTrace LogTrace(context.Context, *LogTraceParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#progress Progress(context.Context, *ProgressParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#client_registerCapability RegisterCapability(context.Context, *RegistrationParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#client_unregisterCapability UnregisterCapability(context.Context, *UnregistrationParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#telemetry_event Event(context.Context, *interface{}) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_publishDiagnostics PublishDiagnostics(context.Context, *PublishDiagnosticsParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#window_logMessage LogMessage(context.Context, *LogMessageParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#window_showDocument ShowDocument(context.Context, *ShowDocumentParams) (*ShowDocumentResult, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#window_showMessage ShowMessage(context.Context, *ShowMessageParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#window_showMessageRequest ShowMessageRequest(context.Context, *ShowMessageRequestParams) (*MessageActionItem, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#window_workDoneProgress_create WorkDoneProgressCreate(context.Context, *WorkDoneProgressCreateParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_applyEdit ApplyEdit(context.Context, *ApplyWorkspaceEditParams) (*ApplyWorkspaceEditResult, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_codeLens_refresh CodeLensRefresh(context.Context) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_configuration Configuration(context.Context, *ParamConfiguration) ([]LSPAny, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_diagnostic_refresh DiagnosticRefresh(context.Context) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_foldingRange_refresh FoldingRangeRefresh(context.Context) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_inlayHint_refresh InlayHintRefresh(context.Context) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_inlineValue_refresh InlineValueRefresh(context.Context) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_semanticTokens_refresh SemanticTokensRefresh(context.Context) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_textDocumentContent_refresh TextDocumentContentRefresh(context.Context, *TextDocumentContentRefreshParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_workspaceFolders WorkspaceFolders(context.Context) ([]WorkspaceFolder, error) }
type ClientCapabilities ¶
type ClientCapabilities struct { // Workspace specific client capabilities. Workspace WorkspaceClientCapabilities `json:"workspace,omitempty"` // Text document specific client capabilities. TextDocument TextDocumentClientCapabilities `json:"textDocument,omitempty"` // Capabilities specific to the notebook document support. // // @since 3.17.0 NotebookDocument *NotebookDocumentClientCapabilities `json:"notebookDocument,omitempty"` // Window specific client capabilities. Window WindowClientCapabilities `json:"window,omitempty"` // General client capabilities. // // @since 3.16.0 General *GeneralClientCapabilities `json:"general,omitempty"` // Experimental client capabilities. Experimental interface{} `json:"experimental,omitempty"` }
Defines the capabilities provided by the client.
type ClientCloser ¶
func ClientDispatcher ¶
func ClientDispatcher(conn jsonrpc2.Conn) ClientCloser
ClientDispatcher returns a Client that dispatches LSP requests across the given jsonrpc2 connection.
func ClientDispatcherV2 ¶
func ClientDispatcherV2(conn *jsonrpc2_v2.Connection) ClientCloser
type ClientCodeActionKindOptions ¶
type ClientCodeActionKindOptions struct { // The code action kind values the client supports. When this // property exists the client also guarantees that it will // handle values outside its set gracefully and falls back // to a default value when unknown. ValueSet []CodeActionKind `json:"valueSet"` }
@since 3.18.0
type ClientCodeActionLiteralOptions ¶
type ClientCodeActionLiteralOptions struct { // The code action kind is support with the following value // set. CodeActionKind ClientCodeActionKindOptions `json:"codeActionKind"` }
@since 3.18.0
type ClientCodeActionResolveOptions ¶
type ClientCodeActionResolveOptions struct { // The properties that a client can resolve lazily. Properties []string `json:"properties"` }
@since 3.18.0
type ClientCodeLensResolveOptions ¶ added in v0.17.0
type ClientCodeLensResolveOptions struct { // The properties that a client can resolve lazily. Properties []string `json:"properties"` }
@since 3.18.0
type ClientCompletionItemInsertTextModeOptions ¶
type ClientCompletionItemInsertTextModeOptions struct {
ValueSet []InsertTextMode `json:"valueSet"`
}
@since 3.18.0
type ClientCompletionItemOptions ¶
type ClientCompletionItemOptions struct { // Client supports snippets as insert text. // // A snippet can define tab stops and placeholders with `$1`, `$2` // and `${3:foo}`. `$0` defines the final tab stop, it defaults to // the end of the snippet. Placeholders with equal identifiers are linked, // that is typing in one will update others too. SnippetSupport bool `json:"snippetSupport,omitempty"` // Client supports commit characters on a completion item. CommitCharactersSupport bool `json:"commitCharactersSupport,omitempty"` // Client supports the following content formats for the documentation // property. The order describes the preferred format of the client. DocumentationFormat []MarkupKind `json:"documentationFormat,omitempty"` // Client supports the deprecated property on a completion item. DeprecatedSupport bool `json:"deprecatedSupport,omitempty"` // Client supports the preselect property on a completion item. PreselectSupport bool `json:"preselectSupport,omitempty"` // Client supports the tag property on a completion item. Clients supporting // tags have to handle unknown tags gracefully. Clients especially need to // preserve unknown tags when sending a completion item back to the server in // a resolve call. // // @since 3.15.0 TagSupport *CompletionItemTagOptions `json:"tagSupport,omitempty"` // Client support insert replace edit to control different behavior if a // completion item is inserted in the text or should replace text. // // @since 3.16.0 InsertReplaceSupport bool `json:"insertReplaceSupport,omitempty"` // Indicates which properties a client can resolve lazily on a completion // item. Before version 3.16.0 only the predefined properties `documentation` // and `details` could be resolved lazily. // // @since 3.16.0 ResolveSupport *ClientCompletionItemResolveOptions `json:"resolveSupport,omitempty"` // The client supports the `insertTextMode` property on // a completion item to override the whitespace handling mode // as defined by the client (see `insertTextMode`). // // @since 3.16.0 InsertTextModeSupport *ClientCompletionItemInsertTextModeOptions `json:"insertTextModeSupport,omitempty"` // The client has support for completion item label // details (see also `CompletionItemLabelDetails`). // // @since 3.17.0 LabelDetailsSupport bool `json:"labelDetailsSupport,omitempty"` }
@since 3.18.0
type ClientCompletionItemOptionsKind ¶
type ClientCompletionItemOptionsKind struct { // The completion item kind values the client supports. When this // property exists the client also guarantees that it will // handle values outside its set gracefully and falls back // to a default value when unknown. // // If this property is not present the client only supports // the completion items kinds from `Text` to `Reference` as defined in // the initial version of the protocol. ValueSet []CompletionItemKind `json:"valueSet,omitempty"` }
@since 3.18.0
type ClientCompletionItemResolveOptions ¶
type ClientCompletionItemResolveOptions struct { // The properties that a client can resolve lazily. Properties []string `json:"properties"` }
@since 3.18.0
type ClientDiagnosticsTagOptions ¶
type ClientDiagnosticsTagOptions struct { // The tags supported by the client. ValueSet []DiagnosticTag `json:"valueSet"` }
@since 3.18.0
type ClientFoldingRangeKindOptions ¶
type ClientFoldingRangeKindOptions struct { // The folding range kind values the client supports. When this // property exists the client also guarantees that it will // handle values outside its set gracefully and falls back // to a default value when unknown. ValueSet []FoldingRangeKind `json:"valueSet,omitempty"` }
@since 3.18.0
type ClientFoldingRangeOptions ¶
type ClientFoldingRangeOptions struct { // If set, the client signals that it supports setting collapsedText on // folding ranges to display custom labels instead of the default text. // // @since 3.17.0 CollapsedText bool `json:"collapsedText,omitempty"` }
@since 3.18.0
type ClientInfo ¶
type ClientInfo struct { // The name of the client as defined by the client. Name string `json:"name"` // The client's version as defined by the client. Version string `json:"version,omitempty"` }
Information about the client
@since 3.15.0 @since 3.18.0 ClientInfo type name added.
type ClientInlayHintResolveOptions ¶
type ClientInlayHintResolveOptions struct { // The properties that a client can resolve lazily. Properties []string `json:"properties"` }
@since 3.18.0
type ClientSemanticTokensRequestFullDelta ¶
type ClientSemanticTokensRequestFullDelta struct { // The client will send the `textDocument/semanticTokens/full/delta` request if // the server provides a corresponding handler. Delta bool `json:"delta,omitempty"` }
@since 3.18.0
type ClientSemanticTokensRequestOptions ¶
type ClientSemanticTokensRequestOptions struct { // The client will send the `textDocument/semanticTokens/range` request if // the server provides a corresponding handler. Range *Or_ClientSemanticTokensRequestOptions_range `json:"range,omitempty"` // The client will send the `textDocument/semanticTokens/full` request if // the server provides a corresponding handler. Full *Or_ClientSemanticTokensRequestOptions_full `json:"full,omitempty"` }
@since 3.18.0
type ClientShowMessageActionItemOptions ¶
type ClientShowMessageActionItemOptions struct { // Whether the client supports additional attributes which // are preserved and send back to the server in the // request's response. AdditionalPropertiesSupport bool `json:"additionalPropertiesSupport,omitempty"` }
@since 3.18.0
type ClientSignatureInformationOptions ¶
type ClientSignatureInformationOptions struct { // Client supports the following content formats for the documentation // property. The order describes the preferred format of the client. DocumentationFormat []MarkupKind `json:"documentationFormat,omitempty"` // Client capabilities specific to parameter information. ParameterInformation *ClientSignatureParameterInformationOptions `json:"parameterInformation,omitempty"` // The client supports the `activeParameter` property on `SignatureInformation` // literal. // // @since 3.16.0 ActiveParameterSupport bool `json:"activeParameterSupport,omitempty"` // The client supports the `activeParameter` property on // `SignatureHelp`/`SignatureInformation` being set to `null` to // indicate that no parameter should be active. // // @since 3.18.0 // @proposed NoActiveParameterSupport bool `json:"noActiveParameterSupport,omitempty"` }
@since 3.18.0
type ClientSignatureParameterInformationOptions ¶
type ClientSignatureParameterInformationOptions struct { // The client supports processing label offsets instead of a // simple label string. // // @since 3.14.0 LabelOffsetSupport bool `json:"labelOffsetSupport,omitempty"` }
@since 3.18.0
type ClientSymbolKindOptions ¶
type ClientSymbolKindOptions struct { // The symbol kind values the client supports. When this // property exists the client also guarantees that it will // handle values outside its set gracefully and falls back // to a default value when unknown. // // If this property is not present the client only supports // the symbol kinds from `File` to `Array` as defined in // the initial version of the protocol. ValueSet []SymbolKind `json:"valueSet,omitempty"` }
@since 3.18.0
type ClientSymbolResolveOptions ¶
type ClientSymbolResolveOptions struct { // The properties that a client can resolve lazily. Usually // `location.range` Properties []string `json:"properties"` }
@since 3.18.0
type ClientSymbolTagOptions ¶
type ClientSymbolTagOptions struct { // The tags supported by the client. ValueSet []SymbolTag `json:"valueSet"` }
@since 3.18.0
type CodeAction ¶
type CodeAction struct { // A short, human-readable, title for this code action. Title string `json:"title"` // The kind of the code action. // // Used to filter code actions. Kind CodeActionKind `json:"kind,omitempty"` // The diagnostics that this code action resolves. Diagnostics []Diagnostic `json:"diagnostics,omitempty"` // Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted // by keybindings. // // A quick fix should be marked preferred if it properly addresses the underlying error. // A refactoring should be marked preferred if it is the most reasonable choice of actions to take. // // @since 3.15.0 IsPreferred bool `json:"isPreferred,omitempty"` // Marks that the code action cannot currently be applied. // // Clients should follow the following guidelines regarding disabled code actions: // // - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) // code action menus. // // - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type // of code action, such as refactorings. // // - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions) // that auto applies a code action and only disabled code actions are returned, the client should show the user an // error message with `reason` in the editor. // // @since 3.16.0 Disabled *CodeActionDisabled `json:"disabled,omitempty"` // The workspace edit this code action performs. Edit *WorkspaceEdit `json:"edit,omitempty"` // A command this code action executes. If a code action // provides an edit and a command, first the edit is // executed and then the command. Command *Command `json:"command,omitempty"` // A data entry field that is preserved on a code action between // a `textDocument/codeAction` and a `codeAction/resolve` request. // // @since 3.16.0 Data *json.RawMessage `json:"data,omitempty"` }
A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.
A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
type CodeActionClientCapabilities ¶
type CodeActionClientCapabilities struct { // Whether code action supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The client support code action literals of type `CodeAction` as a valid // response of the `textDocument/codeAction` request. If the property is not // set the request can only return `Command` literals. // // @since 3.8.0 CodeActionLiteralSupport ClientCodeActionLiteralOptions `json:"codeActionLiteralSupport,omitempty"` // Whether code action supports the `isPreferred` property. // // @since 3.15.0 IsPreferredSupport bool `json:"isPreferredSupport,omitempty"` // Whether code action supports the `disabled` property. // // @since 3.16.0 DisabledSupport bool `json:"disabledSupport,omitempty"` // Whether code action supports the `data` property which is // preserved between a `textDocument/codeAction` and a // `codeAction/resolve` request. // // @since 3.16.0 DataSupport bool `json:"dataSupport,omitempty"` // Whether the client supports resolving additional code action // properties via a separate `codeAction/resolve` request. // // @since 3.16.0 ResolveSupport *ClientCodeActionResolveOptions `json:"resolveSupport,omitempty"` // Whether the client honors the change annotations in // text edits and resource operations returned via the // `CodeAction#edit` property by for example presenting // the workspace edit in the user interface and asking // for confirmation. // // @since 3.16.0 HonorsChangeAnnotations bool `json:"honorsChangeAnnotations,omitempty"` // Whether the client supports documentation for a class of // code actions. // // @since 3.18.0 // @proposed DocumentationSupport bool `json:"documentationSupport,omitempty"` }
The Client Capabilities of a {@link CodeActionRequest}.
type CodeActionContext ¶
type CodeActionContext struct { // An array of diagnostics known on the client side overlapping the range provided to the // `textDocument/codeAction` request. They are provided so that the server knows which // errors are currently presented to the user for the given range. There is no guarantee // that these accurately reflect the error state of the resource. The primary parameter // to compute code actions is the provided range. Diagnostics []Diagnostic `json:"diagnostics"` // Requested kind of actions to return. // // Actions not of this kind are filtered out by the client before being shown. So servers // can omit computing them. Only []CodeActionKind `json:"only,omitempty"` // The reason why code actions were requested. // // @since 3.17.0 TriggerKind *CodeActionTriggerKind `json:"triggerKind,omitempty"` }
Contains additional diagnostic information about the context in which a {@link CodeActionProvider.provideCodeActions code action} is run.
type CodeActionDisabled ¶
type CodeActionDisabled struct { // Human readable description of why the code action is currently disabled. // // This is displayed in the code actions UI. Reason string `json:"reason"` }
Captures why the code action is currently disabled.
@since 3.18.0
type CodeActionKindDocumentation ¶ added in v0.16.0
type CodeActionKindDocumentation struct { // The kind of the code action being documented. // // If the kind is generic, such as `CodeActionKind.Refactor`, the documentation will be shown whenever any // refactorings are returned. If the kind if more specific, such as `CodeActionKind.RefactorExtract`, the // documentation will only be shown when extract refactoring code actions are returned. Kind CodeActionKind `json:"kind"` // Command that is ued to display the documentation to the user. // // The title of this documentation code action is taken from {@linkcode Command.title} Command Command `json:"command"` }
Documentation for a class of code actions.
@since 3.18.0 @proposed
type CodeActionOptions ¶
type CodeActionOptions struct { // CodeActionKinds that this server may return. // // The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server // may list out every specific kind they provide. CodeActionKinds []CodeActionKind `json:"codeActionKinds,omitempty"` // Static documentation for a class of code actions. // // Documentation from the provider should be shown in the code actions menu if either: // // // - Code actions of `kind` are requested by the editor. In this case, the editor will show the documentation that // most closely matches the requested code action kind. For example, if a provider has documentation for // both `Refactor` and `RefactorExtract`, when the user requests code actions for `RefactorExtract`, // the editor will use the documentation for `RefactorExtract` instead of the documentation for `Refactor`. // // // - Any code actions of `kind` are returned by the provider. // // At most one documentation entry should be shown per provider. // // @since 3.18.0 // @proposed Documentation []CodeActionKindDocumentation `json:"documentation,omitempty"` // The server provides support to resolve additional // information for a code action. // // @since 3.16.0 ResolveProvider bool `json:"resolveProvider,omitempty"` WorkDoneProgressOptions }
Provider options for a {@link CodeActionRequest}.
type CodeActionParams ¶
type CodeActionParams struct { // The document in which the command was invoked. TextDocument TextDocumentIdentifier `json:"textDocument"` // The range for which the command was invoked. Range Range `json:"range"` // Context carrying additional information. Context CodeActionContext `json:"context"` WorkDoneProgressParams PartialResultParams }
The parameters of a {@link CodeActionRequest}.
type CodeActionRegistrationOptions ¶
type CodeActionRegistrationOptions struct { TextDocumentRegistrationOptions CodeActionOptions }
Registration options for a {@link CodeActionRequest}.
type CodeActionTriggerKind ¶
type CodeActionTriggerKind uint32
The reason why code actions were requested.
@since 3.17.0
const CodeActionUnknownTrigger CodeActionTriggerKind = 0
CodeActionUnknownTrigger indicates that the trigger for a CodeAction request is unknown. A missing CodeActionContext.TriggerKind should be treated as equivalent.
type CodeDescription ¶
type CodeDescription struct { // An URI to open with more information about the diagnostic error. Href URI `json:"href"` }
Structure to capture a description for an error code.
@since 3.16.0
type CodeLens ¶
type CodeLens struct { // The range in which this code lens is valid. Should only span a single line. Range Range `json:"range"` // The command this code lens represents. Command *Command `json:"command,omitempty"` // A data entry field that is preserved on a code lens item between // a {@link CodeLensRequest} and a {@link CodeLensResolveRequest} Data interface{} `json:"data,omitempty"` }
A code lens represents a {@link Command command} that should be shown along with source text, like the number of references, a way to run tests, etc.
A code lens is _unresolved_ when no command is associated to it. For performance reasons the creation of a code lens and resolving should be done in two stages.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#codeLens
type CodeLensClientCapabilities ¶
type CodeLensClientCapabilities struct { // Whether code lens supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Whether the client supports resolving additional code lens // properties via a separate `codeLens/resolve` request. // // @since 3.18.0 ResolveSupport *ClientCodeLensResolveOptions `json:"resolveSupport,omitempty"` }
The client capabilities of a {@link CodeLensRequest}.
type CodeLensOptions ¶
type CodeLensOptions struct { // Code lens has a resolve provider as well. ResolveProvider bool `json:"resolveProvider,omitempty"` WorkDoneProgressOptions }
Code Lens provider options of a {@link CodeLensRequest}.
type CodeLensParams ¶
type CodeLensParams struct { // The document to request code lens for. TextDocument TextDocumentIdentifier `json:"textDocument"` WorkDoneProgressParams PartialResultParams }
The parameters of a {@link CodeLensRequest}.
type CodeLensRegistrationOptions ¶
type CodeLensRegistrationOptions struct { TextDocumentRegistrationOptions CodeLensOptions }
Registration options for a {@link CodeLensRequest}.
type CodeLensWorkspaceClientCapabilities ¶
type CodeLensWorkspaceClientCapabilities struct { // Whether the client implementation supports a refresh request sent from the // server to the client. // // Note that this event is global and will force the client to refresh all // code lenses currently shown. It should be used with absolute care and is // useful for situation where a server for example detect a project wide // change that requires such a calculation. RefreshSupport bool `json:"refreshSupport,omitempty"` }
@since 3.16.0
type Color ¶
type Color struct { // The red component of this color in the range [0-1]. Red float64 `json:"red"` // The green component of this color in the range [0-1]. Green float64 `json:"green"` // The blue component of this color in the range [0-1]. Blue float64 `json:"blue"` // The alpha component of this color in the range [0-1]. Alpha float64 `json:"alpha"` }
Represents a color in RGBA space.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#color
type ColorInformation ¶
type ColorInformation struct { // The range in the document where this color appears. Range Range `json:"range"` // The actual color value for this color range. Color Color `json:"color"` }
Represents a color range from a document.
type ColorPresentation ¶
type ColorPresentation struct { // The label of this color presentation. It will be shown on the color // picker header. By default this is also the text that is inserted when selecting // this color presentation. Label string `json:"label"` // An {@link TextEdit edit} which is applied to a document when selecting // this presentation for the color. When `falsy` the {@link ColorPresentation.label label} // is used. TextEdit *TextEdit `json:"textEdit,omitempty"` // An optional array of additional {@link TextEdit text edits} that are applied when // selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves. AdditionalTextEdits []TextEdit `json:"additionalTextEdits,omitempty"` }
type ColorPresentationParams ¶
type ColorPresentationParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` // The color to request presentations for. Color Color `json:"color"` // The range where the color would be inserted. Serves as a context. Range Range `json:"range"` WorkDoneProgressParams PartialResultParams }
Parameters for a {@link ColorPresentationRequest}.
type Command ¶
type Command struct { // Title of the command, like `save`. Title string `json:"title"` // An optional tooltip. // // @since 3.18.0 // @proposed Tooltip string `json:"tooltip,omitempty"` // The identifier of the actual command handler. Command string `json:"command"` // Arguments that the command handler should be // invoked with. Arguments []json.RawMessage `json:"arguments,omitempty"` }
Represents a reference to a command. Provides a title which will be used to represent a command in the UI and, optionally, an array of arguments which will be passed to the command handler function when invoked.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#command
type CompletionClientCapabilities ¶
type CompletionClientCapabilities struct { // Whether completion supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The client supports the following `CompletionItem` specific // capabilities. CompletionItem ClientCompletionItemOptions `json:"completionItem,omitempty"` CompletionItemKind *ClientCompletionItemOptionsKind `json:"completionItemKind,omitempty"` // Defines how the client handles whitespace and indentation // when accepting a completion item that uses multi line // text in either `insertText` or `textEdit`. // // @since 3.17.0 InsertTextMode InsertTextMode `json:"insertTextMode,omitempty"` // The client supports to send additional context information for a // `textDocument/completion` request. ContextSupport bool `json:"contextSupport,omitempty"` // The client supports the following `CompletionList` specific // capabilities. // // @since 3.17.0 CompletionList *CompletionListCapabilities `json:"completionList,omitempty"` }
Completion client capabilities
type CompletionContext ¶
type CompletionContext struct { // How the completion was triggered. TriggerKind CompletionTriggerKind `json:"triggerKind"` // The trigger character (a single character) that has trigger code complete. // Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter` TriggerCharacter string `json:"triggerCharacter,omitempty"` }
Contains additional information about the context in which a completion request is triggered.
type CompletionItem ¶
type CompletionItem struct { // The label of this completion item. // // The label property is also by default the text that // is inserted when selecting this completion. // // If label details are provided the label itself should // be an unqualified name of the completion item. Label string `json:"label"` // Additional details for the label // // @since 3.17.0 LabelDetails *CompletionItemLabelDetails `json:"labelDetails,omitempty"` // The kind of this completion item. Based of the kind // an icon is chosen by the editor. Kind CompletionItemKind `json:"kind,omitempty"` // Tags for this completion item. // // @since 3.15.0 Tags []CompletionItemTag `json:"tags,omitempty"` // A human-readable string with additional information // about this item, like type or symbol information. Detail string `json:"detail,omitempty"` // A human-readable string that represents a doc-comment. Documentation *Or_CompletionItem_documentation `json:"documentation,omitempty"` // Indicates if this item is deprecated. // @deprecated Use `tags` instead. Deprecated bool `json:"deprecated,omitempty"` // Select this item when showing. // // *Note* that only one completion item can be selected and that the // tool / client decides which item that is. The rule is that the *first* // item of those that match best is selected. Preselect bool `json:"preselect,omitempty"` // A string that should be used when comparing this item // with other items. When `falsy` the {@link CompletionItem.label label} // is used. SortText string `json:"sortText,omitempty"` // A string that should be used when filtering a set of // completion items. When `falsy` the {@link CompletionItem.label label} // is used. FilterText string `json:"filterText,omitempty"` // A string that should be inserted into a document when selecting // this completion. When `falsy` the {@link CompletionItem.label label} // is used. // // The `insertText` is subject to interpretation by the client side. // Some tools might not take the string literally. For example // VS Code when code complete is requested in this example // `con<cursor position>` and a completion item with an `insertText` of // `console` is provided it will only insert `sole`. Therefore it is // recommended to use `textEdit` instead since it avoids additional client // side interpretation. InsertText string `json:"insertText,omitempty"` // The format of the insert text. The format applies to both the // `insertText` property and the `newText` property of a provided // `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`. // // Please note that the insertTextFormat doesn't apply to // `additionalTextEdits`. InsertTextFormat *InsertTextFormat `json:"insertTextFormat,omitempty"` // How whitespace and indentation is handled during completion // item insertion. If not provided the clients default value depends on // the `textDocument.completion.insertTextMode` client capability. // // @since 3.16.0 InsertTextMode *InsertTextMode `json:"insertTextMode,omitempty"` // An {@link TextEdit edit} which is applied to a document when selecting // this completion. When an edit is provided the value of // {@link CompletionItem.insertText insertText} is ignored. // // Most editors support two different operations when accepting a completion // item. One is to insert a completion text and the other is to replace an // existing text with a completion text. Since this can usually not be // predetermined by a server it can report both ranges. Clients need to // signal support for `InsertReplaceEdits` via the // `textDocument.completion.insertReplaceSupport` client capability // property. // // *Note 1:* The text edit's range as well as both ranges from an insert // replace edit must be a [single line] and they must contain the position // at which completion has been requested. // *Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range // must be a prefix of the edit's replace range, that means it must be // contained and starting at the same position. // // @since 3.16.0 additional type `InsertReplaceEdit` TextEdit *Or_CompletionItem_textEdit `json:"textEdit,omitempty"` // The edit text used if the completion item is part of a CompletionList and // CompletionList defines an item default for the text edit range. // // Clients will only honor this property if they opt into completion list // item defaults using the capability `completionList.itemDefaults`. // // If not provided and a list's default range is provided the label // property is used as a text. // // @since 3.17.0 TextEditText string `json:"textEditText,omitempty"` // An optional array of additional {@link TextEdit text edits} that are applied when // selecting this completion. Edits must not overlap (including the same insert position) // with the main {@link CompletionItem.textEdit edit} nor with themselves. // // Additional text edits should be used to change text unrelated to the current cursor position // (for example adding an import statement at the top of the file if the completion item will // insert an unqualified type). AdditionalTextEdits []TextEdit `json:"additionalTextEdits,omitempty"` // An optional set of characters that when pressed while this completion is active will accept it first and // then type that character. *Note* that all commit characters should have `length=1` and that superfluous // characters will be ignored. CommitCharacters []string `json:"commitCharacters,omitempty"` // An optional {@link Command command} that is executed *after* inserting this completion. *Note* that // additional modifications to the current document should be described with the // {@link CompletionItem.additionalTextEdits additionalTextEdits}-property. Command *Command `json:"command,omitempty"` // A data entry field that is preserved on a completion item between a // {@link CompletionRequest} and a {@link CompletionResolveRequest}. Data interface{} `json:"data,omitempty"` }
A completion item represents a text snippet that is proposed to complete text that is being typed.
type CompletionItemDefaults ¶
type CompletionItemDefaults struct { // A default commit character set. // // @since 3.17.0 CommitCharacters []string `json:"commitCharacters,omitempty"` // A default edit range. // // @since 3.17.0 EditRange *Or_CompletionItemDefaults_editRange `json:"editRange,omitempty"` // A default insert text format. // // @since 3.17.0 InsertTextFormat *InsertTextFormat `json:"insertTextFormat,omitempty"` // A default insert text mode. // // @since 3.17.0 InsertTextMode *InsertTextMode `json:"insertTextMode,omitempty"` // A default data value. // // @since 3.17.0 Data interface{} `json:"data,omitempty"` }
In many cases the items of an actual completion result share the same value for properties like `commitCharacters` or the range of a text edit. A completion list can therefore define item defaults which will be used if a completion item itself doesn't specify the value.
If a completion list specifies a default value and a completion item also specifies a corresponding value the one from the item is used.
Servers are only allowed to return default values if the client signals support for this via the `completionList.itemDefaults` capability.
@since 3.17.0
type CompletionItemLabelDetails ¶
type CompletionItemLabelDetails struct { // An optional string which is rendered less prominently directly after {@link CompletionItem.label label}, // without any spacing. Should be used for function signatures and type annotations. Detail string `json:"detail,omitempty"` // An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used // for fully qualified names and file paths. Description string `json:"description,omitempty"` }
Additional details for a completion item label.
@since 3.17.0
type CompletionItemTag ¶
type CompletionItemTag uint32
Completion item tags are extra annotations that tweak the rendering of a completion item.
@since 3.15.0
type CompletionItemTagOptions ¶
type CompletionItemTagOptions struct { // The tags supported by the client. ValueSet []CompletionItemTag `json:"valueSet"` }
@since 3.18.0
type CompletionList ¶
type CompletionList struct { // This list it not complete. Further typing results in recomputing this list. // // Recomputed lists have all their items replaced (not appended) in the // incomplete completion sessions. IsIncomplete bool `json:"isIncomplete"` // In many cases the items of an actual completion result share the same // value for properties like `commitCharacters` or the range of a text // edit. A completion list can therefore define item defaults which will // be used if a completion item itself doesn't specify the value. // // If a completion list specifies a default value and a completion item // also specifies a corresponding value the one from the item is used. // // Servers are only allowed to return default values if the client // signals support for this via the `completionList.itemDefaults` // capability. // // @since 3.17.0 ItemDefaults *CompletionItemDefaults `json:"itemDefaults,omitempty"` // The completion items. Items []CompletionItem `json:"items"` }
Represents a collection of {@link CompletionItem completion items} to be presented in the editor.
type CompletionListCapabilities ¶
type CompletionListCapabilities struct { // The client supports the following itemDefaults on // a completion list. // // The value lists the supported property names of the // `CompletionList.itemDefaults` object. If omitted // no properties are supported. // // @since 3.17.0 ItemDefaults []string `json:"itemDefaults,omitempty"` }
The client supports the following `CompletionList` specific capabilities.
@since 3.17.0
type CompletionOptions ¶
type CompletionOptions struct { // Most tools trigger completion request automatically without explicitly requesting // it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user // starts to type an identifier. For example if the user types `c` in a JavaScript file // code complete will automatically pop up present `console` besides others as a // completion item. Characters that make up identifiers don't need to be listed here. // // If code complete should automatically be trigger on characters not being valid inside // an identifier (for example `.` in JavaScript) list them in `triggerCharacters`. TriggerCharacters []string `json:"triggerCharacters,omitempty"` // The list of all possible characters that commit a completion. This field can be used // if clients don't support individual commit characters per completion item. See // `ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport` // // If a server provides both `allCommitCharacters` and commit characters on an individual // completion item the ones on the completion item win. // // @since 3.2.0 AllCommitCharacters []string `json:"allCommitCharacters,omitempty"` // The server provides support to resolve additional // information for a completion item. ResolveProvider bool `json:"resolveProvider,omitempty"` // The server supports the following `CompletionItem` specific // capabilities. // // @since 3.17.0 CompletionItem *ServerCompletionItemOptions `json:"completionItem,omitempty"` WorkDoneProgressOptions }
Completion options.
type CompletionParams ¶
type CompletionParams struct { // The completion context. This is only available it the client specifies // to send this using the client capability `textDocument.completion.contextSupport === true` Context CompletionContext `json:"context,omitempty"` TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
Completion parameters
type CompletionRegistrationOptions ¶
type CompletionRegistrationOptions struct { TextDocumentRegistrationOptions CompletionOptions }
Registration options for a {@link CompletionRequest}.
type ConfigurationItem ¶
type ConfigurationParams ¶
type ConfigurationParams struct {
Items []ConfigurationItem `json:"items"`
}
The parameters of a configuration request.
type CreateFile ¶
type CreateFile struct { // A create Kind string `json:"kind"` // The resource to create. URI DocumentURI `json:"uri"` // Additional options Options *CreateFileOptions `json:"options,omitempty"` ResourceOperation }
Create file operation.
type CreateFileOptions ¶
type CreateFileOptions struct { // Overwrite existing file. Overwrite wins over `ignoreIfExists` Overwrite bool `json:"overwrite,omitempty"` // Ignore if exists. IgnoreIfExists bool `json:"ignoreIfExists,omitempty"` }
Options to create a file.
type CreateFilesParams ¶
type CreateFilesParams struct { // An array of all files/folders created in this operation. Files []FileCreate `json:"files"` }
The parameters sent in notifications/requests for user-initiated creation of files.
@since 3.16.0
type Declaration ¶
type Declaration = []Location // (alias)
The declaration of a symbol representation as one or many {@link Location locations}.
type DeclarationClientCapabilities ¶
type DeclarationClientCapabilities struct { // Whether declaration supports dynamic registration. If this is set to `true` // the client supports the new `DeclarationRegistrationOptions` return value // for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The client supports additional metadata in the form of declaration links. LinkSupport bool `json:"linkSupport,omitempty"` }
@since 3.14.0
type DeclarationLink ¶
type DeclarationLink = LocationLink // (alias)
Information about where a symbol is declared.
Provides additional metadata over normal {@link Location location} declarations, including the range of the declaring symbol.
Servers should prefer returning `DeclarationLink` over `Declaration` if supported by the client.
type DeclarationOptions ¶
type DeclarationOptions struct {
WorkDoneProgressOptions
}
type DeclarationParams ¶
type DeclarationParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
type DeclarationRegistrationOptions ¶
type DeclarationRegistrationOptions struct { DeclarationOptions TextDocumentRegistrationOptions StaticRegistrationOptions }
type Definition ¶
type Definition = Or_Definition // (alias)
The definition of a symbol represented as one or many {@link Location locations}. For most programming languages there is only one location at which a symbol is defined.
Servers should prefer returning `DefinitionLink` over `Definition` if supported by the client.
type DefinitionClientCapabilities ¶
type DefinitionClientCapabilities struct { // Whether definition supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The client supports additional metadata in the form of definition links. // // @since 3.14.0 LinkSupport bool `json:"linkSupport,omitempty"` }
Client Capabilities for a {@link DefinitionRequest}.
type DefinitionLink ¶
type DefinitionLink = LocationLink // (alias)
Information about where a symbol is defined.
Provides additional metadata over normal {@link Location location} definitions, including the range of the defining symbol
type DefinitionOptions ¶
type DefinitionOptions struct {
WorkDoneProgressOptions
}
Server Capabilities for a {@link DefinitionRequest}.
type DefinitionParams ¶
type DefinitionParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
Parameters for a {@link DefinitionRequest}.
type DefinitionRegistrationOptions ¶
type DefinitionRegistrationOptions struct { TextDocumentRegistrationOptions DefinitionOptions }
Registration options for a {@link DefinitionRequest}.
type DeleteFile ¶
type DeleteFile struct { // A delete Kind string `json:"kind"` // The file to delete. URI DocumentURI `json:"uri"` // Delete options. Options *DeleteFileOptions `json:"options,omitempty"` ResourceOperation }
Delete file operation
type DeleteFileOptions ¶
type DeleteFileOptions struct { // Delete the content recursively if a folder is denoted. Recursive bool `json:"recursive,omitempty"` // Ignore the operation if the file doesn't exist. IgnoreIfNotExists bool `json:"ignoreIfNotExists,omitempty"` }
Delete file options
type DeleteFilesParams ¶
type DeleteFilesParams struct { // An array of all files/folders deleted in this operation. Files []FileDelete `json:"files"` }
The parameters sent in notifications/requests for user-initiated deletes of files.
@since 3.16.0
type Diagnostic ¶
type Diagnostic struct { // The range at which the message applies Range Range `json:"range"` // The diagnostic's severity. To avoid interpretation mismatches when a // server is used with different clients it is highly recommended that servers // always provide a severity value. Severity DiagnosticSeverity `json:"severity,omitempty"` // The diagnostic's code, which usually appear in the user interface. Code interface{} `json:"code,omitempty"` // An optional property to describe the error code. // Requires the code field (above) to be present/not null. // // @since 3.16.0 CodeDescription *CodeDescription `json:"codeDescription,omitempty"` // A human-readable string describing the source of this // diagnostic, e.g. 'typescript' or 'super lint'. It usually // appears in the user interface. Source string `json:"source,omitempty"` // The diagnostic's message. It usually appears in the user interface Message string `json:"message"` // Additional metadata about the diagnostic. // // @since 3.15.0 Tags []DiagnosticTag `json:"tags,omitempty"` // An array of related diagnostic information, e.g. when symbol-names within // a scope collide all definitions can be marked via this property. RelatedInformation []DiagnosticRelatedInformation `json:"relatedInformation,omitempty"` // A data entry field that is preserved between a `textDocument/publishDiagnostics` // notification and `textDocument/codeAction` request. // // @since 3.16.0 Data *json.RawMessage `json:"data,omitempty"` }
Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.
type DiagnosticClientCapabilities ¶
type DiagnosticClientCapabilities struct { // Whether implementation supports dynamic registration. If this is set to `true` // the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` // return value for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Whether the clients supports related documents for document diagnostic pulls. RelatedDocumentSupport bool `json:"relatedDocumentSupport,omitempty"` DiagnosticsCapabilities }
Client capabilities specific to diagnostic pull requests.
@since 3.17.0
type DiagnosticOptions ¶
type DiagnosticOptions struct { // An optional identifier under which the diagnostics are // managed by the client. Identifier string `json:"identifier,omitempty"` // Whether the language has inter file dependencies meaning that // editing code in one file can result in a different diagnostic // set in another file. Inter file dependencies are common for // most programming languages and typically uncommon for linters. InterFileDependencies bool `json:"interFileDependencies"` // The server provides support for workspace diagnostics as well. WorkspaceDiagnostics bool `json:"workspaceDiagnostics"` WorkDoneProgressOptions }
Diagnostic options.
@since 3.17.0
type DiagnosticRegistrationOptions ¶
type DiagnosticRegistrationOptions struct { TextDocumentRegistrationOptions DiagnosticOptions StaticRegistrationOptions }
Diagnostic registration options.
@since 3.17.0
type DiagnosticRelatedInformation ¶
type DiagnosticRelatedInformation struct { // The location of this related diagnostic information. Location Location `json:"location"` // The message of this related diagnostic information. Message string `json:"message"` }
Represents a related message and source code location for a diagnostic. This should be used to point to code locations that cause or related to a diagnostics, e.g when duplicating a symbol in a scope.
type DiagnosticServerCancellationData ¶
type DiagnosticServerCancellationData struct {
RetriggerRequest bool `json:"retriggerRequest"`
}
Cancellation data returned from a diagnostic request.
@since 3.17.0
type DiagnosticWorkspaceClientCapabilities ¶
type DiagnosticWorkspaceClientCapabilities struct { // Whether the client implementation supports a refresh request sent from // the server to the client. // // Note that this event is global and will force the client to refresh all // pulled diagnostics currently shown. It should be used with absolute care and // is useful for situation where a server for example detects a project wide // change that requires such a calculation. RefreshSupport bool `json:"refreshSupport,omitempty"` }
Workspace client capabilities specific to diagnostic pull requests.
@since 3.17.0
type DiagnosticsCapabilities ¶ added in v0.17.0
type DiagnosticsCapabilities struct { // Whether the clients accepts diagnostics with related information. RelatedInformation bool `json:"relatedInformation,omitempty"` // Client supports the tag property to provide meta data about a diagnostic. // Clients supporting tags have to handle unknown tags gracefully. // // @since 3.15.0 TagSupport *ClientDiagnosticsTagOptions `json:"tagSupport,omitempty"` // Client supports a codeDescription property // // @since 3.16.0 CodeDescriptionSupport bool `json:"codeDescriptionSupport,omitempty"` // Whether code action supports the `data` property which is // preserved between a `textDocument/publishDiagnostics` and // `textDocument/codeAction` request. // // @since 3.16.0 DataSupport bool `json:"dataSupport,omitempty"` }
General diagnostics capabilities for pull and push model.
type DidChangeConfigurationClientCapabilities ¶
type DidChangeConfigurationClientCapabilities struct { // Did change configuration notification supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
type DidChangeConfigurationParams ¶
type DidChangeConfigurationParams struct {
// The actual changed settings
Settings interface{} `json:"settings"`
}
The parameters of a change configuration notification.
type DidChangeConfigurationRegistrationOptions ¶
type DidChangeConfigurationRegistrationOptions struct {
Section *OrPSection_workspace_didChangeConfiguration `json:"section,omitempty"`
}
type DidChangeNotebookDocumentParams ¶
type DidChangeNotebookDocumentParams struct { // The notebook document that did change. The version number points // to the version after all provided changes have been applied. If // only the text document content of a cell changes the notebook version // doesn't necessarily have to change. NotebookDocument VersionedNotebookDocumentIdentifier `json:"notebookDocument"` // The actual changes to the notebook document. // // The changes describe single state changes to the notebook document. // So if there are two changes c1 (at array index 0) and c2 (at array // index 1) for a notebook in state S then c1 moves the notebook from // S to S' and c2 from S' to S”. So c1 is computed on the state S and // c2 is computed on the state S'. // // To mirror the content of a notebook using change events use the following approach: // // - start with the same initial content // - apply the 'notebookDocument/didChange' notifications in the order you receive them. // - apply the `NotebookChangeEvent`s in a single notification in the order // you receive them. Change NotebookDocumentChangeEvent `json:"change"` }
The params sent in a change notebook document notification.
@since 3.17.0
type DidChangeTextDocumentParams ¶
type DidChangeTextDocumentParams struct { // The document that did change. The version number points // to the version after all provided content changes have // been applied. TextDocument VersionedTextDocumentIdentifier `json:"textDocument"` // The actual content changes. The content changes describe single state changes // to the document. So if there are two content changes c1 (at array index 0) and // c2 (at array index 1) for a document in state S then c1 moves the document from // S to S' and c2 from S' to S”. So c1 is computed on the state S and c2 is computed // on the state S'. // // To mirror the content of a document using change events use the following approach: // // - start with the same initial content // - apply the 'textDocument/didChange' notifications in the order you receive them. // - apply the `TextDocumentContentChangeEvent`s in a single notification in the order // you receive them. ContentChanges []TextDocumentContentChangeEvent `json:"contentChanges"` }
The change text document notification's parameters.
type DidChangeWatchedFilesClientCapabilities ¶
type DidChangeWatchedFilesClientCapabilities struct { // Did change watched files notification supports dynamic registration. Please note // that the current protocol doesn't support static configuration for file changes // from the server side. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Whether the client has support for {@link RelativePattern relative pattern} // or not. // // @since 3.17.0 RelativePatternSupport bool `json:"relativePatternSupport,omitempty"` }
type DidChangeWatchedFilesParams ¶
type DidChangeWatchedFilesParams struct { // The actual file events. Changes []FileEvent `json:"changes"` }
The watched files change notification's parameters.
type DidChangeWatchedFilesRegistrationOptions ¶
type DidChangeWatchedFilesRegistrationOptions struct { // The watchers to register. Watchers []FileSystemWatcher `json:"watchers"` }
Describe options to be used when registered for text document change events.
type DidChangeWorkspaceFoldersParams ¶
type DidChangeWorkspaceFoldersParams struct { // The actual workspace folder change event. Event WorkspaceFoldersChangeEvent `json:"event"` }
The parameters of a `workspace/didChangeWorkspaceFolders` notification.
type DidCloseNotebookDocumentParams ¶
type DidCloseNotebookDocumentParams struct { // The notebook document that got closed. NotebookDocument NotebookDocumentIdentifier `json:"notebookDocument"` // The text documents that represent the content // of a notebook cell that got closed. CellTextDocuments []TextDocumentIdentifier `json:"cellTextDocuments"` }
The params sent in a close notebook document notification.
@since 3.17.0
type DidCloseTextDocumentParams ¶
type DidCloseTextDocumentParams struct { // The document that was closed. TextDocument TextDocumentIdentifier `json:"textDocument"` }
The parameters sent in a close text document notification
type DidOpenNotebookDocumentParams ¶
type DidOpenNotebookDocumentParams struct { // The notebook document that got opened. NotebookDocument NotebookDocument `json:"notebookDocument"` // The text documents that represent the content // of a notebook cell. CellTextDocuments []TextDocumentItem `json:"cellTextDocuments"` }
The params sent in an open notebook document notification.
@since 3.17.0
type DidOpenTextDocumentParams ¶
type DidOpenTextDocumentParams struct { // The document that was opened. TextDocument TextDocumentItem `json:"textDocument"` }
The parameters sent in an open text document notification
type DidSaveNotebookDocumentParams ¶
type DidSaveNotebookDocumentParams struct { // The notebook document that got saved. NotebookDocument NotebookDocumentIdentifier `json:"notebookDocument"` }
The params sent in a save notebook document notification.
@since 3.17.0
type DidSaveTextDocumentParams ¶
type DidSaveTextDocumentParams struct { // The document that was saved. TextDocument TextDocumentIdentifier `json:"textDocument"` // Optional the content when saved. Depends on the includeText value // when the save notification was requested. Text *string `json:"text,omitempty"` }
The parameters sent in a save text document notification
type DocumentChange ¶ added in v0.16.0
type DocumentChange struct { TextDocumentEdit *TextDocumentEdit CreateFile *CreateFile RenameFile *RenameFile DeleteFile *DeleteFile }
DocumentChange is a union of various file edit operations.
Exactly one field of this struct is non-nil; see DocumentChange.Valid.
func DocumentChangeCreate ¶ added in v0.17.0
func DocumentChangeCreate(uri DocumentURI) DocumentChange
DocumentChangeCreate constructs a DocumentChange that creates a file.
func DocumentChangeEdit ¶ added in v0.16.0
func DocumentChangeEdit(fh fileHandle, textedits []TextEdit) DocumentChange
DocumentChangeEdit constructs a DocumentChange containing a TextDocumentEdit from a file.Handle and a list of TextEdits.
func DocumentChangeRename ¶ added in v0.16.0
func DocumentChangeRename(src, dst DocumentURI) DocumentChange
DocumentChangeRename constructs a DocumentChange that renames a file.
func (*DocumentChange) MarshalJSON ¶ added in v0.16.0
func (d *DocumentChange) MarshalJSON() ([]byte, error)
func (*DocumentChange) UnmarshalJSON ¶ added in v0.16.0
func (d *DocumentChange) UnmarshalJSON(data []byte) error
func (DocumentChange) Valid ¶ added in v0.16.0
func (ch DocumentChange) Valid() bool
Valid reports whether the DocumentChange sum-type value is valid, that is, exactly one of create, delete, edit, or rename.
type DocumentColorClientCapabilities ¶
type DocumentColorClientCapabilities struct { // Whether implementation supports dynamic registration. If this is set to `true` // the client supports the new `DocumentColorRegistrationOptions` return value // for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
type DocumentColorOptions ¶
type DocumentColorOptions struct {
WorkDoneProgressOptions
}
type DocumentColorParams ¶
type DocumentColorParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` WorkDoneProgressParams PartialResultParams }
Parameters for a {@link DocumentColorRequest}.
type DocumentColorRegistrationOptions ¶
type DocumentColorRegistrationOptions struct { TextDocumentRegistrationOptions DocumentColorOptions StaticRegistrationOptions }
type DocumentDiagnosticParams ¶
type DocumentDiagnosticParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` // The additional identifier provided during registration. Identifier string `json:"identifier,omitempty"` // The result id of a previous response if provided. PreviousResultID string `json:"previousResultId,omitempty"` WorkDoneProgressParams PartialResultParams }
Parameters of the document diagnostic request.
@since 3.17.0
type DocumentDiagnosticReport ¶
type DocumentDiagnosticReport = Or_DocumentDiagnosticReport // (alias)
The result of a document diagnostic pull request. A report can either be a full report containing all diagnostics for the requested document or an unchanged report indicating that nothing has changed in terms of diagnostics in comparison to the last pull request.
@since 3.17.0
type DocumentDiagnosticReportKind ¶
type DocumentDiagnosticReportKind string
The document diagnostic report kinds.
@since 3.17.0
type DocumentDiagnosticReportPartialResult ¶
type DocumentDiagnosticReportPartialResult struct {
RelatedDocuments map[DocumentURI]interface{} `json:"relatedDocuments"`
}
A partial result for a document diagnostic report.
@since 3.17.0
type DocumentFilter ¶
type DocumentFilter = Or_DocumentFilter // (alias)
A document filter describes a top level text document or a notebook cell document.
@since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
type DocumentFormattingClientCapabilities ¶
type DocumentFormattingClientCapabilities struct { // Whether formatting supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
Client capabilities of a {@link DocumentFormattingRequest}.
type DocumentFormattingOptions ¶
type DocumentFormattingOptions struct {
WorkDoneProgressOptions
}
Provider options for a {@link DocumentFormattingRequest}.
type DocumentFormattingParams ¶
type DocumentFormattingParams struct { // The document to format. TextDocument TextDocumentIdentifier `json:"textDocument"` // The format options. Options FormattingOptions `json:"options"` WorkDoneProgressParams }
The parameters of a {@link DocumentFormattingRequest}.
type DocumentFormattingRegistrationOptions ¶
type DocumentFormattingRegistrationOptions struct { TextDocumentRegistrationOptions DocumentFormattingOptions }
Registration options for a {@link DocumentFormattingRequest}.
type DocumentHighlight ¶
type DocumentHighlight struct { // The range this highlight applies to. Range Range `json:"range"` // The highlight kind, default is {@link DocumentHighlightKind.Text text}. Kind DocumentHighlightKind `json:"kind,omitempty"` }
A document highlight is a range inside a text document which deserves special attention. Usually a document highlight is visualized by changing the background color of its range.
type DocumentHighlightClientCapabilities ¶
type DocumentHighlightClientCapabilities struct { // Whether document highlight supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
Client Capabilities for a {@link DocumentHighlightRequest}.
type DocumentHighlightOptions ¶
type DocumentHighlightOptions struct {
WorkDoneProgressOptions
}
Provider options for a {@link DocumentHighlightRequest}.
type DocumentHighlightParams ¶
type DocumentHighlightParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
Parameters for a {@link DocumentHighlightRequest}.
type DocumentHighlightRegistrationOptions ¶
type DocumentHighlightRegistrationOptions struct { TextDocumentRegistrationOptions DocumentHighlightOptions }
Registration options for a {@link DocumentHighlightRequest}.
type DocumentLink ¶
type DocumentLink struct { // The range this link applies to. Range Range `json:"range"` // The uri this link points to. If missing a resolve request is sent later. Target *URI `json:"target,omitempty"` // The tooltip text when you hover over this link. // // If a tooltip is provided, is will be displayed in a string that includes instructions on how to // trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS, // user settings, and localization. // // @since 3.15.0 Tooltip string `json:"tooltip,omitempty"` // A data entry field that is preserved on a document link between a // DocumentLinkRequest and a DocumentLinkResolveRequest. Data interface{} `json:"data,omitempty"` }
A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.
type DocumentLinkClientCapabilities ¶
type DocumentLinkClientCapabilities struct { // Whether document link supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Whether the client supports the `tooltip` property on `DocumentLink`. // // @since 3.15.0 TooltipSupport bool `json:"tooltipSupport,omitempty"` }
The client capabilities of a {@link DocumentLinkRequest}.
type DocumentLinkOptions ¶
type DocumentLinkOptions struct { // Document links have a resolve provider as well. ResolveProvider bool `json:"resolveProvider,omitempty"` WorkDoneProgressOptions }
Provider options for a {@link DocumentLinkRequest}.
type DocumentLinkParams ¶
type DocumentLinkParams struct { // The document to provide document links for. TextDocument TextDocumentIdentifier `json:"textDocument"` WorkDoneProgressParams PartialResultParams }
The parameters of a {@link DocumentLinkRequest}.
type DocumentLinkRegistrationOptions ¶
type DocumentLinkRegistrationOptions struct { TextDocumentRegistrationOptions DocumentLinkOptions }
Registration options for a {@link DocumentLinkRequest}.
type DocumentOnTypeFormattingClientCapabilities ¶
type DocumentOnTypeFormattingClientCapabilities struct { // Whether on type formatting supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
type DocumentOnTypeFormattingOptions ¶
type DocumentOnTypeFormattingOptions struct { // A character on which formatting should be triggered, like `{`. FirstTriggerCharacter string `json:"firstTriggerCharacter"` // More trigger characters. MoreTriggerCharacter []string `json:"moreTriggerCharacter,omitempty"` }
Provider options for a {@link DocumentOnTypeFormattingRequest}.
type DocumentOnTypeFormattingParams ¶
type DocumentOnTypeFormattingParams struct { // The document to format. TextDocument TextDocumentIdentifier `json:"textDocument"` // The position around which the on type formatting should happen. // This is not necessarily the exact position where the character denoted // by the property `ch` got typed. Position Position `json:"position"` // The character that has been typed that triggered the formatting // on type request. That is not necessarily the last character that // got inserted into the document since the client could auto insert // characters as well (e.g. like automatic brace completion). Ch string `json:"ch"` // The formatting options. Options FormattingOptions `json:"options"` }
The parameters of a {@link DocumentOnTypeFormattingRequest}.
type DocumentOnTypeFormattingRegistrationOptions ¶
type DocumentOnTypeFormattingRegistrationOptions struct { TextDocumentRegistrationOptions DocumentOnTypeFormattingOptions }
Registration options for a {@link DocumentOnTypeFormattingRequest}.
type DocumentRangeFormattingClientCapabilities ¶
type DocumentRangeFormattingClientCapabilities struct { // Whether range formatting supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Whether the client supports formatting multiple ranges at once. // // @since 3.18.0 // @proposed RangesSupport bool `json:"rangesSupport,omitempty"` }
Client capabilities of a {@link DocumentRangeFormattingRequest}.
type DocumentRangeFormattingOptions ¶
type DocumentRangeFormattingOptions struct { // Whether the server supports formatting multiple ranges at once. // // @since 3.18.0 // @proposed RangesSupport bool `json:"rangesSupport,omitempty"` WorkDoneProgressOptions }
Provider options for a {@link DocumentRangeFormattingRequest}.
type DocumentRangeFormattingParams ¶
type DocumentRangeFormattingParams struct { // The document to format. TextDocument TextDocumentIdentifier `json:"textDocument"` // The range to format Range Range `json:"range"` // The format options Options FormattingOptions `json:"options"` WorkDoneProgressParams }
The parameters of a {@link DocumentRangeFormattingRequest}.
type DocumentRangeFormattingRegistrationOptions ¶
type DocumentRangeFormattingRegistrationOptions struct { TextDocumentRegistrationOptions DocumentRangeFormattingOptions }
Registration options for a {@link DocumentRangeFormattingRequest}.
type DocumentRangesFormattingParams ¶
type DocumentRangesFormattingParams struct { // The document to format. TextDocument TextDocumentIdentifier `json:"textDocument"` // The ranges to format Ranges []Range `json:"ranges"` // The format options Options FormattingOptions `json:"options"` WorkDoneProgressParams }
The parameters of a {@link DocumentRangesFormattingRequest}.
@since 3.18.0 @proposed
type DocumentSelector ¶
type DocumentSelector = []DocumentFilter // (alias)
A document selector is the combination of one or many document filters.
@sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;
The use of a string as a document filter is deprecated @since 3.16.0.
type DocumentSymbol ¶
type DocumentSymbol struct { // The name of this symbol. Will be displayed in the user interface and therefore must not be // an empty string or a string only consisting of white spaces. Name string `json:"name"` // More detail for this symbol, e.g the signature of a function. Detail string `json:"detail,omitempty"` // The kind of this symbol. Kind SymbolKind `json:"kind"` // Tags for this document symbol. // // @since 3.16.0 Tags []SymbolTag `json:"tags,omitempty"` // Indicates if this symbol is deprecated. // // @deprecated Use tags instead Deprecated bool `json:"deprecated,omitempty"` // The range enclosing this symbol not including leading/trailing whitespace but everything else // like comments. This information is typically used to determine if the clients cursor is // inside the symbol to reveal in the symbol in the UI. Range Range `json:"range"` // The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. // Must be contained by the `range`. SelectionRange Range `json:"selectionRange"` // Children of this symbol, e.g. properties of a class. Children []DocumentSymbol `json:"children,omitempty"` }
Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier.
type DocumentSymbolClientCapabilities ¶
type DocumentSymbolClientCapabilities struct { // Whether document symbol supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Specific capabilities for the `SymbolKind` in the // `textDocument/documentSymbol` request. SymbolKind *ClientSymbolKindOptions `json:"symbolKind,omitempty"` // The client supports hierarchical document symbols. HierarchicalDocumentSymbolSupport bool `json:"hierarchicalDocumentSymbolSupport,omitempty"` // The client supports tags on `SymbolInformation`. Tags are supported on // `DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true. // Clients supporting tags have to handle unknown tags gracefully. // // @since 3.16.0 TagSupport *ClientSymbolTagOptions `json:"tagSupport,omitempty"` // The client supports an additional label presented in the UI when // registering a document symbol provider. // // @since 3.16.0 LabelSupport bool `json:"labelSupport,omitempty"` }
Client Capabilities for a {@link DocumentSymbolRequest}.
type DocumentSymbolOptions ¶
type DocumentSymbolOptions struct { // A human-readable string that is shown when multiple outlines trees // are shown for the same document. // // @since 3.16.0 Label string `json:"label,omitempty"` WorkDoneProgressOptions }
Provider options for a {@link DocumentSymbolRequest}.
type DocumentSymbolParams ¶
type DocumentSymbolParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` WorkDoneProgressParams PartialResultParams }
Parameters for a {@link DocumentSymbolRequest}.
type DocumentSymbolRegistrationOptions ¶
type DocumentSymbolRegistrationOptions struct { TextDocumentRegistrationOptions DocumentSymbolOptions }
Registration options for a {@link DocumentSymbolRequest}.
type DocumentURI ¶
type DocumentURI string
A DocumentURI is the URI of a client editor document.
According to the LSP specification:
Care should be taken to handle encoding in URIs. For example, some clients (such as VS Code) may encode colons in drive letters while others do not. The URIs below are both valid, but clients and servers should be consistent with the form they use themselves to ensure the other party doesn’t interpret them as distinct URIs. Clients and servers should not assume that each other are encoding the same way (for example a client encoding colons in drive letters cannot assume server responses will have encoded colons). The same applies to casing of drive letters - one party should not assume the other party will return paths with drive letters cased the same as it. file:///c:/project/readme.md file:///C%3A/project/readme.md
This is done during JSON unmarshalling; see DocumentURI.UnmarshalText for details.
func ParseDocumentURI ¶
func ParseDocumentURI(s string) (DocumentURI, error)
ParseDocumentURI interprets a string as a DocumentURI, applying VS Code workarounds; see DocumentURI.UnmarshalText for details.
func URIFromPath ¶
func URIFromPath(path string) DocumentURI
URIFromPath returns DocumentURI for the supplied file path. Given "", it returns "".
func (DocumentURI) Dir ¶
func (uri DocumentURI) Dir() DocumentURI
Dir returns the URI for the directory containing the receiver.
func (DocumentURI) DirPath ¶ added in v0.17.0
func (uri DocumentURI) DirPath() string
DirPath returns the file path to the directory containing this URI, which must be a file URI.
func (DocumentURI) Encloses ¶
func (uri DocumentURI) Encloses(file DocumentURI) bool
Encloses reports whether uri's path, considered as a sequence of segments, is a prefix of file's path.
func (DocumentURI) Path ¶
func (uri DocumentURI) Path() string
Path returns the file path for the given URI.
DocumentURI("").Path() returns the empty string.
Path panics if called on a URI that is not a valid filename.
func (*DocumentURI) UnmarshalText ¶
func (uri *DocumentURI) UnmarshalText(data []byte) (err error)
UnmarshalText implements decoding of DocumentURI values.
In particular, it implements a systematic correction of various odd features of the definition of DocumentURI in the LSP spec that appear to be workarounds for bugs in VS Code. For example, it may URI-encode the URI itself, so that colon becomes %3A, and it may send file://foo.go URIs that have two slashes (not three) and no hostname.
We use UnmarshalText, not UnmarshalJSON, because it is called even for non-addressable values such as keys and values of map[K]V, where there is no pointer of type *K or *V on which to call UnmarshalJSON. (See Go issue #28189 for more detail.)
Non-empty DocumentURIs are valid "file"-scheme URIs. The empty DocumentURI is valid.
type EditRangeWithInsertReplace ¶
type EditRangeWithInsertReplace struct { Insert Range `json:"insert"` Replace Range `json:"replace"` }
Edit range variant that includes ranges for insert and replace operations.
@since 3.18.0
type ExecuteCommandClientCapabilities ¶
type ExecuteCommandClientCapabilities struct { // Execute command supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
The client capabilities of a {@link ExecuteCommandRequest}.
type ExecuteCommandOptions ¶
type ExecuteCommandOptions struct { // The commands to be executed on the server Commands []string `json:"commands"` WorkDoneProgressOptions }
The server capabilities of a {@link ExecuteCommandRequest}.
type ExecuteCommandParams ¶
type ExecuteCommandParams struct { // The identifier of the actual command handler. Command string `json:"command"` // Arguments that the command should be invoked with. Arguments []json.RawMessage `json:"arguments,omitempty"` WorkDoneProgressParams }
The parameters of a {@link ExecuteCommandRequest}.
type ExecuteCommandRegistrationOptions ¶
type ExecuteCommandRegistrationOptions struct {
ExecuteCommandOptions
}
Registration options for a {@link ExecuteCommandRequest}.
type ExecutionSummary ¶
type ExecutionSummary struct { // A strict monotonically increasing value // indicating the execution order of a cell // inside a notebook. ExecutionOrder uint32 `json:"executionOrder"` // Whether the execution was successful or // not if known by the client. Success bool `json:"success,omitempty"` }
type FailureHandlingKind ¶
type FailureHandlingKind string
type FileCreate ¶
type FileCreate struct { // A file:// URI for the location of the file/folder being created. URI string `json:"uri"` }
Represents information on a file/folder create.
@since 3.16.0
type FileDelete ¶
type FileDelete struct { // A file:// URI for the location of the file/folder being deleted. URI string `json:"uri"` }
Represents information on a file/folder delete.
@since 3.16.0
type FileEvent ¶
type FileEvent struct { // The file's uri. URI DocumentURI `json:"uri"` // The change type. Type FileChangeType `json:"type"` }
An event describing a file change.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#fileEvent
type FileOperationClientCapabilities ¶
type FileOperationClientCapabilities struct { // Whether the client supports dynamic registration for file requests/notifications. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The client has support for sending didCreateFiles notifications. DidCreate bool `json:"didCreate,omitempty"` // The client has support for sending willCreateFiles requests. WillCreate bool `json:"willCreate,omitempty"` // The client has support for sending didRenameFiles notifications. DidRename bool `json:"didRename,omitempty"` // The client has support for sending willRenameFiles requests. WillRename bool `json:"willRename,omitempty"` // The client has support for sending didDeleteFiles notifications. DidDelete bool `json:"didDelete,omitempty"` // The client has support for sending willDeleteFiles requests. WillDelete bool `json:"willDelete,omitempty"` }
Capabilities relating to events from file operations by the user in the client.
These events do not come from the file system, they come from user operations like renaming a file in the UI.
@since 3.16.0
type FileOperationFilter ¶
type FileOperationFilter struct { // A Uri scheme like `file` or `untitled`. Scheme string `json:"scheme,omitempty"` // The actual file operation pattern. Pattern FileOperationPattern `json:"pattern"` }
A filter to describe in which file operation requests or notifications the server is interested in receiving.
@since 3.16.0
type FileOperationOptions ¶
type FileOperationOptions struct { // The server is interested in receiving didCreateFiles notifications. DidCreate *FileOperationRegistrationOptions `json:"didCreate,omitempty"` // The server is interested in receiving willCreateFiles requests. WillCreate *FileOperationRegistrationOptions `json:"willCreate,omitempty"` // The server is interested in receiving didRenameFiles notifications. DidRename *FileOperationRegistrationOptions `json:"didRename,omitempty"` // The server is interested in receiving willRenameFiles requests. WillRename *FileOperationRegistrationOptions `json:"willRename,omitempty"` // The server is interested in receiving didDeleteFiles file notifications. DidDelete *FileOperationRegistrationOptions `json:"didDelete,omitempty"` // The server is interested in receiving willDeleteFiles file requests. WillDelete *FileOperationRegistrationOptions `json:"willDelete,omitempty"` }
Options for notifications/requests for user operations on files.
@since 3.16.0
type FileOperationPattern ¶
type FileOperationPattern struct { // The glob pattern to match. Glob patterns can have the following syntax: // // - `*` to match one or more characters in a path segment // - `?` to match on one character in a path segment // - `**` to match any number of path segments, including none // - `{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files) // - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …) // - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`) Glob string `json:"glob"` // Whether to match files or folders with this pattern. // // Matches both if undefined. Matches *FileOperationPatternKind `json:"matches,omitempty"` // Additional options used during matching. Options *FileOperationPatternOptions `json:"options,omitempty"` }
A pattern to describe in which file operation requests or notifications the server is interested in receiving.
@since 3.16.0
type FileOperationPatternKind ¶
type FileOperationPatternKind string
A pattern kind describing if a glob pattern matches a file a folder or both.
@since 3.16.0
type FileOperationPatternOptions ¶
type FileOperationPatternOptions struct { // The pattern should be matched ignoring casing. IgnoreCase bool `json:"ignoreCase,omitempty"` }
Matching options for the file operation pattern.
@since 3.16.0
type FileOperationRegistrationOptions ¶
type FileOperationRegistrationOptions struct { // The actual filters. Filters []FileOperationFilter `json:"filters"` }
The options to register for file operations.
@since 3.16.0
type FileRename ¶
type FileRename struct { // A file:// URI for the original location of the file/folder being renamed. OldURI string `json:"oldUri"` // A file:// URI for the new location of the file/folder being renamed. NewURI string `json:"newUri"` }
Represents information on a file/folder rename.
@since 3.16.0
type FileSystemWatcher ¶
type FileSystemWatcher struct { // The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail. // // @since 3.17.0 support for relative patterns. GlobPattern GlobPattern `json:"globPattern"` // The kind of events of interest. If omitted it defaults // to WatchKind.Create | WatchKind.Change | WatchKind.Delete // which is 7. Kind *WatchKind `json:"kind,omitempty"` }
type FoldingRange ¶
type FoldingRange struct { // The zero-based start line of the range to fold. The folded area starts after the line's last character. // To be valid, the end must be zero or larger and smaller than the number of lines in the document. StartLine uint32 `json:"startLine"` // The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line. StartCharacter uint32 `json:"startCharacter,omitempty"` // The zero-based end line of the range to fold. The folded area ends with the line's last character. // To be valid, the end must be zero or larger and smaller than the number of lines in the document. EndLine uint32 `json:"endLine"` // The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line. EndCharacter uint32 `json:"endCharacter,omitempty"` // Describes the kind of the folding range such as 'comment' or 'region'. The kind // is used to categorize folding ranges and used by commands like 'Fold all comments'. // See {@link FoldingRangeKind} for an enumeration of standardized kinds. Kind string `json:"kind,omitempty"` // The text that the client should show when the specified range is // collapsed. If not defined or not supported by the client, a default // will be chosen by the client. // // @since 3.17.0 CollapsedText string `json:"collapsedText,omitempty"` }
Represents a folding range. To be valid, start and end line must be bigger than zero and smaller than the number of lines in the document. Clients are free to ignore invalid ranges.
type FoldingRangeClientCapabilities ¶
type FoldingRangeClientCapabilities struct { // Whether implementation supports dynamic registration for folding range // providers. If this is set to `true` the client supports the new // `FoldingRangeRegistrationOptions` return value for the corresponding // server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The maximum number of folding ranges that the client prefers to receive // per document. The value serves as a hint, servers are free to follow the // limit. RangeLimit uint32 `json:"rangeLimit,omitempty"` // If set, the client signals that it only supports folding complete lines. // If set, client will ignore specified `startCharacter` and `endCharacter` // properties in a FoldingRange. LineFoldingOnly bool `json:"lineFoldingOnly,omitempty"` // Specific options for the folding range kind. // // @since 3.17.0 FoldingRangeKind *ClientFoldingRangeKindOptions `json:"foldingRangeKind,omitempty"` // Specific options for the folding range. // // @since 3.17.0 FoldingRange *ClientFoldingRangeOptions `json:"foldingRange,omitempty"` }
type FoldingRangeOptions ¶
type FoldingRangeOptions struct {
WorkDoneProgressOptions
}
type FoldingRangeParams ¶
type FoldingRangeParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` WorkDoneProgressParams PartialResultParams }
Parameters for a {@link FoldingRangeRequest}.
type FoldingRangeRegistrationOptions ¶
type FoldingRangeRegistrationOptions struct { TextDocumentRegistrationOptions FoldingRangeOptions StaticRegistrationOptions }
type FoldingRangeWorkspaceClientCapabilities ¶
type FoldingRangeWorkspaceClientCapabilities struct { // Whether the client implementation supports a refresh request sent from the // server to the client. // // Note that this event is global and will force the client to refresh all // folding ranges currently shown. It should be used with absolute care and is // useful for situation where a server for example detects a project wide // change that requires such a calculation. // // @since 3.18.0 // @proposed RefreshSupport bool `json:"refreshSupport,omitempty"` }
Client workspace capabilities specific to folding ranges
@since 3.18.0 @proposed
type FormattingOptions ¶
type FormattingOptions struct { // Size of a tab in spaces. TabSize uint32 `json:"tabSize"` // Prefer spaces over tabs. InsertSpaces bool `json:"insertSpaces"` // Trim trailing whitespace on a line. // // @since 3.15.0 TrimTrailingWhitespace bool `json:"trimTrailingWhitespace,omitempty"` // Insert a newline character at the end of the file if one does not exist. // // @since 3.15.0 InsertFinalNewline bool `json:"insertFinalNewline,omitempty"` // Trim all newlines after the final newline at the end of the file. // // @since 3.15.0 TrimFinalNewlines bool `json:"trimFinalNewlines,omitempty"` }
Value-object describing what options formatting should use.
type FullDocumentDiagnosticReport ¶
type FullDocumentDiagnosticReport struct { // A full document diagnostic report. Kind string `json:"kind"` // An optional result id. If provided it will // be sent on the next diagnostic request for the // same document. ResultID string `json:"resultId,omitempty"` // The actual items. Items []Diagnostic `json:"items"` }
A diagnostic report with a full set of problems.
@since 3.17.0
type GeneralClientCapabilities ¶
type GeneralClientCapabilities struct { // Client capability that signals how the client // handles stale requests (e.g. a request // for which the client will not process the response // anymore since the information is outdated). // // @since 3.17.0 StaleRequestSupport *StaleRequestSupportOptions `json:"staleRequestSupport,omitempty"` // Client capabilities specific to regular expressions. // // @since 3.16.0 RegularExpressions *RegularExpressionsClientCapabilities `json:"regularExpressions,omitempty"` // Client capabilities specific to the client's markdown parser. // // @since 3.16.0 Markdown *MarkdownClientCapabilities `json:"markdown,omitempty"` // The position encodings supported by the client. Client and server // have to agree on the same position encoding to ensure that offsets // (e.g. character position in a line) are interpreted the same on both // sides. // // To keep the protocol backwards compatible the following applies: if // the value 'utf-16' is missing from the array of position encodings // servers can assume that the client supports UTF-16. UTF-16 is // therefore a mandatory encoding. // // If omitted it defaults to ['utf-16']. // // Implementation considerations: since the conversion from one encoding // into another requires the content of the file / line the conversion // is best done where the file is read which is usually on the server // side. // // @since 3.17.0 PositionEncodings []PositionEncodingKind `json:"positionEncodings,omitempty"` }
General client capabilities.
@since 3.16.0
type GlobPattern ¶
type GlobPattern = Or_GlobPattern // (alias)
The glob pattern. Either a string pattern or a relative pattern.
@since 3.17.0
type Hover ¶
type Hover struct { // The hover's content Contents MarkupContent `json:"contents"` // An optional range inside the text document that is used to // visualize the hover, e.g. by changing the background color. Range Range `json:"range,omitempty"` }
The result of a hover request.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#hover
type HoverClientCapabilities ¶
type HoverClientCapabilities struct { // Whether hover supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Client supports the following content formats for the content // property. The order describes the preferred format of the client. ContentFormat []MarkupKind `json:"contentFormat,omitempty"` }
type HoverParams ¶
type HoverParams struct { TextDocumentPositionParams WorkDoneProgressParams }
Parameters for a {@link HoverRequest}.
type HoverRegistrationOptions ¶
type HoverRegistrationOptions struct { TextDocumentRegistrationOptions HoverOptions }
Registration options for a {@link HoverRequest}.
type ImplementationClientCapabilities ¶
type ImplementationClientCapabilities struct { // Whether implementation supports dynamic registration. If this is set to `true` // the client supports the new `ImplementationRegistrationOptions` return value // for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The client supports additional metadata in the form of definition links. // // @since 3.14.0 LinkSupport bool `json:"linkSupport,omitempty"` }
@since 3.6.0
type ImplementationOptions ¶
type ImplementationOptions struct {
WorkDoneProgressOptions
}
type ImplementationParams ¶
type ImplementationParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
type ImplementationRegistrationOptions ¶
type ImplementationRegistrationOptions struct { TextDocumentRegistrationOptions ImplementationOptions StaticRegistrationOptions }
type InitializeError ¶
type InitializeError struct { // Indicates whether the client execute the following retry logic: // (1) show the message provided by the ResponseError to the user // (2) user selects retry or cancel // (3) if user selected retry the initialize method is sent again. Retry bool `json:"retry"` }
The data type of the ResponseError if the initialize request fails.
type InitializeParams ¶
type InitializeParams struct { XInitializeParams WorkspaceFoldersInitializeParams }
type InitializeResult ¶
type InitializeResult struct { // The capabilities the language server provides. Capabilities ServerCapabilities `json:"capabilities"` // Information about the server. // // @since 3.15.0 ServerInfo *ServerInfo `json:"serverInfo,omitempty"` }
The result returned from an initialize request.
type InitializedParams ¶
type InitializedParams struct { }
type InlayHint ¶
type InlayHint struct { // The position of this hint. // // If multiple hints have the same position, they will be shown in the order // they appear in the response. Position Position `json:"position"` // The label of this hint. A human readable string or an array of // InlayHintLabelPart label parts. // // *Note* that neither the string nor the label part can be empty. Label []InlayHintLabelPart `json:"label"` // The kind of this hint. Can be omitted in which case the client // should fall back to a reasonable default. Kind InlayHintKind `json:"kind,omitempty"` // Optional text edits that are performed when accepting this inlay hint. // // *Note* that edits are expected to change the document so that the inlay // hint (or its nearest variant) is now part of the document and the inlay // hint itself is now obsolete. TextEdits []TextEdit `json:"textEdits,omitempty"` // The tooltip text when you hover over this item. Tooltip *OrPTooltip_textDocument_inlayHint `json:"tooltip,omitempty"` // Render padding before the hint. // // Note: Padding should use the editor's background color, not the // background color of the hint itself. That means padding can be used // to visually align/separate an inlay hint. PaddingLeft bool `json:"paddingLeft,omitempty"` // Render padding after the hint. // // Note: Padding should use the editor's background color, not the // background color of the hint itself. That means padding can be used // to visually align/separate an inlay hint. PaddingRight bool `json:"paddingRight,omitempty"` // A data entry field that is preserved on an inlay hint between // a `textDocument/inlayHint` and a `inlayHint/resolve` request. Data interface{} `json:"data,omitempty"` }
Inlay hint information.
@since 3.17.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#inlayHint
type InlayHintClientCapabilities ¶
type InlayHintClientCapabilities struct { // Whether inlay hints support dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Indicates which properties a client can resolve lazily on an inlay // hint. ResolveSupport *ClientInlayHintResolveOptions `json:"resolveSupport,omitempty"` }
Inlay hint client capabilities.
@since 3.17.0
type InlayHintLabelPart ¶
type InlayHintLabelPart struct { // The value of this label part. Value string `json:"value"` // The tooltip text when you hover over this label part. Depending on // the client capability `inlayHint.resolveSupport` clients might resolve // this property late using the resolve request. Tooltip *OrPTooltipPLabel `json:"tooltip,omitempty"` // An optional source code location that represents this // label part. // // The editor will use this location for the hover and for code navigation // features: This part will become a clickable link that resolves to the // definition of the symbol at the given location (not necessarily the // location itself), it shows the hover that shows at the given location, // and it shows a context menu with further code navigation commands. // // Depending on the client capability `inlayHint.resolveSupport` clients // might resolve this property late using the resolve request. Location *Location `json:"location,omitempty"` // An optional command for this label part. // // Depending on the client capability `inlayHint.resolveSupport` clients // might resolve this property late using the resolve request. Command *Command `json:"command,omitempty"` }
An inlay hint label part allows for interactive and composite labels of inlay hints.
@since 3.17.0
type InlayHintOptions ¶
type InlayHintOptions struct { // The server provides support to resolve additional // information for an inlay hint item. ResolveProvider bool `json:"resolveProvider,omitempty"` WorkDoneProgressOptions }
Inlay hint options used during static registration.
@since 3.17.0
type InlayHintParams ¶
type InlayHintParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` // The document range for which inlay hints should be computed. Range Range `json:"range"` WorkDoneProgressParams }
A parameter literal used in inlay hint requests.
@since 3.17.0
type InlayHintRegistrationOptions ¶
type InlayHintRegistrationOptions struct { InlayHintOptions TextDocumentRegistrationOptions StaticRegistrationOptions }
Inlay hint options used during static or dynamic registration.
@since 3.17.0
type InlayHintWorkspaceClientCapabilities ¶
type InlayHintWorkspaceClientCapabilities struct { // Whether the client implementation supports a refresh request sent from // the server to the client. // // Note that this event is global and will force the client to refresh all // inlay hints currently shown. It should be used with absolute care and // is useful for situation where a server for example detects a project wide // change that requires such a calculation. RefreshSupport bool `json:"refreshSupport,omitempty"` }
Client workspace capabilities specific to inlay hints.
@since 3.17.0
type InlineCompletionClientCapabilities ¶
type InlineCompletionClientCapabilities struct { // Whether implementation supports dynamic registration for inline completion providers. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
Client capabilities specific to inline completions.
@since 3.18.0 @proposed
type InlineCompletionContext ¶
type InlineCompletionContext struct { // Describes how the inline completion was triggered. TriggerKind InlineCompletionTriggerKind `json:"triggerKind"` // Provides information about the currently selected item in the autocomplete widget if it is visible. SelectedCompletionInfo *SelectedCompletionInfo `json:"selectedCompletionInfo,omitempty"` }
Provides information about the context in which an inline completion was requested.
@since 3.18.0 @proposed
type InlineCompletionItem ¶
type InlineCompletionItem struct { // The text to replace the range with. Must be set. InsertText Or_InlineCompletionItem_insertText `json:"insertText"` // A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used. FilterText string `json:"filterText,omitempty"` // The range to replace. Must begin and end on the same line. Range *Range `json:"range,omitempty"` // An optional {@link Command} that is executed *after* inserting this completion. Command *Command `json:"command,omitempty"` }
An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
@since 3.18.0 @proposed
type InlineCompletionList ¶
type InlineCompletionList struct { // The inline completion items Items []InlineCompletionItem `json:"items"` }
Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
@since 3.18.0 @proposed
type InlineCompletionOptions ¶
type InlineCompletionOptions struct {
WorkDoneProgressOptions
}
Inline completion options used during static registration.
@since 3.18.0 @proposed
type InlineCompletionParams ¶
type InlineCompletionParams struct { // Additional information about the context in which inline completions were // requested. Context InlineCompletionContext `json:"context"` TextDocumentPositionParams WorkDoneProgressParams }
A parameter literal used in inline completion requests.
@since 3.18.0 @proposed
type InlineCompletionRegistrationOptions ¶
type InlineCompletionRegistrationOptions struct { InlineCompletionOptions TextDocumentRegistrationOptions StaticRegistrationOptions }
Inline completion options used during static or dynamic registration.
@since 3.18.0 @proposed
type InlineCompletionTriggerKind ¶
type InlineCompletionTriggerKind uint32
Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
@since 3.18.0 @proposed
type InlineValue ¶
type InlineValue = Or_InlineValue // (alias)
Inline value information can be provided by different means:
- directly as a text value (class InlineValueText).
- as a name to use for a variable lookup (class InlineValueVariableLookup)
- as an evaluatable expression (class InlineValueEvaluatableExpression)
The InlineValue types combines all inline value types into one type.
@since 3.17.0
type InlineValueClientCapabilities ¶
type InlineValueClientCapabilities struct { // Whether implementation supports dynamic registration for inline value providers. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
Client capabilities specific to inline values.
@since 3.17.0
type InlineValueContext ¶
type InlineValueContext struct { // The stack frame (as a DAP Id) where the execution has stopped. FrameID int32 `json:"frameId"` // The document range where execution has stopped. // Typically the end position of the range denotes the line where the inline values are shown. StoppedLocation Range `json:"stoppedLocation"` }
@since 3.17.0
type InlineValueEvaluatableExpression ¶
type InlineValueEvaluatableExpression struct { // The document range for which the inline value applies. // The range is used to extract the evaluatable expression from the underlying document. Range Range `json:"range"` // If specified the expression overrides the extracted expression. Expression string `json:"expression,omitempty"` }
Provide an inline value through an expression evaluation. If only a range is specified, the expression will be extracted from the underlying document. An optional expression can be used to override the extracted expression.
@since 3.17.0
type InlineValueOptions ¶
type InlineValueOptions struct {
WorkDoneProgressOptions
}
Inline value options used during static registration.
@since 3.17.0
type InlineValueParams ¶
type InlineValueParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` // The document range for which inline values should be computed. Range Range `json:"range"` // Additional information about the context in which inline values were // requested. Context InlineValueContext `json:"context"` WorkDoneProgressParams }
A parameter literal used in inline value requests.
@since 3.17.0
type InlineValueRegistrationOptions ¶
type InlineValueRegistrationOptions struct { InlineValueOptions TextDocumentRegistrationOptions StaticRegistrationOptions }
Inline value options used during static or dynamic registration.
@since 3.17.0
type InlineValueText ¶
type InlineValueText struct { // The document range for which the inline value applies. Range Range `json:"range"` // The text of the inline value. Text string `json:"text"` }
Provide inline value as text.
@since 3.17.0
type InlineValueVariableLookup ¶
type InlineValueVariableLookup struct { // The document range for which the inline value applies. // The range is used to extract the variable name from the underlying document. Range Range `json:"range"` // If specified the name of the variable to look up. VariableName string `json:"variableName,omitempty"` // How to perform the lookup. CaseSensitiveLookup bool `json:"caseSensitiveLookup"` }
Provide inline value through a variable lookup. If only a range is specified, the variable name will be extracted from the underlying document. An optional variable name can be used to override the extracted name.
@since 3.17.0
type InlineValueWorkspaceClientCapabilities ¶
type InlineValueWorkspaceClientCapabilities struct { // Whether the client implementation supports a refresh request sent from the // server to the client. // // Note that this event is global and will force the client to refresh all // inline values currently shown. It should be used with absolute care and is // useful for situation where a server for example detects a project wide // change that requires such a calculation. RefreshSupport bool `json:"refreshSupport,omitempty"` }
Client workspace capabilities specific to inline values.
@since 3.17.0
type InsertReplaceEdit ¶
type InsertReplaceEdit struct { // The string to be inserted. NewText string `json:"newText"` // The range if the insert is requested Insert Range `json:"insert"` // The range if the replace is requested. Replace Range `json:"replace"` }
A special text edit to provide an insert and a replace operation.
@since 3.16.0
func (*InsertReplaceEdit) UnmarshalJSON ¶ added in v0.16.0
func (e *InsertReplaceEdit) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshals InsertReplaceEdit with extra checks on the presence of "insert" and "replace" properties.
type InsertTextFormat ¶
type InsertTextFormat uint32
Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.
type InsertTextMode ¶
type InsertTextMode uint32
How whitespace and indentation is handled during completion item insertion.
@since 3.16.0
type LSPArray ¶
type LSPArray = []interface{} // (alias)
LSP arrays. @since 3.17.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#lSPArray
type LSPErrorCodes ¶
type LSPErrorCodes int32
type LSPObject ¶
LSP object definition. @since 3.17.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#lSPObject
type LanguageKind ¶ added in v0.16.0
type LanguageKind string
Predefined Language kinds @since 3.18.0 @proposed
type LinkedEditingRangeClientCapabilities ¶
type LinkedEditingRangeClientCapabilities struct { // Whether implementation supports dynamic registration. If this is set to `true` // the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` // return value for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
Client capabilities for the linked editing range request.
@since 3.16.0
type LinkedEditingRangeOptions ¶
type LinkedEditingRangeOptions struct {
WorkDoneProgressOptions
}
type LinkedEditingRangeParams ¶
type LinkedEditingRangeParams struct { TextDocumentPositionParams WorkDoneProgressParams }
type LinkedEditingRangeRegistrationOptions ¶
type LinkedEditingRangeRegistrationOptions struct { TextDocumentRegistrationOptions LinkedEditingRangeOptions StaticRegistrationOptions }
type LinkedEditingRanges ¶
type LinkedEditingRanges struct { // A list of ranges that can be edited together. The ranges must have // identical length and contain identical text content. The ranges cannot overlap. Ranges []Range `json:"ranges"` // An optional word pattern (regular expression) that describes valid contents for // the given ranges. If no pattern is provided, the client configuration's word // pattern will be used. WordPattern string `json:"wordPattern,omitempty"` }
The result of a linked editing range request.
@since 3.16.0
type Lit_ClientSemanticTokensRequestOptions_range_Item1 ¶
type Lit_ClientSemanticTokensRequestOptions_range_Item1 struct { }
created for Literal (Lit_ClientSemanticTokensRequestOptions_range_Item1)
type Location ¶
type Location struct { URI DocumentURI `json:"uri"` Range Range `json:"range"` }
Represents a location inside a resource, such as a line inside a text file.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#location
type LocationLink ¶
type LocationLink struct { // Span of the origin of this link. // // Used as the underlined span for mouse interaction. Defaults to the word range at // the definition position. OriginSelectionRange *Range `json:"originSelectionRange,omitempty"` // The target resource identifier of this link. TargetURI DocumentURI `json:"targetUri"` // The full target range of this link. If the target for example is a symbol then target range is the // range enclosing this symbol not including leading/trailing whitespace but everything else // like comments. This information is typically used to highlight the range in the editor. TargetRange Range `json:"targetRange"` // The range that should be selected and revealed when this link is being followed, e.g the name of a function. // Must be contained by the `targetRange`. See also `DocumentSymbol#range` TargetSelectionRange Range `json:"targetSelectionRange"` }
Represents the connection of two locations. Provides additional metadata over normal {@link Location locations}, including an origin range.
type LocationUriOnly ¶
type LocationUriOnly struct {
URI DocumentURI `json:"uri"`
}
Location with only uri and does not include range.
@since 3.18.0
type LogMessageParams ¶
type LogMessageParams struct { // The message type. See {@link MessageType} Type MessageType `json:"type"` // The actual message. Message string `json:"message"` }
The log message parameters.
type LogTraceParams ¶
type MappedRange ¶
type MappedRange struct { Mapper *Mapper // contains filtered or unexported fields }
A MappedRange represents a valid byte-offset range of a file. Through its Mapper it can be converted into other forms such as protocol.Range or UTF-8.
Construct one by calling Mapper.OffsetMappedRange with start/end offsets. From the go/token domain, call safetoken.Offsets first, or use a helper such as parsego.File.MappedPosRange.
Two MappedRanges produced the same Mapper are equal if and only if they denote the same range. Two MappedRanges produced by different Mappers are unequal even when they represent the same range of the same file.
func (MappedRange) Location ¶
func (mr MappedRange) Location() Location
Location returns the range in protocol location (UTF-16) form.
func (MappedRange) Offsets ¶
func (mr MappedRange) Offsets() (start, end int)
Offsets returns the (start, end) byte offsets of this range.
func (MappedRange) Range ¶
func (mr MappedRange) Range() Range
Range returns the range in protocol (UTF-16) form.
func (MappedRange) String ¶
func (mr MappedRange) String() string
String formats the range in UTF-8 notation.
func (MappedRange) URI ¶
func (mr MappedRange) URI() DocumentURI
URI returns the URI of the range's file.
type Mapper ¶
type Mapper struct { URI DocumentURI Content []byte // contains filtered or unexported fields }
A Mapper wraps the content of a file and provides mapping between byte offsets and notations of position such as:
(line, col8) pairs, where col8 is a 1-based UTF-8 column number (bytes), as used by the go/token and cmd packages.
(line, col16) pairs, where col16 is a 1-based UTF-16 column number, as used by the LSP protocol.
All conversion methods are named "FromTo", where From and To are the two types. For example, the PointPosition method converts from a Point to a Position.
Mapper does not intrinsically depend on go/token-based representations. Use safetoken to map between token.Pos <=> byte offsets, or the convenience methods such as PosPosition, NodePosition, or NodeRange.
See overview comments at top of this file.
func NewMapper ¶
func NewMapper(uri DocumentURI, content []byte) *Mapper
NewMapper creates a new mapper for the given URI and content.
func (*Mapper) LineCol8Position ¶
LineCol8Position converts a valid line and UTF-8 column number, both 1-based, to a protocol (UTF-16) position.
func (*Mapper) NodeMappedRange ¶
NodeMappedRange returns a MappedRange for the given node range.
func (*Mapper) OffsetLineCol8 ¶
OffsetLineCol8 converts a valid byte offset to line and UTF-8 column numbers, both 1-based.
func (*Mapper) OffsetLocation ¶
OffsetLocation converts a byte-offset interval to a protocol (UTF-16) location.
func (*Mapper) OffsetMappedRange ¶
func (m *Mapper) OffsetMappedRange(start, end int) (MappedRange, error)
OffsetMappedRange returns a MappedRange for the given byte offsets. A MappedRange can be converted to any other form.
func (*Mapper) OffsetPosition ¶
OffsetPosition converts a byte offset to a protocol (UTF-16) position.
func (*Mapper) OffsetRange ¶
OffsetRange converts a byte-offset interval to a protocol (UTF-16) range.
func (*Mapper) PosLocation ¶
PosLocation converts a token range to a protocol (UTF-16) location.
func (*Mapper) PosMappedRange ¶
PosMappedRange returns a MappedRange for the given token.Pos range.
func (*Mapper) PosPosition ¶
PosPosition converts a token pos to a protocol (UTF-16) position.
func (*Mapper) PositionOffset ¶
PositionOffset converts a protocol (UTF-16) position to a byte offset.
func (*Mapper) RangeLocation ¶
RangeLocation pairs a protocol Range with its URI, in a Location.
type MarkdownClientCapabilities ¶
type MarkdownClientCapabilities struct { // The name of the parser. Parser string `json:"parser"` // The version of the parser. Version string `json:"version,omitempty"` // A list of HTML tags that the client allows / supports in // Markdown. // // @since 3.17.0 AllowedTags []string `json:"allowedTags,omitempty"` }
Client capabilities specific to the used markdown parser.
@since 3.16.0
type MarkedString ¶
type MarkedString = Or_MarkedString // (alias)
MarkedString can be used to render human readable text. It is either a markdown string or a code-block that provides a language and a code snippet. The language identifier is semantically equal to the optional language identifier in fenced code blocks in GitHub issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
The pair of a language and a value is an equivalent to markdown: ```${language} ${value} ```
Note that markdown strings will be sanitized - that means html will be escaped. @deprecated use MarkupContent instead.
type MarkedStringWithLanguage ¶
type MarkedStringWithLanguage struct { Language string `json:"language"` Value string `json:"value"` }
@since 3.18.0 @deprecated use MarkupContent instead.
type MarkupContent ¶
type MarkupContent struct { // The type of the Markup Kind MarkupKind `json:"kind"` // The content itself Value string `json:"value"` }
A `MarkupContent` literal represents a string value which content is interpreted base on its kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
Here is an example how such a string can be constructed using JavaScript / TypeScript: ```ts
let markdown: MarkdownContent = { kind: MarkupKind.Markdown, value: [ '# Header', 'Some text', '```typescript', 'someCode();', '```' ].join('\n') };
```
*Please Note* that clients might sanitize the return markdown. A client could decide to remove HTML from the markdown to avoid script execution.
type MarkupKind ¶
type MarkupKind string
Describes the content type that a client supports in various result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
Please note that `MarkupKinds` must not start with a `$`. This kinds are reserved for internal usage.
type MessageActionItem ¶
type MessageActionItem struct { // A short title like 'Retry', 'Open Log' etc. Title string `json:"title"` }
type Moniker ¶
type Moniker struct { // The scheme of the moniker. For example tsc or .Net Scheme string `json:"scheme"` // The identifier of the moniker. The value is opaque in LSIF however // schema owners are allowed to define the structure if they want. Identifier string `json:"identifier"` // The scope in which the moniker is unique Unique UniquenessLevel `json:"unique"` // The moniker kind if known. Kind *MonikerKind `json:"kind,omitempty"` }
Moniker definition to match LSIF 0.5 moniker definition.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#moniker
type MonikerClientCapabilities ¶
type MonikerClientCapabilities struct { // Whether moniker supports dynamic registration. If this is set to `true` // the client supports the new `MonikerRegistrationOptions` return value // for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
Client capabilities specific to the moniker request.
@since 3.16.0
type MonikerOptions ¶
type MonikerOptions struct {
WorkDoneProgressOptions
}
type MonikerParams ¶
type MonikerParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
type MonikerRegistrationOptions ¶
type MonikerRegistrationOptions struct { TextDocumentRegistrationOptions MonikerOptions }
type NotebookCell ¶
type NotebookCell struct { // The cell's kind Kind NotebookCellKind `json:"kind"` // The URI of the cell's text document // content. Document DocumentURI `json:"document"` // Additional metadata stored with the cell. // // Note: should always be an object literal (e.g. LSPObject) Metadata *LSPObject `json:"metadata,omitempty"` // Additional execution summary information // if supported by the client. ExecutionSummary *ExecutionSummary `json:"executionSummary,omitempty"` }
A notebook cell.
A cell's document URI must be unique across ALL notebook cells and can therefore be used to uniquely identify a notebook cell or the cell's text document.
@since 3.17.0
type NotebookCellArrayChange ¶
type NotebookCellArrayChange struct { // The start oftest of the cell that changed. Start uint32 `json:"start"` // The deleted cells DeleteCount uint32 `json:"deleteCount"` // The new cells, if any Cells []NotebookCell `json:"cells,omitempty"` }
A change describing how to move a `NotebookCell` array from state S to S'.
@since 3.17.0
type NotebookCellLanguage ¶
type NotebookCellLanguage struct {
Language string `json:"language"`
}
@since 3.18.0
type NotebookCellTextDocumentFilter ¶
type NotebookCellTextDocumentFilter struct { // A filter that matches against the notebook // containing the notebook cell. If a string // value is provided it matches against the // notebook type. '*' matches every notebook. Notebook Or_NotebookCellTextDocumentFilter_notebook `json:"notebook"` // A language id like `python`. // // Will be matched against the language id of the // notebook cell document. '*' matches every language. Language string `json:"language,omitempty"` }
A notebook cell text document filter denotes a cell text document by different properties.
@since 3.17.0
type NotebookDocument ¶
type NotebookDocument struct { // The notebook document's uri. URI URI `json:"uri"` // The type of the notebook. NotebookType string `json:"notebookType"` // The version number of this document (it will increase after each // change, including undo/redo). Version int32 `json:"version"` // Additional metadata stored with the notebook // document. // // Note: should always be an object literal (e.g. LSPObject) Metadata *LSPObject `json:"metadata,omitempty"` // The cells of a notebook. Cells []NotebookCell `json:"cells"` }
A notebook document.
@since 3.17.0
type NotebookDocumentCellChangeStructure ¶
type NotebookDocumentCellChangeStructure struct { // The change to the cell array. Array NotebookCellArrayChange `json:"array"` // Additional opened cell text documents. DidOpen []TextDocumentItem `json:"didOpen,omitempty"` // Additional closed cell text documents. DidClose []TextDocumentIdentifier `json:"didClose,omitempty"` }
Structural changes to cells in a notebook document.
@since 3.18.0
type NotebookDocumentCellChanges ¶
type NotebookDocumentCellChanges struct { // Changes to the cell structure to add or // remove cells. Structure *NotebookDocumentCellChangeStructure `json:"structure,omitempty"` // Changes to notebook cells properties like its // kind, execution summary or metadata. Data []NotebookCell `json:"data,omitempty"` // Changes to the text content of notebook cells. TextContent []NotebookDocumentCellContentChanges `json:"textContent,omitempty"` }
Cell changes to a notebook document.
@since 3.18.0
type NotebookDocumentCellContentChanges ¶
type NotebookDocumentCellContentChanges struct { Document VersionedTextDocumentIdentifier `json:"document"` Changes []TextDocumentContentChangeEvent `json:"changes"` }
Content changes to a cell in a notebook document.
@since 3.18.0
type NotebookDocumentChangeEvent ¶
type NotebookDocumentChangeEvent struct { // The changed meta data if any. // // Note: should always be an object literal (e.g. LSPObject) Metadata *LSPObject `json:"metadata,omitempty"` // Changes to cells Cells *NotebookDocumentCellChanges `json:"cells,omitempty"` }
A change event for a notebook document.
@since 3.17.0
type NotebookDocumentClientCapabilities ¶
type NotebookDocumentClientCapabilities struct { // Capabilities specific to notebook document synchronization // // @since 3.17.0 Synchronization NotebookDocumentSyncClientCapabilities `json:"synchronization"` }
Capabilities specific to the notebook document support.
@since 3.17.0
type NotebookDocumentFilter ¶
type NotebookDocumentFilter = Or_NotebookDocumentFilter // (alias)
A notebook document filter denotes a notebook document by different properties. The properties will be match against the notebook's URI (same as with documents)
@since 3.17.0
type NotebookDocumentFilterNotebookType ¶
type NotebookDocumentFilterNotebookType struct { // The type of the enclosing notebook. NotebookType string `json:"notebookType"` // A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. Scheme string `json:"scheme,omitempty"` // A glob pattern. Pattern *GlobPattern `json:"pattern,omitempty"` }
A notebook document filter where `notebookType` is required field.
@since 3.18.0
type NotebookDocumentFilterPattern ¶
type NotebookDocumentFilterPattern struct { // The type of the enclosing notebook. NotebookType string `json:"notebookType,omitempty"` // A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. Scheme string `json:"scheme,omitempty"` // A glob pattern. Pattern GlobPattern `json:"pattern"` }
A notebook document filter where `pattern` is required field.
@since 3.18.0
type NotebookDocumentFilterScheme ¶
type NotebookDocumentFilterScheme struct { // The type of the enclosing notebook. NotebookType string `json:"notebookType,omitempty"` // A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. Scheme string `json:"scheme"` // A glob pattern. Pattern *GlobPattern `json:"pattern,omitempty"` }
A notebook document filter where `scheme` is required field.
@since 3.18.0
type NotebookDocumentFilterWithCells ¶
type NotebookDocumentFilterWithCells struct { // The notebook to be synced If a string // value is provided it matches against the // notebook type. '*' matches every notebook. Notebook *Or_NotebookDocumentFilterWithCells_notebook `json:"notebook,omitempty"` // The cells of the matching notebook to be synced. Cells []NotebookCellLanguage `json:"cells"` }
@since 3.18.0
type NotebookDocumentFilterWithNotebook ¶
type NotebookDocumentFilterWithNotebook struct { // The notebook to be synced If a string // value is provided it matches against the // notebook type. '*' matches every notebook. Notebook Or_NotebookDocumentFilterWithNotebook_notebook `json:"notebook"` // The cells of the matching notebook to be synced. Cells []NotebookCellLanguage `json:"cells,omitempty"` }
@since 3.18.0
type NotebookDocumentIdentifier ¶
type NotebookDocumentIdentifier struct { // The notebook document's uri. URI URI `json:"uri"` }
A literal to identify a notebook document in the client.
@since 3.17.0
type NotebookDocumentSyncClientCapabilities ¶
type NotebookDocumentSyncClientCapabilities struct { // Whether implementation supports dynamic registration. If this is // set to `true` the client supports the new // `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` // return value for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The client supports sending execution summary data per cell. ExecutionSummarySupport bool `json:"executionSummarySupport,omitempty"` }
Notebook specific client capabilities.
@since 3.17.0
type NotebookDocumentSyncOptions ¶
type NotebookDocumentSyncOptions struct { // The notebooks to be synced NotebookSelector []Or_NotebookDocumentSyncOptions_notebookSelector_Elem `json:"notebookSelector"` // Whether save notification should be forwarded to // the server. Will only be honored if mode === `notebook`. Save bool `json:"save,omitempty"` }
Options specific to a notebook plus its cells to be synced to the server.
If a selector provides a notebook document filter but no cell selector all cells of a matching notebook document will be synced.
If a selector provides no notebook document filter but only a cell selector all notebook document that contain at least one matching cell will be synced.
@since 3.17.0
type NotebookDocumentSyncRegistrationOptions ¶
type NotebookDocumentSyncRegistrationOptions struct { NotebookDocumentSyncOptions StaticRegistrationOptions }
Registration options specific to a notebook.
@since 3.17.0
type OptionalVersionedTextDocumentIdentifier ¶
type OptionalVersionedTextDocumentIdentifier struct { // The version number of this document. If a versioned text document identifier // is sent from the server to the client and the file is not open in the editor // (the server has not received an open notification before) the server can send // `null` to indicate that the version is unknown and the content on disk is the // truth (as specified with document content ownership). Version int32 `json:"version"` TextDocumentIdentifier }
A text document identifier to optionally denote a specific version of a text document.
type OrPLocation_workspace_symbol ¶
type OrPLocation_workspace_symbol struct {
Value interface{} `json:"value"`
}
created for Or [Location LocationUriOnly]
func (OrPLocation_workspace_symbol) MarshalJSON ¶
func (t OrPLocation_workspace_symbol) MarshalJSON() ([]byte, error)
func (*OrPLocation_workspace_symbol) UnmarshalJSON ¶
func (t *OrPLocation_workspace_symbol) UnmarshalJSON(x []byte) error
type OrPSection_workspace_didChangeConfiguration ¶
type OrPSection_workspace_didChangeConfiguration struct {
Value interface{} `json:"value"`
}
created for Or [[]string string]
func (OrPSection_workspace_didChangeConfiguration) MarshalJSON ¶
func (t OrPSection_workspace_didChangeConfiguration) MarshalJSON() ([]byte, error)
func (*OrPSection_workspace_didChangeConfiguration) UnmarshalJSON ¶
func (t *OrPSection_workspace_didChangeConfiguration) UnmarshalJSON(x []byte) error
type OrPTooltipPLabel ¶
type OrPTooltipPLabel struct {
Value interface{} `json:"value"`
}
created for Or [MarkupContent string]
func (OrPTooltipPLabel) MarshalJSON ¶
func (t OrPTooltipPLabel) MarshalJSON() ([]byte, error)
func (*OrPTooltipPLabel) UnmarshalJSON ¶
func (t *OrPTooltipPLabel) UnmarshalJSON(x []byte) error
type OrPTooltip_textDocument_inlayHint ¶
type OrPTooltip_textDocument_inlayHint struct {
Value interface{} `json:"value"`
}
created for Or [MarkupContent string]
func (OrPTooltip_textDocument_inlayHint) MarshalJSON ¶
func (t OrPTooltip_textDocument_inlayHint) MarshalJSON() ([]byte, error)
func (*OrPTooltip_textDocument_inlayHint) UnmarshalJSON ¶
func (t *OrPTooltip_textDocument_inlayHint) UnmarshalJSON(x []byte) error
type Or_CancelParams_id ¶
type Or_CancelParams_id struct {
Value interface{} `json:"value"`
}
created for Or [int32 string]
func (Or_CancelParams_id) MarshalJSON ¶
func (t Or_CancelParams_id) MarshalJSON() ([]byte, error)
func (*Or_CancelParams_id) UnmarshalJSON ¶
func (t *Or_CancelParams_id) UnmarshalJSON(x []byte) error
type Or_ClientSemanticTokensRequestOptions_full ¶
type Or_ClientSemanticTokensRequestOptions_full struct {
Value interface{} `json:"value"`
}
created for Or [ClientSemanticTokensRequestFullDelta bool]
func (Or_ClientSemanticTokensRequestOptions_full) MarshalJSON ¶
func (t Or_ClientSemanticTokensRequestOptions_full) MarshalJSON() ([]byte, error)
func (*Or_ClientSemanticTokensRequestOptions_full) UnmarshalJSON ¶
func (t *Or_ClientSemanticTokensRequestOptions_full) UnmarshalJSON(x []byte) error
type Or_ClientSemanticTokensRequestOptions_range ¶
type Or_ClientSemanticTokensRequestOptions_range struct {
Value interface{} `json:"value"`
}
created for Or [Lit_ClientSemanticTokensRequestOptions_range_Item1 bool]
func (Or_ClientSemanticTokensRequestOptions_range) MarshalJSON ¶
func (t Or_ClientSemanticTokensRequestOptions_range) MarshalJSON() ([]byte, error)
func (*Or_ClientSemanticTokensRequestOptions_range) UnmarshalJSON ¶
func (t *Or_ClientSemanticTokensRequestOptions_range) UnmarshalJSON(x []byte) error
type Or_CompletionItemDefaults_editRange ¶
type Or_CompletionItemDefaults_editRange struct {
Value interface{} `json:"value"`
}
created for Or [EditRangeWithInsertReplace Range]
func (Or_CompletionItemDefaults_editRange) MarshalJSON ¶
func (t Or_CompletionItemDefaults_editRange) MarshalJSON() ([]byte, error)
func (*Or_CompletionItemDefaults_editRange) UnmarshalJSON ¶
func (t *Or_CompletionItemDefaults_editRange) UnmarshalJSON(x []byte) error
type Or_CompletionItem_documentation ¶
type Or_CompletionItem_documentation struct {
Value interface{} `json:"value"`
}
created for Or [MarkupContent string]
func (Or_CompletionItem_documentation) MarshalJSON ¶
func (t Or_CompletionItem_documentation) MarshalJSON() ([]byte, error)
func (*Or_CompletionItem_documentation) UnmarshalJSON ¶
func (t *Or_CompletionItem_documentation) UnmarshalJSON(x []byte) error
type Or_CompletionItem_textEdit ¶
type Or_CompletionItem_textEdit struct {
Value interface{} `json:"value"`
}
created for Or [InsertReplaceEdit TextEdit]
func (Or_CompletionItem_textEdit) MarshalJSON ¶
func (t Or_CompletionItem_textEdit) MarshalJSON() ([]byte, error)
func (*Or_CompletionItem_textEdit) UnmarshalJSON ¶
func (t *Or_CompletionItem_textEdit) UnmarshalJSON(x []byte) error
type Or_Definition ¶
type Or_Definition struct {
Value interface{} `json:"value"`
}
created for Or [Location []Location]
func (Or_Definition) MarshalJSON ¶
func (t Or_Definition) MarshalJSON() ([]byte, error)
func (*Or_Definition) UnmarshalJSON ¶
func (t *Or_Definition) UnmarshalJSON(x []byte) error
type Or_Diagnostic_code ¶
type Or_Diagnostic_code struct {
Value interface{} `json:"value"`
}
created for Or [int32 string]
func (Or_Diagnostic_code) MarshalJSON ¶
func (t Or_Diagnostic_code) MarshalJSON() ([]byte, error)
func (*Or_Diagnostic_code) UnmarshalJSON ¶
func (t *Or_Diagnostic_code) UnmarshalJSON(x []byte) error
type Or_DocumentDiagnosticReport ¶
type Or_DocumentDiagnosticReport struct {
Value interface{} `json:"value"`
}
created for Or [RelatedFullDocumentDiagnosticReport RelatedUnchangedDocumentDiagnosticReport]
func (Or_DocumentDiagnosticReport) MarshalJSON ¶
func (t Or_DocumentDiagnosticReport) MarshalJSON() ([]byte, error)
func (*Or_DocumentDiagnosticReport) UnmarshalJSON ¶
func (t *Or_DocumentDiagnosticReport) UnmarshalJSON(x []byte) error
type Or_DocumentDiagnosticReportPartialResult_relatedDocuments_Value ¶
type Or_DocumentDiagnosticReportPartialResult_relatedDocuments_Value struct {
}created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport]
func (Or_DocumentDiagnosticReportPartialResult_relatedDocuments_Value) MarshalJSON ¶
func (t Or_DocumentDiagnosticReportPartialResult_relatedDocuments_Value) MarshalJSON() ([]byte, error)
func (*Or_DocumentDiagnosticReportPartialResult_relatedDocuments_Value) UnmarshalJSON ¶
func (t *Or_DocumentDiagnosticReportPartialResult_relatedDocuments_Value) UnmarshalJSON(x []byte) error
type Or_DocumentFilter ¶
type Or_DocumentFilter struct {
Value interface{} `json:"value"`
}
created for Or [NotebookCellTextDocumentFilter TextDocumentFilter]
func (Or_DocumentFilter) MarshalJSON ¶
func (t Or_DocumentFilter) MarshalJSON() ([]byte, error)
func (*Or_DocumentFilter) UnmarshalJSON ¶
func (t *Or_DocumentFilter) UnmarshalJSON(x []byte) error
type Or_GlobPattern ¶
type Or_GlobPattern struct {
Value interface{} `json:"value"`
}
created for Or [Pattern RelativePattern]
func (Or_GlobPattern) MarshalJSON ¶
func (t Or_GlobPattern) MarshalJSON() ([]byte, error)
func (*Or_GlobPattern) UnmarshalJSON ¶
func (t *Or_GlobPattern) UnmarshalJSON(x []byte) error
type Or_Hover_contents ¶
type Or_Hover_contents struct {
Value interface{} `json:"value"`
}
created for Or [MarkedString MarkupContent []MarkedString]
func (Or_Hover_contents) MarshalJSON ¶
func (t Or_Hover_contents) MarshalJSON() ([]byte, error)
func (*Or_Hover_contents) UnmarshalJSON ¶
func (t *Or_Hover_contents) UnmarshalJSON(x []byte) error
type Or_InlayHint_label ¶
type Or_InlayHint_label struct {
Value interface{} `json:"value"`
}
created for Or [[]InlayHintLabelPart string]
func (Or_InlayHint_label) MarshalJSON ¶
func (t Or_InlayHint_label) MarshalJSON() ([]byte, error)
func (*Or_InlayHint_label) UnmarshalJSON ¶
func (t *Or_InlayHint_label) UnmarshalJSON(x []byte) error
type Or_InlineCompletionItem_insertText ¶
type Or_InlineCompletionItem_insertText struct {
Value interface{} `json:"value"`
}
created for Or [StringValue string]
func (Or_InlineCompletionItem_insertText) MarshalJSON ¶
func (t Or_InlineCompletionItem_insertText) MarshalJSON() ([]byte, error)
func (*Or_InlineCompletionItem_insertText) UnmarshalJSON ¶
func (t *Or_InlineCompletionItem_insertText) UnmarshalJSON(x []byte) error
type Or_InlineValue ¶
type Or_InlineValue struct {
Value interface{} `json:"value"`
}
created for Or [InlineValueEvaluatableExpression InlineValueText InlineValueVariableLookup]
func (Or_InlineValue) MarshalJSON ¶
func (t Or_InlineValue) MarshalJSON() ([]byte, error)
func (*Or_InlineValue) UnmarshalJSON ¶
func (t *Or_InlineValue) UnmarshalJSON(x []byte) error
type Or_MarkedString ¶
type Or_MarkedString struct {
Value interface{} `json:"value"`
}
created for Or [MarkedStringWithLanguage string]
func (Or_MarkedString) MarshalJSON ¶
func (t Or_MarkedString) MarshalJSON() ([]byte, error)
func (*Or_MarkedString) UnmarshalJSON ¶
func (t *Or_MarkedString) UnmarshalJSON(x []byte) error
type Or_NotebookCellTextDocumentFilter_notebook ¶
type Or_NotebookCellTextDocumentFilter_notebook struct {
Value interface{} `json:"value"`
}
created for Or [NotebookDocumentFilter string]
func (Or_NotebookCellTextDocumentFilter_notebook) MarshalJSON ¶
func (t Or_NotebookCellTextDocumentFilter_notebook) MarshalJSON() ([]byte, error)
func (*Or_NotebookCellTextDocumentFilter_notebook) UnmarshalJSON ¶
func (t *Or_NotebookCellTextDocumentFilter_notebook) UnmarshalJSON(x []byte) error
type Or_NotebookDocumentFilter ¶
type Or_NotebookDocumentFilter struct {
Value interface{} `json:"value"`
}
created for Or [NotebookDocumentFilterNotebookType NotebookDocumentFilterPattern NotebookDocumentFilterScheme]
func (Or_NotebookDocumentFilter) MarshalJSON ¶
func (t Or_NotebookDocumentFilter) MarshalJSON() ([]byte, error)
func (*Or_NotebookDocumentFilter) UnmarshalJSON ¶
func (t *Or_NotebookDocumentFilter) UnmarshalJSON(x []byte) error
type Or_NotebookDocumentFilterWithCells_notebook ¶
type Or_NotebookDocumentFilterWithCells_notebook struct {
Value interface{} `json:"value"`
}
created for Or [NotebookDocumentFilter string]
func (Or_NotebookDocumentFilterWithCells_notebook) MarshalJSON ¶
func (t Or_NotebookDocumentFilterWithCells_notebook) MarshalJSON() ([]byte, error)
func (*Or_NotebookDocumentFilterWithCells_notebook) UnmarshalJSON ¶
func (t *Or_NotebookDocumentFilterWithCells_notebook) UnmarshalJSON(x []byte) error
type Or_NotebookDocumentFilterWithNotebook_notebook ¶
type Or_NotebookDocumentFilterWithNotebook_notebook struct {
Value interface{} `json:"value"`
}
created for Or [NotebookDocumentFilter string]
func (Or_NotebookDocumentFilterWithNotebook_notebook) MarshalJSON ¶
func (t Or_NotebookDocumentFilterWithNotebook_notebook) MarshalJSON() ([]byte, error)
func (*Or_NotebookDocumentFilterWithNotebook_notebook) UnmarshalJSON ¶
func (t *Or_NotebookDocumentFilterWithNotebook_notebook) UnmarshalJSON(x []byte) error
type Or_NotebookDocumentSyncOptions_notebookSelector_Elem ¶
type Or_NotebookDocumentSyncOptions_notebookSelector_Elem struct {
Value interface{} `json:"value"`
}
created for Or [NotebookDocumentFilterWithCells NotebookDocumentFilterWithNotebook]
func (Or_NotebookDocumentSyncOptions_notebookSelector_Elem) MarshalJSON ¶
func (t Or_NotebookDocumentSyncOptions_notebookSelector_Elem) MarshalJSON() ([]byte, error)
func (*Or_NotebookDocumentSyncOptions_notebookSelector_Elem) UnmarshalJSON ¶
func (t *Or_NotebookDocumentSyncOptions_notebookSelector_Elem) UnmarshalJSON(x []byte) error
type Or_RelatedFullDocumentDiagnosticReport_relatedDocuments_Value ¶
type Or_RelatedFullDocumentDiagnosticReport_relatedDocuments_Value struct {
}created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport]
func (Or_RelatedFullDocumentDiagnosticReport_relatedDocuments_Value) MarshalJSON ¶
func (t Or_RelatedFullDocumentDiagnosticReport_relatedDocuments_Value) MarshalJSON() ([]byte, error)
func (*Or_RelatedFullDocumentDiagnosticReport_relatedDocuments_Value) UnmarshalJSON ¶
func (t *Or_RelatedFullDocumentDiagnosticReport_relatedDocuments_Value) UnmarshalJSON(x []byte) error
type Or_RelatedUnchangedDocumentDiagnosticReport_relatedDocuments_Value ¶
type Or_RelatedUnchangedDocumentDiagnosticReport_relatedDocuments_Value struct {
}created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport]
func (Or_RelatedUnchangedDocumentDiagnosticReport_relatedDocuments_Value) MarshalJSON ¶
func (t Or_RelatedUnchangedDocumentDiagnosticReport_relatedDocuments_Value) MarshalJSON() ([]byte, error)
func (*Or_RelatedUnchangedDocumentDiagnosticReport_relatedDocuments_Value) UnmarshalJSON ¶
func (t *Or_RelatedUnchangedDocumentDiagnosticReport_relatedDocuments_Value) UnmarshalJSON(x []byte) error
type Or_Result_textDocument_codeAction_Item0_Elem ¶
type Or_Result_textDocument_codeAction_Item0_Elem struct {
Value interface{} `json:"value"`
}
created for Or [CodeAction Command]
func (Or_Result_textDocument_codeAction_Item0_Elem) MarshalJSON ¶
func (t Or_Result_textDocument_codeAction_Item0_Elem) MarshalJSON() ([]byte, error)
func (*Or_Result_textDocument_codeAction_Item0_Elem) UnmarshalJSON ¶
func (t *Or_Result_textDocument_codeAction_Item0_Elem) UnmarshalJSON(x []byte) error
type Or_Result_textDocument_inlineCompletion ¶
type Or_Result_textDocument_inlineCompletion struct {
Value interface{} `json:"value"`
}
created for Or [InlineCompletionList []InlineCompletionItem]
func (Or_Result_textDocument_inlineCompletion) MarshalJSON ¶
func (t Or_Result_textDocument_inlineCompletion) MarshalJSON() ([]byte, error)
func (*Or_Result_textDocument_inlineCompletion) UnmarshalJSON ¶
func (t *Or_Result_textDocument_inlineCompletion) UnmarshalJSON(x []byte) error
type Or_SemanticTokensOptions_full ¶
type Or_SemanticTokensOptions_full struct {
Value interface{} `json:"value"`
}
created for Or [SemanticTokensFullDelta bool]
func (Or_SemanticTokensOptions_full) MarshalJSON ¶
func (t Or_SemanticTokensOptions_full) MarshalJSON() ([]byte, error)
func (*Or_SemanticTokensOptions_full) UnmarshalJSON ¶
func (t *Or_SemanticTokensOptions_full) UnmarshalJSON(x []byte) error
type Or_SemanticTokensOptions_range ¶
type Or_SemanticTokensOptions_range struct {
Value interface{} `json:"value"`
}
created for Or [PRangeESemanticTokensOptions bool]
func (Or_SemanticTokensOptions_range) MarshalJSON ¶
func (t Or_SemanticTokensOptions_range) MarshalJSON() ([]byte, error)
func (*Or_SemanticTokensOptions_range) UnmarshalJSON ¶
func (t *Or_SemanticTokensOptions_range) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_callHierarchyProvider ¶
type Or_ServerCapabilities_callHierarchyProvider struct {
Value interface{} `json:"value"`
}
created for Or [CallHierarchyOptions CallHierarchyRegistrationOptions bool]
func (Or_ServerCapabilities_callHierarchyProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_callHierarchyProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_callHierarchyProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_callHierarchyProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_codeActionProvider ¶
type Or_ServerCapabilities_codeActionProvider struct {
Value interface{} `json:"value"`
}
created for Or [CodeActionOptions bool]
func (Or_ServerCapabilities_codeActionProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_codeActionProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_codeActionProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_codeActionProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_colorProvider ¶
type Or_ServerCapabilities_colorProvider struct {
Value interface{} `json:"value"`
}
created for Or [DocumentColorOptions DocumentColorRegistrationOptions bool]
func (Or_ServerCapabilities_colorProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_colorProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_colorProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_colorProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_declarationProvider ¶
type Or_ServerCapabilities_declarationProvider struct {
Value interface{} `json:"value"`
}
created for Or [DeclarationOptions DeclarationRegistrationOptions bool]
func (Or_ServerCapabilities_declarationProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_declarationProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_declarationProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_declarationProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_definitionProvider ¶
type Or_ServerCapabilities_definitionProvider struct {
Value interface{} `json:"value"`
}
created for Or [DefinitionOptions bool]
func (Or_ServerCapabilities_definitionProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_definitionProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_definitionProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_definitionProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_diagnosticProvider ¶
type Or_ServerCapabilities_diagnosticProvider struct {
Value interface{} `json:"value"`
}
created for Or [DiagnosticOptions DiagnosticRegistrationOptions]
func (Or_ServerCapabilities_diagnosticProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_diagnosticProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_diagnosticProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_diagnosticProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_documentFormattingProvider ¶
type Or_ServerCapabilities_documentFormattingProvider struct {
Value interface{} `json:"value"`
}
created for Or [DocumentFormattingOptions bool]
func (Or_ServerCapabilities_documentFormattingProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_documentFormattingProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_documentFormattingProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_documentFormattingProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_documentHighlightProvider ¶
type Or_ServerCapabilities_documentHighlightProvider struct {
Value interface{} `json:"value"`
}
created for Or [DocumentHighlightOptions bool]
func (Or_ServerCapabilities_documentHighlightProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_documentHighlightProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_documentHighlightProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_documentHighlightProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_documentRangeFormattingProvider ¶
type Or_ServerCapabilities_documentRangeFormattingProvider struct {
Value interface{} `json:"value"`
}
created for Or [DocumentRangeFormattingOptions bool]
func (Or_ServerCapabilities_documentRangeFormattingProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_documentRangeFormattingProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_documentRangeFormattingProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_documentRangeFormattingProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_documentSymbolProvider ¶
type Or_ServerCapabilities_documentSymbolProvider struct {
Value interface{} `json:"value"`
}
created for Or [DocumentSymbolOptions bool]
func (Or_ServerCapabilities_documentSymbolProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_documentSymbolProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_documentSymbolProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_documentSymbolProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_foldingRangeProvider ¶
type Or_ServerCapabilities_foldingRangeProvider struct {
Value interface{} `json:"value"`
}
created for Or [FoldingRangeOptions FoldingRangeRegistrationOptions bool]
func (Or_ServerCapabilities_foldingRangeProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_foldingRangeProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_foldingRangeProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_foldingRangeProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_hoverProvider ¶
type Or_ServerCapabilities_hoverProvider struct {
Value interface{} `json:"value"`
}
created for Or [HoverOptions bool]
func (Or_ServerCapabilities_hoverProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_hoverProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_hoverProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_hoverProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_implementationProvider ¶
type Or_ServerCapabilities_implementationProvider struct {
Value interface{} `json:"value"`
}
created for Or [ImplementationOptions ImplementationRegistrationOptions bool]
func (Or_ServerCapabilities_implementationProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_implementationProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_implementationProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_implementationProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_inlayHintProvider ¶
type Or_ServerCapabilities_inlayHintProvider struct {
Value interface{} `json:"value"`
}
created for Or [InlayHintOptions InlayHintRegistrationOptions bool]
func (Or_ServerCapabilities_inlayHintProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_inlayHintProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_inlayHintProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_inlayHintProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_inlineCompletionProvider ¶
type Or_ServerCapabilities_inlineCompletionProvider struct {
Value interface{} `json:"value"`
}
created for Or [InlineCompletionOptions bool]
func (Or_ServerCapabilities_inlineCompletionProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_inlineCompletionProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_inlineCompletionProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_inlineCompletionProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_inlineValueProvider ¶
type Or_ServerCapabilities_inlineValueProvider struct {
Value interface{} `json:"value"`
}
created for Or [InlineValueOptions InlineValueRegistrationOptions bool]
func (Or_ServerCapabilities_inlineValueProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_inlineValueProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_inlineValueProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_inlineValueProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_linkedEditingRangeProvider ¶
type Or_ServerCapabilities_linkedEditingRangeProvider struct {
Value interface{} `json:"value"`
}
created for Or [LinkedEditingRangeOptions LinkedEditingRangeRegistrationOptions bool]
func (Or_ServerCapabilities_linkedEditingRangeProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_linkedEditingRangeProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_linkedEditingRangeProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_linkedEditingRangeProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_monikerProvider ¶
type Or_ServerCapabilities_monikerProvider struct {
Value interface{} `json:"value"`
}
created for Or [MonikerOptions MonikerRegistrationOptions bool]
func (Or_ServerCapabilities_monikerProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_monikerProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_monikerProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_monikerProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_notebookDocumentSync ¶
type Or_ServerCapabilities_notebookDocumentSync struct {
Value interface{} `json:"value"`
}
created for Or [NotebookDocumentSyncOptions NotebookDocumentSyncRegistrationOptions]
func (Or_ServerCapabilities_notebookDocumentSync) MarshalJSON ¶
func (t Or_ServerCapabilities_notebookDocumentSync) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_notebookDocumentSync) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_notebookDocumentSync) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_referencesProvider ¶
type Or_ServerCapabilities_referencesProvider struct {
Value interface{} `json:"value"`
}
created for Or [ReferenceOptions bool]
func (Or_ServerCapabilities_referencesProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_referencesProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_referencesProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_referencesProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_renameProvider ¶
type Or_ServerCapabilities_renameProvider struct {
Value interface{} `json:"value"`
}
created for Or [RenameOptions bool]
func (Or_ServerCapabilities_renameProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_renameProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_renameProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_renameProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_selectionRangeProvider ¶
type Or_ServerCapabilities_selectionRangeProvider struct {
Value interface{} `json:"value"`
}
created for Or [SelectionRangeOptions SelectionRangeRegistrationOptions bool]
func (Or_ServerCapabilities_selectionRangeProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_selectionRangeProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_selectionRangeProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_selectionRangeProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_semanticTokensProvider ¶
type Or_ServerCapabilities_semanticTokensProvider struct {
Value interface{} `json:"value"`
}
created for Or [SemanticTokensOptions SemanticTokensRegistrationOptions]
func (Or_ServerCapabilities_semanticTokensProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_semanticTokensProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_semanticTokensProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_semanticTokensProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_textDocumentSync ¶
type Or_ServerCapabilities_textDocumentSync struct {
Value interface{} `json:"value"`
}
created for Or [TextDocumentSyncKind TextDocumentSyncOptions]
func (Or_ServerCapabilities_textDocumentSync) MarshalJSON ¶
func (t Or_ServerCapabilities_textDocumentSync) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_textDocumentSync) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_textDocumentSync) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_typeDefinitionProvider ¶
type Or_ServerCapabilities_typeDefinitionProvider struct {
Value interface{} `json:"value"`
}
created for Or [TypeDefinitionOptions TypeDefinitionRegistrationOptions bool]
func (Or_ServerCapabilities_typeDefinitionProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_typeDefinitionProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_typeDefinitionProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_typeDefinitionProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_typeHierarchyProvider ¶
type Or_ServerCapabilities_typeHierarchyProvider struct {
Value interface{} `json:"value"`
}
created for Or [TypeHierarchyOptions TypeHierarchyRegistrationOptions bool]
func (Or_ServerCapabilities_typeHierarchyProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_typeHierarchyProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_typeHierarchyProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_typeHierarchyProvider) UnmarshalJSON(x []byte) error
type Or_ServerCapabilities_workspaceSymbolProvider ¶
type Or_ServerCapabilities_workspaceSymbolProvider struct {
Value interface{} `json:"value"`
}
created for Or [WorkspaceSymbolOptions bool]
func (Or_ServerCapabilities_workspaceSymbolProvider) MarshalJSON ¶
func (t Or_ServerCapabilities_workspaceSymbolProvider) MarshalJSON() ([]byte, error)
func (*Or_ServerCapabilities_workspaceSymbolProvider) UnmarshalJSON ¶
func (t *Or_ServerCapabilities_workspaceSymbolProvider) UnmarshalJSON(x []byte) error
type Or_SignatureInformation_documentation ¶
type Or_SignatureInformation_documentation struct {
Value interface{} `json:"value"`
}
created for Or [MarkupContent string]
func (Or_SignatureInformation_documentation) MarshalJSON ¶
func (t Or_SignatureInformation_documentation) MarshalJSON() ([]byte, error)
func (*Or_SignatureInformation_documentation) UnmarshalJSON ¶
func (t *Or_SignatureInformation_documentation) UnmarshalJSON(x []byte) error
type Or_TextDocumentEdit_edits_Elem ¶
type Or_TextDocumentEdit_edits_Elem struct {
Value interface{} `json:"value"`
}
created for Or [AnnotatedTextEdit SnippetTextEdit TextEdit]
func AsAnnotatedTextEdits ¶
func AsAnnotatedTextEdits(edits []TextEdit) []Or_TextDocumentEdit_edits_Elem
AsAnnotatedTextEdits converts a slice of TextEdits to a slice of Or_TextDocumentEdit_edits_Elem. (returning a typed nil is required in server: in code_action.go and command.go))
func (Or_TextDocumentEdit_edits_Elem) MarshalJSON ¶
func (t Or_TextDocumentEdit_edits_Elem) MarshalJSON() ([]byte, error)
func (*Or_TextDocumentEdit_edits_Elem) UnmarshalJSON ¶
func (t *Or_TextDocumentEdit_edits_Elem) UnmarshalJSON(x []byte) error
type Or_TextDocumentFilter ¶
type Or_TextDocumentFilter struct {
Value interface{} `json:"value"`
}
created for Or [TextDocumentFilterLanguage TextDocumentFilterPattern TextDocumentFilterScheme]
func (Or_TextDocumentFilter) MarshalJSON ¶
func (t Or_TextDocumentFilter) MarshalJSON() ([]byte, error)
func (*Or_TextDocumentFilter) UnmarshalJSON ¶
func (t *Or_TextDocumentFilter) UnmarshalJSON(x []byte) error
type Or_TextDocumentSyncOptions_save ¶
type Or_TextDocumentSyncOptions_save struct {
Value interface{} `json:"value"`
}
created for Or [SaveOptions bool]
func (Or_TextDocumentSyncOptions_save) MarshalJSON ¶
func (t Or_TextDocumentSyncOptions_save) MarshalJSON() ([]byte, error)
func (*Or_TextDocumentSyncOptions_save) UnmarshalJSON ¶
func (t *Or_TextDocumentSyncOptions_save) UnmarshalJSON(x []byte) error
type Or_WorkspaceDocumentDiagnosticReport ¶
type Or_WorkspaceDocumentDiagnosticReport struct {
Value interface{} `json:"value"`
}
created for Or [WorkspaceFullDocumentDiagnosticReport WorkspaceUnchangedDocumentDiagnosticReport]
func (Or_WorkspaceDocumentDiagnosticReport) MarshalJSON ¶
func (t Or_WorkspaceDocumentDiagnosticReport) MarshalJSON() ([]byte, error)
func (*Or_WorkspaceDocumentDiagnosticReport) UnmarshalJSON ¶
func (t *Or_WorkspaceDocumentDiagnosticReport) UnmarshalJSON(x []byte) error
type Or_WorkspaceEdit_documentChanges_Elem ¶
type Or_WorkspaceEdit_documentChanges_Elem struct {
Value interface{} `json:"value"`
}
created for Or [CreateFile DeleteFile RenameFile TextDocumentEdit]
func (Or_WorkspaceEdit_documentChanges_Elem) MarshalJSON ¶
func (t Or_WorkspaceEdit_documentChanges_Elem) MarshalJSON() ([]byte, error)
func (*Or_WorkspaceEdit_documentChanges_Elem) UnmarshalJSON ¶
func (t *Or_WorkspaceEdit_documentChanges_Elem) UnmarshalJSON(x []byte) error
type Or_WorkspaceOptions_textDocumentContent ¶ added in v0.17.0
type Or_WorkspaceOptions_textDocumentContent struct {
Value interface{} `json:"value"`
}
created for Or [TextDocumentContentOptions TextDocumentContentRegistrationOptions]
func (Or_WorkspaceOptions_textDocumentContent) MarshalJSON ¶ added in v0.17.0
func (t Or_WorkspaceOptions_textDocumentContent) MarshalJSON() ([]byte, error)
func (*Or_WorkspaceOptions_textDocumentContent) UnmarshalJSON ¶ added in v0.17.0
func (t *Or_WorkspaceOptions_textDocumentContent) UnmarshalJSON(x []byte) error
type Or_textDocument_declaration ¶
type Or_textDocument_declaration struct {
Value interface{} `json:"value"`
}
created for Or [Declaration []DeclarationLink]
func (Or_textDocument_declaration) MarshalJSON ¶
func (t Or_textDocument_declaration) MarshalJSON() ([]byte, error)
func (*Or_textDocument_declaration) UnmarshalJSON ¶
func (t *Or_textDocument_declaration) UnmarshalJSON(x []byte) error
type PRangeESemanticTokensOptions ¶
type PRangeESemanticTokensOptions struct { }
created for Literal (Lit_SemanticTokensOptions_range_Item1)
type ParamConfiguration ¶
type ParamConfiguration struct {
Items []ConfigurationItem `json:"items"`
}
The parameters of a configuration request.
type ParamInitialize ¶
type ParamInitialize struct { XInitializeParams WorkspaceFoldersInitializeParams }
type ParameterInformation ¶
type ParameterInformation struct { // The label of this parameter information. // // Either a string or an inclusive start and exclusive end offsets within its containing // signature label. (see SignatureInformation.label). The offsets are based on a UTF-16 // string representation as `Position` and `Range` does. // // To avoid ambiguities a server should use the [start, end] offset value instead of using // a substring. Whether a client support this is controlled via `labelOffsetSupport` client // capability. // // *Note*: a label of type string should be a substring of its containing signature label. // Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`. Label string `json:"label"` // The human-readable doc-comment of this parameter. Will be shown // in the UI but can be omitted. Documentation string `json:"documentation,omitempty"` }
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
type PartialResultParams ¶
type PartialResultParams struct { // An optional token that a server can use to report partial results (e.g. streaming) to // the client. PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"` }
type Pattern ¶
type Pattern = string // (alias)
The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
- `*` to match one or more characters in a path segment
- `?` to match on one character in a path segment
- `**` to match any number of path segments, including none
- `{}` to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
@since 3.17.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#pattern
type Position ¶
type Position struct { // Line position in a document (zero-based). // // If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document. // If a line number is negative, it defaults to 0. Line uint32 `json:"line"` // Character offset on a line in a document (zero-based). // // The meaning of this offset is determined by the negotiated // `PositionEncodingKind`. // // If the character value is greater than the line length it defaults back to the // line length. Character uint32 `json:"character"` }
Position in a text document expressed as zero-based line and character offset. Prior to 3.17 the offsets were always based on a UTF-16 string representation. So a string of the form `a𐐀b` the character offset of the character `a` is 0, the character offset of `𐐀` is 1 and the character offset of b is 3 since `𐐀` is represented using two code units in UTF-16. Since 3.17 clients and servers can agree on a different string encoding representation (e.g. UTF-8). The client announces it's supported encoding via the client capability [`general.positionEncodings`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#clientCapabilities). The value is an array of position encodings the client supports, with decreasing preference (e.g. the encoding at index `0` is the most preferred one). To stay backwards compatible the only mandatory encoding is UTF-16 represented via the string `utf-16`. The server can pick one of the encodings offered by the client and signals that encoding back to the client via the initialize result's property [`capabilities.positionEncoding`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#serverCapabilities). If the string value `utf-16` is missing from the client's capability `general.positionEncodings` servers can safely assume that the client supports UTF-16. If the server omits the position encoding in its initialize result the encoding defaults to the string value `utf-16`. Implementation considerations: since the conversion from one encoding into another requires the content of the file / line the conversion is best done where the file is read which is usually on the server side.
Positions are line end character agnostic. So you can not specify a position that denotes `\r|\n` or `\n|` where `|` represents the character offset.
@since 3.17.0 - support for negotiated position encoding.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#position
type PositionEncodingKind ¶
type PositionEncodingKind string
A set of predefined position encoding kinds.
@since 3.17.0
type PrepareRenameDefaultBehavior ¶
type PrepareRenameDefaultBehavior struct {
DefaultBehavior bool `json:"defaultBehavior"`
}
@since 3.18.0
type PrepareRenameParams ¶
type PrepareRenameParams struct { TextDocumentPositionParams WorkDoneProgressParams }
type PrepareRenamePlaceholder ¶
type PrepareRenamePlaceholder struct { Range Range `json:"range"` Placeholder string `json:"placeholder"` }
@since 3.18.0
type PrepareRenameResult ¶
type PrepareRenameResult = PrepareRenamePlaceholder // (alias)
type PrepareSupportDefaultBehavior ¶
type PrepareSupportDefaultBehavior uint32
type PreviousResultID ¶
type PreviousResultID struct { // The URI for which the client knowns a // result id. URI DocumentURI `json:"uri"` // The value of the previous result id. Value string `json:"value"` }
A previous result id in a workspace pull request.
@since 3.17.0
type PreviousResultId ¶
type PreviousResultId struct { // The URI for which the client knowns a // result id. URI DocumentURI `json:"uri"` // The value of the previous result id. Value string `json:"value"` }
A previous result id in a workspace pull request.
@since 3.17.0
type ProgressParams ¶
type ProgressParams struct { // The progress token provided by the client or server. Token ProgressToken `json:"token"` // The progress data. Value interface{} `json:"value"` }
type ProgressToken ¶
type ProgressToken = interface{} // (alias)
type PublishDiagnosticsClientCapabilities ¶
type PublishDiagnosticsClientCapabilities struct { // Whether the client interprets the version property of the // `textDocument/publishDiagnostics` notification's parameter. // // @since 3.15.0 VersionSupport bool `json:"versionSupport,omitempty"` DiagnosticsCapabilities }
The publish diagnostic client capabilities.
type 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 int32 `json:"version,omitempty"` // An array of diagnostic information items. Diagnostics []Diagnostic `json:"diagnostics"` }
The publish diagnostic notification's parameters.
type Range ¶
type Range struct { // The range's start position. Start Position `json:"start"` // The range's end position. End Position `json:"end"` }
A range in a text document expressed as (zero-based) start and end positions.
If you want to specify a range that contains a line including the line ending character(s) then use an end position denoting the start of the next line. For example: ```ts
{ start: { line: 5, character: 23 } end : { line 6, character : 0 } }
```
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#range
type ReferenceClientCapabilities ¶
type ReferenceClientCapabilities struct { // Whether references supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
Client Capabilities for a {@link ReferencesRequest}.
type ReferenceContext ¶
type ReferenceContext struct { // Include the declaration of the current symbol. IncludeDeclaration bool `json:"includeDeclaration"` }
Value-object that contains additional information when requesting references.
type ReferenceParams ¶
type ReferenceParams struct { Context ReferenceContext `json:"context"` TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
Parameters for a {@link ReferencesRequest}.
type ReferenceRegistrationOptions ¶
type ReferenceRegistrationOptions struct { TextDocumentRegistrationOptions ReferenceOptions }
Registration options for a {@link ReferencesRequest}.
type Registration ¶
type Registration struct { // The id used to register the request. The id can be used to deregister // the request again. ID string `json:"id"` // The method / capability to register for. Method string `json:"method"` // Options necessary for the registration. RegisterOptions interface{} `json:"registerOptions,omitempty"` }
General parameters to register for a notification or to register a provider.
type RegistrationParams ¶
type RegistrationParams struct {
Registrations []Registration `json:"registrations"`
}
type RegularExpressionEngineKind ¶ added in v0.16.0
type RegularExpressionEngineKind = string // (alias)
type RegularExpressionsClientCapabilities ¶
type RegularExpressionsClientCapabilities struct { // The engine's name. Engine RegularExpressionEngineKind `json:"engine"` // The engine's version. Version string `json:"version,omitempty"` }
Client capabilities specific to regular expressions.
@since 3.16.0
type RelatedFullDocumentDiagnosticReport ¶
type RelatedFullDocumentDiagnosticReport struct { // Diagnostics of related documents. This information is useful // in programming languages where code in a file A can generate // diagnostics in a file B which A depends on. An example of // such a language is C/C++ where marco definitions in a file // a.cpp and result in errors in a header file b.hpp. // // @since 3.17.0 RelatedDocuments map[DocumentURI]interface{} `json:"relatedDocuments,omitempty"` FullDocumentDiagnosticReport }
A full diagnostic report with a set of related documents.
@since 3.17.0
type RelatedUnchangedDocumentDiagnosticReport ¶
type RelatedUnchangedDocumentDiagnosticReport struct { // Diagnostics of related documents. This information is useful // in programming languages where code in a file A can generate // diagnostics in a file B which A depends on. An example of // such a language is C/C++ where marco definitions in a file // a.cpp and result in errors in a header file b.hpp. // // @since 3.17.0 RelatedDocuments map[DocumentURI]interface{} `json:"relatedDocuments,omitempty"` UnchangedDocumentDiagnosticReport }
An unchanged diagnostic report with a set of related documents.
@since 3.17.0
type RelativePattern ¶
type RelativePattern struct { // A workspace folder or a base URI to which this pattern will be matched // against relatively. BaseURI DocumentURI `json:"baseUri"` // The actual glob pattern; Pattern Pattern `json:"pattern"` }
A relative pattern is a helper to construct glob patterns that are matched relatively to a base URI. The common value for a `baseUri` is a workspace folder root, but it can be another absolute URI as well.
@since 3.17.0
type RenameClientCapabilities ¶
type RenameClientCapabilities struct { // Whether rename supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Client supports testing for validity of rename operations // before execution. // // @since 3.12.0 PrepareSupport bool `json:"prepareSupport,omitempty"` // Client supports the default behavior result. // // The value indicates the default behavior used by the // client. // // @since 3.16.0 PrepareSupportDefaultBehavior *PrepareSupportDefaultBehavior `json:"prepareSupportDefaultBehavior,omitempty"` // Whether the client honors the change annotations in // text edits and resource operations returned via the // rename request's workspace edit by for example presenting // the workspace edit in the user interface and asking // for confirmation. // // @since 3.16.0 HonorsChangeAnnotations bool `json:"honorsChangeAnnotations,omitempty"` }
type RenameFile ¶
type RenameFile struct { // A rename Kind string `json:"kind"` // The old (existing) location. OldURI DocumentURI `json:"oldUri"` // The new location. NewURI DocumentURI `json:"newUri"` // Rename options. Options *RenameFileOptions `json:"options,omitempty"` ResourceOperation }
Rename file operation
type RenameFileOptions ¶
type RenameFileOptions struct { // Overwrite target if existing. Overwrite wins over `ignoreIfExists` Overwrite bool `json:"overwrite,omitempty"` // Ignores if target exists. IgnoreIfExists bool `json:"ignoreIfExists,omitempty"` }
Rename file options
type RenameFilesParams ¶
type RenameFilesParams struct { // An array of all files/folders renamed in this operation. When a folder is renamed, only // the folder will be included, and not its children. Files []FileRename `json:"files"` }
The parameters sent in notifications/requests for user-initiated renames of files.
@since 3.16.0
type RenameOptions ¶
type RenameOptions struct { // Renames should be checked and tested before being executed. // // @since version 3.12.0 PrepareProvider bool `json:"prepareProvider,omitempty"` WorkDoneProgressOptions }
Provider options for a {@link RenameRequest}.
type RenameParams ¶
type RenameParams struct { // The document to rename. TextDocument TextDocumentIdentifier `json:"textDocument"` // The position at which this request was sent. Position Position `json:"position"` // The new name of the symbol. If the given name is not valid the // request must return a {@link ResponseError} with an // appropriate message set. NewName string `json:"newName"` WorkDoneProgressParams }
The parameters of a {@link RenameRequest}.
type RenameRegistrationOptions ¶
type RenameRegistrationOptions struct { TextDocumentRegistrationOptions RenameOptions }
Registration options for a {@link RenameRequest}.
type ResourceOperation ¶
type ResourceOperation struct { // The resource operation kind. Kind string `json:"kind"` // An optional annotation identifier describing the operation. // // @since 3.16.0 AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"` }
A generic resource operation.
type ResourceOperationKind ¶
type ResourceOperationKind string
type SaveOptions ¶
type SaveOptions struct { // The client is supposed to include the content on save. IncludeText bool `json:"includeText,omitempty"` }
Save options.
type SelectedCompletionInfo ¶
type SelectedCompletionInfo struct { // The range that will be replaced if this completion item is accepted. Range Range `json:"range"` // The text the range will be replaced with if this completion is accepted. Text string `json:"text"` }
Describes the currently selected completion item.
@since 3.18.0 @proposed
type SelectionRange ¶
type SelectionRange struct { // The {@link Range range} of this selection range. Range Range `json:"range"` // The parent selection range containing this range. Therefore `parent.range` must contain `this.range`. Parent *SelectionRange `json:"parent,omitempty"` }
A selection range represents a part of a selection hierarchy. A selection range may have a parent selection range that contains it.
type SelectionRangeClientCapabilities ¶
type SelectionRangeClientCapabilities struct { // Whether implementation supports dynamic registration for selection range providers. If this is set to `true` // the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server // capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
type SelectionRangeOptions ¶
type SelectionRangeOptions struct {
WorkDoneProgressOptions
}
type SelectionRangeParams ¶
type SelectionRangeParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` // The positions inside the text document. Positions []Position `json:"positions"` WorkDoneProgressParams PartialResultParams }
A parameter literal used in selection range requests.
type SelectionRangeRegistrationOptions ¶
type SelectionRangeRegistrationOptions struct { SelectionRangeOptions TextDocumentRegistrationOptions StaticRegistrationOptions }
type SemanticTokenModifiers ¶
type SemanticTokenModifiers string
A set of predefined token modifiers. This set is not fixed an clients can specify additional token types via the corresponding client capabilities.
@since 3.16.0
type SemanticTokenTypes ¶
type SemanticTokenTypes string
A set of predefined token types. This set is not fixed an clients can specify additional token types via the corresponding client capabilities.
@since 3.16.0
type SemanticTokens ¶
type SemanticTokens struct { // An optional result id. If provided and clients support delta updating // the client will include the result id in the next semantic token request. // A server can then instead of computing all semantic tokens again simply // send a delta. ResultID string `json:"resultId,omitempty"` // The actual tokens. Data []uint32 `json:"data"` }
@since 3.16.0
type SemanticTokensClientCapabilities ¶
type SemanticTokensClientCapabilities struct { // Whether implementation supports dynamic registration. If this is set to `true` // the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` // return value for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Which requests the client supports and might send to the server // depending on the server's capability. Please note that clients might not // show semantic tokens or degrade some of the user experience if a range // or full request is advertised by the client but not provided by the // server. If for example the client capability `requests.full` and // `request.range` are both set to true but the server only provides a // range provider the client might not render a minimap correctly or might // even decide to not show any semantic tokens at all. Requests ClientSemanticTokensRequestOptions `json:"requests"` // The token types that the client supports. TokenTypes []string `json:"tokenTypes"` // The token modifiers that the client supports. TokenModifiers []string `json:"tokenModifiers"` // The token formats the clients supports. Formats []TokenFormat `json:"formats"` // Whether the client supports tokens that can overlap each other. OverlappingTokenSupport bool `json:"overlappingTokenSupport,omitempty"` // Whether the client supports tokens that can span multiple lines. MultilineTokenSupport bool `json:"multilineTokenSupport,omitempty"` // Whether the client allows the server to actively cancel a // semantic token request, e.g. supports returning // LSPErrorCodes.ServerCancelled. If a server does the client // needs to retrigger the request. // // @since 3.17.0 ServerCancelSupport bool `json:"serverCancelSupport,omitempty"` // Whether the client uses semantic tokens to augment existing // syntax tokens. If set to `true` client side created syntax // tokens and semantic tokens are both used for colorization. If // set to `false` the client only uses the returned semantic tokens // for colorization. // // If the value is `undefined` then the client behavior is not // specified. // // @since 3.17.0 AugmentsSyntaxTokens bool `json:"augmentsSyntaxTokens,omitempty"` }
@since 3.16.0
type SemanticTokensDelta ¶
type SemanticTokensDelta struct { ResultID string `json:"resultId,omitempty"` // The semantic token edits to transform a previous result into a new result. Edits []SemanticTokensEdit `json:"edits"` }
@since 3.16.0
type SemanticTokensDeltaParams ¶
type SemanticTokensDeltaParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` // The result id of a previous response. The result Id can either point to a full response // or a delta response depending on what was received last. PreviousResultID string `json:"previousResultId"` WorkDoneProgressParams PartialResultParams }
@since 3.16.0
type SemanticTokensDeltaPartialResult ¶
type SemanticTokensDeltaPartialResult struct {
Edits []SemanticTokensEdit `json:"edits"`
}
@since 3.16.0
type SemanticTokensEdit ¶
type SemanticTokensEdit struct { // The start offset of the edit. Start uint32 `json:"start"` // The count of elements to remove. DeleteCount uint32 `json:"deleteCount"` // The elements to insert. Data []uint32 `json:"data,omitempty"` }
@since 3.16.0
type SemanticTokensFullDelta ¶
type SemanticTokensFullDelta struct { // The server supports deltas for full documents. Delta bool `json:"delta,omitempty"` }
Semantic tokens options to support deltas for full documents
@since 3.18.0
type SemanticTokensLegend ¶
type SemanticTokensLegend struct { // The token types a server uses. TokenTypes []string `json:"tokenTypes"` // The token modifiers a server uses. TokenModifiers []string `json:"tokenModifiers"` }
@since 3.16.0
type SemanticTokensOptions ¶
type SemanticTokensOptions struct { // The legend used by the server Legend SemanticTokensLegend `json:"legend"` // Server supports providing semantic tokens for a specific range // of a document. Range *Or_SemanticTokensOptions_range `json:"range,omitempty"` // Server supports providing semantic tokens for a full document. Full *Or_SemanticTokensOptions_full `json:"full,omitempty"` WorkDoneProgressOptions }
@since 3.16.0
type SemanticTokensParams ¶
type SemanticTokensParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` WorkDoneProgressParams PartialResultParams }
@since 3.16.0
type SemanticTokensPartialResult ¶
type SemanticTokensPartialResult struct {
Data []uint32 `json:"data"`
}
@since 3.16.0
type SemanticTokensRangeParams ¶
type SemanticTokensRangeParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` // The range the semantic tokens are requested for. Range Range `json:"range"` WorkDoneProgressParams PartialResultParams }
@since 3.16.0
type SemanticTokensRegistrationOptions ¶
type SemanticTokensRegistrationOptions struct { TextDocumentRegistrationOptions SemanticTokensOptions StaticRegistrationOptions }
@since 3.16.0
type SemanticTokensWorkspaceClientCapabilities ¶
type SemanticTokensWorkspaceClientCapabilities struct { // Whether the client implementation supports a refresh request sent from // the server to the client. // // Note that this event is global and will force the client to refresh all // semantic tokens currently shown. It should be used with absolute care // and is useful for situation where a server for example detects a project // wide change that requires such a calculation. RefreshSupport bool `json:"refreshSupport,omitempty"` }
@since 3.16.0
type Server ¶
type Server interface { // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#progress Progress(context.Context, *ProgressParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#setTrace SetTrace(context.Context, *SetTraceParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#callHierarchy_incomingCalls IncomingCalls(context.Context, *CallHierarchyIncomingCallsParams) ([]CallHierarchyIncomingCall, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#callHierarchy_outgoingCalls OutgoingCalls(context.Context, *CallHierarchyOutgoingCallsParams) ([]CallHierarchyOutgoingCall, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#codeAction_resolve ResolveCodeAction(context.Context, *CodeAction) (*CodeAction, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#codeLens_resolve ResolveCodeLens(context.Context, *CodeLens) (*CodeLens, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#completionItem_resolve ResolveCompletionItem(context.Context, *CompletionItem) (*CompletionItem, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#documentLink_resolve ResolveDocumentLink(context.Context, *DocumentLink) (*DocumentLink, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#exit Exit(context.Context) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#initialize Initialize(context.Context, *ParamInitialize) (*InitializeResult, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#initialized Initialized(context.Context, *InitializedParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#inlayHint_resolve Resolve(context.Context, *InlayHint) (*InlayHint, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#notebookDocument_didChange DidChangeNotebookDocument(context.Context, *DidChangeNotebookDocumentParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#notebookDocument_didClose DidCloseNotebookDocument(context.Context, *DidCloseNotebookDocumentParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#notebookDocument_didOpen DidOpenNotebookDocument(context.Context, *DidOpenNotebookDocumentParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#notebookDocument_didSave DidSaveNotebookDocument(context.Context, *DidSaveNotebookDocumentParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#shutdown Shutdown(context.Context) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_codeAction CodeAction(context.Context, *CodeActionParams) ([]CodeAction, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_codeLens CodeLens(context.Context, *CodeLensParams) ([]CodeLens, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_colorPresentation ColorPresentation(context.Context, *ColorPresentationParams) ([]ColorPresentation, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_completion Completion(context.Context, *CompletionParams) (*CompletionList, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_declaration Declaration(context.Context, *DeclarationParams) (*Or_textDocument_declaration, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_definition Definition(context.Context, *DefinitionParams) ([]Location, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_diagnostic Diagnostic(context.Context, *DocumentDiagnosticParams) (*DocumentDiagnosticReport, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_didChange DidChange(context.Context, *DidChangeTextDocumentParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_didClose DidClose(context.Context, *DidCloseTextDocumentParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_didOpen DidOpen(context.Context, *DidOpenTextDocumentParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_didSave DidSave(context.Context, *DidSaveTextDocumentParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_documentColor DocumentColor(context.Context, *DocumentColorParams) ([]ColorInformation, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_documentHighlight DocumentHighlight(context.Context, *DocumentHighlightParams) ([]DocumentHighlight, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_documentLink DocumentLink(context.Context, *DocumentLinkParams) ([]DocumentLink, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_documentSymbol DocumentSymbol(context.Context, *DocumentSymbolParams) ([]interface{}, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_foldingRange FoldingRange(context.Context, *FoldingRangeParams) ([]FoldingRange, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_formatting Formatting(context.Context, *DocumentFormattingParams) ([]TextEdit, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_hover Hover(context.Context, *HoverParams) (*Hover, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_implementation Implementation(context.Context, *ImplementationParams) ([]Location, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_inlayHint InlayHint(context.Context, *InlayHintParams) ([]InlayHint, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_inlineCompletion InlineCompletion(context.Context, *InlineCompletionParams) (*Or_Result_textDocument_inlineCompletion, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_inlineValue InlineValue(context.Context, *InlineValueParams) ([]InlineValue, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_linkedEditingRange LinkedEditingRange(context.Context, *LinkedEditingRangeParams) (*LinkedEditingRanges, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_moniker Moniker(context.Context, *MonikerParams) ([]Moniker, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_onTypeFormatting OnTypeFormatting(context.Context, *DocumentOnTypeFormattingParams) ([]TextEdit, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_prepareCallHierarchy PrepareCallHierarchy(context.Context, *CallHierarchyPrepareParams) ([]CallHierarchyItem, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_prepareRename PrepareRename(context.Context, *PrepareRenameParams) (*PrepareRenameResult, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_prepareTypeHierarchy PrepareTypeHierarchy(context.Context, *TypeHierarchyPrepareParams) ([]TypeHierarchyItem, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_rangeFormatting RangeFormatting(context.Context, *DocumentRangeFormattingParams) ([]TextEdit, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_rangesFormatting RangesFormatting(context.Context, *DocumentRangesFormattingParams) ([]TextEdit, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_references References(context.Context, *ReferenceParams) ([]Location, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_rename Rename(context.Context, *RenameParams) (*WorkspaceEdit, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_selectionRange SelectionRange(context.Context, *SelectionRangeParams) ([]SelectionRange, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_semanticTokens_full SemanticTokensFull(context.Context, *SemanticTokensParams) (*SemanticTokens, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_semanticTokens_full_delta SemanticTokensFullDelta(context.Context, *SemanticTokensDeltaParams) (interface{}, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_semanticTokens_range SemanticTokensRange(context.Context, *SemanticTokensRangeParams) (*SemanticTokens, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_signatureHelp SignatureHelp(context.Context, *SignatureHelpParams) (*SignatureHelp, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_typeDefinition TypeDefinition(context.Context, *TypeDefinitionParams) ([]Location, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_willSave WillSave(context.Context, *WillSaveTextDocumentParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocument_willSaveWaitUntil WillSaveWaitUntil(context.Context, *WillSaveTextDocumentParams) ([]TextEdit, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#typeHierarchy_subtypes Subtypes(context.Context, *TypeHierarchySubtypesParams) ([]TypeHierarchyItem, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#typeHierarchy_supertypes Supertypes(context.Context, *TypeHierarchySupertypesParams) ([]TypeHierarchyItem, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#window_workDoneProgress_cancel WorkDoneProgressCancel(context.Context, *WorkDoneProgressCancelParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_diagnostic DiagnosticWorkspace(context.Context, *WorkspaceDiagnosticParams) (*WorkspaceDiagnosticReport, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_didChangeConfiguration DidChangeConfiguration(context.Context, *DidChangeConfigurationParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_didChangeWatchedFiles DidChangeWatchedFiles(context.Context, *DidChangeWatchedFilesParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_didChangeWorkspaceFolders DidChangeWorkspaceFolders(context.Context, *DidChangeWorkspaceFoldersParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_didCreateFiles DidCreateFiles(context.Context, *CreateFilesParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_didDeleteFiles DidDeleteFiles(context.Context, *DeleteFilesParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_didRenameFiles DidRenameFiles(context.Context, *RenameFilesParams) error // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_executeCommand ExecuteCommand(context.Context, *ExecuteCommandParams) (interface{}, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_symbol Symbol(context.Context, *WorkspaceSymbolParams) ([]SymbolInformation, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_textDocumentContent TextDocumentContent(context.Context, *TextDocumentContentParams) (*string, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_willCreateFiles WillCreateFiles(context.Context, *CreateFilesParams) (*WorkspaceEdit, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_willDeleteFiles WillDeleteFiles(context.Context, *DeleteFilesParams) (*WorkspaceEdit, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspace_willRenameFiles WillRenameFiles(context.Context, *RenameFilesParams) (*WorkspaceEdit, error) // See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspaceSymbol_resolve ResolveWorkspaceSymbol(context.Context, *WorkspaceSymbol) (*WorkspaceSymbol, error) }
func ServerDispatcher ¶
ServerDispatcher returns a Server that dispatches LSP requests across the given jsonrpc2 connection.
func ServerDispatcherV2 ¶
func ServerDispatcherV2(conn *jsonrpc2_v2.Connection) Server
type ServerCapabilities ¶
type ServerCapabilities struct { // The position encoding the server picked from the encodings offered // by the client via the client capability `general.positionEncodings`. // // If the client didn't provide any position encodings the only valid // value that a server can return is 'utf-16'. // // If omitted it defaults to 'utf-16'. // // @since 3.17.0 PositionEncoding *PositionEncodingKind `json:"positionEncoding,omitempty"` // Defines how text documents are synced. Is either a detailed structure // defining each notification or for backwards compatibility the // TextDocumentSyncKind number. TextDocumentSync interface{} `json:"textDocumentSync,omitempty"` // Defines how notebook documents are synced. // // @since 3.17.0 NotebookDocumentSync *Or_ServerCapabilities_notebookDocumentSync `json:"notebookDocumentSync,omitempty"` // The server provides completion support. CompletionProvider *CompletionOptions `json:"completionProvider,omitempty"` // The server provides hover support. HoverProvider *Or_ServerCapabilities_hoverProvider `json:"hoverProvider,omitempty"` // The server provides signature help support. SignatureHelpProvider *SignatureHelpOptions `json:"signatureHelpProvider,omitempty"` // The server provides Goto Declaration support. DeclarationProvider *Or_ServerCapabilities_declarationProvider `json:"declarationProvider,omitempty"` // The server provides goto definition support. DefinitionProvider *Or_ServerCapabilities_definitionProvider `json:"definitionProvider,omitempty"` // The server provides Goto Type Definition support. TypeDefinitionProvider *Or_ServerCapabilities_typeDefinitionProvider `json:"typeDefinitionProvider,omitempty"` // The server provides Goto Implementation support. ImplementationProvider *Or_ServerCapabilities_implementationProvider `json:"implementationProvider,omitempty"` // The server provides find references support. ReferencesProvider *Or_ServerCapabilities_referencesProvider `json:"referencesProvider,omitempty"` // The server provides document highlight support. DocumentHighlightProvider *Or_ServerCapabilities_documentHighlightProvider `json:"documentHighlightProvider,omitempty"` // The server provides document symbol support. DocumentSymbolProvider *Or_ServerCapabilities_documentSymbolProvider `json:"documentSymbolProvider,omitempty"` // The server provides code actions. CodeActionOptions may only be // specified if the client states that it supports // `codeActionLiteralSupport` in its initial `initialize` request. CodeActionProvider interface{} `json:"codeActionProvider,omitempty"` // The server provides code lens. CodeLensProvider *CodeLensOptions `json:"codeLensProvider,omitempty"` // The server provides document link support. DocumentLinkProvider *DocumentLinkOptions `json:"documentLinkProvider,omitempty"` // The server provides color provider support. ColorProvider *Or_ServerCapabilities_colorProvider `json:"colorProvider,omitempty"` // The server provides workspace symbol support. WorkspaceSymbolProvider *Or_ServerCapabilities_workspaceSymbolProvider `json:"workspaceSymbolProvider,omitempty"` // The server provides document formatting. DocumentFormattingProvider *Or_ServerCapabilities_documentFormattingProvider `json:"documentFormattingProvider,omitempty"` // The server provides document range formatting. DocumentRangeFormattingProvider *Or_ServerCapabilities_documentRangeFormattingProvider `json:"documentRangeFormattingProvider,omitempty"` // The server provides document formatting on typing. DocumentOnTypeFormattingProvider *DocumentOnTypeFormattingOptions `json:"documentOnTypeFormattingProvider,omitempty"` // The server provides rename support. RenameOptions may only be // specified if the client states that it supports // `prepareSupport` in its initial `initialize` request. RenameProvider interface{} `json:"renameProvider,omitempty"` // The server provides folding provider support. FoldingRangeProvider *Or_ServerCapabilities_foldingRangeProvider `json:"foldingRangeProvider,omitempty"` // The server provides selection range support. SelectionRangeProvider *Or_ServerCapabilities_selectionRangeProvider `json:"selectionRangeProvider,omitempty"` // The server provides execute command support. ExecuteCommandProvider *ExecuteCommandOptions `json:"executeCommandProvider,omitempty"` // The server provides call hierarchy support. // // @since 3.16.0 CallHierarchyProvider *Or_ServerCapabilities_callHierarchyProvider `json:"callHierarchyProvider,omitempty"` // The server provides linked editing range support. // // @since 3.16.0 LinkedEditingRangeProvider *Or_ServerCapabilities_linkedEditingRangeProvider `json:"linkedEditingRangeProvider,omitempty"` // The server provides semantic tokens support. // // @since 3.16.0 SemanticTokensProvider interface{} `json:"semanticTokensProvider,omitempty"` // The server provides moniker support. // // @since 3.16.0 MonikerProvider *Or_ServerCapabilities_monikerProvider `json:"monikerProvider,omitempty"` // The server provides type hierarchy support. // // @since 3.17.0 TypeHierarchyProvider *Or_ServerCapabilities_typeHierarchyProvider `json:"typeHierarchyProvider,omitempty"` // The server provides inline values. // // @since 3.17.0 InlineValueProvider *Or_ServerCapabilities_inlineValueProvider `json:"inlineValueProvider,omitempty"` // The server provides inlay hints. // // @since 3.17.0 InlayHintProvider interface{} `json:"inlayHintProvider,omitempty"` // The server has support for pull model diagnostics. // // @since 3.17.0 DiagnosticProvider *Or_ServerCapabilities_diagnosticProvider `json:"diagnosticProvider,omitempty"` // Inline completion options used during static registration. // // @since 3.18.0 // @proposed InlineCompletionProvider *Or_ServerCapabilities_inlineCompletionProvider `json:"inlineCompletionProvider,omitempty"` // Workspace specific server capabilities. Workspace *WorkspaceOptions `json:"workspace,omitempty"` // Experimental server capabilities. Experimental interface{} `json:"experimental,omitempty"` }
Defines the capabilities provided by a language server.
type ServerCompletionItemOptions ¶
type ServerCompletionItemOptions struct { // The server has support for completion item label // details (see also `CompletionItemLabelDetails`) when // receiving a completion item in a resolve call. // // @since 3.17.0 LabelDetailsSupport bool `json:"labelDetailsSupport,omitempty"` }
@since 3.18.0
type ServerInfo ¶
type ServerInfo struct { // The name of the server as defined by the server. Name string `json:"name"` // The server's version as defined by the server. Version string `json:"version,omitempty"` }
Information about the server
@since 3.15.0 @since 3.18.0 ServerInfo type name added.
type SetTraceParams ¶
type SetTraceParams struct {
Value TraceValue `json:"value"`
}
type ShowDocumentClientCapabilities ¶
type ShowDocumentClientCapabilities struct { // The client has support for the showDocument // request. Support bool `json:"support"` }
Client capabilities for the showDocument request.
@since 3.16.0
type ShowDocumentParams ¶
type ShowDocumentParams struct { // The uri to show. URI URI `json:"uri"` // Indicates to show the resource in an external program. // To show, for example, `https://code.visualstudio.com/` // in the default WEB browser set `external` to `true`. External bool `json:"external,omitempty"` // An optional property to indicate whether the editor // showing the document should take focus or not. // Clients might ignore this property if an external // program is started. TakeFocus bool `json:"takeFocus,omitempty"` // An optional selection range if the document is a text // document. Clients might ignore the property if an // external program is started or the file is not a text // file. Selection *Range `json:"selection,omitempty"` }
Params to show a resource in the UI.
@since 3.16.0
type ShowDocumentResult ¶
type ShowDocumentResult struct { // A boolean indicating if the show was successful. Success bool `json:"success"` }
The result of a showDocument request.
@since 3.16.0
type ShowMessageParams ¶
type ShowMessageParams struct { // The message type. See {@link MessageType} Type MessageType `json:"type"` // The actual message. Message string `json:"message"` }
The parameters of a notification message.
type ShowMessageRequestClientCapabilities ¶
type ShowMessageRequestClientCapabilities struct { // Capabilities specific to the `MessageActionItem` type. MessageActionItem *ClientShowMessageActionItemOptions `json:"messageActionItem,omitempty"` }
Show message request client capabilities
type ShowMessageRequestParams ¶
type ShowMessageRequestParams struct { // The message type. See {@link MessageType} Type MessageType `json:"type"` // The actual message. Message string `json:"message"` // The message action items to present. Actions []MessageActionItem `json:"actions,omitempty"` }
type SignatureHelp ¶
type SignatureHelp struct { // One or more signatures. Signatures []SignatureInformation `json:"signatures"` // The active signature. If omitted or the value lies outside the // range of `signatures` the value defaults to zero or is ignored if // the `SignatureHelp` has no signatures. // // Whenever possible implementors should make an active decision about // the active signature and shouldn't rely on a default value. // // In future version of the protocol this property might become // mandatory to better express this. ActiveSignature uint32 `json:"activeSignature,omitempty"` // The active parameter of the active signature. // // If `null`, no parameter of the signature is active (for example a named // argument that does not match any declared parameters). This is only valid // if the client specifies the client capability // `textDocument.signatureHelp.noActiveParameterSupport === true` // // If omitted or the value lies outside the range of // `signatures[activeSignature].parameters` defaults to 0 if the active // signature has parameters. // // If the active signature has no parameters it is ignored. // // In future version of the protocol this property might become // mandatory (but still nullable) to better express the active parameter if // the active signature does have any. ActiveParameter uint32 `json:"activeParameter,omitempty"` }
Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.
type SignatureHelpClientCapabilities ¶
type SignatureHelpClientCapabilities struct { // Whether signature help supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The client supports the following `SignatureInformation` // specific properties. SignatureInformation *ClientSignatureInformationOptions `json:"signatureInformation,omitempty"` // The client supports to send additional context information for a // `textDocument/signatureHelp` request. A client that opts into // contextSupport will also support the `retriggerCharacters` on // `SignatureHelpOptions`. // // @since 3.15.0 ContextSupport bool `json:"contextSupport,omitempty"` }
Client Capabilities for a {@link SignatureHelpRequest}.
type SignatureHelpContext ¶
type SignatureHelpContext struct { // Action that caused signature help to be triggered. TriggerKind SignatureHelpTriggerKind `json:"triggerKind"` // Character that caused signature help to be triggered. // // This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter` TriggerCharacter string `json:"triggerCharacter,omitempty"` // `true` if signature help was already showing when it was triggered. // // Retriggers occurs when the signature help is already active and can be caused by actions such as // typing a trigger character, a cursor move, or document content changes. IsRetrigger bool `json:"isRetrigger"` // The currently active `SignatureHelp`. // // The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on // the user navigating through available signatures. ActiveSignatureHelp *SignatureHelp `json:"activeSignatureHelp,omitempty"` }
Additional information about the context in which a signature help request was triggered.
@since 3.15.0
type SignatureHelpOptions ¶
type SignatureHelpOptions struct { // List of characters that trigger signature help automatically. TriggerCharacters []string `json:"triggerCharacters,omitempty"` // List of characters that re-trigger signature help. // // These trigger characters are only active when signature help is already showing. All trigger characters // are also counted as re-trigger characters. // // @since 3.15.0 RetriggerCharacters []string `json:"retriggerCharacters,omitempty"` WorkDoneProgressOptions }
Server Capabilities for a {@link SignatureHelpRequest}.
type SignatureHelpParams ¶
type SignatureHelpParams struct { // The signature help context. This is only available if the client specifies // to send this using the client capability `textDocument.signatureHelp.contextSupport === true` // // @since 3.15.0 Context *SignatureHelpContext `json:"context,omitempty"` TextDocumentPositionParams WorkDoneProgressParams }
Parameters for a {@link SignatureHelpRequest}.
type SignatureHelpRegistrationOptions ¶
type SignatureHelpRegistrationOptions struct { TextDocumentRegistrationOptions SignatureHelpOptions }
Registration options for a {@link SignatureHelpRequest}.
type SignatureHelpTriggerKind ¶
type SignatureHelpTriggerKind uint32
How a signature help was triggered.
@since 3.15.0
type SignatureInformation ¶
type SignatureInformation struct { // The label of this signature. Will be shown in // the UI. Label string `json:"label"` // The human-readable doc-comment of this signature. Will be shown // in the UI but can be omitted. Documentation *Or_SignatureInformation_documentation `json:"documentation,omitempty"` // The parameters of this signature. Parameters []ParameterInformation `json:"parameters,omitempty"` // The index of the active parameter. // // If `null`, no parameter of the signature is active (for example a named // argument that does not match any declared parameters). This is only valid // if the client specifies the client capability // `textDocument.signatureHelp.noActiveParameterSupport === true` // // If provided (or `null`), this is used in place of // `SignatureHelp.activeParameter`. // // @since 3.16.0 ActiveParameter uint32 `json:"activeParameter,omitempty"` }
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
type SnippetTextEdit ¶ added in v0.17.0
type SnippetTextEdit struct { // The range of the text document to be manipulated. Range Range `json:"range"` // The snippet to be inserted. Snippet StringValue `json:"snippet"` // The actual identifier of the snippet edit. AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"` }
An interactive text edit.
@since 3.18.0 @proposed
type StaleRequestSupportOptions ¶
type StaleRequestSupportOptions struct { // The client will actively cancel the request. Cancel bool `json:"cancel"` // The list of requests for which the client // will retry the request if it receives a // response with error code `ContentModified` RetryOnContentModified []string `json:"retryOnContentModified"` }
@since 3.18.0
type StaticRegistrationOptions ¶
type StaticRegistrationOptions struct { // The id used to register the request. The id can be used to deregister // the request again. See also Registration#id. ID string `json:"id,omitempty"` }
Static registration options to be returned in the initialize request.
type StringValue ¶
type StringValue struct { // The kind of string value. Kind string `json:"kind"` // The snippet string. Value string `json:"value"` }
A string value used as a snippet is a template which allows to insert text and to control the editor cursor when insertion happens.
A snippet can define tab stops and placeholders with `$1`, `$2` and `${3:foo}`. `$0` defines the final tab stop, it defaults to the end of the snippet. Variables are defined with `$name` and `${name:default value}`.
@since 3.18.0 @proposed
type SymbolInformation ¶
type SymbolInformation struct { // extends BaseSymbolInformation // Indicates if this symbol is deprecated. // // @deprecated Use tags instead Deprecated bool `json:"deprecated,omitempty"` // The location of this symbol. The location's range is used by a tool // to reveal the location in the editor. If the symbol is selected in the // tool the range's start information is used to position the cursor. So // the range usually spans more than the actual symbol's name and does // normally include things like visibility modifiers. // // The range doesn't have to denote a node range in the sense of an abstract // syntax tree. It can therefore not be used to re-construct a hierarchy of // the symbols. Location Location `json:"location"` // The name of this symbol. Name string `json:"name"` // The kind of this symbol. Kind SymbolKind `json:"kind"` // Tags for this symbol. // // @since 3.16.0 Tags []SymbolTag `json:"tags,omitempty"` // The name of the symbol containing this symbol. This information is for // user interface purposes (e.g. to render a qualifier in the user interface // if necessary). It can't be used to re-infer a hierarchy for the document // symbols. ContainerName string `json:"containerName,omitempty"` }
Represents information about programming constructs like variables, classes, interfaces etc.
type SymbolTag ¶
type SymbolTag uint32
Symbol tags are extra annotations that tweak the rendering of a symbol.
@since 3.16
type TextDocumentChangeRegistrationOptions ¶
type TextDocumentChangeRegistrationOptions struct { // How documents are synced to the server. SyncKind TextDocumentSyncKind `json:"syncKind"` TextDocumentRegistrationOptions }
Describe options to be used when registered for text document change events.
type TextDocumentClientCapabilities ¶
type TextDocumentClientCapabilities struct { // Defines which synchronization capabilities the client supports. Synchronization *TextDocumentSyncClientCapabilities `json:"synchronization,omitempty"` // Capabilities specific to the `textDocument/completion` request. Completion CompletionClientCapabilities `json:"completion,omitempty"` // Capabilities specific to the `textDocument/hover` request. Hover *HoverClientCapabilities `json:"hover,omitempty"` // Capabilities specific to the `textDocument/signatureHelp` request. SignatureHelp *SignatureHelpClientCapabilities `json:"signatureHelp,omitempty"` // Capabilities specific to the `textDocument/declaration` request. // // @since 3.14.0 Declaration *DeclarationClientCapabilities `json:"declaration,omitempty"` // Capabilities specific to the `textDocument/definition` request. Definition *DefinitionClientCapabilities `json:"definition,omitempty"` // Capabilities specific to the `textDocument/typeDefinition` request. // // @since 3.6.0 TypeDefinition *TypeDefinitionClientCapabilities `json:"typeDefinition,omitempty"` // Capabilities specific to the `textDocument/implementation` request. // // @since 3.6.0 Implementation *ImplementationClientCapabilities `json:"implementation,omitempty"` // Capabilities specific to the `textDocument/references` request. References *ReferenceClientCapabilities `json:"references,omitempty"` // Capabilities specific to the `textDocument/documentHighlight` request. DocumentHighlight *DocumentHighlightClientCapabilities `json:"documentHighlight,omitempty"` // Capabilities specific to the `textDocument/documentSymbol` request. DocumentSymbol DocumentSymbolClientCapabilities `json:"documentSymbol,omitempty"` // Capabilities specific to the `textDocument/codeAction` request. CodeAction CodeActionClientCapabilities `json:"codeAction,omitempty"` // Capabilities specific to the `textDocument/codeLens` request. CodeLens *CodeLensClientCapabilities `json:"codeLens,omitempty"` // Capabilities specific to the `textDocument/documentLink` request. DocumentLink *DocumentLinkClientCapabilities `json:"documentLink,omitempty"` // Capabilities specific to the `textDocument/documentColor` and the // `textDocument/colorPresentation` request. // // @since 3.6.0 ColorProvider *DocumentColorClientCapabilities `json:"colorProvider,omitempty"` // Capabilities specific to the `textDocument/formatting` request. Formatting *DocumentFormattingClientCapabilities `json:"formatting,omitempty"` // Capabilities specific to the `textDocument/rangeFormatting` request. RangeFormatting *DocumentRangeFormattingClientCapabilities `json:"rangeFormatting,omitempty"` // Capabilities specific to the `textDocument/onTypeFormatting` request. OnTypeFormatting *DocumentOnTypeFormattingClientCapabilities `json:"onTypeFormatting,omitempty"` // Capabilities specific to the `textDocument/rename` request. Rename *RenameClientCapabilities `json:"rename,omitempty"` // Capabilities specific to the `textDocument/foldingRange` request. // // @since 3.10.0 FoldingRange *FoldingRangeClientCapabilities `json:"foldingRange,omitempty"` // Capabilities specific to the `textDocument/selectionRange` request. // // @since 3.15.0 SelectionRange *SelectionRangeClientCapabilities `json:"selectionRange,omitempty"` // Capabilities specific to the `textDocument/publishDiagnostics` notification. PublishDiagnostics PublishDiagnosticsClientCapabilities `json:"publishDiagnostics,omitempty"` // Capabilities specific to the various call hierarchy requests. // // @since 3.16.0 CallHierarchy *CallHierarchyClientCapabilities `json:"callHierarchy,omitempty"` // Capabilities specific to the various semantic token request. // // @since 3.16.0 SemanticTokens SemanticTokensClientCapabilities `json:"semanticTokens,omitempty"` // Capabilities specific to the `textDocument/linkedEditingRange` request. // // @since 3.16.0 LinkedEditingRange *LinkedEditingRangeClientCapabilities `json:"linkedEditingRange,omitempty"` // Client capabilities specific to the `textDocument/moniker` request. // // @since 3.16.0 Moniker *MonikerClientCapabilities `json:"moniker,omitempty"` // Capabilities specific to the various type hierarchy requests. // // @since 3.17.0 TypeHierarchy *TypeHierarchyClientCapabilities `json:"typeHierarchy,omitempty"` // Capabilities specific to the `textDocument/inlineValue` request. // // @since 3.17.0 InlineValue *InlineValueClientCapabilities `json:"inlineValue,omitempty"` // Capabilities specific to the `textDocument/inlayHint` request. // // @since 3.17.0 InlayHint *InlayHintClientCapabilities `json:"inlayHint,omitempty"` // Capabilities specific to the diagnostic pull model. // // @since 3.17.0 Diagnostic *DiagnosticClientCapabilities `json:"diagnostic,omitempty"` // Client capabilities specific to inline completions. // // @since 3.18.0 // @proposed InlineCompletion *InlineCompletionClientCapabilities `json:"inlineCompletion,omitempty"` }
Text document specific client capabilities.
type TextDocumentContentChangeEvent ¶
type TextDocumentContentChangeEvent = TextDocumentContentChangePartial // (alias)
An event describing a change to a text document. If only a text is provided it is considered to be the full content of the document.
type TextDocumentContentChangePartial ¶
type TextDocumentContentChangePartial struct { // The range of the document that changed. Range *Range `json:"range,omitempty"` // The optional length of the range that got replaced. // // @deprecated use range instead. RangeLength uint32 `json:"rangeLength,omitempty"` // The new text for the provided range. Text string `json:"text"` }
@since 3.18.0
type TextDocumentContentChangeWholeDocument ¶
type TextDocumentContentChangeWholeDocument struct { // The new text of the whole document. Text string `json:"text"` }
@since 3.18.0
type TextDocumentContentClientCapabilities ¶ added in v0.17.0
type TextDocumentContentClientCapabilities struct { // Text document content provider supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
Client capabilities for a text document content provider.
@since 3.18.0 @proposed
type TextDocumentContentOptions ¶ added in v0.17.0
type TextDocumentContentOptions struct { // The scheme for which the server provides content. Scheme string `json:"scheme"` }
Text document content provider options.
@since 3.18.0 @proposed
type TextDocumentContentParams ¶ added in v0.17.0
type TextDocumentContentParams struct { // The uri of the text document. URI DocumentURI `json:"uri"` }
Parameters for the `workspace/textDocumentContent` request.
@since 3.18.0 @proposed
type TextDocumentContentRefreshParams ¶ added in v0.17.0
type TextDocumentContentRefreshParams struct { // The uri of the text document to refresh. URI DocumentURI `json:"uri"` }
Parameters for the `workspace/textDocumentContent/refresh` request.
@since 3.18.0 @proposed
type TextDocumentContentRegistrationOptions ¶ added in v0.17.0
type TextDocumentContentRegistrationOptions struct { TextDocumentContentOptions StaticRegistrationOptions }
Text document content provider registration options.
@since 3.18.0 @proposed
type TextDocumentEdit ¶
type TextDocumentEdit struct { // The text document to change. TextDocument OptionalVersionedTextDocumentIdentifier `json:"textDocument"` // The edits to be applied. // // @since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a // client capability. // // @since 3.18.0 - support for SnippetTextEdit. This is guarded using a // client capability. Edits []Or_TextDocumentEdit_edits_Elem `json:"edits"` }
Describes textual changes on a text document. A TextDocumentEdit describes all changes on a document version Si and after they are applied move the document to version Si+1. So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any kind of ordering. However the edits must be non overlapping.
type TextDocumentFilter ¶
type TextDocumentFilter = Or_TextDocumentFilter // (alias)
A document filter denotes a document by different properties like the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
Glob patterns can have the following syntax:
- `*` to match one or more characters in a path segment
- `?` to match on one character in a path segment
- `**` to match any number of path segments, including none
- `{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
@sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }` @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
@since 3.17.0
type TextDocumentFilterLanguage ¶
type TextDocumentFilterLanguage struct { // A language id, like `typescript`. Language string `json:"language"` // A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. Scheme string `json:"scheme,omitempty"` // A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples. // // @since 3.18.0 - support for relative patterns. Pattern *GlobPattern `json:"pattern,omitempty"` }
A document filter where `language` is required field.
@since 3.18.0
type TextDocumentFilterPattern ¶
type TextDocumentFilterPattern struct { // A language id, like `typescript`. Language string `json:"language,omitempty"` // A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. Scheme string `json:"scheme,omitempty"` // A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples. // // @since 3.18.0 - support for relative patterns. Pattern GlobPattern `json:"pattern"` }
A document filter where `pattern` is required field.
@since 3.18.0
type TextDocumentFilterScheme ¶
type TextDocumentFilterScheme struct { // A language id, like `typescript`. Language string `json:"language,omitempty"` // A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. Scheme string `json:"scheme"` // A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples. // // @since 3.18.0 - support for relative patterns. Pattern *GlobPattern `json:"pattern,omitempty"` }
A document filter where `scheme` is required field.
@since 3.18.0
type TextDocumentIdentifier ¶
type TextDocumentIdentifier struct { // The text document's uri. URI DocumentURI `json:"uri"` }
A literal to identify a text document in the client.
type TextDocumentItem ¶
type TextDocumentItem struct { // The text document's uri. URI DocumentURI `json:"uri"` // The text document's language identifier. LanguageID LanguageKind `json:"languageId"` // The version number of this document (it will increase after each // change, including undo/redo). Version int32 `json:"version"` // The content of the opened text document. Text string `json:"text"` }
An item to transfer a text document from the client to the server.
type TextDocumentPositionParams ¶
type TextDocumentPositionParams struct { // The text document. TextDocument TextDocumentIdentifier `json:"textDocument"` // The position inside the text document. Position Position `json:"position"` }
A parameter literal used in requests to pass a text document and a position inside that document.
func LocationTextDocumentPositionParams ¶
func LocationTextDocumentPositionParams(loc Location) TextDocumentPositionParams
LocationTextDocumentPositionParams converts its argument to its result.
type TextDocumentRegistrationOptions ¶
type TextDocumentRegistrationOptions struct { // A document selector to identify the scope of the registration. If set to null // the document selector provided on the client side will be used. DocumentSelector DocumentSelector `json:"documentSelector"` }
General text document registration options.
type TextDocumentSaveReason ¶
type TextDocumentSaveReason uint32
Represents reasons why a text document is saved.
type TextDocumentSaveRegistrationOptions ¶
type TextDocumentSaveRegistrationOptions struct { TextDocumentRegistrationOptions SaveOptions }
Save registration options.
type TextDocumentSyncClientCapabilities ¶
type TextDocumentSyncClientCapabilities struct { // Whether text document synchronization supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The client supports sending will save notifications. WillSave bool `json:"willSave,omitempty"` // The client supports sending a will save request and // waits for a response providing text edits which will // be applied to the document before it is saved. WillSaveWaitUntil bool `json:"willSaveWaitUntil,omitempty"` // The client supports did save notifications. DidSave bool `json:"didSave,omitempty"` }
type TextDocumentSyncKind ¶
type TextDocumentSyncKind uint32
Defines how the host (editor) should sync document changes to the language server.
type TextDocumentSyncOptions ¶
type TextDocumentSyncOptions struct { // Open and close notifications are sent to the server. If omitted open close notification should not // be sent. OpenClose bool `json:"openClose,omitempty"` // Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full // and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None. Change TextDocumentSyncKind `json:"change,omitempty"` // If present will save notifications are sent to the server. If omitted the notification should not be // sent. WillSave bool `json:"willSave,omitempty"` // If present will save wait until requests are sent to the server. If omitted the request should not be // sent. WillSaveWaitUntil bool `json:"willSaveWaitUntil,omitempty"` // If present save notifications are sent to the server. If omitted the notification should not be // sent. Save *SaveOptions `json:"save,omitempty"` }
type TextEdit ¶
type TextEdit struct { // The range of the text document to be manipulated. To insert // text into a document create a range where start === end. Range Range `json:"range"` // The string to be inserted. For delete operations use an // empty string. NewText string `json:"newText"` }
A text edit applicable to a text document.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textEdit
func AsTextEdits ¶
func AsTextEdits(edits []Or_TextDocumentEdit_edits_Elem) []TextEdit
AsTextEdits converts a slice possibly containing AnnotatedTextEdits to a slice of TextEdits.
func EditsFromDiffEdits ¶
EditsFromDiffEdits converts diff.Edits to a non-nil slice of LSP TextEdits. See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textEditArray
func SelectCompletionTextEdit ¶ added in v0.16.0
func SelectCompletionTextEdit(item CompletionItem, useReplaceMode bool) (TextEdit, error)
SelectCompletionTextEdit returns insert or replace mode TextEdit included in the completion item.
type TokenFormat ¶
type TokenFormat string
type TraceValue ¶ added in v0.16.0
type TraceValue string
type TypeDefinitionClientCapabilities ¶
type TypeDefinitionClientCapabilities struct { // Whether implementation supports dynamic registration. If this is set to `true` // the client supports the new `TypeDefinitionRegistrationOptions` return value // for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // The client supports additional metadata in the form of definition links. // // Since 3.14.0 LinkSupport bool `json:"linkSupport,omitempty"` }
Since 3.6.0
type TypeDefinitionOptions ¶
type TypeDefinitionOptions struct {
WorkDoneProgressOptions
}
type TypeDefinitionParams ¶
type TypeDefinitionParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
type TypeDefinitionRegistrationOptions ¶
type TypeDefinitionRegistrationOptions struct { TextDocumentRegistrationOptions TypeDefinitionOptions StaticRegistrationOptions }
type TypeHierarchyClientCapabilities ¶
type TypeHierarchyClientCapabilities struct { // Whether implementation supports dynamic registration. If this is set to `true` // the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` // return value for the corresponding server capability as well. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` }
@since 3.17.0
type TypeHierarchyItem ¶
type TypeHierarchyItem struct { // The name of this item. Name string `json:"name"` // The kind of this item. Kind SymbolKind `json:"kind"` // Tags for this item. Tags []SymbolTag `json:"tags,omitempty"` // More detail for this item, e.g. the signature of a function. Detail string `json:"detail,omitempty"` // The resource identifier of this item. URI DocumentURI `json:"uri"` // The range enclosing this symbol not including leading/trailing whitespace // but everything else, e.g. comments and code. Range Range `json:"range"` // The range that should be selected and revealed when this symbol is being // picked, e.g. the name of a function. Must be contained by the // {@link TypeHierarchyItem.range `range`}. SelectionRange Range `json:"selectionRange"` // A data entry field that is preserved between a type hierarchy prepare and // supertypes or subtypes requests. It could also be used to identify the // type hierarchy in the server, helping improve the performance on // resolving supertypes and subtypes. Data interface{} `json:"data,omitempty"` }
@since 3.17.0
type TypeHierarchyOptions ¶
type TypeHierarchyOptions struct {
WorkDoneProgressOptions
}
Type hierarchy options used during static registration.
@since 3.17.0
type TypeHierarchyPrepareParams ¶
type TypeHierarchyPrepareParams struct { TextDocumentPositionParams WorkDoneProgressParams }
The parameter of a `textDocument/prepareTypeHierarchy` request.
@since 3.17.0
type TypeHierarchyRegistrationOptions ¶
type TypeHierarchyRegistrationOptions struct { TextDocumentRegistrationOptions TypeHierarchyOptions StaticRegistrationOptions }
Type hierarchy options used during static or dynamic registration.
@since 3.17.0
type TypeHierarchySubtypesParams ¶
type TypeHierarchySubtypesParams struct { Item TypeHierarchyItem `json:"item"` WorkDoneProgressParams PartialResultParams }
The parameter of a `typeHierarchy/subtypes` request.
@since 3.17.0
type TypeHierarchySupertypesParams ¶
type TypeHierarchySupertypesParams struct { Item TypeHierarchyItem `json:"item"` WorkDoneProgressParams PartialResultParams }
The parameter of a `typeHierarchy/supertypes` request.
@since 3.17.0
type UIntCommaUInt ¶
created for Tuple
type UnchangedDocumentDiagnosticReport ¶
type UnchangedDocumentDiagnosticReport struct { // A document diagnostic report indicating // no changes to the last result. A server can // only return `unchanged` if result ids are // provided. Kind string `json:"kind"` // A result id which will be sent on the next // diagnostic request for the same document. ResultID string `json:"resultId"` }
A diagnostic report indicating that the last returned report is still accurate.
@since 3.17.0
type UniquenessLevel ¶
type UniquenessLevel string
Moniker uniqueness level to define scope of the moniker.
@since 3.16.0
type UnmarshalError ¶
type UnmarshalError struct {
// contains filtered or unexported fields
}
UnmarshalError indicates that a JSON value did not conform to one of the expected cases of an LSP union type.
func (UnmarshalError) Error ¶
func (e UnmarshalError) Error() string
type Unregistration ¶
type Unregistration struct { // The id used to unregister the request or notification. Usually an id // provided during the register request. ID string `json:"id"` // The method to unregister for. Method string `json:"method"` }
General parameters to unregister a request or notification.
type UnregistrationParams ¶
type UnregistrationParams struct {
Unregisterations []Unregistration `json:"unregisterations"`
}
type VersionedNotebookDocumentIdentifier ¶
type VersionedNotebookDocumentIdentifier struct { // The version number of this notebook document. Version int32 `json:"version"` // The notebook document's uri. URI URI `json:"uri"` }
A versioned notebook document identifier.
@since 3.17.0
type VersionedTextDocumentIdentifier ¶
type VersionedTextDocumentIdentifier struct { // The version number of this document. Version int32 `json:"version"` TextDocumentIdentifier }
A text document identifier to denote a specific version of a text document.
type WatchKind ¶
type WatchKind = uint32 // The parameters sent in a will save text document notification.
type WillSaveTextDocumentParams ¶
type WillSaveTextDocumentParams struct { // The document that will be saved. TextDocument TextDocumentIdentifier `json:"textDocument"` // The 'TextDocumentSaveReason'. Reason TextDocumentSaveReason `json:"reason"` }
type WindowClientCapabilities ¶
type WindowClientCapabilities struct { // It indicates whether the client supports server initiated // progress using the `window/workDoneProgress/create` request. // // The capability also controls Whether client supports handling // of progress notifications. If set servers are allowed to report a // `workDoneProgress` property in the request specific server // capabilities. // // @since 3.15.0 WorkDoneProgress bool `json:"workDoneProgress,omitempty"` // Capabilities specific to the showMessage request. // // @since 3.16.0 ShowMessage *ShowMessageRequestClientCapabilities `json:"showMessage,omitempty"` // Capabilities specific to the showDocument request. // // @since 3.16.0 ShowDocument *ShowDocumentClientCapabilities `json:"showDocument,omitempty"` }
type WorkDoneProgressBegin ¶
type WorkDoneProgressBegin struct { Kind string `json:"kind"` // Mandatory title of the progress operation. Used to briefly inform about // the kind of operation being performed. // // Examples: "Indexing" or "Linking dependencies". Title string `json:"title"` // Controls if a cancel button should show to allow the user to cancel the // long running operation. Clients that don't support cancellation are allowed // to ignore the setting. Cancellable bool `json:"cancellable,omitempty"` // Optional, more detailed associated progress message. Contains // complementary information to the `title`. // // Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". // If unset, the previous progress message (if any) is still valid. Message string `json:"message,omitempty"` // Optional progress percentage to display (value 100 is considered 100%). // If not provided infinite progress is assumed and clients are allowed // to ignore the `percentage` value in subsequent in report notifications. // // The value should be steadily rising. Clients are free to ignore values // that are not following this rule. The value range is [0, 100]. Percentage uint32 `json:"percentage,omitempty"` }
type WorkDoneProgressCancelParams ¶
type WorkDoneProgressCancelParams struct { // The token to be used to report progress. Token ProgressToken `json:"token"` }
type WorkDoneProgressCreateParams ¶
type WorkDoneProgressCreateParams struct { // The token to be used to report progress. Token ProgressToken `json:"token"` }
type WorkDoneProgressEnd ¶
type WorkDoneProgressOptions ¶
type WorkDoneProgressOptions struct {
WorkDoneProgress bool `json:"workDoneProgress,omitempty"`
}
type WorkDoneProgressOptionsAndTextDocumentRegistrationOptions ¶
type WorkDoneProgressOptionsAndTextDocumentRegistrationOptions struct { WorkDoneProgressOptions TextDocumentRegistrationOptions }
created for And
type WorkDoneProgressParams ¶
type WorkDoneProgressParams struct { // An optional token that a server can use to report work done progress. WorkDoneToken ProgressToken `json:"workDoneToken,omitempty"` }
type WorkDoneProgressReport ¶
type WorkDoneProgressReport struct { Kind string `json:"kind"` // Controls enablement state of a cancel button. // // Clients that don't support cancellation or don't support controlling the button's // enablement state are allowed to ignore the property. Cancellable bool `json:"cancellable,omitempty"` // Optional, more detailed associated progress message. Contains // complementary information to the `title`. // // Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". // If unset, the previous progress message (if any) is still valid. Message string `json:"message,omitempty"` // Optional progress percentage to display (value 100 is considered 100%). // If not provided infinite progress is assumed and clients are allowed // to ignore the `percentage` value in subsequent in report notifications. // // The value should be steadily rising. Clients are free to ignore values // that are not following this rule. The value range is [0, 100] Percentage uint32 `json:"percentage,omitempty"` }
type WorkspaceClientCapabilities ¶
type WorkspaceClientCapabilities struct { // The client supports applying batch edits // to the workspace by supporting the request // 'workspace/applyEdit' ApplyEdit bool `json:"applyEdit,omitempty"` // Capabilities specific to `WorkspaceEdit`s. WorkspaceEdit *WorkspaceEditClientCapabilities `json:"workspaceEdit,omitempty"` // Capabilities specific to the `workspace/didChangeConfiguration` notification. DidChangeConfiguration DidChangeConfigurationClientCapabilities `json:"didChangeConfiguration,omitempty"` // Capabilities specific to the `workspace/didChangeWatchedFiles` notification. DidChangeWatchedFiles DidChangeWatchedFilesClientCapabilities `json:"didChangeWatchedFiles,omitempty"` // Capabilities specific to the `workspace/symbol` request. Symbol *WorkspaceSymbolClientCapabilities `json:"symbol,omitempty"` // Capabilities specific to the `workspace/executeCommand` request. ExecuteCommand *ExecuteCommandClientCapabilities `json:"executeCommand,omitempty"` // The client has support for workspace folders. // // @since 3.6.0 WorkspaceFolders bool `json:"workspaceFolders,omitempty"` // The client supports `workspace/configuration` requests. // // @since 3.6.0 Configuration bool `json:"configuration,omitempty"` // Capabilities specific to the semantic token requests scoped to the // workspace. // // @since 3.16.0. SemanticTokens *SemanticTokensWorkspaceClientCapabilities `json:"semanticTokens,omitempty"` // Capabilities specific to the code lens requests scoped to the // workspace. // // @since 3.16.0. CodeLens *CodeLensWorkspaceClientCapabilities `json:"codeLens,omitempty"` // The client has support for file notifications/requests for user operations on files. // // Since 3.16.0 FileOperations *FileOperationClientCapabilities `json:"fileOperations,omitempty"` // Capabilities specific to the inline values requests scoped to the // workspace. // // @since 3.17.0. InlineValue *InlineValueWorkspaceClientCapabilities `json:"inlineValue,omitempty"` // Capabilities specific to the inlay hint requests scoped to the // workspace. // // @since 3.17.0. InlayHint *InlayHintWorkspaceClientCapabilities `json:"inlayHint,omitempty"` // Capabilities specific to the diagnostic requests scoped to the // workspace. // // @since 3.17.0. Diagnostics *DiagnosticWorkspaceClientCapabilities `json:"diagnostics,omitempty"` // Capabilities specific to the folding range requests scoped to the workspace. // // @since 3.18.0 // @proposed FoldingRange *FoldingRangeWorkspaceClientCapabilities `json:"foldingRange,omitempty"` // Capabilities specific to the `workspace/textDocumentContent` request. // // @since 3.18.0 // @proposed TextDocumentContent *TextDocumentContentClientCapabilities `json:"textDocumentContent,omitempty"` }
Workspace specific client capabilities.
type WorkspaceDiagnosticParams ¶
type WorkspaceDiagnosticParams struct { // The additional identifier provided during registration. Identifier string `json:"identifier,omitempty"` // The currently known diagnostic reports with their // previous result ids. PreviousResultIds []PreviousResultID `json:"previousResultIds"` WorkDoneProgressParams PartialResultParams }
Parameters of the workspace diagnostic request.
@since 3.17.0
type WorkspaceDiagnosticReport ¶
type WorkspaceDiagnosticReport struct {
Items []WorkspaceDocumentDiagnosticReport `json:"items"`
}
A workspace diagnostic report.
@since 3.17.0
type WorkspaceDiagnosticReportPartialResult ¶
type WorkspaceDiagnosticReportPartialResult struct {
Items []WorkspaceDocumentDiagnosticReport `json:"items"`
}
A partial result for a workspace diagnostic report.
@since 3.17.0
type WorkspaceDocumentDiagnosticReport ¶
type WorkspaceDocumentDiagnosticReport = Or_WorkspaceDocumentDiagnosticReport // (alias)
A workspace diagnostic document report.
@since 3.17.0
type WorkspaceEdit ¶
type WorkspaceEdit struct { // Holds changes to existing resources. Changes map[DocumentURI][]TextEdit `json:"changes,omitempty"` // Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes // are either an array of `TextDocumentEdit`s to express changes to n different text documents // where each text document edit addresses a specific version of a text document. Or it can contain // above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations. // // Whether a client supports versioned document edits is expressed via // `workspace.workspaceEdit.documentChanges` client capability. // // If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then // only plain `TextEdit`s using the `changes` property are supported. DocumentChanges []DocumentChange `json:"documentChanges,omitempty"` // A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and // delete file / folder operations. // // Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`. // // @since 3.16.0 ChangeAnnotations map[ChangeAnnotationIdentifier]ChangeAnnotation `json:"changeAnnotations,omitempty"` }
A workspace edit represents changes to many resources managed in the workspace. The edit should either provide `changes` or `documentChanges`. If documentChanges are present they are preferred over `changes` if the client can handle versioned document edits.
Since version 3.13.0 a workspace edit can contain resource operations as well. If resource operations are present clients need to execute the operations in the order in which they are provided. So a workspace edit for example can consist of the following two changes: (1) a create file a.txt and (2) a text document edit which insert text into file a.txt.
An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will cause failure of the operation. How the client recovers from the failure is described by the client capability: `workspace.workspaceEdit.failureHandling`
func NewWorkspaceEdit ¶ added in v0.16.0
func NewWorkspaceEdit(changes ...DocumentChange) *WorkspaceEdit
NewWorkspaceEdit constructs a WorkspaceEdit from a list of document changes.
Any ChangeAnnotations must be added after.
type WorkspaceEditClientCapabilities ¶
type WorkspaceEditClientCapabilities struct { // The client supports versioned document changes in `WorkspaceEdit`s DocumentChanges bool `json:"documentChanges,omitempty"` // The resource operations the client supports. Clients should at least // support 'create', 'rename' and 'delete' files and folders. // // @since 3.13.0 ResourceOperations []ResourceOperationKind `json:"resourceOperations,omitempty"` // The failure handling strategy of a client if applying the workspace edit // fails. // // @since 3.13.0 FailureHandling *FailureHandlingKind `json:"failureHandling,omitempty"` // Whether the client normalizes line endings to the client specific // setting. // If set to `true` the client will normalize line ending characters // in a workspace edit to the client-specified new line // character. // // @since 3.16.0 NormalizesLineEndings bool `json:"normalizesLineEndings,omitempty"` // Whether the client in general supports change annotations on text edits, // create file, rename file and delete file changes. // // @since 3.16.0 ChangeAnnotationSupport *ChangeAnnotationsSupportOptions `json:"changeAnnotationSupport,omitempty"` // Whether the client supports `WorkspaceEditMetadata` in `WorkspaceEdit`s. // // @since 3.18.0 // @proposed MetadataSupport bool `json:"metadataSupport,omitempty"` // Whether the client supports snippets as text edits. // // @since 3.18.0 // @proposed SnippetEditSupport bool `json:"snippetEditSupport,omitempty"` }
type WorkspaceEditMetadata ¶ added in v0.17.0
type WorkspaceEditMetadata struct { // Signal to the editor that this edit is a refactoring. IsRefactoring bool `json:"isRefactoring,omitempty"` }
Additional data about a workspace edit.
@since 3.18.0 @proposed
type WorkspaceFolder ¶
type WorkspaceFolder struct { // The associated URI for this workspace folder. URI URI `json:"uri"` // The name of the workspace folder. Used to refer to this // workspace folder in the user interface. Name string `json:"name"` }
A workspace folder inside a client.
type WorkspaceFolders5Gn ¶
type WorkspaceFolders5Gn struct { // The server has support for workspace folders Supported bool `json:"supported,omitempty"` // Whether the server wants to receive workspace folder // change notifications. // // If a string is provided the string is treated as an ID // under which the notification is registered on the client // side. The ID can be used to unregister for these events // using the `client/unregisterCapability` request. ChangeNotifications string `json:"changeNotifications,omitempty"` }
type WorkspaceFoldersChangeEvent ¶
type WorkspaceFoldersChangeEvent struct { // The array of added workspace folders Added []WorkspaceFolder `json:"added"` // The array of the removed workspace folders Removed []WorkspaceFolder `json:"removed"` }
The workspace folder change event.
type WorkspaceFoldersInitializeParams ¶
type WorkspaceFoldersInitializeParams struct { // The workspace folders configured in the client when the server starts. // // This property is only available if the client supports workspace folders. // It can be `null` if the client supports workspace folders but none are // configured. // // @since 3.6.0 WorkspaceFolders []WorkspaceFolder `json:"workspaceFolders,omitempty"` }
type WorkspaceFoldersServerCapabilities ¶
type WorkspaceFoldersServerCapabilities struct { // The server has support for workspace folders Supported bool `json:"supported,omitempty"` // Whether the server wants to receive workspace folder // change notifications. // // If a string is provided the string is treated as an ID // under which the notification is registered on the client // side. The ID can be used to unregister for these events // using the `client/unregisterCapability` request. ChangeNotifications string `json:"changeNotifications,omitempty"` }
type WorkspaceFullDocumentDiagnosticReport ¶
type WorkspaceFullDocumentDiagnosticReport struct { // The URI for which diagnostic information is reported. URI DocumentURI `json:"uri"` // The version number for which the diagnostics are reported. // If the document is not marked as open `null` can be provided. Version int32 `json:"version"` FullDocumentDiagnosticReport }
A full document diagnostic report for a workspace diagnostic result.
@since 3.17.0
type WorkspaceOptions ¶
type WorkspaceOptions struct { // The server supports workspace folder. // // @since 3.6.0 WorkspaceFolders *WorkspaceFolders5Gn `json:"workspaceFolders,omitempty"` // The server is interested in notifications/requests for operations on files. // // @since 3.16.0 FileOperations *FileOperationOptions `json:"fileOperations,omitempty"` // The server supports the `workspace/textDocumentContent` request. // // @since 3.18.0 // @proposed TextDocumentContent *Or_WorkspaceOptions_textDocumentContent `json:"textDocumentContent,omitempty"` }
Defines workspace specific capabilities of the server.
@since 3.18.0
type WorkspaceSymbol ¶
type WorkspaceSymbol struct { // The location of the symbol. Whether a server is allowed to // return a location without a range depends on the client // capability `workspace.symbol.resolveSupport`. // // See SymbolInformation#location for more details. Location OrPLocation_workspace_symbol `json:"location"` // A data entry field that is preserved on a workspace symbol between a // workspace symbol request and a workspace symbol resolve request. Data interface{} `json:"data,omitempty"` BaseSymbolInformation }
A special workspace symbol that supports locations without a range.
See also SymbolInformation.
@since 3.17.0
type WorkspaceSymbolClientCapabilities ¶
type WorkspaceSymbolClientCapabilities struct { // Symbol request supports dynamic registration. DynamicRegistration bool `json:"dynamicRegistration,omitempty"` // Specific capabilities for the `SymbolKind` in the `workspace/symbol` request. SymbolKind *ClientSymbolKindOptions `json:"symbolKind,omitempty"` // The client supports tags on `SymbolInformation`. // Clients supporting tags have to handle unknown tags gracefully. // // @since 3.16.0 TagSupport *ClientSymbolTagOptions `json:"tagSupport,omitempty"` // The client support partial workspace symbols. The client will send the // request `workspaceSymbol/resolve` to the server to resolve additional // properties. // // @since 3.17.0 ResolveSupport *ClientSymbolResolveOptions `json:"resolveSupport,omitempty"` }
Client capabilities for a {@link WorkspaceSymbolRequest}.
type WorkspaceSymbolOptions ¶
type WorkspaceSymbolOptions struct { // The server provides support to resolve additional // information for a workspace symbol. // // @since 3.17.0 ResolveProvider bool `json:"resolveProvider,omitempty"` WorkDoneProgressOptions }
Server capabilities for a {@link WorkspaceSymbolRequest}.
type WorkspaceSymbolParams ¶
type WorkspaceSymbolParams struct { // A query string to filter symbols by. Clients may send an empty // string here to request all symbols. // // The `query`-parameter should be interpreted in a *relaxed way* as editors // will apply their own highlighting and scoring on the results. A good rule // of thumb is to match case-insensitive and to simply check that the // characters of *query* appear in their order in a candidate symbol. // Servers shouldn't use prefix, substring, or similar strict matching. Query string `json:"query"` WorkDoneProgressParams PartialResultParams }
The parameters of a {@link WorkspaceSymbolRequest}.
type WorkspaceSymbolRegistrationOptions ¶
type WorkspaceSymbolRegistrationOptions struct {
WorkspaceSymbolOptions
}
Registration options for a {@link WorkspaceSymbolRequest}.
type WorkspaceUnchangedDocumentDiagnosticReport ¶
type WorkspaceUnchangedDocumentDiagnosticReport struct { // The URI for which diagnostic information is reported. URI DocumentURI `json:"uri"` // The version number for which the diagnostics are reported. // If the document is not marked as open `null` can be provided. Version int32 `json:"version"` UnchangedDocumentDiagnosticReport }
An unchanged document diagnostic report for a workspace diagnostic result.
@since 3.17.0
type XInitializeParams ¶
type XInitializeParams struct { // The process Id of the parent process that started // the server. // // Is `null` if the process has not been started by another process. // If the parent process is not alive then the server should exit. ProcessID int32 `json:"processId"` // Information about the client // // @since 3.15.0 ClientInfo *ClientInfo `json:"clientInfo,omitempty"` // The locale the client is currently showing the user interface // in. This must not necessarily be the locale of the operating // system. // // Uses IETF language tags as the value's syntax // (See https://en.wikipedia.org/wiki/IETF_language_tag) // // @since 3.16.0 Locale string `json:"locale,omitempty"` // The rootPath of the workspace. Is null // if no folder is open. // // @deprecated in favour of rootUri. RootPath string `json:"rootPath,omitempty"` // The rootUri of the workspace. Is null if no // folder is open. If both `rootPath` and `rootUri` are set // `rootUri` wins. // // @deprecated in favour of workspaceFolders. RootURI DocumentURI `json:"rootUri"` // The capabilities provided by the client (editor or tool) Capabilities ClientCapabilities `json:"capabilities"` // User provided initialization options. InitializationOptions interface{} `json:"initializationOptions,omitempty"` // The initial trace setting. If omitted trace is disabled ('off'). Trace *TraceValue `json:"trace,omitempty"` WorkDoneProgressParams }
The initialize parameters
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package command defines the interface provided by gopls for the workspace/executeCommand LSP request.
|
Package command defines the interface provided by gopls for the workspace/executeCommand LSP request. |
commandmeta
Package commandmeta provides metadata about LSP commands, by statically analyzing the command.Interface type.
|
Package commandmeta provides metadata about LSP commands, by statically analyzing the command.Interface type. |
gen
Package gen is used to generate command bindings from the gopls command interface.
|
Package gen is used to generate command bindings from the gopls command interface. |
The generate command generates Go declarations from VSCode's description of the Language Server Protocol.
|
The generate command generates Go declarations from VSCode's description of the Language Server Protocol. |
The semtok package provides an encoder for LSP's semantic tokens.
|
The semtok package provides an encoder for LSP's semantic tokens. |