Documentation ¶
Index ¶
- Constants
- Variables
- func HasTraceLevel(value TraceValue) bool
- func HasTraceMessageType(type_ MessageType) bool
- func SetTraceValue(value TraceValue)
- func Trace(context *glsp.Context, type_ MessageType, message string) error
- type AnnotatedTextEdit
- type ApplyWorkspaceEditParams
- type ApplyWorkspaceEditResponse
- type BoolOrString
- type CallHierarchyClientCapabilities
- type CallHierarchyIncomingCall
- type CallHierarchyIncomingCallsFunc
- type CallHierarchyIncomingCallsParams
- type CallHierarchyItem
- type CallHierarchyOptions
- type CallHierarchyOutgoingCall
- type CallHierarchyOutgoingCallsFunc
- type CallHierarchyOutgoingCallsParams
- type CallHierarchyPrepareParams
- type CallHierarchyRegistrationOptions
- type CancelParams
- type CancelRequestFunc
- type ChangeAnnotation
- type ChangeAnnotationIdentifier
- type ClientCapabilities
- type CodeAction
- type CodeActionClientCapabilities
- type CodeActionContext
- type CodeActionKind
- type CodeActionOptions
- type CodeActionParams
- type CodeActionRegistrationOptions
- type CodeActionResolveFunc
- type CodeDescription
- type CodeLens
- type CodeLensClientCapabilities
- type CodeLensOptions
- type CodeLensParams
- type CodeLensRegistrationOptions
- type CodeLensResolveFunc
- type CodeLensWorkspaceClientCapabilities
- type Color
- type ColorInformation
- type ColorPresentation
- type ColorPresentationParams
- type Command
- type CompletionClientCapabilities
- type CompletionContext
- type CompletionItem
- type CompletionItemKind
- type CompletionItemResolveFunc
- type CompletionItemTag
- type CompletionList
- type CompletionOptions
- type CompletionParams
- type CompletionRegistrationOptions
- type CompletionTriggerKind
- type ConfigurationItem
- type ConfigurationParams
- type CreateFile
- type CreateFileOptions
- type CreateFilesParams
- type Decimal
- type DeclarationClientCapabilities
- type DeclarationOptions
- type DeclarationParams
- type DeclarationRegistrationOptions
- type DefaultBehavior
- type DefinitionClientCapabilities
- type DefinitionOptions
- type DefinitionParams
- type DefinitionRegistrationOptions
- type DeleteFile
- type DeleteFileOptions
- type DeleteFilesParams
- type Diagnostic
- type DiagnosticRelatedInformation
- type DiagnosticSeverity
- type DiagnosticTag
- type DidChangeConfigurationClientCapabilities
- type DidChangeConfigurationParams
- type DidChangeTextDocumentParams
- type DidChangeWatchedFilesClientCapabilities
- type DidChangeWatchedFilesParams
- type DidChangeWatchedFilesRegistrationOptions
- type DidChangeWorkspaceFoldersParams
- type DidCloseTextDocumentParams
- type DidOpenTextDocumentParams
- type DidSaveTextDocumentParams
- type DocumentColorClientCapabilities
- type DocumentColorOptions
- type DocumentColorParams
- type DocumentColorRegistrationOptions
- 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 DocumentLinkResolveFunc
- type DocumentOnTypeFormattingClientCapabilities
- type DocumentOnTypeFormattingOptions
- type DocumentOnTypeFormattingParams
- type DocumentOnTypeFormattingRegistrationOptions
- type DocumentRangeFormattingClientCapabilities
- type DocumentRangeFormattingOptions
- type DocumentRangeFormattingParams
- type DocumentRangeFormattingRegistrationOptions
- type DocumentSelector
- type DocumentSymbol
- type DocumentSymbolClientCapabilities
- type DocumentSymbolOptions
- type DocumentSymbolParams
- type DocumentSymbolRegistrationOptions
- type DocumentUri
- type ExecuteCommandClientCapabilities
- type ExecuteCommandOptions
- type ExecuteCommandParams
- type ExecuteCommandRegistrationOptions
- type ExitFunc
- type FailureHandlingKind
- type FileCreate
- type FileDelete
- type FileEvent
- type FileOperationFilter
- 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 FormattingOptions
- type Handler
- type Hover
- type HoverClientCapabilities
- type HoverOptions
- type HoverParams
- type HoverRegistrationOptions
- type ImplementationClientCapabilities
- type ImplementationOptions
- type ImplementationParams
- type ImplementationRegistrationOptions
- type InitializeError
- type InitializeErrorCode
- type InitializeFunc
- type InitializeParams
- type InitializeResult
- type InitializeResultServerInfo
- type InitializedFunc
- type InitializedParams
- type InsertReplaceEdit
- type InsertTextFormat
- type InsertTextMode
- type Integer
- type IntegerOrString
- type LinkedEditingRangeClientCapabilities
- type LinkedEditingRangeOptions
- type LinkedEditingRangeParams
- type LinkedEditingRangeRegistrationOptions
- type LinkedEditingRanges
- type Location
- type LocationLink
- type LogMessageParams
- type LogTraceFunc
- type LogTraceParams
- type MarkdownClientCapabilities
- type MarkedString
- type MarkedStringStruct
- type MarkupContent
- type MarkupKind
- type MessageActionItem
- type MessageType
- type Method
- type Moniker
- type MonikerClientCapabilities
- type MonikerKind
- type MonikerOptions
- type MonikerParams
- type MonikerRegistrationOptions
- type OptionalVersionedTextDocumentIdentifier
- type ParameterInformation
- type PartialResultParams
- type Position
- type PrepareRenameParams
- type PrepareSupportDefaultBehavior
- type ProgressFunc
- type ProgressParams
- type ProgressToken
- type PublishDiagnosticsClientCapabilities
- type PublishDiagnosticsParams
- type Range
- type RangeWithPlaceholder
- type ReferenceClientCapabilities
- type ReferenceContext
- type ReferenceOptions
- type ReferenceParams
- type ReferenceRegistrationOptions
- type Registration
- type RegistrationParams
- type RegularExpressionsClientCapabilities
- type RenameClientCapabilities
- type RenameFile
- type RenameFileOptions
- type RenameFilesParams
- type RenameOptions
- type RenameParams
- type RenameRegistrationOptions
- type ResourceOperationKind
- type SaveOptions
- type SelectionRange
- type SelectionRangeClientCapabilities
- type SelectionRangeOptions
- type SelectionRangeParams
- type SelectionRangeRegistrationOptions
- type SemanticDelta
- type SemanticTokenModifier
- type SemanticTokenType
- type SemanticTokens
- type SemanticTokensClientCapabilities
- type SemanticTokensDelta
- type SemanticTokensDeltaParams
- type SemanticTokensDeltaPartialResult
- type SemanticTokensEdit
- type SemanticTokensLegend
- type SemanticTokensOptions
- type SemanticTokensParams
- type SemanticTokensPartialResult
- type SemanticTokensRangeParams
- type SemanticTokensRegistrationOptions
- type SemanticTokensWorkspaceClientCapabilities
- type ServerCapabilities
- type ServerCapabilitiesWorkspace
- type ServerCapabilitiesWorkspaceFileOperations
- type SetTraceFunc
- type SetTraceParams
- type ShowDocumentClientCapabilities
- type ShowDocumentParams
- type ShowDocumentResult
- type ShowMessageParams
- type ShowMessageRequestClientCapabilities
- type ShowMessageRequestParams
- type ShutdownFunc
- type SignatureHelp
- type SignatureHelpClientCapabilities
- type SignatureHelpContext
- type SignatureHelpOptions
- type SignatureHelpParams
- type SignatureHelpRegistrationOptions
- type SignatureHelpTriggerKind
- type SignatureInformation
- type StaticRegistrationOptions
- type SymbolInformation
- type SymbolKind
- type SymbolTag
- type TextDocumentChangeRegistrationOptions
- type TextDocumentClientCapabilities
- type TextDocumentCodeActionFunc
- type TextDocumentCodeLensFunc
- type TextDocumentColorFunc
- type TextDocumentColorPresentationFunc
- type TextDocumentCompletionFunc
- type TextDocumentContentChangeEvent
- type TextDocumentContentChangeEventWhole
- type TextDocumentDeclarationFunc
- type TextDocumentDefinitionFunc
- type TextDocumentDidChangeFunc
- type TextDocumentDidCloseFunc
- type TextDocumentDidOpenFunc
- type TextDocumentDidSaveFunc
- type TextDocumentDocumentHighlightFunc
- type TextDocumentDocumentLinkFunc
- type TextDocumentDocumentSymbolFunc
- type TextDocumentEdit
- type TextDocumentFoldingRangeFunc
- type TextDocumentFormattingFunc
- type TextDocumentHoverFunc
- type TextDocumentIdentifier
- type TextDocumentImplementationFunc
- type TextDocumentItem
- type TextDocumentLinkedEditingRangeFunc
- type TextDocumentMonikerFunc
- type TextDocumentOnTypeFormattingFunc
- type TextDocumentPositionParams
- type TextDocumentPrepareCallHierarchyFunc
- type TextDocumentPrepareRenameFunc
- type TextDocumentRangeFormattingFunc
- type TextDocumentReferencesFunc
- type TextDocumentRegistrationOptions
- type TextDocumentRenameFunc
- type TextDocumentSaveReason
- type TextDocumentSaveRegistrationOptions
- type TextDocumentSelectionRangeFunc
- type TextDocumentSemanticTokensFullDeltaFunc
- type TextDocumentSemanticTokensFullFunc
- type TextDocumentSemanticTokensRangeFunc
- type TextDocumentSignatureHelpFunc
- type TextDocumentSyncClientCapabilities
- type TextDocumentSyncKind
- type TextDocumentSyncOptions
- type TextDocumentTypeDefinitionFunc
- type TextDocumentWillSaveFunc
- type TextDocumentWillSaveWaitUntilFunc
- type TextEdit
- type TokenFormat
- type TraceValue
- type TypeDefinitionClientCapabilities
- type TypeDefinitionOptions
- type TypeDefinitionParams
- type TypeDefinitionRegistrationOptions
- type UInteger
- type URI
- type UniquenessLevel
- type Unregistration
- type UnregistrationParams
- type VersionedTextDocumentIdentifier
- type WillSaveTextDocumentParams
- type WindowWorkDoneProgressCancelFunc
- type WorkDoneProgressBegin
- type WorkDoneProgressCancelParams
- type WorkDoneProgressCreateParams
- type WorkDoneProgressEnd
- type WorkDoneProgressOptions
- type WorkDoneProgressParams
- type WorkDoneProgressReport
- type WorkspaceDidChangeConfigurationFunc
- type WorkspaceDidChangeWatchedFilesFunc
- type WorkspaceDidChangeWorkspaceFoldersFunc
- type WorkspaceDidCreateFilesFunc
- type WorkspaceDidDeleteFilesFunc
- type WorkspaceDidRenameFilesFunc
- type WorkspaceEdit
- type WorkspaceEditClientCapabilities
- type WorkspaceExecuteCommandFunc
- type WorkspaceFolder
- type WorkspaceFoldersChangeEvent
- type WorkspaceFoldersServerCapabilities
- type WorkspaceSemanticTokensRefreshFunc
- type WorkspaceSymbolClientCapabilities
- type WorkspaceSymbolFunc
- type WorkspaceSymbolOptions
- type WorkspaceSymbolParams
- type WorkspaceSymbolRegistrationOptions
- type WorkspaceWillCreateFilesFunc
- type WorkspaceWillDeleteFilesFunc
- type WorkspaceWillRenameFilesFunc
Constants ¶
const ( /** * Reports an error. */ DiagnosticSeverityError = DiagnosticSeverity(1) /** * Reports a warning. */ DiagnosticSeverityWarning = DiagnosticSeverity(2) /** * Reports an information. */ DiagnosticSeverityInformation = DiagnosticSeverity(3) /** * Reports a hint. */ DiagnosticSeverityHint = DiagnosticSeverity(4) )
const ( /** * Unused or unnecessary code. * * Clients are allowed to render diagnostics with this tag faded out * instead of having an error squiggle. */ DiagnosticTagUnnecessary = DiagnosticTag(1) /** * Deprecated or obsolete code. * * Clients are allowed to rendered diagnostics with this tag strike through. */ DiagnosticTagDeprecated = DiagnosticTag(2) )
const ( /** * Supports creating new files and folders. */ ResourceOperationKindCreate = ResourceOperationKind("create") /** * Supports renaming existing files and folders. */ ResourceOperationKindRename = ResourceOperationKind("rename") /** * Supports deleting existing files and folders. */ ResourceOperationKindDelete = ResourceOperationKind("delete") )
const ( /** * Applying the workspace change is simply aborted if one of the changes * provided fails. All operations executed before the failing operation * stay executed. */ FailureHandlingKindAbort = FailureHandlingKind("abort") /** * All operations are executed transactional. That means they either all * succeed or no changes at all are applied to the workspace. */ FailureHandlingKindTransactional = 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. */ FailureHandlingKindTextOnlyTransactional = FailureHandlingKind("textOnlyTransactional") /** * The client tries to undo the operations already executed. But there is no * guarantee that this is succeeding. */ FailureHandlingKindUndo = FailureHandlingKind("undo") )
const ( /** * Plain text is supported as a content format */ MarkupKindPlainText = MarkupKind("plaintext") /** * Markdown is supported as a content format */ MarkupKindMarkdown = MarkupKind("markdown") )
const ( TraceValueOff = TraceValue("off") TraceValueMessage = TraceValue("message") // The spec clearly says "message", but some implementations use "messages" instead TraceValueVerbose = TraceValue("verbose") )
const ( /** * Completion was triggered by typing an identifier (24x7 code * complete), manual invocation (e.g Ctrl+Space) or via API. */ CompletionTriggerKindInvoked = CompletionTriggerKind(1) /** * Completion was triggered by a trigger character specified by * the `triggerCharacters` properties of the * `CompletionRegistrationOptions`. */ CompletionTriggerKindTriggerCharacter = CompletionTriggerKind(2) /** * Completion was re-triggered as the current completion list is incomplete. */ CompletionTriggerKindTriggerForIncompleteCompletions = CompletionTriggerKind(3) )
const ( /** * The primary text to be inserted is treated as a plain string. */ InsertTextFormatPlainText = 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. */ InsertTextFormatSnippet = InsertTextFormat(2) )
const ( /** * 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. */ InsertTextModeAsIs = 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. */ InsertTextModeAdjustIndentation = InsertTextMode(2) )
const ( CompletionItemKindText = CompletionItemKind(1) CompletionItemKindMethod = CompletionItemKind(2) CompletionItemKindFunction = CompletionItemKind(3) CompletionItemKindConstructor = CompletionItemKind(4) CompletionItemKindField = CompletionItemKind(5) CompletionItemKindVariable = CompletionItemKind(6) CompletionItemKindClass = CompletionItemKind(7) CompletionItemKindInterface = CompletionItemKind(8) CompletionItemKindModule = CompletionItemKind(9) CompletionItemKindProperty = CompletionItemKind(10) CompletionItemKindUnit = CompletionItemKind(11) CompletionItemKindValue = CompletionItemKind(12) CompletionItemKindEnum = CompletionItemKind(13) CompletionItemKindKeyword = CompletionItemKind(14) CompletionItemKindSnippet = CompletionItemKind(15) CompletionItemKindColor = CompletionItemKind(16) CompletionItemKindFile = CompletionItemKind(17) CompletionItemKindReference = CompletionItemKind(18) CompletionItemKindFolder = CompletionItemKind(19) CompletionItemKindEnumMember = CompletionItemKind(20) CompletionItemKindConstant = CompletionItemKind(21) CompletionItemKindStruct = CompletionItemKind(22) CompletionItemKindEvent = CompletionItemKind(23) CompletionItemKindOperator = CompletionItemKind(24) CompletionItemKindTypeParameter = CompletionItemKind(25) )
const ( /** * Signature help was invoked manually by the user or by a command. */ SignatureHelpTriggerKindInvoked = SignatureHelpTriggerKind(1) /** * Signature help was triggered by a trigger character. */ SignatureHelpTriggerKindTriggerCharacter = SignatureHelpTriggerKind(2) /** * Signature help was triggered by the cursor moving or by the document * content changing. */ SignatureHelpTriggerKindContentChange = SignatureHelpTriggerKind(3) )
const ( /** * A textual occurrence. */ DocumentHighlightKindText = DocumentHighlightKind(1) /** * Read-access of a symbol, like reading a variable. */ DocumentHighlightKindRead = DocumentHighlightKind(2) /** * Write-access of a symbol, like writing to a variable. */ DocumentHighlightKindWrite = DocumentHighlightKind(3) )
const ( SymbolKindFile = SymbolKind(1) SymbolKindModule = SymbolKind(2) SymbolKindNamespace = SymbolKind(3) SymbolKindPackage = SymbolKind(4) SymbolKindClass = SymbolKind(5) SymbolKindMethod = SymbolKind(6) SymbolKindProperty = SymbolKind(7) SymbolKindField = SymbolKind(8) SymbolKindConstructor = SymbolKind(9) SymbolKindEnum = SymbolKind(10) SymbolKindInterface = SymbolKind(11) SymbolKindFunction = SymbolKind(12) SymbolKindVariable = SymbolKind(13) SymbolKindConstant = SymbolKind(14) SymbolKindString = SymbolKind(15) SymbolKindNumber = SymbolKind(16) SymbolKindBoolean = SymbolKind(17) SymbolKindArray = SymbolKind(18) SymbolKindObject = SymbolKind(19) SymbolKindKey = SymbolKind(20) SymbolKindNull = SymbolKind(21) SymbolKindEnumMember = SymbolKind(22) SymbolKindStruct = SymbolKind(23) SymbolKindEvent = SymbolKind(24) SymbolKindOperator = SymbolKind(25) SymbolKindTypeParameter = SymbolKind(26) )
const ( /** * Empty kind. */ CodeActionKindEmpty = CodeActionKind("") /** * Base kind for quickfix actions: 'quickfix'. */ CodeActionKindQuickFix = CodeActionKind("quickfix") /** * Base kind for refactoring actions: 'refactor'. */ CodeActionKindRefactor = CodeActionKind("refactor") /** * Base kind for refactoring extraction actions: 'refactor.extract'. * * Example extract actions: * * - Extract method * - Extract function * - Extract variable * - Extract interface from class * - ... */ CodeActionKindRefactorExtract = CodeActionKind("refactor.extract") /** * Base kind for refactoring inline actions: 'refactor.inline'. * * Example inline actions: * * - Inline function * - Inline variable * - Inline constant * - ... */ CodeActionKindRefactorInline = CodeActionKind("refactor.inline") /** * 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 * - ... */ CodeActionKindRefactorRewrite = CodeActionKind("refactor.rewrite") /** * Base kind for source actions: `source`. * * Source code actions apply to the entire file. */ CodeActionKindSource = CodeActionKind("source") /** * Base kind for an organize imports source action: * `source.organizeImports`. */ CodeActionKindSourceOrganizeImports = CodeActionKind("source.organizeImports") )
*
- A set of predefined code action kinds.
const ( /** * Size of a tab in spaces. */ FormattingOptionTabSize = "tabSize" /** * Prefer spaces over tabs. */ FormattingOptionInsertSpaces = "insertSpaces" /** * Trim trailing whitespace on a line. * * @since 3.15.0 */ FormattingOptionTrimTrailingWhitespace = "trimTrailingWhitespace" /** * Insert a newline character at the end of the file if one does not exist. * * @since 3.15.0 */ FormattingOptionInsertFinalNewline = "insertFinalNewline" /** * Trim all newlines after the final newline at the end of the file. * * @since 3.15.0 */ FormattingOptionTrimFinalNewlines = "trimFinalNewlines" )
*
- Value-object describing what options formatting should use.
const ( /** * Folding range for a comment */ FoldingRangeKindComment = FoldingRangeKind("comment") /** * Folding range for a imports or includes */ FoldingRangeKindImports = FoldingRangeKind("imports") /** * Folding range for a region (e.g. `#region`) */ FoldingRangeKindRegion = FoldingRangeKind("region") )
const ( SemanticTokenTypeNamespace = SemanticTokenType("namespace") /** * Represents a generic type. Acts as a fallback for types which * can't be mapped to a specific type like class or enum. */ SemanticTokenTypeType = SemanticTokenType("type") SemanticTokenTypeClass = SemanticTokenType("class") SemanticTokenTypeEnum = SemanticTokenType("enum") SemanticTokenTypeInterface = SemanticTokenType("interface") SemanticTokenTypeStruct = SemanticTokenType("struct") SemanticTokenTypeTypeParameter = SemanticTokenType("typeParameter") SemanticTokenTypeParameter = SemanticTokenType("parameter") SemanticTokenTypeVariable = SemanticTokenType("variable") SemanticTokenTypeProperty = SemanticTokenType("property") SemanticTokenTypeEnumMember = SemanticTokenType("enumMember") SemanticTokenTypeEvent = SemanticTokenType("event") SemanticTokenTypeFunction = SemanticTokenType("function") SemanticTokenTypeMethod = SemanticTokenType("method") SemanticTokenTypeMacro = SemanticTokenType("macro") SemanticTokenTypeKeyword = SemanticTokenType("keyword") SemanticTokenTypeModifier = SemanticTokenType("modifier") SemanticTokenTypeComment = SemanticTokenType("comment") SemanticTokenTypeString = SemanticTokenType("string") SemanticTokenTypeNumber = SemanticTokenType("number") SemanticTokenTypeRegexp = SemanticTokenType("regexp") SemanticTokenTypeOperator = SemanticTokenType("operator") )
const ( SemanticTokenModifierDeclaration = SemanticTokenModifier("declaration") SemanticTokenModifierDefinition = SemanticTokenModifier("definition") SemanticTokenModifierReadonly = SemanticTokenModifier("readonly") SemanticTokenModifierStatic = SemanticTokenModifier("static") SemanticTokenModifierDeprecated = SemanticTokenModifier("deprecated") SemanticTokenModifierAbstract = SemanticTokenModifier("abstract") SemanticTokenModifierAsync = SemanticTokenModifier("async") SemanticTokenModifierModification = SemanticTokenModifier("modification") SemanticTokenModifierDocumentation = SemanticTokenModifier("documentation") SemanticTokenModifierDefaultLibrary = SemanticTokenModifier("defaultLibrary") )
const ( /** * The moniker is only unique inside a document */ UniquenessLevelDocument = UniquenessLevel("document") /** * The moniker is unique inside a project for which a dump got created */ UniquenessLevelProject = UniquenessLevel("project") /** * The moniker is unique inside the group to which a project belongs */ UniquenessLevelGroup = UniquenessLevel("group") /** * The moniker is unique inside the moniker scheme. */ UniquenessLevelScheme = UniquenessLevel("scheme") /** * The moniker is globally unique */ UniquenessLevelGlobal = UniquenessLevel("global") )
const ( /** * The moniker represent a symbol that is imported into a project */ MonikerKindImport = MonikerKind("import") /** * The moniker represents a symbol that is exported from a project */ MonikerKindExport = 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, ...) */ MonikerKindLocal = MonikerKind("local") )
const ( /** * Documents should not be synced at all. */ TextDocumentSyncKindNone = TextDocumentSyncKind(0) /** * Documents are synced by always sending the full content * of the document. */ TextDocumentSyncKindFull = TextDocumentSyncKind(1) /** * Documents are synced by sending the full content on open. * After that only incremental updates to the document are * send. */ TextDocumentSyncKindIncremental = TextDocumentSyncKind(2) )
*
- Defines how the host (editor) should sync document changes to the language
- server.
const ( /** * Manually triggered, e.g. by the user pressing save, by starting * debugging, or by an API call. */ TextDocumentSaveReasonManual = TextDocumentSaveReason(1) /** * Automatic after a delay. */ TextDocumentSaveReasonAfterDelay = TextDocumentSaveReason(2) /** * When the editor lost focus. */ TextDocumentSaveReasonFocusOut = TextDocumentSaveReason(3) )
*
- Represents reasons why a text document is saved.
const ( /** * An error message. */ MessageTypeError = MessageType(1) /** * A warning message. */ MessageTypeWarning = MessageType(2) /** * An information message. */ MessageTypeInfo = MessageType(3) /** * A log message. */ MessageTypeLog = MessageType(4) )
const ( /** * Interested in create events. */ WatchKindCreate = UInteger(1) /** * Interested in change events */ WatchKindChange = UInteger(2) /** * Interested in delete events */ WatchKindDelete = UInteger(4) )
const ( /** * The file got created. */ FileChangeTypeCreated = UInteger(1) /** * The file got changed. */ FileChangeTypeChanged = UInteger(2) /** * The file got deleted. */ FileChangeTypeDeleted = UInteger(3) )
*
- The file event type.
const ( /** * The pattern matches a file only. */ FileOperationPatternKindFile = FileOperationPatternKind("file") /** * The pattern matches a folder only. */ FileOperationPatternKindFolder = FileOperationPatternKind("folder") )
*
- A pattern kind describing if a glob pattern matches a file a folder or
- both. *
- @since 3.16.0
const ( /** * Render a completion as obsolete, usually using a strike-out. */ CompletionItemTagDeprecated = CompletionItemTag(1) )
const ( /** * If the protocol version provided by the client can't be handled by the * server. * * @deprecated This initialize error got replaced by client capabilities. * There is no version handshake in version 3.0x */ InitializeErrorCodeUnknownProtocolVersion = InitializeErrorCode(1) )
const MethodCallHierarchyIncomingCalls = Method("callHierarchy/incomingCalls")
const MethodCallHierarchyOutgoingCalls = Method("callHierarchy/outgoingCalls")
const MethodCancelRequest = Method("$/cancelRequest")
const MethodCodeActionResolve = Method("codeAction/resolve")
const MethodCodeLensResolve = Method("codeLens/resolve")
const MethodCompletionItemResolve = Method("completionItem/resolve")
const MethodDocumentLinkResolve = Method("documentLink/resolve")
const MethodExit = Method("exit")
const MethodInitialize = Method("initialize")
const MethodInitialized = Method("initialized")
const MethodLogTrace = Method("$/logTrace")
const MethodProgress = Method("$/progress")
const MethodSetTrace = Method("$/setTrace")
const MethodShutdown = Method("shutdown")
const MethodTextDocumentCodeAction = Method("textDocument/codeAction")
const MethodTextDocumentCodeLens = Method("textDocument/codeLens")
const MethodTextDocumentColor = Method("textDocument/documentColor")
const MethodTextDocumentColorPresentation = Method("textDocument/colorPresentation")
const MethodTextDocumentCompletion = Method("textDocument/completion")
const MethodTextDocumentDeclaration = Method("textDocument/declaration")
const MethodTextDocumentDefinition = Method("textDocument/definition")
const MethodTextDocumentDidChange = Method("textDocument/didChange")
const MethodTextDocumentDidClose = Method("textDocument/didClose")
const MethodTextDocumentDidOpen = Method("textDocument/didOpen")
const MethodTextDocumentDidSave = Method("textDocument/didSave")
const MethodTextDocumentDocumentHighlight = Method("textDocument/documentHighlight")
const MethodTextDocumentDocumentLink = Method("textDocument/documentLink")
const MethodTextDocumentDocumentSymbol = Method("textDocument/documentSymbol")
const MethodTextDocumentFoldingRange = Method("textDocument/foldingRange")
const MethodTextDocumentFormatting = Method("textDocument/formatting")
const MethodTextDocumentHover = Method("textDocument/hover")
const MethodTextDocumentImplementation = Method("textDocument/implementation")
const MethodTextDocumentLinkedEditingRange = Method("textDocument/linkedEditingRange")
const MethodTextDocumentMoniker = Method("textDocument/moniker")
const MethodTextDocumentOnTypeFormatting = Method("textDocument/onTypeFormatting")
const MethodTextDocumentPrepareCallHierarchy = Method("textDocument/prepareCallHierarchy")
const MethodTextDocumentPrepareRename = Method("textDocument/prepareRename")
const MethodTextDocumentRangeFormatting = Method("textDocument/rangeFormatting")
const MethodTextDocumentReferences = Method("textDocument/references")
const MethodTextDocumentRename = Method("textDocument/rename")
const MethodTextDocumentSelectionRange = Method("textDocument/selectionRange")
const MethodTextDocumentSemanticTokensFull = Method("textDocument/semanticTokens/full")
const MethodTextDocumentSemanticTokensFullDelta = Method("textDocument/semanticTokens/full/delta")
const MethodTextDocumentSemanticTokensRange = Method("textDocument/semanticTokens/range")
const MethodTextDocumentSignatureHelp = Method("textDocument/signatureHelp")
const MethodTextDocumentTypeDefinition = Method("textDocument/typeDefinition")
const MethodTextDocumentWillSave = Method("textDocument/willSave")
const MethodTextDocumentWillSaveWaitUntil = Method("textDocument/willSaveWaitUntil")
const MethodWindowWorkDoneProgressCancel = Method("window/workDoneProgress/cancel")
const MethodWorkspaceDidChangeConfiguration = Method("workspace/didChangeConfiguration")
const MethodWorkspaceDidChangeWatchedFiles = Method("workspace/didChangeWatchedFiles")
const MethodWorkspaceDidChangeWorkspaceFolders = Method("workspace/didChangeWorkspaceFolders")
const MethodWorkspaceDidCreateFiles = Method("workspace/didCreateFiles")
const MethodWorkspaceDidDeleteFiles = Method("workspace/didDeleteFiles")
const MethodWorkspaceDidRenameFiles = Method("workspace/didRenameFiles")
const MethodWorkspaceExecuteCommand = Method("workspace/executeCommand")
const MethodWorkspaceSemanticTokensRefresh = Method("workspace/semanticTokens/refresh")
const MethodWorkspaceSymbol = Method("workspace/symbol")
const MethodWorkspaceWillCreateFiles = Method("workspace/willCreateFiles")
const MethodWorkspaceWillDeleteFiles = Method("workspace/willDeleteFiles")
const MethodWorkspaceWillRenameFiles = Method("workspace/willRenameFiles")
const ( /** * The client's default behavior is to select the identifier * according the to language's syntax rule. */ PrepareSupportDefaultBehaviorIdentifier = PrepareSupportDefaultBehavior(1) )
const ServerClientRegisterCapability = Method("client/registerCapability")
const ServerClientUnregisterCapability = Method("client/unregisterCapability")
const ServerTelemetryEvent = Method("telemetry/event")
const ServerTextDocumentPublishDiagnostics = Method("textDocument/publishDiagnostics")
const ServerWindowLogMessage = Method("window/logMessage")
const ServerWindowShowDocument = Method("window/showDocument")
const ServerWindowShowMessage = Method("window/showMessage")
const ServerWindowShowMessageRequest = Method("window/showMessageRequest")
const ServerWindowWorkDoneProgressCreate = Method("window/workDoneProgress/create")
const ServerWorkspaceApplyEdit = Method("workspace/applyEdit")
const ServerWorkspaceCodeLensRefresh = Method("workspace/codeLens/refresh")
const ServerWorkspaceConfiguration = Method("workspace/configuration")
const ServerWorkspaceWorkspaceFolders = Method("workspace/workspaceFolders")
const ( /** * Render a symbol as obsolete, usually using a strike-out. */ SymbolTagDeprecated = SymbolTag(1) )
const (
TokenFormatRelative = TokenFormat("relative")
)
Variables ¶
var EOL = []string{"\n", "\r\n", "\r"}
var False bool = false
var True bool = true
Functions ¶
func HasTraceLevel ¶
func HasTraceLevel(value TraceValue) bool
func HasTraceMessageType ¶
func HasTraceMessageType(type_ MessageType) bool
func SetTraceValue ¶
func SetTraceValue(value TraceValue)
Types ¶
type AnnotatedTextEdit ¶
type AnnotatedTextEdit struct { TextEdit /** * The actual annotation identifier. */ AnnotationID ChangeAnnotationIdentifier `json:"annotationId"` }
*
- 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"` }
type ApplyWorkspaceEditResponse ¶
type ApplyWorkspaceEditResponse 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 *UInteger `json:"failedChange,omitempty"` }
type BoolOrString ¶
type BoolOrString struct {
Value any // bool | string
}
func (BoolOrString) MarshalJSON ¶
func (self BoolOrString) MarshalJSON() ([]byte, error)
(json.Marshaler interface)
func (BoolOrString) UnmarshalJSON ¶
func (self BoolOrString) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
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"` }
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 [`this.from`](#CallHierarchyIncomingCall.from). */ FromRanges []Range `json:"fromRanges"` }
type CallHierarchyIncomingCallsFunc ¶
type CallHierarchyIncomingCallsFunc func(context *glsp.Context, params *CallHierarchyIncomingCallsParams) ([]CallHierarchyIncomingCall, error)
type CallHierarchyIncomingCallsParams ¶
type CallHierarchyIncomingCallsParams struct { WorkDoneProgressParams PartialResultParams Item CallHierarchyItem `json:"item"` }
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 * [`range`](#CallHierarchyItem.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 any `json:"data,omitempty"` }
type CallHierarchyOptions ¶
type CallHierarchyOptions struct {
WorkDoneProgressOptions
}
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 `callHierarchy/outgoingCalls` request. */ FromRanges []Range `json:"fromRanges"` }
type CallHierarchyOutgoingCallsFunc ¶
type CallHierarchyOutgoingCallsFunc func(context *glsp.Context, params *CallHierarchyOutgoingCallsParams) ([]CallHierarchyOutgoingCall, error)
type CallHierarchyOutgoingCallsParams ¶
type CallHierarchyOutgoingCallsParams struct { WorkDoneProgressParams PartialResultParams Item CallHierarchyItem `json:"item"` }
type CallHierarchyPrepareParams ¶
type CallHierarchyPrepareParams struct { TextDocumentPositionParams WorkDoneProgressParams }
type CallHierarchyRegistrationOptions ¶
type CallHierarchyRegistrationOptions struct { TextDocumentRegistrationOptions CallHierarchyOptions StaticRegistrationOptions }
type CancelParams ¶
type CancelParams struct { /** * The request id to cancel. */ ID IntegerOrString `json:"id"` }
type CancelRequestFunc ¶
type CancelRequestFunc func(context *glsp.Context, params *CancelParams) error
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
*
- An identifier referring to a change annotation managed by a workspace
- edit. *
- @since 3.16.0
type ClientCapabilities ¶
type ClientCapabilities struct { /** * Workspace specific client capabilities. */ Workspace *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 requests/notifications. * * @since 3.16.0 */ FileOperations *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"` } `json:"fileOperations,omitempty"` } `json:"workspace,omitempty"` /** * Text document specific client capabilities. */ TextDocument *TextDocumentClientCapabilities `json:"textDocument,omitempty"` /** * Window specific client capabilities. */ Window *struct { /** * Whether client supports handling progress notifications. If set * servers are allowed to report in `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"` /** * Client capabilities for the show document request. * * @since 3.16.0 */ ShowDocument *ShowDocumentClientCapabilities `json:"showDocument,omitempty"` } `json:"window,omitempty"` /** * General client capabilities. * * @since 3.16.0 */ General *struct { /** * 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"` } `json:"general,omitempty"` /** * Experimental client capabilities. */ Experimental any `json:"experimental,omitempty"` }
func (*ClientCapabilities) SupportsSymbolKind ¶
func (self *ClientCapabilities) SupportsSymbolKind(kind SymbolKind) bool
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 code * action menus. * * - Disabled actions are shown as faded out in the code action menu when * the user request a more specific type of code action, such as * refactorings. * * - If the user has a keybinding that auto applies a code action and only * a disabled code actions are returned, the client should show the user * an error message with `reason` in the editor. * * @since 3.16.0 */ Disabled *struct { /** * Human readable description of why the code action is currently * disabled. * * This is displayed in the code actions UI. */ Reason string `json:"reason"` } `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 any `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 supports code action literals as a valid * response of the `textDocument/codeAction` request. * * @since 3.8.0 */ CodeActionLiteralSupport *struct { /** * The code action kind is supported with the following value * set. */ CodeActionKind 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"` } `json:"codeActionKind"` } `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 *struct { /** * The properties that a client can resolve lazily. */ Properties []string `json:"properties"` } `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"` }
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"` }
* * Contains additional diagnostic information about the context in which * a code action is run.
type CodeActionKind ¶
type CodeActionKind = string
*
- The kind of a code action. *
- Kinds are a hierarchical list of identifiers separated by `.`,
- e.g. `"refactor.extract.function"`. *
- The set of kinds is open and client needs to announce the kinds it supports
- to the server during initialization.
type CodeActionOptions ¶
type CodeActionOptions struct { WorkDoneProgressOptions /** * 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"` /** * The server provides support to resolve additional * information for a code action. * * @since 3.16.0 */ ResolveProvider *bool `json:"resolveProvider,omitempty"` }
type CodeActionParams ¶
type CodeActionParams struct { WorkDoneProgressParams PartialResultParams /** * 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"` }
*
- Params for the CodeActionRequest
type CodeActionRegistrationOptions ¶
type CodeActionRegistrationOptions struct { TextDocumentRegistrationOptions CodeActionOptions }
type CodeActionResolveFunc ¶
type CodeActionResolveFunc func(context *glsp.Context, params *CodeAction) (*CodeAction, error)
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 code lens and a code lens resolve request. */ Data any `json:"data,omitempty"` }
*
- A code lens represents a 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.
type CodeLensClientCapabilities ¶
type CodeLensClientCapabilities struct { /** * Whether code lens supports dynamic registration. */ DynamicRegistration *bool `json:"dynamicRegistration,omitempty"` }
type CodeLensOptions ¶
type CodeLensOptions struct { WorkDoneProgressOptions /** * Code lens has a resolve provider as well. */ ResolveProvider *bool `json:"resolveProvider,omitempty"` }
type CodeLensParams ¶
type CodeLensParams struct { WorkDoneProgressParams PartialResultParams /** * The document to request code lens for. */ TextDocument TextDocumentIdentifier `json:"textDocument"` }
type CodeLensRegistrationOptions ¶
type CodeLensRegistrationOptions struct { TextDocumentRegistrationOptions CodeLensOptions }
type CodeLensResolveFunc ¶
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"` }
type Color ¶
type Color struct { /** * The red component of this color in the range [0-1]. */ Red Decimal `json:"red"` /** * The green component of this color in the range [0-1]. */ Green Decimal `json:"green"` /** * The blue component of this color in the range [0-1]. */ Blue Decimal `json:"blue"` /** * The alpha component of this color in the range [0-1]. */ Alpha Decimal `json:"alpha"` }
*
- Represents a color in RGBA space.
type ColorInformation ¶
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 [edit](#TextEdit) which is applied to a document when selecting * this presentation for the color. When `falsy` the * [label](#ColorPresentation.label) is used. */ TextEdit *TextEdit `json:"textEdit,omitempty"` /** * An optional array of additional [text edits](#TextEdit) that are applied * when selecting this color presentation. Edits must not overlap with the * main [edit](#ColorPresentation.textEdit) nor with themselves. */ AdditionalTextEdits []TextEdit `json:"additionalTextEdits,omitempty"` }
type ColorPresentationParams ¶
type ColorPresentationParams struct { WorkDoneProgressParams PartialResultParams /** * The text document. */ TextDocument TextDocumentIdentifier `json:"textDocument"` /** * The color information to request presentations for. */ Color Color `json:"color"` /** * The range where the color would be inserted. Serves as a context. */ Range Range `json:"range"` }
type CompletionClientCapabilities ¶
type CompletionClientCapabilities struct { /** * Whether completion supports dynamic registration. */ DynamicRegistration *bool `json:"dynamicRegistration,omitempty"` /** * The client supports the following `CompletionItem` specific * capabilities. */ CompletionItem *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 *struct { /** * The tags supported by the client. */ ValueSet []CompletionItemTag `json:"valueSet"` } `json:"tagSupport,omitempty"` /** * Client supports 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 *struct { /** * The properties that a client can resolve lazily. */ Properties []string `json:"properties"` } `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 *struct { ValueSet []InsertTextMode `json:"valueSet"` } `json:"insertTextModeSupport,omitempty"` } `json:"completionItem,omitempty"` CompletionItemKind *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"` } `json:"completionItemKind,omitempty"` /** * The client supports to send additional context information for a * `textDocument/completion` request. */ ContextSupport *bool `json:"contextSupport,omitempty"` }
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. By default * also the text that is inserted when selecting * this completion. */ Label string `json:"label"` /** * The kind of this completion item. Based of the kind * an icon is chosen by the editor. The standardized set * of available values is defined in `CompletionItemKind`. */ 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 any `json:"documentation,omitempty"` // nil | string | MarkupContent /** * Indicates if this item is deprecated. * * @deprecated Use `tags` instead if supported. */ 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 label is used. */ SortText *string `json:"sortText,omitempty"` /** * A string that should be used when filtering a set of * completion items. When `falsy` the label is used. */ FilterText *string `json:"filterText,omitempty"` /** * A string that should be inserted into a document when selecting * this completion. When `falsy` the 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`. */ InsertTextFormat *InsertTextFormat `json:"insertTextFormat,omitempty"` /** * How whitespace and indentation is handled during completion * item insertion. If not provided the client's default value depends on * the `textDocument.completion.insertTextMode` client capability. * * @since 3.16.0 */ InsertTextMode *InsertTextMode `json:"insertTextMode,omitempty"` /** * An edit which is applied to a document when selecting this completion. * When an edit is provided the value of `insertText` is ignored. * * *Note:* The range of the edit must be a single line range and it must * contain the position at which completion has been requested. * * 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 any `json:"textEdit,omitempty"` // nil | TextEdit | InsertReplaceEdit /** * An optional array of additional text edits that are applied when * selecting this completion. Edits must not overlap (including the same * insert position) with the main 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 command that is executed *after* inserting this completion. * *Note* that additional modifications to the current document should be * described with the additionalTextEdits-property. */ Command *Command `json:"command,omitempty"` /** * A data entry field that is preserved on a completion item between * a completion and a completion resolve request. */ Data any `json:"data,omitempty"` }
func (*CompletionItem) UnmarshalJSON ¶
func (self *CompletionItem) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
type CompletionItemResolveFunc ¶
type CompletionItemResolveFunc func(context *glsp.Context, params *CompletionItem) (*CompletionItem, error)
type CompletionItemTag ¶
type CompletionItemTag Integer
*
- Completion item tags are extra annotations that tweak the rendering of a
- completion item. *
- @since 3.15.0
type CompletionList ¶
type CompletionList struct { /** * This list it not complete. Further typing should result in recomputing * this list. */ IsIncomplete bool `json:"isIncomplete"` /** * The completion items. */ Items []CompletionItem `json:"items"` }
*
- Represents a collection of [completion items](#CompletionItem) to be
- presented in the editor.
type CompletionOptions ¶
type CompletionOptions struct { WorkDoneProgressOptions /** * 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 client capability * `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"` }
*
- Completion options.
type CompletionParams ¶
type CompletionParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams /** * The completion context. This is only available if the client specifies * to send this using the client capability * `completion.contextSupport === true` */ Context *CompletionContext `json:"context,omitempty"` }
type CompletionRegistrationOptions ¶
type CompletionRegistrationOptions struct { TextDocumentRegistrationOptions CompletionOptions }
type ConfigurationItem ¶
type ConfigurationItem struct { /** * The scope to get the configuration section for. */ ScopeURI *DocumentUri `json:"scopeUri,omitempty"` /** * The configuration section asked for. */ Section *string `json:"section,omitempty"` }
type ConfigurationParams ¶
type ConfigurationParams struct {
Items []ConfigurationItem `json:"items"`
}
type CreateFile ¶
type CreateFile struct { /** * A create */ Kind string `json:"kind"` // == "create" /** * The resource to create. */ URI DocumentUri `json:"uri"` /** * Additional options */ Options *CreateFileOptions `json:"options,omitempty"` /** * An optional annotation identifer describing the operation. * * @since 3.16.0 */ AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"` }
*
- 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 Decimal ¶
type Decimal = float32
*
- Defines a decimal number. Since decimal numbers are very
- rare in the language server specification we denote the
- exact range with every decimal using the mathematics
- interval notation (e.g. [0, 1] denotes all decimals d with
- 0 <= d <= 1.
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"` }
type DeclarationOptions ¶
type DeclarationOptions struct {
WorkDoneProgressOptions
}
type DeclarationParams ¶
type DeclarationParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
type DeclarationRegistrationOptions ¶
type DeclarationRegistrationOptions struct { DeclarationOptions TextDocumentRegistrationOptions StaticRegistrationOptions }
type DefaultBehavior ¶
type DefaultBehavior struct {
DefaultBehavior bool `json:"defaultBehavior"`
}
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"` }
type DefinitionOptions ¶
type DefinitionOptions struct {
WorkDoneProgressOptions
}
type DefinitionParams ¶
type DefinitionParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
type DefinitionRegistrationOptions ¶
type DefinitionRegistrationOptions struct { TextDocumentRegistrationOptions DefinitionOptions }
type DeleteFile ¶
type DeleteFile struct { /** * A delete */ Kind string `json:"kind"` // == "delete" /** * The file to delete. */ URI DocumentUri `json:"uri"` /** * Delete options. */ Options *DeleteFileOptions `json:"options,omitempty"` /** * An optional annotation identifer describing the operation. * * @since 3.16.0 */ AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"` }
*
- 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. Can be omitted. If omitted it is up to the * client to interpret diagnostics as error, warning, info or hint. */ Severity *DiagnosticSeverity `json:"severity,omitempty"` /** * The diagnostic's code, which might appear in the user interface. */ Code *IntegerOrString `json:"code,omitempty"` /** * An optional property to describe the error code. * * @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'. */ Source *string `json:"source,omitempty"` /** * The diagnostic's message. */ 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 any `json:"data,omitempty"` }
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 are related to
- a diagnostics, e.g when duplicating a symbol in a scope.
type DiagnosticSeverity ¶
type DiagnosticSeverity Integer
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 any `json:"settings"` }
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 []any `json:"contentChanges"` // TextDocumentContentChangeEvent or TextDocumentContentChangeEventWhole }
func (*DidChangeTextDocumentParams) UnmarshalJSON ¶
func (self *DidChangeTextDocumentParams) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
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"` }
type DidChangeWatchedFilesParams ¶
type DidChangeWatchedFilesParams struct { /** * The actual file events. */ Changes []FileEvent `json:"changes"` }
type DidChangeWatchedFilesRegistrationOptions ¶
type DidChangeWatchedFilesRegistrationOptions struct { /** * The watchers to register. */ Watchers []FileSystemWatcher `json:"watchers"` }
*
- Describe options to be used when registering for file system change events.
type DidChangeWorkspaceFoldersParams ¶
type DidChangeWorkspaceFoldersParams struct { /** * The actual workspace folder change event. */ Event WorkspaceFoldersChangeEvent `json:"event"` }
type DidCloseTextDocumentParams ¶
type DidCloseTextDocumentParams struct { /** * The document that was closed. */ TextDocument TextDocumentIdentifier `json:"textDocument"` }
type DidOpenTextDocumentParams ¶
type DidOpenTextDocumentParams struct { /** * The document that was opened. */ TextDocument TextDocumentItem `json:"textDocument"` }
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"` }
type DocumentColorClientCapabilities ¶
type DocumentColorClientCapabilities struct { /** * Whether document color supports dynamic registration. */ DynamicRegistration *bool `json:"dynamicRegistration,omitempty"` }
type DocumentColorOptions ¶
type DocumentColorOptions struct {
WorkDoneProgressOptions
}
type DocumentColorParams ¶
type DocumentColorParams struct { WorkDoneProgressParams PartialResultParams /** * The text document. */ TextDocument TextDocumentIdentifier `json:"textDocument"` }
type DocumentColorRegistrationOptions ¶
type DocumentColorRegistrationOptions struct { TextDocumentRegistrationOptions StaticRegistrationOptions DocumentColorOptions }
type DocumentFilter ¶
type DocumentFilter struct { /** * A language id, like `typescript`. */ Language *string `json:"language,omitempty"` /** * A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */ Scheme *string `json:"scheme,omitempty"` /** * A glob pattern, like `*.{ts,js}`. * * 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`) */ Pattern *string `json:"pattern,omitempty"` }
type DocumentFormattingClientCapabilities ¶
type DocumentFormattingClientCapabilities struct { /** * Whether formatting supports dynamic registration. */ DynamicRegistration *bool `json:"dynamicRegistration,omitempty"` }
type DocumentFormattingOptions ¶
type DocumentFormattingOptions struct {
WorkDoneProgressOptions
}
type DocumentFormattingParams ¶
type DocumentFormattingParams struct { WorkDoneProgressParams /** * The document to format. */ TextDocument TextDocumentIdentifier `json:"textDocument"` /** * The format options. */ Options FormattingOptions `json:"options"` }
type DocumentFormattingRegistrationOptions ¶
type DocumentFormattingRegistrationOptions struct { TextDocumentRegistrationOptions DocumentFormattingOptions }
type DocumentHighlight ¶
type DocumentHighlight struct { /** * The range this highlight applies to. */ Range Range `json:"range"` /** * The highlight kind, default is DocumentHighlightKind.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"` }
type DocumentHighlightOptions ¶
type DocumentHighlightOptions struct {
WorkDoneProgressOptions
}
type DocumentHighlightParams ¶
type DocumentHighlightParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
type DocumentHighlightRegistrationOptions ¶
type DocumentHighlightRegistrationOptions struct { TextDocumentRegistrationOptions DocumentHighlightOptions }
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 *DocumentUri `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 any `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"` }
type DocumentLinkOptions ¶
type DocumentLinkOptions struct { WorkDoneProgressOptions /** * Document links have a resolve provider as well. */ ResolveProvider *bool `json:"resolveProvider,omitempty"` }
type DocumentLinkParams ¶
type DocumentLinkParams struct { WorkDoneProgressParams PartialResultParams /** * The document to provide document links for. */ TextDocument TextDocumentIdentifier `json:"textDocument"` }
type DocumentLinkRegistrationOptions ¶
type DocumentLinkRegistrationOptions struct { TextDocumentRegistrationOptions DocumentLinkOptions }
type DocumentLinkResolveFunc ¶
type DocumentLinkResolveFunc func(context *glsp.Context, params *DocumentLink) (*DocumentLink, error)
type DocumentOnTypeFormattingClientCapabilities ¶
type DocumentOnTypeFormattingClientCapabilities struct { /** * Whether on type formatting supports dynamic registration. */ DynamicRegistration *bool `json:"dynamicRegistration,omitempty"` }
type DocumentOnTypeFormattingParams ¶
type DocumentOnTypeFormattingParams struct { TextDocumentPositionParams /** * The character that has been typed. */ Ch string `json:"ch"` /** * The format options. */ Options FormattingOptions `json:"options"` }
type DocumentOnTypeFormattingRegistrationOptions ¶
type DocumentOnTypeFormattingRegistrationOptions struct { TextDocumentRegistrationOptions DocumentOnTypeFormattingOptions }
type DocumentRangeFormattingClientCapabilities ¶
type DocumentRangeFormattingClientCapabilities struct { /** * Whether formatting supports dynamic registration. */ DynamicRegistration *bool `json:"dynamicRegistration,omitempty"` }
type DocumentRangeFormattingOptions ¶
type DocumentRangeFormattingOptions struct {
WorkDoneProgressOptions
}
type DocumentRangeFormattingParams ¶
type DocumentRangeFormattingParams struct { WorkDoneProgressParams /** * The document to format. */ TextDocument TextDocumentIdentifier `json:"textDocument"` /** * The range to format */ Range Range `json:"range"` /** * The format options */ Options FormattingOptions `json:"options"` }
type DocumentRangeFormattingRegistrationOptions ¶
type DocumentRangeFormattingRegistrationOptions struct { TextDocumentRegistrationOptions DocumentRangeFormattingOptions }
type DocumentSelector ¶
type DocumentSelector []DocumentFilter
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 *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"` } `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 *struct { /** * The tags supported by the client. */ ValueSet []SymbolTag `json:"valueSet"` } `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"` }
type DocumentSymbolOptions ¶
type DocumentSymbolOptions struct { WorkDoneProgressOptions /** * 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"` }
type DocumentSymbolParams ¶
type DocumentSymbolParams struct { WorkDoneProgressParams PartialResultParams /** * The text document. */ TextDocument TextDocumentIdentifier `json:"textDocument"` }
type DocumentSymbolRegistrationOptions ¶
type DocumentSymbolRegistrationOptions struct { TextDocumentRegistrationOptions DocumentSymbolOptions }
type DocumentUri ¶
type DocumentUri = string
type ExecuteCommandClientCapabilities ¶
type ExecuteCommandClientCapabilities struct { /** * Execute command supports dynamic registration. */ DynamicRegistration *bool `json:"dynamicRegistration,omitempty"` }
type ExecuteCommandOptions ¶
type ExecuteCommandOptions struct { WorkDoneProgressOptions /** * The commands to be executed on the server */ Commands []string `json:"commands"` }
type ExecuteCommandParams ¶
type ExecuteCommandParams struct { WorkDoneProgressParams /** * The identifier of the actual command handler. */ Command string `json:"command"` /** * Arguments that the command should be invoked with. */ Arguments []any `json:"arguments,omitempty"` }
type ExecuteCommandRegistrationOptions ¶
type ExecuteCommandRegistrationOptions struct {
ExecuteCommandOptions
}
*
- Execute command registration options.
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 UInteger `json:"type"` }
*
- An event describing a file change.
type FileOperationFilter ¶
type FileOperationFilter struct { /** * A Uri 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. *
- @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 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`) */ 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. *
- @since 3.16.0
type FileOperationPatternKind ¶
type FileOperationPatternKind string
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. * * 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`) */ GlobPattern string `json:"globPattern"` /** * The kind of events of interest. If omitted it defaults * to WatchKind.Create | WatchKind.Change | WatchKind.Delete * which is 7. */ Kind *UInteger `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 UInteger `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 *UInteger `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 UInteger `json:"endLine"` /** * The zero-based character offset before the folded range ends. If not * defined, defaults to the length of the end line. */ EndCharacter *UInteger `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 [FoldingRangeKind](#FoldingRangeKind) for an * enumeration of standardized kinds. */ Kind *string `json:"kind,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 *UInteger `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"` }
type FoldingRangeOptions ¶
type FoldingRangeOptions struct {
WorkDoneProgressOptions
}
type FoldingRangeParams ¶
type FoldingRangeParams struct { WorkDoneProgressParams PartialResultParams /** * The text document. */ TextDocument TextDocumentIdentifier `json:"textDocument"` }
type FoldingRangeRegistrationOptions ¶
type FoldingRangeRegistrationOptions struct { TextDocumentRegistrationOptions FoldingRangeOptions StaticRegistrationOptions }
type FormattingOptions ¶
type Handler ¶
type Handler struct { // Base Protocol CancelRequest CancelRequestFunc Progress ProgressFunc // General Messages Initialize InitializeFunc Initialized InitializedFunc Shutdown ShutdownFunc Exit ExitFunc LogTrace LogTraceFunc SetTrace SetTraceFunc // Window WindowWorkDoneProgressCancel WindowWorkDoneProgressCancelFunc // Workspace WorkspaceDidChangeWorkspaceFolders WorkspaceDidChangeWorkspaceFoldersFunc WorkspaceDidChangeConfiguration WorkspaceDidChangeConfigurationFunc WorkspaceDidChangeWatchedFiles WorkspaceDidChangeWatchedFilesFunc WorkspaceSymbol WorkspaceSymbolFunc WorkspaceExecuteCommand WorkspaceExecuteCommandFunc WorkspaceWillCreateFiles WorkspaceWillCreateFilesFunc WorkspaceDidCreateFiles WorkspaceDidCreateFilesFunc WorkspaceWillRenameFiles WorkspaceWillRenameFilesFunc WorkspaceDidRenameFiles WorkspaceDidRenameFilesFunc WorkspaceWillDeleteFiles WorkspaceWillDeleteFilesFunc WorkspaceDidDeleteFiles WorkspaceDidDeleteFilesFunc WorkspaceSemanticTokensRefresh WorkspaceSemanticTokensRefreshFunc // Text Document Synchronization TextDocumentDidOpen TextDocumentDidOpenFunc TextDocumentDidChange TextDocumentDidChangeFunc TextDocumentWillSave TextDocumentWillSaveFunc TextDocumentWillSaveWaitUntil TextDocumentWillSaveWaitUntilFunc TextDocumentDidSave TextDocumentDidSaveFunc TextDocumentDidClose TextDocumentDidCloseFunc // Language Features TextDocumentCompletion TextDocumentCompletionFunc CompletionItemResolve CompletionItemResolveFunc TextDocumentHover TextDocumentHoverFunc TextDocumentSignatureHelp TextDocumentSignatureHelpFunc TextDocumentDeclaration TextDocumentDeclarationFunc TextDocumentDefinition TextDocumentDefinitionFunc TextDocumentTypeDefinition TextDocumentTypeDefinitionFunc TextDocumentImplementation TextDocumentImplementationFunc TextDocumentReferences TextDocumentReferencesFunc TextDocumentDocumentHighlight TextDocumentDocumentHighlightFunc TextDocumentDocumentSymbol TextDocumentDocumentSymbolFunc TextDocumentCodeAction TextDocumentCodeActionFunc CodeActionResolve CodeActionResolveFunc TextDocumentCodeLens TextDocumentCodeLensFunc CodeLensResolve CodeLensResolveFunc TextDocumentDocumentLink TextDocumentDocumentLinkFunc DocumentLinkResolve DocumentLinkResolveFunc TextDocumentColor TextDocumentColorFunc TextDocumentColorPresentation TextDocumentColorPresentationFunc TextDocumentFormatting TextDocumentFormattingFunc TextDocumentRangeFormatting TextDocumentRangeFormattingFunc TextDocumentOnTypeFormatting TextDocumentOnTypeFormattingFunc TextDocumentRename TextDocumentRenameFunc TextDocumentPrepareRename TextDocumentPrepareRenameFunc TextDocumentFoldingRange TextDocumentFoldingRangeFunc TextDocumentSelectionRange TextDocumentSelectionRangeFunc TextDocumentPrepareCallHierarchy TextDocumentPrepareCallHierarchyFunc CallHierarchyIncomingCalls CallHierarchyIncomingCallsFunc CallHierarchyOutgoingCalls CallHierarchyOutgoingCallsFunc TextDocumentSemanticTokensFull TextDocumentSemanticTokensFullFunc TextDocumentSemanticTokensFullDelta TextDocumentSemanticTokensFullDeltaFunc TextDocumentSemanticTokensRange TextDocumentSemanticTokensRangeFunc TextDocumentLinkedEditingRange TextDocumentLinkedEditingRangeFunc TextDocumentMoniker TextDocumentMonikerFunc // contains filtered or unexported fields }
func (*Handler) CreateServerCapabilities ¶
func (self *Handler) CreateServerCapabilities() ServerCapabilities
func (*Handler) Handle ¶
func (self *Handler) Handle(context *glsp.Context) (r any, validMethod bool, validParams bool, err error)
glsp.Handler interface
func (*Handler) IsInitialized ¶
func (*Handler) SetInitialized ¶
type Hover ¶
type Hover struct { /** * The hover's content */ Contents any `json:"contents"` // MarkupContent | MarkedString | []MarkedString /** * An optional range is a range inside a text document * that is used to visualize a hover, e.g. by changing the background color. */ Range *Range `json:"range,omitempty"` }
*
- The result of a hover request.
func (*Hover) UnmarshalJSON ¶
json.Unmarshaler interface
type HoverClientCapabilities ¶
type HoverClientCapabilities struct { /** * Whether hover supports dynamic registration. */ DynamicRegistration *bool `json:"dynamicRegistration,omitempty"` /** * Client supports the following content formats if the content * property refers to a `literal of type MarkupContent`. * The order describes the preferred format of the client. */ ContentFormat []MarkupKind `json:"contentFormat,omitempty"` }
type HoverOptions ¶
type HoverOptions struct {
WorkDoneProgressOptions
}
type HoverParams ¶
type HoverParams struct { TextDocumentPositionParams WorkDoneProgressParams }
type HoverRegistrationOptions ¶
type HoverRegistrationOptions struct { TextDocumentRegistrationOptions HoverOptions }
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"` }
type ImplementationOptions ¶
type ImplementationOptions struct {
WorkDoneProgressOptions
}
type ImplementationParams ¶
type ImplementationParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
type ImplementationRegistrationOptions ¶
type ImplementationRegistrationOptions struct { TextDocumentRegistrationOptions TypeDefinitionOptions 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"` }
type InitializeErrorCode ¶
type InitializeErrorCode Integer
*
- Known error codes for an `InitializeError`;
type InitializeFunc ¶
type InitializeFunc func(context *glsp.Context, params *InitializeParams) (any, error)
Returns: InitializeResult | InitializeError
type InitializeParams ¶
type InitializeParams struct { WorkDoneProgressParams /** * 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 (see exit notification) * its process. */ ProcessID *Integer `json:"processId"` /** * Information about the client * * @since 3.15.0 */ 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"` } `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"` /** * User provided initialization options. */ InitializationOptions any `json:"initializationOptions,omitempty"` /** * The capabilities provided by the client (editor or tool) */ Capabilities ClientCapabilities `json:"capabilities"` /** * The initial trace setting. If omitted trace is disabled ('off'). */ Trace *TraceValue `json:"trace,omitempty"` /** * 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 InitializeResult ¶
type InitializeResult struct { /** * The capabilities the language server provides. */ Capabilities ServerCapabilities `json:"capabilities"` /** * Information about the server. * * @since 3.15.0 */ ServerInfo *InitializeResultServerInfo `json:"serverInfo,omitempty"` }
type InitializedFunc ¶
type InitializedFunc func(context *glsp.Context, params *InitializedParams) error
type InitializedParams ¶
type InitializedParams struct{}
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
type InsertTextFormat ¶
type InsertTextFormat Integer
*
- Defines whether the insert text in a completion item should be interpreted as
- plain text or a snippet.
type InsertTextMode ¶
type InsertTextMode Integer
*
- How whitespace and indentation is handled during completion
- item insertion. *
- @since 3.16.0
type IntegerOrString ¶
type IntegerOrString struct {
Value any // Integer | string
}
func (IntegerOrString) MarshalJSON ¶
func (self IntegerOrString) MarshalJSON() ([]byte, error)
(json.Marshaler interface)
func (IntegerOrString) UnmarshalJSON ¶
func (self IntegerOrString) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
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"` }
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 renamed 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"` }
type Location ¶
type Location struct { URI DocumentUri `json:"uri"` Range Range `json:"range"` }
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 mouse 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 the * `targetRange`. See also `DocumentSymbol#range` */ TargetSelectionRange Range `json:"targetSelectionRange"` }
type LogMessageParams ¶
type LogMessageParams struct { /** * The message type. See {@link MessageType} */ Type MessageType `json:"type"` /** * The actual message */ Message string `json:"message"` }
type LogTraceFunc ¶
type LogTraceFunc func(context *glsp.Context, params *LogTraceParams) error
type LogTraceParams ¶
type MarkdownClientCapabilities ¶
type MarkdownClientCapabilities struct { /** * The name of the parser. */ Parser string `json:"parser"` /** * The version of the parser. */ Version *string `json:"version,omitempty"` }
*
- Client capabilities specific to the used markdown parser. *
- @since 3.16.0
type MarkedString ¶
type MarkedString struct {
// contains filtered or unexported fields
}
*
- 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. *
- 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.
func (MarkedString) MarshalJSON ¶
func (self MarkedString) MarshalJSON() ([]byte, error)
(json.Marshaler interface)
func (MarkedString) UnmarshalJSON ¶
func (self MarkedString) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
type MarkedStringStruct ¶
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. *
- Here is an example how such a string can be constructed using
- JavaScript / TypeScript:
- ```typescript
- 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 MessageType ¶
type MessageType Integer
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.
type MonikerClientCapabilities ¶
type MonikerClientCapabilities 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"` }
type MonikerOptions ¶
type MonikerOptions struct {
WorkDoneProgressOptions
}
type MonikerParams ¶
type MonikerParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
type MonikerRegistrationOptions ¶
type MonikerRegistrationOptions struct { TextDocumentRegistrationOptions MonikerOptions }
type OptionalVersionedTextDocumentIdentifier ¶
type OptionalVersionedTextDocumentIdentifier struct { TextDocumentIdentifier /** * The version number of this document. If an optional 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 * known and the content on disk is the master (as specified with document * content ownership). * * The version number of a document will increase after each change, * including undo/redo. The number doesn't need to be consecutive. */ Version *Integer `json:"version"` }
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. * * *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 any `json:"label"` // string | [2]UInteger /** * The human-readable doc-comment of this parameter. Will be shown * in the UI but can be omitted. */ Documentation any `json:"documentation,omitempty"` // nil | string | MarkupContent }
*
- Represents a parameter of a callable-signature. A parameter can
- have a label and a doc-comment.
func (*ParameterInformation) UnmarshalJSON ¶
func (self *ParameterInformation) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
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 Position ¶
type Position struct { /** * Line position in a document (zero-based). */ Line UInteger `json:"line"` /** * Character offset on a line in a document (zero-based). Assuming that * the line is represented as a string, the `character` value represents * the gap between the `character` and `character + 1`. * * If the character value is greater than the line length it defaults back * to the line length. */ Character UInteger `json:"character"` }
func (Position) EndOfLineIn ¶
type PrepareRenameParams ¶
type PrepareRenameParams struct {
TextDocumentPositionParams
}
type PrepareSupportDefaultBehavior ¶
type PrepareSupportDefaultBehavior Integer
type ProgressFunc ¶
type ProgressFunc func(context *glsp.Context, params *ProgressParams) error
type ProgressParams ¶
type ProgressParams struct { /** * The progress token provided by the client or server. */ Token ProgressToken `json:"token"` /** * The progress data. */ Value any `json:"value"` }
type ProgressToken ¶
type ProgressToken = IntegerOrString
type PublishDiagnosticsClientCapabilities ¶
type PublishDiagnosticsClientCapabilities 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 *struct { /** * The tags supported by the client. */ ValueSet []DiagnosticTag `json:"valueSet"` } `json:"tagSupport,omitempty"` /** * Whether the client interprets the version property of the * `textDocument/publishDiagnostics` notification's parameter. * * @since 3.15.0 */ VersionSupport *bool `json:"versionSupport,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"` }
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 *UInteger `json:"version,omitempty"` /** * An array of diagnostic information items. */ Diagnostics []Diagnostic `json:"diagnostics"` }
type Range ¶
type RangeWithPlaceholder ¶
type ReferenceClientCapabilities ¶
type ReferenceClientCapabilities struct { /** * Whether references supports dynamic registration. */ DynamicRegistration *bool `json:"dynamicRegistration,omitempty"` }
type ReferenceContext ¶
type ReferenceContext struct { /** * Include the declaration of the current symbol. */ IncludeDeclaration bool `json:"includeDeclaration"` }
type ReferenceOptions ¶
type ReferenceOptions struct {
WorkDoneProgressOptions
}
type ReferenceParams ¶
type ReferenceParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams Context ReferenceContext `json:"context"` }
type ReferenceRegistrationOptions ¶
type ReferenceRegistrationOptions struct { TextDocumentRegistrationOptions ReferenceOptions }
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 any `json:"registerOptions,omitempty"` }
*
- General parameters to register for a capability.
type RegistrationParams ¶
type RegistrationParams struct {
Registrations []Registration `json:"registrations"`
}
type RegularExpressionsClientCapabilities ¶
type RegularExpressionsClientCapabilities struct { /** * The engine's name. */ Engine string `json:"engine"` /** * The engine's version. */ Version *string `json:"version,omitempty"` }
*
- Client capabilities specific to regular expressions.
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 * (`{ defaultBehavior: boolean }`). * * The value indicates the default behavior used by the * client. * * @since 3.16.0 */ PrepareSupportDefaultBehavior *PrepareSupportDefaultBehavior `json:"prepareSupportDefaultBehavior,omitempty"` /** * Whether th 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"` // == "rename" /** * The old (existing) location. */ OldURI DocumentUri `json:"oldUri"` /** * The new location. */ NewURI DocumentUri `json:"newUri"` /** * Rename options. */ Options *RenameFileOptions `json:"options,omitempty"` /** * An optional annotation identifer describing the operation. * * @since 3.16.0 */ AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"` }
*
- 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 { WorkDoneProgressOptions /** * Renames should be checked and tested before being executed. */ PrepareProvider *bool `json:"prepareProvider,omitempty"` }
type RenameParams ¶
type RenameParams struct { TextDocumentPositionParams WorkDoneProgressParams /** * The new name of the symbol. If the given name is not valid the * request must return a [ResponseError](#ResponseError) with an * appropriate message set. */ NewName string `json:"newName"` }
type RenameRegistrationOptions ¶
type RenameRegistrationOptions struct { TextDocumentRegistrationOptions RenameOptions }
type ResourceOperationKind ¶
type ResourceOperationKind string
*
- The kind of resource operations supported by the client.
type SaveOptions ¶
type SaveOptions struct { /** * The client is supposed to include the content on save. */ IncludeText *bool `json:"includeText,omitempty"` }
type SelectionRange ¶
type SelectionRange struct { /** * The [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"` }
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 { WorkDoneProgressParams PartialResultParams /** * The text document. */ TextDocument TextDocumentIdentifier `json:"textDocument"` /** * The positions inside the text document. */ Positions []Position `json:"positions"` }
type SelectionRangeRegistrationOptions ¶
type SelectionRangeRegistrationOptions struct { SelectionRangeOptions TextDocumentRegistrationOptions StaticRegistrationOptions }
type SemanticDelta ¶
type SemanticDelta struct {
Delta *bool `json:"delta,omitempty"`
}
type SemanticTokenModifier ¶
type SemanticTokenModifier string
type SemanticTokenType ¶
type SemanticTokenType string
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 []UInteger `json:"data"` }
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 struct { /** * The client will send the `textDocument/semanticTokens/range` request * if the server provides a corresponding handler. */ Range any `json:"Range,omitempty"` // nil | bool | struct{} /** * The client will send the `textDocument/semanticTokens/full` request * if the server provides a corresponding handler. */ Full any `json:"full,omitempty"` // nil | bool | SemanticDelta } `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 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"` }
func (*SemanticTokensClientCapabilities) UnmarshalJSON ¶
func (self *SemanticTokensClientCapabilities) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
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"` }
type SemanticTokensDeltaParams ¶
type SemanticTokensDeltaParams struct { WorkDoneProgressParams PartialResultParams /** * 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"` }
type SemanticTokensDeltaPartialResult ¶
type SemanticTokensDeltaPartialResult struct {
Edits []SemanticTokensEdit `json:"edits"`
}
type SemanticTokensEdit ¶
type SemanticTokensLegend ¶
type SemanticTokensOptions ¶
type SemanticTokensOptions struct { WorkDoneProgressOptions /** * The legend used by the server */ Legend SemanticTokensLegend `json:"legend"` /** * Server supports providing semantic tokens for a specific range * of a document. */ Range any `json:"range,omitempty"` // nil | bool | struct{} /** * Server supports providing semantic tokens for a full document. */ Full any `json:"full,omitempty"` // nil | bool | SemanticDelta }
func (*SemanticTokensOptions) UnmarshalJSON ¶
func (self *SemanticTokensOptions) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
type SemanticTokensParams ¶
type SemanticTokensParams struct { WorkDoneProgressParams PartialResultParams /** * The text document. */ TextDocument TextDocumentIdentifier `json:"textDocument"` }
type SemanticTokensPartialResult ¶
type SemanticTokensPartialResult struct {
Data []UInteger `json:"data"`
}
type SemanticTokensRangeParams ¶
type SemanticTokensRangeParams struct { WorkDoneProgressParams PartialResultParams /** * The text document. */ TextDocument TextDocumentIdentifier `json:"textDocument"` /** * The range the semantic tokens are requested for. */ Range Range `json:"range"` }
type SemanticTokensRegistrationOptions ¶
type SemanticTokensRegistrationOptions struct { TextDocumentRegistrationOptions SemanticTokensOptions StaticRegistrationOptions }
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 detect a project * wide change that requires such a calculation. */ RefreshSupport *bool `json:"refreshSupport,omitempty"` }
type ServerCapabilities ¶
type ServerCapabilities struct { /** * Defines how text documents are synced. Is either a detailed structure * defining each notification or for backwards compatibility the * TextDocumentSyncKind number. If omitted it defaults to * `TextDocumentSyncKind.None`. */ TextDocumentSync any `json:"textDocumentSync,omitempty"` // nil | TextDocumentSyncOptions | TextDocumentSyncKind /** * The server provides completion support. */ CompletionProvider *CompletionOptions `json:"completionProvider,omitempty"` /** * The server provides hover support. */ HoverProvider any `json:"hoverProvider,omitempty"` // nil | bool | HoverOptions /** * The server provides signature help support. */ SignatureHelpProvider *SignatureHelpOptions `json:"signatureHelpProvider,omitempty"` /** * The server provides go to declaration support. * * @since 3.14.0 */ DeclarationProvider any `json:"declarationProvider,omitempty"` // nil | bool | DeclarationOptions | DeclarationRegistrationOptions /** * The server provides goto definition support. */ DefinitionProvider any `json:"definitionProvider,omitempty"` // nil | bool | DefinitionOptions /** * The server provides goto type definition support. * * @since 3.6.0 */ TypeDefinitionProvider any `json:"typeDefinitionProvider,omitempty"` // nil | bool | TypeDefinitionOption | TypeDefinitionRegistrationOptions /** * The server provides goto implementation support. * * @since 3.6.0 */ ImplementationProvider any `json:"implementationProvider,omitempty"` // nil | bool | ImplementationOptions | ImplementationRegistrationOptions /** * The server provides find references support. */ ReferencesProvider any `json:"referencesProvider,omitempty"` // nil | bool | ReferenceOptions /** * The server provides document highlight support. */ DocumentHighlightProvider any `json:"documentHighlightProvider,omitempty"` // nil | bool | DocumentHighlightOptions /** * The server provides document symbol support. */ DocumentSymbolProvider any `json:"documentSymbolProvider,omitempty"` // nil | bool | DocumentSymbolOptions /** * The server provides code actions. The `CodeActionOptions` return type is * only valid if the client signals code action literal support via the * property `textDocument.codeAction.codeActionLiteralSupport`. */ CodeActionProvider any `json:"codeActionProvider,omitempty"` // nil | bool | CodeActionOptions /** * 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. * * @since 3.6.0 */ ColorProvider any `json:"colorProvider,omitempty"` // nil | bool | DocumentColorOptions | DocumentColorRegistrationOptions /** * The server provides document formatting. */ DocumentFormattingProvider any `json:"documentFormattingProvider,omitempty"` // nil | bool | DocumentFormattingOptions /** * The server provides document range formatting. */ DocumentRangeFormattingProvider any `json:"documentRangeFormattingProvider,omitempty"` // nil | bool | DocumentRangeFormattingOptions /** * 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 any `json:"renameProvider,omitempty"` // nil | bool | RenameOptions /** * The server provides folding provider support. * * @since 3.10.0 */ FoldingRangeProvider any `json:"foldingRangeProvider,omitempty"` // nil | bool | FoldingRangeOptions | FoldingRangeRegistrationOptions /** * The server provides execute command support. */ ExecuteCommandProvider *ExecuteCommandOptions `json:"executeCommandProvider,omitempty"` /** * The server provides selection range support. * * @since 3.15.0 */ SelectionRangeProvider any `json:"selectionRangeProvider,omitempty"` // nil | bool | SelectionRangeOptions | SelectionRangeRegistrationOptions /** * The server provides linked editing range support. * * @since 3.16.0 */ LinkedEditingRangeProvider any `json:"linkedEditingRangeProvider,omitempty"` // nil | bool | LinkedEditingRangeOptions | LinkedEditingRangeRegistrationOptions /** * The server provides call hierarchy support. * * @since 3.16.0 */ CallHierarchyProvider any `json:"callHierarchyProvider,omitempty"` // nil | bool | CallHierarchyOptions | CallHierarchyRegistrationOptions /** * The server provides semantic tokens support. * * @since 3.16.0 */ SemanticTokensProvider any `json:"semanticTokensProvider,omitempty"` // nil | SemanticTokensOptions | SemanticTokensRegistrationOptions /** * Whether server provides moniker support. * * @since 3.16.0 */ MonikerProvider any `json:"monikerProvider,omitempty"` // nil | bool | MonikerOptions | MonikerRegistrationOptions /** * The server provides workspace symbol support. */ WorkspaceSymbolProvider any `json:"workspaceSymbolProvider,omitempty"` // nil | bool | WorkspaceSymbolOptions /** * Workspace specific server capabilities */ Workspace *ServerCapabilitiesWorkspace `json:"workspace,omitempty"` /** * Experimental server capabilities. */ Experimental any `json:"experimental,omitempty"` }
func (*ServerCapabilities) UnmarshalJSON ¶
func (self *ServerCapabilities) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
type ServerCapabilitiesWorkspace ¶
type ServerCapabilitiesWorkspace struct { /** * The server supports workspace folder. * * @since 3.6.0 */ WorkspaceFolders *WorkspaceFoldersServerCapabilities `json:"workspaceFolders,omitempty"` /** * The server is interested in file notifications/requests. * * @since 3.16.0 */ FileOperations *ServerCapabilitiesWorkspaceFileOperations `json:"fileOperations,omitempty"` }
type ServerCapabilitiesWorkspaceFileOperations ¶
type ServerCapabilitiesWorkspaceFileOperations 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"` }
type SetTraceFunc ¶
type SetTraceFunc func(context *glsp.Context, params *SetTraceParams) error
type SetTraceParams ¶
type SetTraceParams struct { /** * The new value that should be assigned to the trace setting. */ Value TraceValue `json:"value"` }
type ShowDocumentClientCapabilities ¶
type ShowDocumentClientCapabilities struct { /** * The client has support for the show document * request. */ Support bool `json:"support"` }
*
- Client capabilities for the show document request. *
- @since 3.16.0
type ShowDocumentParams ¶
type ShowDocumentParams struct { /** * The document 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 document. *
- @since 3.16.0
type ShowDocumentResult ¶
type ShowDocumentResult struct { /** * A boolean indicating if the show was successful. */ Success bool `json:"success"` }
*
- The result of an show document 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"` }
type ShowMessageRequestClientCapabilities ¶
type ShowMessageRequestClientCapabilities struct { /** * Capabilities specific to the `MessageActionItem` type. */ MessageActionItem *struct { /** * Whether the client supports additional attributes which * are preserved and sent back to the server in the * request's response. */ AdditionalPropertiesSupport *bool `json:"additionalPropertiesSupport,omitempty"` } `json:"messageActionItem,omitempty"` }
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 ShutdownFunc ¶
type SignatureHelp ¶
type SignatureHelp struct { /** * One or more signatures. If no signatures are available the signature help * request should return `null`. */ 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 *UInteger `json:"activeSignature,omitempty"` /** * The active parameter of the active signature. 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 to better express the active parameter if the * active signature does have any. */ ActiveParameter *UInteger `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 *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 *struct { /** * The client supports processing label offsets instead of a * simple label string. * * @since 3.14.0 */ LabelOffsetSupport *bool `json:"labelOffsetSupport,omitempty"` } `json:"parameterInformation,omitempty"` /** * The client supports the `activeParameter` property on * `SignatureInformation` literal. * * @since 3.16.0 */ ActiveParameterSupport *bool `json:"activeParameterSupport,omitempty"` } `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"` }
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 occur 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 { WorkDoneProgressOptions /** * The 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"` }
type SignatureHelpParams ¶
type SignatureHelpParams struct { TextDocumentPositionParams WorkDoneProgressParams /** * 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"` }
type SignatureHelpRegistrationOptions ¶
type SignatureHelpRegistrationOptions struct { TextDocumentRegistrationOptions SignatureHelpOptions }
type SignatureHelpTriggerKind ¶
type SignatureHelpTriggerKind Integer
*
- 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 any `json:"documentation,omitempty"` // nil | string | MarkupContent /** * The parameters of this signature. */ Parameters []ParameterInformation `json:"parameters,omitempty"` /** * The index of the active parameter. * * If provided, this is used in place of `SignatureHelp.activeParameter`. * * @since 3.16.0 */ ActiveParameter *UInteger `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.
func (*SignatureInformation) UnmarshalJSON ¶
func (self *SignatureInformation) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
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 SymbolInformation ¶
type SymbolInformation struct { /** * The name of this symbol. */ Name string `json:"name"` /** * The kind of this symbol. */ Kind SymbolKind `json:"kind"` /** * Tags for this completion item. * * @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 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 then 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 a abstract * syntax tree. It can therefore not be used to re-construct a hierarchy of * the symbols. */ Location Location `json:"location"` /** * 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 Integer
*
- Symbol tags are extra annotations that tweak the rendering of a symbol. *
- @since 3.16.0
type TextDocumentChangeRegistrationOptions ¶
type TextDocumentChangeRegistrationOptions struct { TextDocumentRegistrationOptions /** * How documents are synced to the server. See TextDocumentSyncKind.Full * and TextDocumentSyncKind.Incremental. */ SyncKind TextDocumentSyncKind `json:"syncKind"` }
*
- Describe options to be used when registering for text document change events.
type TextDocumentClientCapabilities ¶
type TextDocumentClientCapabilities struct { 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"` /** request. * 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/publishDiagnostics` * notification. */ PublishDiagnostics *PublishDiagnosticsClientCapabilities `json:"publishDiagnostics,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/linkedEditingRange` request. * * @since 3.16.0 */ LinkedEditingRange *LinkedEditingRangeClientCapabilities `json:"linkedEditingRange,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 requests. * * @since 3.16.0 */ SemanticTokens *SemanticTokensClientCapabilities `json:"semanticTokens,omitempty"` /** * Capabilities specific to the `textDocument/moniker` request. * * @since 3.16.0 */ Moniker *MonikerClientCapabilities `json:"moniker,omitempty"` }
*
- Text document specific client capabilities.
type TextDocumentCodeActionFunc ¶
type TextDocumentCodeActionFunc func(context *glsp.Context, params *CodeActionParams) (any, error)
Returns: Command | []CodeAction | nil
type TextDocumentCodeLensFunc ¶
type TextDocumentCodeLensFunc func(context *glsp.Context, params *CodeLensParams) ([]CodeLens, error)
type TextDocumentColorFunc ¶
type TextDocumentColorFunc func(context *glsp.Context, params *DocumentColorParams) ([]ColorInformation, error)
type TextDocumentColorPresentationFunc ¶
type TextDocumentColorPresentationFunc func(context *glsp.Context, params *ColorPresentationParams) ([]ColorPresentation, error)
type TextDocumentCompletionFunc ¶
type TextDocumentCompletionFunc func(context *glsp.Context, params *CompletionParams) (any, error)
Returns: []CompletionItem | CompletionList | nil
type TextDocumentContentChangeEvent ¶
type TextDocumentContentChangeEvent struct { /** * The range of the document that changed. */ Range *Range `json:"range"` /** * The optional length of the range that got replaced. * * @deprecated use range instead. */ RangeLength *UInteger `json:"rangeLength,omitempty"` /** * The new text for the provided range. */ Text string `json:"text"` }
*
- An event describing a change to a text document. If range and rangeLength are
- omitted the new text is considered to be the full content of the document.
type TextDocumentContentChangeEventWhole ¶
type TextDocumentContentChangeEventWhole struct { /** * The new text of the whole document. */ Text string `json:"text"` }
type TextDocumentDeclarationFunc ¶
type TextDocumentDeclarationFunc func(context *glsp.Context, params *DeclarationParams) (any, error)
Returns: Location | []Location | []LocationLink | nil
type TextDocumentDefinitionFunc ¶
type TextDocumentDefinitionFunc func(context *glsp.Context, params *DefinitionParams) (any, error)
Returns: Location | []Location | []LocationLink | nil
type TextDocumentDidChangeFunc ¶
type TextDocumentDidChangeFunc func(context *glsp.Context, params *DidChangeTextDocumentParams) error
type TextDocumentDidCloseFunc ¶
type TextDocumentDidCloseFunc func(context *glsp.Context, params *DidCloseTextDocumentParams) error
type TextDocumentDidOpenFunc ¶
type TextDocumentDidOpenFunc func(context *glsp.Context, params *DidOpenTextDocumentParams) error
type TextDocumentDidSaveFunc ¶
type TextDocumentDidSaveFunc func(context *glsp.Context, params *DidSaveTextDocumentParams) error
type TextDocumentDocumentHighlightFunc ¶
type TextDocumentDocumentHighlightFunc func(context *glsp.Context, params *DocumentHighlightParams) ([]DocumentHighlight, error)
type TextDocumentDocumentLinkFunc ¶
type TextDocumentDocumentLinkFunc func(context *glsp.Context, params *DocumentLinkParams) ([]DocumentLink, error)
type TextDocumentDocumentSymbolFunc ¶
type TextDocumentDocumentSymbolFunc func(context *glsp.Context, params *DocumentSymbolParams) (any, error)
Returns: []DocumentSymbol | []SymbolInformation | nil
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 by the * client capability `workspace.workspaceEdit.changeAnnotationSupport` */ Edits []any `json:"edits"` // TextEdit | AnnotatedTextEdit }
func (*TextDocumentEdit) UnmarshalJSON ¶
func (self *TextDocumentEdit) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
type TextDocumentFoldingRangeFunc ¶
type TextDocumentFoldingRangeFunc func(context *glsp.Context, params *FoldingRangeParams) ([]FoldingRange, error)
type TextDocumentFormattingFunc ¶
type TextDocumentFormattingFunc func(context *glsp.Context, params *DocumentFormattingParams) ([]TextEdit, error)
type TextDocumentHoverFunc ¶
type TextDocumentHoverFunc func(context *glsp.Context, params *HoverParams) (*Hover, error)
type TextDocumentIdentifier ¶
type TextDocumentIdentifier struct { /** * The text document's URI. */ URI DocumentUri `json:"uri"` }
type TextDocumentImplementationFunc ¶
type TextDocumentImplementationFunc func(context *glsp.Context, params *ImplementationParams) (any, error)
Returns: Location | []Location | []LocationLink | nil
type TextDocumentItem ¶
type TextDocumentItem struct { /** * The text document's URI. */ URI DocumentUri `json:"uri"` /** * The text document's language identifier. */ LanguageID string `json:"languageId"` /** * The version number of this document (it will increase after each * change, including undo/redo). */ Version Integer `json:"version"` /** * The content of the opened text document. */ Text string `json:"text"` }
type TextDocumentLinkedEditingRangeFunc ¶
type TextDocumentLinkedEditingRangeFunc func(context *glsp.Context, params *LinkedEditingRangeParams) (*LinkedEditingRanges, error)
type TextDocumentMonikerFunc ¶
type TextDocumentMonikerFunc func(context *glsp.Context, params *MonikerParams) ([]Moniker, error)
type TextDocumentOnTypeFormattingFunc ¶
type TextDocumentOnTypeFormattingFunc func(context *glsp.Context, params *DocumentOnTypeFormattingParams) ([]TextEdit, error)
type TextDocumentPositionParams ¶
type TextDocumentPositionParams struct { /** * The text document. */ TextDocument TextDocumentIdentifier `json:"textDocument"` /** * The position inside the text document. */ Position Position `json:"position"` }
type TextDocumentPrepareCallHierarchyFunc ¶
type TextDocumentPrepareCallHierarchyFunc func(context *glsp.Context, params *CallHierarchyPrepareParams) ([]CallHierarchyItem, error)
type TextDocumentPrepareRenameFunc ¶
type TextDocumentPrepareRenameFunc func(context *glsp.Context, params *PrepareRenameParams) (any, error)
Returns: Range | RangeWithPlaceholder | DefaultBehavior | nil
type TextDocumentRangeFormattingFunc ¶
type TextDocumentRangeFormattingFunc func(context *glsp.Context, params *DocumentRangeFormattingParams) ([]TextEdit, error)
type TextDocumentReferencesFunc ¶
type TextDocumentReferencesFunc func(context *glsp.Context, params *ReferenceParams) ([]Location, error)
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 TextDocumentRenameFunc ¶
type TextDocumentRenameFunc func(context *glsp.Context, params *RenameParams) (*WorkspaceEdit, error)
type TextDocumentSaveReason ¶
type TextDocumentSaveReason Integer
type TextDocumentSaveRegistrationOptions ¶
type TextDocumentSaveRegistrationOptions struct { TextDocumentRegistrationOptions /** * The client is supposed to include the content on save. */ IncludeText *bool `json:"includeText"` }
type TextDocumentSelectionRangeFunc ¶
type TextDocumentSelectionRangeFunc func(context *glsp.Context, params *SelectionRangeParams) ([]SelectionRange, error)
type TextDocumentSemanticTokensFullDeltaFunc ¶
type TextDocumentSemanticTokensFullDeltaFunc func(context *glsp.Context, params *SemanticTokensDeltaParams) (any, error)
Returns: SemanticTokens | SemanticTokensDelta | SemanticTokensDeltaPartialResult | nil
type TextDocumentSemanticTokensFullFunc ¶
type TextDocumentSemanticTokensFullFunc func(context *glsp.Context, params *SemanticTokensParams) (*SemanticTokens, error)
type TextDocumentSemanticTokensRangeFunc ¶
type TextDocumentSemanticTokensRangeFunc func(context *glsp.Context, params *SemanticTokensRangeParams) (any, error)
Returns: SemanticTokens | SemanticTokensPartialResult | nil
type TextDocumentSignatureHelpFunc ¶
type TextDocumentSignatureHelpFunc func(context *glsp.Context, params *SignatureHelpParams) (*SignatureHelp, error)
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 Integer
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 any `json:"save,omitempty"` // nil | bool | SaveOptions }
func (*TextDocumentSyncOptions) UnmarshalJSON ¶
func (self *TextDocumentSyncOptions) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
type TextDocumentTypeDefinitionFunc ¶
type TextDocumentTypeDefinitionFunc func(context *glsp.Context, params *TypeDefinitionParams) (any, error)
Returns: Location | []Location | []LocationLink | nil
type TextDocumentWillSaveFunc ¶
type TextDocumentWillSaveFunc func(context *glsp.Context, params *WillSaveTextDocumentParams) error
type TextDocumentWillSaveWaitUntilFunc ¶
type TextDocumentWillSaveWaitUntilFunc func(context *glsp.Context, params *WillSaveTextDocumentParams) ([]TextEdit, error)
type TokenFormat ¶
type TokenFormat 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"` }
type TypeDefinitionOptions ¶
type TypeDefinitionOptions struct {
WorkDoneProgressOptions
}
type TypeDefinitionParams ¶
type TypeDefinitionParams struct { TextDocumentPositionParams WorkDoneProgressParams PartialResultParams }
type TypeDefinitionRegistrationOptions ¶
type TypeDefinitionRegistrationOptions struct { TextDocumentRegistrationOptions TypeDefinitionOptions StaticRegistrationOptions }
type UInteger ¶
type UInteger = uint32
*
- Defines an unsigned integer number in the range of 0 to 2^31 - 1.
type UniquenessLevel ¶
type UniquenessLevel string
*
- Moniker uniqueness level to define scope of the moniker.
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 / capability to unregister for. */ Method string `json:"method"` }
*
- General parameters to unregister a capability.
type UnregistrationParams ¶
type UnregistrationParams struct { // This should correctly be named `unregistrations`. However changing this // is a breaking change and needs to wait until we deliver a 4.x version // of the specification. Unregisterations []Unregistration `json:"unregisterations"` }
type VersionedTextDocumentIdentifier ¶
type VersionedTextDocumentIdentifier struct { TextDocumentIdentifier /** * The version number of this document. * * The version number of a document will increase after each change, * including undo/redo. The number doesn't need to be consecutive. */ Version Integer `json:"version"` }
type WillSaveTextDocumentParams ¶
type WillSaveTextDocumentParams struct { /** * The document that will be saved. */ TextDocument TextDocumentIdentifier `json:"textDocument"` /** * The 'TextDocumentSaveReason'. */ Reason TextDocumentSaveReason `json:"reason"` }
*
- The parameters send in a will save text document notification.
type WindowWorkDoneProgressCancelFunc ¶
type WindowWorkDoneProgressCancelFunc func(context *glsp.Context, params *WorkDoneProgressCancelParams) error
type WorkDoneProgressBegin ¶
type WorkDoneProgressBegin struct { Kind string `json:"kind"` // == "begin" /** * 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 *UInteger `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 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"` // == "report" /** * Controls enablement state of a cancel button. This property is only valid * if a cancel button got requested in the `WorkDoneProgressStart` payload. * * Clients that don't support cancellation or don't support control the * button's enablement state 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 *UInteger `json:"percentage,omitempty"` }
type WorkspaceDidChangeConfigurationFunc ¶
type WorkspaceDidChangeConfigurationFunc func(context *glsp.Context, params *DidChangeConfigurationParams) error
type WorkspaceDidChangeWatchedFilesFunc ¶
type WorkspaceDidChangeWatchedFilesFunc func(context *glsp.Context, params *DidChangeWatchedFilesParams) error
type WorkspaceDidChangeWorkspaceFoldersFunc ¶
type WorkspaceDidChangeWorkspaceFoldersFunc func(context *glsp.Context, params *DidChangeWorkspaceFoldersParams) error
type WorkspaceDidCreateFilesFunc ¶
type WorkspaceDidCreateFilesFunc func(context *glsp.Context, params *CreateFilesParams) error
type WorkspaceDidDeleteFilesFunc ¶
type WorkspaceDidDeleteFilesFunc func(context *glsp.Context, params *DeleteFilesParams) error
type WorkspaceDidRenameFilesFunc ¶
type WorkspaceDidRenameFilesFunc func(context *glsp.Context, params *RenameFilesParams) error
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 []any `json:"documentChanges,omitempty"` // TextDocumentEdit | CreateFile | RenameFile | DeleteFile /** * 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"` }
func (*WorkspaceEdit) UnmarshalJSON ¶
func (self *WorkspaceEdit) UnmarshalJSON(data []byte) error
json.Unmarshaler interface
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 specific new line character(s). * * @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 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"` } `json:"changeAnnotationSupport,omitempty"` }
type WorkspaceExecuteCommandFunc ¶
type WorkspaceExecuteCommandFunc func(context *glsp.Context, params *ExecuteCommandParams) (any, error)
type WorkspaceFolder ¶
type WorkspaceFolder struct { /** * The associated URI for this workspace folder. */ URI DocumentUri `json:"uri"` /** * The name of the workspace folder. Used to refer to this * workspace folder in the user interface. */ Name string `json:"name"` }
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 WorkspaceFoldersServerCapabilities ¶
type WorkspaceFoldersServerCapabilities struct { /** * The server has support for workspace folders */ Supported *bool `json:"supported"` /** * 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 *BoolOrString `json:"changeNotifications,omitempty"` }
type WorkspaceSemanticTokensRefreshFunc ¶ added in v0.2.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 *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"` } `json:"symbolKind,omitempty"` /** * The client supports tags on `SymbolInformation`. * Clients supporting tags have to handle unknown tags gracefully. * * @since 3.16.0 */ TagSupport *struct { /** * The tags supported by the client. */ ValueSet []SymbolTag `json:"valueSet"` } `json:"tagSupport,omitempty"` }
type WorkspaceSymbolFunc ¶
type WorkspaceSymbolFunc func(context *glsp.Context, params *WorkspaceSymbolParams) ([]SymbolInformation, error)
type WorkspaceSymbolOptions ¶
type WorkspaceSymbolOptions struct {
WorkDoneProgressOptions
}
type WorkspaceSymbolParams ¶
type WorkspaceSymbolParams struct { WorkDoneProgressParams PartialResultParams /** * A query string to filter symbols by. Clients may send an empty * string here to request all symbols. */ Query string `json:"query"` }
type WorkspaceSymbolRegistrationOptions ¶
type WorkspaceSymbolRegistrationOptions struct {
WorkspaceSymbolOptions
}
type WorkspaceWillCreateFilesFunc ¶
type WorkspaceWillCreateFilesFunc func(context *glsp.Context, params *CreateFilesParams) (*WorkspaceEdit, error)
type WorkspaceWillDeleteFilesFunc ¶
type WorkspaceWillDeleteFilesFunc func(context *glsp.Context, params *DeleteFilesParams) (*WorkspaceEdit, error)
type WorkspaceWillRenameFilesFunc ¶
type WorkspaceWillRenameFilesFunc func(context *glsp.Context, params *RenameFilesParams) (*WorkspaceEdit, error)