modulepackage
0.0.0-20240419022041-0a0a5672827e
Repository: https://github.com/tectiv3/go-lsp.git
Documentation: pkg.go.dev
# README
A client/server library for LSP (Language Server Protocol) written in golang
How to use
import "github.com/tectiv3/go-lsp"
Documentation
TODO
Disclaimer
This is alpha-grade software, API may change without notice. If you decide to use this library, expect breaking changes.
# Functions
____\ NOTIFICATION /.
___ REQUEST \ /___/ \.
___ / \___\ RESPONSE /.
NOTIFICATION /___ \.
___ REQUEST / \___\ /.
___ \ /___/ RESPONSE \.
No description provided by the author
No description provided by the author
NewDocumentURI create a DocumentURI from the given string path.
NewDocumentURIFromPath create a DocumentURI from the given Path object.
NewDocumentURIFromURL converts an URL into a DocumentURI.
No description provided by the author
# Constants
Empty kind.
Base kind for quickfix actions: "quickfix".
Base kind for refactoring actions: "refactor".
Base kind for refactoring extraction actions: "refactor.extract".
Base kind for refactoring inline actions: "refactor.inline".
Base kind for refactoring rewrite actions: "refactor.rewrite".
Base kind for source actions: `source`.
Base kind for a "fix all" source action: `source.fixAll`.
Base kind for an organize imports source action: `source.organizeImports`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Render a completion as obsolete, usually using a strike-out.
Completion was triggered by typing an identifier (24x7 code complete), manual invocation (e.g Ctrl+Space) or via API.
Completion was triggered by a trigger character specified by the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
Completion was re-triggered as the current completion list is incomplete.
DiagnosticSeverityError Reports an error.
DiagnosticSeverityHint Reports a hint.
DiagnosticSeverityInformation Reports an information.
DiagnosticSeverityWarning Reports a warning.
DiagnosticTagDeprecated Deprecated or obsolete code.
DiagnosticTagUnnecessary Unused or unnecessary code.
Read-access of a symbol, like reading a variable.
A textual occurrence.
Write-access of a symbol, like writing to a variable.
FailureHandlingKindAbort: Applying the workspace change is simply aborted if one of the changes provided fails.
FailureHandlingKindTextOnlyTransactional: If the workspace edit contains only textual file changes they are executed transactional.
FailureHandlingKindTransactional: All operations are executed transactional.
FailureHandlingKindUndo: The client tries to undo the operations already executed.
The pattern matches a file only.
The pattern matches a folder only.
Folding range for a comment.
Folding range for a imports or includes.
Folding range for a region (e.g.
If the protocol version provided by the client can't be handled by the server.
The primary text to be inserted is treated as a plain string.
The primary text to be inserted is treated as a snippet.
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.
The insertion or replace strings is taken as it is.
Markdown is supported as a content format.
Plain text is supported as a content format.
An error message.
An information message.
A log message.
A warning message.
The moniker represents a symbol that is exported from a project.
The moniker represent a symbol that is imported into a project.
The moniker represents a symbol that is local to a project (e.g.
The client's default behavior is to select the identifier according the to language's syntax rule.
ResourceOperationKindCreate: Supports creating new files and folders.
ResourceOperationKindDelete: Supports deleting existing files and folders.
ResourceOperationKindRename: Supports renaming existing files and folders.
Signature help was triggered by the cursor moving or by the document content changing.
Signature help was invoked manually by the user or by a command.
Signature help was triggered by a trigger character.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Automatic after a delay.
When the editor lost focus.
Manually triggered, e.g.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The moniker is only unique inside a document.
The moniker is globally unique.
The moniker is unique inside the group to which a project belongs.
The moniker is unique inside a project for which a dump got created.
The moniker is unique inside the moniker scheme.
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
boolean | CallHierarchyOptions | CallHierarchyRegistrationOptions.
No description provided by the author
No description provided by the author
No description provided by the author
Additional information that describes document changes.
Client is an LSP Client.
ClientCapabilities Workspace specific client capabilities.
A code action represents a change that can be performed in code, e.g.
No description provided by the author
Contains additional diagnostic information about the context in which a code action is run.
boolean | CodeActionOptions.
Params for the CodeActionRequest.
Structure to capture a description for an error code.
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Represents a color in RGBA space.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Contains additional information about the context in which a completion request is triggered.
No description provided by the author
Additional details for a completion item label.
No description provided by the author
No description provided by the author
Represents a collection of [completion items](#CompletionItem) to be presented in the editor.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The parameters sent in notifications/requests for user-initiated creation of files.
No description provided by the author
boolean|DeclarationOptions|DeclarationRegistrationOptions.
No description provided by the author
No description provided by the author
boolean|DefinitionOptions.
No description provided by the author
The parameters sent in notifications/requests for user-initiated deletes of files.
No description provided by the author
Represents a related message and source code location for a diagnostic.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
boolean | DocumentColorOptions | DocumentColorRegistrationOptions.
No description provided by the author
No description provided by the author
No description provided by the author
boolean | DocumentFormattingOptions.
No description provided by the author
A document highlight is a range inside a text document which deserves special attention.
No description provided by the author
boolean | DocumentHighlightOptions.
No description provided by the author
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
boolean | DocumentFormattingOptions.
No description provided by the author
Represents programming constructs like variables, classes, interfaces etc.
No description provided by the author
boolean | DocumentSymbolOptions.
No description provided by the author
DocumentURI Many of the interfaces contain fields that correspond to the URI of a document.
No description provided by the author
No description provided by the author
No description provided by the author
Represents information on a file/folder create.
Represents information on a file/folder delete.
An event describing a file change.
A filter to describe in which file operation requests or notifications the server is interested in.
A pattern to describe in which file operation requests or notifications the server is interested in.
Matching options for the file operation pattern.
The options to register for file operations.
Represents information on a file/folder rename.
Represents a folding range.
No description provided by the author
boolean | FoldingRangeOptions | FoldingRangeRegistrationOptions.
No description provided by the author
The result of a hover request.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
boolean | ImplementationOptions | ImplementationRegistrationOptions.
No description provided by the author
InitializedParams The initialized notification is sent from the client to the server after the client received the result of the initialize equest but before the client is sending any other request or notification to the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A special text edit to provide an insert and a replace operation.
No description provided by the author
boolean | LinkedEditingRangeOptions | LinkedEditingRangeRegistrationOptions.
No description provided by the author
No description provided by the author
Location represents a location inside a resource, such as a line inside a text file.
No description provided by the author
No description provided by the author
No description provided by the author
Client capabilities specific to the used markdown parser.
MarkedString can be used to render human readable text.
A `MarkupContent` literal represents a string value which content is interpreted base on its kind flag.
No description provided by the author
Moniker definition to match LSIF 0.5 moniker definition.
No description provided by the author
boolean | MonikerOptions | MonikerRegistrationOptions is defined as follows:.
No description provided by the author
Represents a parameter of a callable-signature.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
boolean | ReferenceOptions.
No description provided by the author
General parameters to register for a capability.
No description provided by the author
Client capabilities specific to regular expressions.
No description provided by the author
The parameters sent in notifications/requests for user-initiated renames of files.
boolean | RenameOptions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
boolean | SelectionRangeOptions | SelectionRangeRegistrationOptions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Server is an LSP Server.
No description provided by the author
No description provided by the author
Client capabilities for the show document request.
Params to show a document.
The result of an show document request.
No description provided by the author
Show message request client capabilities.
No description provided by the author
Signature help represents the signature of something callable.
No description provided by the author
Additional information about the context in which a signature help request was triggered.
No description provided by the author
No description provided by the author
Represents the signature of something callable.
Static registration options to be returned in the initialize request.
Represents information about programming constructs like variables, classes, interfaces etc.
No description provided by the author
An event describing a change to a text document.
No description provided by the author
No description provided by the author
No description provided by the author
General text document registration options.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
boolean | TypeDefinitionOptions | TypeDefinitionRegistrationOptions.
No description provided by the author
No description provided by the author
General parameters to unregister a capability.
No description provided by the author
No description provided by the author
The parameters send in a will save text document notification.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The workspace folder change event.
No description provided by the author
No description provided by the author
No description provided by the author
The parameters of a Workspace Symbol Request.
No description provided by the author
# Interfaces
ClientMessagesHandler interface has all the methods that an LSP Server should implement to correctly parse incoming messages.
ServerMessagesHandler interface has all the methods that an LSP Client should implement to correctly parse incoming messages.
# Type aliases
No description provided by the author
The kind of a code action.
The kind of a completion entry.
Completion item tags are extra annotations that tweak the rendering of a completion item.
How a completion was triggered.
CustomNotification is a function type for incoming custom notifications callbacks.
CustomNotification is a function type for incoming custom requests callbacks.
No description provided by the author
The diagnostic tags.
A document highlight kind.
No description provided by the author
No description provided by the author
A pattern kind describing if a glob pattern matches a file a folder or both.
Enum of known range kinds.
No description provided by the author
Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.
How whitespace and indentation is handled during completion item insertion.
No description provided by the author
No description provided by the author
No description provided by the author
The moniker kind.
No description provided by the author
No description provided by the author
How a signature help was triggered.
No description provided by the author
No description provided by the author
Represents reasons why a text document is saved.
No description provided by the author
No description provided by the author
No description provided by the author
Moniker uniqueness level to define scope of the moniker.
No description provided by the author