lspx

package module
v0.0.0-...-21d5e84 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 16, 2026 License: MIT Imports: 15 Imported by: 0

README

lspx

One LSP client. Any number of language servers.

lspx is a Go library and CLI tool that acts as an LSP client multiplexer. Instead of writing one client per language server, you connect a single lspx client to as many language servers as you need. lspx transparently fans out requests, aggregates responses, and routes notifications — your code (or your editor) sees exactly one unified LSP interface.

                         ┌─────────────────────────────────────────────┐
                         │                   lspx                      │
  ┌──────────────┐       │  ┌─────────┐    ┌──────────────────────┐   │
  │  Your code   │       │  │         │───►│  gopls               │   │
  │  (or editor) │◄─────►│  │  Mux    │    └──────────────────────┘   │
  └──────────────┘       │  │         │───►│  rust-analyzer       │   │
   one client            │  │         │    └──────────────────────┘   │
                         │  │         │───►│  typescript-language- │   │
                         │  └─────────┘    │  server               │   │
                         │                 └──────────────────────┘   │
                         └─────────────────────────────────────────────┘
                                         many servers

Why lspx?

The LSP ecosystem is rich but fragmented. In a real project you might need:

  • gopls for Go files
  • rust-analyzer for Rust files
  • typescript-language-server for TypeScript/JavaScript
  • eslint-lsp for linting on top of TypeScript
  • A custom internal server for your proprietary language

Without a multiplexer, every client (editor plugin, build tool, CI script) must manage connections to each of those servers independently. That means duplicated lifecycle code, no result merging, and no shared sessions.

lspx moves that complexity into a single, reusable layer:

Without lspx With lspx
Client manages N server connections Client manages 1 lspx connection
Results per-server, no aggregation Unified results merged across servers
Each editor session starts fresh servers Servers are long-lived and shared
Raw JSON-RPC is opaque Full traffic logging built-in

Features

Feature Description
🔀 Client multiplexing One client interface, any number of language servers
🗂️ Smart routing Requests routed to the right server(s) based on file type or language ID
🔗 Result aggregation Diagnostics, completions, and more merged transparently across servers
🤝 Session sharing Multiple clients share a single long-lived server instance
🪵 Traffic logging Full JSON-RPC stream logging (NDJSON) for debugging and testing
⚙️ Flexible config Declarative TOML config file with optional --auto detection mode
🚀 stdio transport Standard LSP stdio transport — works as a drop-in with any LSP-aware editor
📦 Go library Embed the multiplexer directly in your Go programs via a clean, idiomatic API

Go Library

The lspx package is the primary interface. The CLI is just a thin wrapper around it.

Install
go get github.com/masterkeysrd/lspx
Create a multiplexed client

Configure a single client backed by multiple language servers. lspx handles all routing and aggregation transparently.

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/masterkeysrd/lspx"
)

func main() {
	ctx := context.Background()

	// One client — three servers underneath
	client, err := lspx.NewClient(ctx, lspx.ClientOptions{
		Servers: []lspx.ServerConfig{
			{
				Name:      "gopls",
				Command:   []string{"gopls", "serve"},
				FileTypes: []string{"go"},
			},
			{
				Name:      "rust-analyzer",
				Command:   []string{"rust-analyzer"},
				FileTypes: []string{"rust"},
			},
			{
				Name:      "tsserver",
				Command:   []string{"typescript-language-server", "--stdio"},
				FileTypes: []string{"typescript", "javascript"},
			},
		},
		RootURI: "file:///path/to/your/project",
	})
	if err != nil {
		log.Fatal(err)
	}
	defer client.Close()

	// Open a Go file — lspx routes to gopls automatically
	client.DidOpen(ctx, &lspx.DidOpenTextDocumentParams{
		TextDocument: lspx.TextDocumentItem{
			URI:        "file:///path/to/your/project/main.go",
			LanguageID: "go",
			Version:    1,
		},
	})

	// Hover — lspx sends to gopls and returns its response
	hover, err := client.Hover(ctx, &lspx.HoverParams{
		TextDocumentPositionParams: lspx.TextDocumentPositionParams{
			TextDocument: lspx.TextDocumentIdentifier{
				URI: "file:///path/to/your/project/main.go",
			},
			Position: lspx.Position{Line: 10, Character: 5},
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(hover.Contents.Value)
}
Aggregate results from multiple servers

When more than one server handles a file type, lspx merges their responses.

// Two servers handle TypeScript: tsserver for completions, eslint-lsp for linting
client, _ := lspx.NewClient(ctx, lspx.ClientOptions{
	Servers: []lspx.ServerConfig{
		{
			Name:      "tsserver",
			Command:   []string{"typescript-language-server", "--stdio"},
			FileTypes: []string{"typescript"},
		},
		{
			Name:      "eslint",
			Command:   []string{"vscode-eslint-language-server", "--stdio"},
			FileTypes: []string{"typescript"},
			// Only provide diagnostics; skip completions
			Capabilities: lspx.CapabilityDiagnosticProvider,
		},
	},
	Aggregate: lspx.AggregateOptions{
		Diagnostics: true, // merge from both servers
		Completions: false, // only from first matching server
	},
	RootURI: "file:///path/to/your/project",
})
Subscribe to server-push notifications

All servers' notifications are funneled through a single handler:

// Diagnostics from ALL servers arrive here, already merged
client.OnNotification(lspx.MethodTextDocumentPublishDiagnostics, func(params *lspx.PublishDiagnosticsParams) {
	for _, diag := range params.Diagnostics {
		fmt.Printf("[%s] %s line %d: %s\n",
			diag.Source, diag.Severity, diag.Range.Start.Line, diag.Message)
	}
})
Core API
Method LSP Method Routing
client.Initialize initialize Sent to all servers
client.DidOpen textDocument/didOpen Sent to servers matching the file's language ID
client.DidChange textDocument/didChange Sent to servers matching the file's language ID
client.DidClose textDocument/didClose Sent to servers matching the file's language ID
client.Hover textDocument/hover First matching server
client.Completion textDocument/completion Aggregated or first, configurable
client.Definition textDocument/definition First matching server
client.Declaration textDocument/declaration First matching server
client.TypeDefinition textDocument/typeDefinition First matching server
client.Implementation textDocument/implementation First matching server
client.PrepareCallHierarchy textDocument/prepareCallHierarchy First matching server
client.IncomingCalls callHierarchy/incomingCalls First matching server (routes using item URI)
client.OutgoingCalls callHierarchy/outgoingCalls First matching server (routes using item URI)
client.PrepareTypeHierarchy textDocument/prepareTypeHierarchy First matching server
client.Supertypes typeHierarchy/supertypes First matching server (routes using item URI)
client.Subtypes typeHierarchy/subtypes First matching server (routes using item URI)
client.DocumentHighlight textDocument/documentHighlight First matching server
client.DocumentLink textDocument/documentLink First matching server
client.ResolveDocumentLink documentLink/resolve First matching server (routes using wrapped server metadata)
client.CodeLens textDocument/codeLens First matching server
client.ResolveCodeLens codeLens/resolve First matching server (routes using wrapped server metadata)
client.FoldingRange textDocument/foldingRange First matching server
client.References textDocument/references Aggregated across matching servers
client.Diagnostics textDocument/diagnostic Aggregated across matching servers
client.Formatting textDocument/formatting First matching server
client.OnNotification — Receives notifications from all servers

Full API reference: go doc github.com/masterkeysrd/lspx or pkg.go.dev

CLI

The lspx CLI exposes the same multiplexer over stdio, making it a drop-in LSP server for any editor. The editor connects to lspx and gets unified results from all configured servers.

Installation

From source (requires Go 1.21+):

git clone https://github.com/masterkeysrd/lspx.git
cd lspx
go build -o lspx ./cmd/lspx

Via go install:

go install github.com/masterkeysrd/lspx/cmd/lspx@latest
Config file

lspx looks for .lspx.toml in the project root, then ~/.config/lspx/config.toml.

# .lspx.toml

[lspx]
log_file  = "~/.local/share/lspx/lspx.log"
log_level = "info"

[aggregate]
diagnostics = true
completions = false

[[server]]
name      = "gopls"
command   = ["gopls", "serve"]
filetypes = ["go"]

[[server]]
name      = "rust-analyzer"
command   = ["rust-analyzer"]
filetypes = ["rust"]

[[server]]
name      = "tsserver"
command   = ["typescript-language-server", "--stdio"]
filetypes = ["typescript", "javascript", "typescriptreact", "javascriptreact"]

[[server]]
name         = "eslint"
command      = ["vscode-eslint-language-server", "--stdio"]
filetypes    = ["typescript", "javascript"]
capabilities = ["diagnostics"]
Editor integration

Neovim (via nvim-lspconfig):

require('lspconfig').lspx.setup({
  cmd = { 'lspx' },
  -- lspx handles all languages; list every filetype you need here
  filetypes = { 'go', 'rust', 'typescript', 'javascript' },
  root_dir = require('lspconfig.util').root_pattern('.lspx.toml', '.git'),
})

VS Code (settings.json):

{
  "lspx.server.command": ["lspx"]
}
Auto-detection mode

Skip the config file entirely — lspx detects installed language servers automatically:

lspx --auto

Explicit config always takes precedence. --auto is a fast way to get started.

CLI flags
Usage:
  lspx [flags]

Flags:
  --auto          Auto-detect installed language servers
  --config PATH   Config file path (default: .lspx.toml, ~/.config/lspx/config.toml)
  --log PATH      Override log file path
  --log-level     Log verbosity: debug, info, warn, error (default: info)
  --version       Print version and exit
  -h, --help      Show this help

Configuration Reference

Server block
Field Type Description
name string Friendly name used in logs
command []string Command to launch the server
filetypes []string Language IDs this server handles
env {string: string} Extra environment variables
capabilities []string Limit which capabilities are used from this server (diagnostics, completions, hover, declaration, definition, typeDefinition, implementation, references, callHierarchy, typeHierarchy, documentHighlight, documentLink, codeLens, foldingRange, …). Omit to use all.
share_sessions bool Share this server across multiple editor clients (default: true)
Aggregation block
Field Type Default Description
diagnostics bool true Merge diagnostics from all matching servers
completions bool false Merge completions (disable to avoid duplicates)
references bool true Merge textDocument/references results

Traffic Logging

When log_file is set, lspx records the full JSON-RPC stream in both directions for every client↔server pair. Log entries are NDJSON with:

Field Description
ts ISO-8601 timestamp
server Server name
direction client→server or server→client
message Raw LSP JSON-RPC message

Useful for debugging misbehaving servers, understanding editor traffic, and building test fixtures from real sessions.

Roadmap

Go Library

  • Project scaffold
  • JSON-RPC client over stdio
  • initialize / shutdown lifecycle
  • textDocument/* request methods
  • Server-push notification handlers
  • Multi-server multiplexer core
  • File-type based routing
  • Result aggregation engine
  • Per-server capability filtering
  • Workspace requests (workspace/symbol, etc.)
  • Type-safe LSP types (generated from the LSP spec)
  • pkg.go.dev documentation

CLI

  • Config file parsing (TOML)
  • stdio server mode (editor integration)
  • Session sharing across clients
  • Traffic logging
  • --auto detection mode
  • VS Code extension
  • Homebrew formula

Contributing

Contributions are welcome! Please open an issue first to discuss significant changes.

  1. Fork the repository
  2. Create your feature branch: git checkout -b feat/my-feature
  3. Commit your changes: git commit -m 'feat: add my feature'
  4. Push and open a Pull Request

Please follow the Conventional Commits specification.

License

This project is licensed under the MIT License.

Made with ☕ and Go

Documentation

Overview

Package lspx implements a Language Server Protocol (LSP) client multiplexer.

It allows a single client connection to interact with multiple background language servers (such as gopls, rust-analyzer, or typescript-language-server) transparently. The package manages server processes, routes requests/notifications based on language/file type, aggregates response payloads (e.g. completions, references, or diagnostics), and handles request cancellation natively.

Key Components

  • Client: Represents a multiplexing LSP client that manages connections and lifecycle of multiple backend language servers.
  • Server: Represents a proxy LSP server (typically listening on stdio) that forwards and routes editor client requests to a multiplexed Client.

Basic Usage

To configure a multiplexed client with Go and Rust backend support: 

ctx := context.Background()
client, err := lspx.NewClient(ctx, lspx.ClientOptions{
	Servers: []lspx.ServerConfig{
		{
			Name:      "gopls",
			Command:   []string{"gopls", "serve"},
			FileTypes: []string{"go"},
		},
		{
			Name:      "rust-analyzer",
			Command:   []string{"rust-analyzer"},
			FileTypes: []string{"rust"},
		},
	},
	RootURI: "file:///path/to/project",
})
if err != nil {
	log.Fatal(err)
}
defer client.Close()

// Route file actions and query documentation
client.DidOpen(ctx, &lspx.DidOpenTextDocumentParams{
	TextDocument: lspx.TextDocumentItem{
		URI:        "file:///path/to/project/main.go",
		LanguageID: "go",
		Version:    1,
	},
})

hover, err := client.Hover(ctx, &lspx.HoverParams{
	TextDocumentPositionParams: lspx.TextDocumentPositionParams{
		TextDocument: lspx.TextDocumentIdentifier{URI: "file:///path/to/project/main.go"},
		Position:     lspx.Position{Line: 10, Character: 5},
	},
})

Index

Constants

View Source 
const (
	// A request to resolve the implementation locations of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPositionParams} the response is of type {@link Definition} or a Thenable that resolves to such.
	MethodTextDocumentImplementation = "textDocument/implementation"
	// A request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPositionParams} the response is of type {@link Definition} or a Thenable that resolves to such.
	MethodTextDocumentTypeDefinition = "textDocument/typeDefinition"
	// The `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.
	MethodWorkspaceWorkspaceFolders = "workspace/workspaceFolders"
	// The 'workspace/configuration' request is sent from the server to the client to fetch a certain configuration setting.  This pull model replaces the old push model were the client signaled configuration change via an event. If the server still needs to react to configuration changes (since the server caches the result of `workspace/configuration` requests) the server should register for an empty configuration change event and empty the cache if such an event is received.
	MethodWorkspaceConfiguration = "workspace/configuration"
	// A request to list all color symbols found in a given text document. The request's parameter is of type {@link DocumentColorParams} the response is of type {@link ColorInformation ColorInformation[]} or a Thenable that resolves to such.
	MethodTextDocumentDocumentColor = "textDocument/documentColor"
	// A request to list all presentation for a color. The request's parameter is of type {@link ColorPresentationParams} the response is of type {@link ColorPresentation ColorPresentation[]} or a Thenable that resolves to such.
	MethodTextDocumentColorPresentation = "textDocument/colorPresentation"
	// A request to provide folding ranges in a document. The request's parameter is of type {@link FoldingRangeParams}, the response is of type {@link FoldingRangeList} or a Thenable that resolves to such.
	MethodTextDocumentFoldingRange = "textDocument/foldingRange"
	// A request to refresh the folding ranges in a document.  @since 3.18.0
	MethodWorkspaceFoldingRangeRefresh = "workspace/foldingRange/refresh"
	// A request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPositionParams} the response is of type {@link Declaration} or a typed array of {@link DeclarationLink} or a Thenable that resolves to such.
	MethodTextDocumentDeclaration = "textDocument/declaration"
	// A request to provide selection ranges in a document. The request's parameter is of type {@link SelectionRangeParams}, the response is of type {@link SelectionRange SelectionRange[]} or a Thenable that resolves to such.
	MethodTextDocumentSelectionRange = "textDocument/selectionRange"
	// The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress reporting from the server.
	MethodWindowWorkDoneProgressCreate = "window/workDoneProgress/create"
	// A request to result a `CallHierarchyItem` in a document at a given position. Can be used as an input to an incoming or outgoing call hierarchy.  @since 3.16.0
	MethodTextDocumentPrepareCallHierarchy = "textDocument/prepareCallHierarchy"
	// A request to resolve the incoming calls for a given `CallHierarchyItem`.  @since 3.16.0
	MethodCallHierarchyIncomingCalls = "callHierarchy/incomingCalls"
	// A request to resolve the outgoing calls for a given `CallHierarchyItem`.  @since 3.16.0
	MethodCallHierarchyOutgoingCalls = "callHierarchy/outgoingCalls"
	// @since 3.16.0
	MethodTextDocumentSemanticTokensFull = "textDocument/semanticTokens/full"
	// @since 3.16.0
	MethodTextDocumentSemanticTokensFullDelta = "textDocument/semanticTokens/full/delta"
	// @since 3.16.0
	MethodTextDocumentSemanticTokensRange = "textDocument/semanticTokens/range"
	// @since 3.16.0
	MethodWorkspaceSemanticTokensRefresh = "workspace/semanticTokens/refresh"
	// A request to show a document. This request might open an external program depending on the value of the URI to open. For example a request to open `https://code.visualstudio.com/` will very likely open the URI in a WEB browser.  @since 3.16.0
	MethodWindowShowDocument = "window/showDocument"
	// A request to provide ranges that can be edited together.  @since 3.16.0
	MethodTextDocumentLinkedEditingRange = "textDocument/linkedEditingRange"
	// The will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client.  The request can return a `WorkspaceEdit` which will be applied to workspace before the files are created. Hence the `WorkspaceEdit` can not manipulate the content of the file to be created.  @since 3.16.0
	MethodWorkspaceWillCreateFiles = "workspace/willCreateFiles"
	// The will rename files request is sent from the client to the server before files are actually renamed as long as the rename is triggered from within the client.  @since 3.16.0
	MethodWorkspaceWillRenameFiles = "workspace/willRenameFiles"
	// The did delete files notification is sent from the client to the server when files were deleted from within the client.  @since 3.16.0
	MethodWorkspaceWillDeleteFiles = "workspace/willDeleteFiles"
	// A request to get the moniker of a symbol at a given text document position. The request parameter is of type {@link TextDocumentPositionParams}. The response is of type {@link Moniker Moniker[]} or `null`.
	MethodTextDocumentMoniker = "textDocument/moniker"
	// A request to result a `TypeHierarchyItem` in a document at a given position. Can be used as an input to a subtypes or supertypes type hierarchy.  @since 3.17.0
	MethodTextDocumentPrepareTypeHierarchy = "textDocument/prepareTypeHierarchy"
	// A request to resolve the supertypes for a given `TypeHierarchyItem`.  @since 3.17.0
	MethodTypeHierarchySupertypes = "typeHierarchy/supertypes"
	// A request to resolve the subtypes for a given `TypeHierarchyItem`.  @since 3.17.0
	MethodTypeHierarchySubtypes = "typeHierarchy/subtypes"
	// A request to provide inline values in a document. The request's parameter is of type {@link InlineValueParams}, the response is of type {@link InlineValue InlineValue[]} or a Thenable that resolves to such.  @since 3.17.0
	MethodTextDocumentInlineValue = "textDocument/inlineValue"
	// @since 3.17.0
	MethodWorkspaceInlineValueRefresh = "workspace/inlineValue/refresh"
	// A request to provide inlay hints in a document. The request's parameter is of type {@link InlayHintsParams}, the response is of type {@link InlayHint InlayHint[]} or a Thenable that resolves to such.  @since 3.17.0
	MethodTextDocumentInlayHint = "textDocument/inlayHint"
	// A request to resolve additional properties for an inlay hint. The request's parameter is of type {@link InlayHint}, the response is of type {@link InlayHint} or a Thenable that resolves to such.  @since 3.17.0
	MethodInlayHintResolve = "inlayHint/resolve"
	// @since 3.17.0
	MethodWorkspaceInlayHintRefresh = "workspace/inlayHint/refresh"
	// The document diagnostic request definition.  @since 3.17.0
	MethodTextDocumentDiagnostic = "textDocument/diagnostic"
	// The workspace diagnostic request definition.  @since 3.17.0
	MethodWorkspaceDiagnostic = "workspace/diagnostic"
	// The diagnostic refresh request definition.  @since 3.17.0
	MethodWorkspaceDiagnosticRefresh = "workspace/diagnostic/refresh"
	// A request to provide inline completions in a document. The request's parameter is of type {@link InlineCompletionParams}, the response is of type {@link InlineCompletion InlineCompletion[]} or a Thenable that resolves to such.  @since 3.18.0
	MethodTextDocumentInlineCompletion = "textDocument/inlineCompletion"
	// The `workspace/textDocumentContent` request is sent from the client to the server to request the content of a text document.  @since 3.18.0
	MethodWorkspaceTextDocumentContent = "workspace/textDocumentContent"
	// The `workspace/textDocumentContent` request is sent from the server to the client to refresh the content of a specific text document.  @since 3.18.0
	MethodWorkspaceTextDocumentContentRefresh = "workspace/textDocumentContent/refresh"
	// The `client/registerCapability` request is sent from the server to the client to register a new capability handler on the client side.
	MethodClientRegisterCapability = "client/registerCapability"
	// The `client/unregisterCapability` request is sent from the server to the client to unregister a previously registered capability handler on the client side.
	MethodClientUnregisterCapability = "client/unregisterCapability"
	// The initialize request is sent from the client to the server. It is sent once as the request after starting up the server. The requests parameter is of type {@link InitializeParams} the response if of type {@link InitializeResult} of a Thenable that resolves to such.
	MethodInitialize = "initialize"
	// A shutdown request is sent from the client to the server. It is sent once when the client decides to shutdown the server. The only notification that is sent after a shutdown request is the exit event.
	MethodShutdown = "shutdown"
	// The show message request is sent from the server to the client to show a message and a set of options actions to the user.
	MethodWindowShowMessageRequest = "window/showMessageRequest"
	// A document will save request is sent from the client to the server before the document is actually saved. The request can return an array of TextEdits which will be applied to the text document before it is saved. Please note that clients might drop results if computing the text edits took too long or if a server constantly fails on this request. This is done to keep the save fast and reliable.
	MethodTextDocumentWillSaveWaitUntil = "textDocument/willSaveWaitUntil"
	// Request to request completion at a given text document position. The request's parameter is of type {@link TextDocumentPosition} the response is of type {@link CompletionItem CompletionItem[]} or {@link CompletionList} or a Thenable that resolves to such.  The request can delay the computation of the {@link CompletionItem.detail `detail`} and {@link CompletionItem.documentation `documentation`} properties to the `completionItem/resolve` request. However, properties that are needed for the initial sorting and filtering, like `sortText`, `filterText`, `insertText`, and `textEdit`, must not be changed during resolve.
	MethodTextDocumentCompletion = "textDocument/completion"
	// Request to resolve additional information for a given completion item.The request's parameter is of type {@link CompletionItem} the response is of type {@link CompletionItem} or a Thenable that resolves to such.
	MethodCompletionItemResolve = "completionItem/resolve"
	// Request to request hover information at a given text document position. The request's parameter is of type {@link TextDocumentPosition} the response is of type {@link Hover} or a Thenable that resolves to such.
	MethodTextDocumentHover         = "textDocument/hover"
	MethodTextDocumentSignatureHelp = "textDocument/signatureHelp"
	// A request to resolve the definition location of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPosition} the response is of either type {@link Definition} or a typed array of {@link DefinitionLink} or a Thenable that resolves to such.
	MethodTextDocumentDefinition = "textDocument/definition"
	// A request to resolve project-wide references for the symbol denoted by the given text document position. The request's parameter is of type {@link ReferenceParams} the response is of type {@link Location Location[]} or a Thenable that resolves to such.
	MethodTextDocumentReferences = "textDocument/references"
	// Request to resolve a {@link DocumentHighlight} for a given text document position. The request's parameter is of type {@link TextDocumentPosition} the request response is an array of type {@link DocumentHighlight} or a Thenable that resolves to such.
	MethodTextDocumentDocumentHighlight = "textDocument/documentHighlight"
	// A request to list all symbols found in a given text document. The request's parameter is of type {@link TextDocumentIdentifier} the response is of type {@link SymbolInformation SymbolInformation[]} or a Thenable that resolves to such.
	MethodTextDocumentDocumentSymbol = "textDocument/documentSymbol"
	// A request to provide commands for the given text document and range.
	MethodTextDocumentCodeAction = "textDocument/codeAction"
	// Request to resolve additional information for a given code action.The request's parameter is of type {@link CodeAction} the response is of type {@link CodeAction} or a Thenable that resolves to such.
	MethodCodeActionResolve = "codeAction/resolve"
	// A request to list project-wide symbols matching the query string given by the {@link WorkspaceSymbolParams}. The response is of type {@link SymbolInformation SymbolInformation[]} or a Thenable that resolves to such.  @since 3.17.0 - support for WorkspaceSymbol in the returned data. Clients  need to advertise support for WorkspaceSymbols via the client capability  `workspace.symbol.resolveSupport`.
	MethodWorkspaceSymbol = "workspace/symbol"
	// A request to resolve the range inside the workspace symbol's location.  @since 3.17.0
	MethodWorkspaceSymbolResolve = "workspaceSymbol/resolve"
	// A request to provide code lens for the given text document.
	MethodTextDocumentCodeLens = "textDocument/codeLens"
	// A request to resolve a command for a given code lens.
	MethodCodeLensResolve = "codeLens/resolve"
	// A request to refresh all code actions  @since 3.16.0
	MethodWorkspaceCodeLensRefresh = "workspace/codeLens/refresh"
	// A request to provide document links
	MethodTextDocumentDocumentLink = "textDocument/documentLink"
	// Request to resolve additional information for a given document link. The request's parameter is of type {@link DocumentLink} the response is of type {@link DocumentLink} or a Thenable that resolves to such.
	MethodDocumentLinkResolve = "documentLink/resolve"
	// A request to format a whole document.
	MethodTextDocumentFormatting = "textDocument/formatting"
	// A request to format a range in a document.
	MethodTextDocumentRangeFormatting = "textDocument/rangeFormatting"
	// A request to format ranges in a document.  @since 3.18.0
	MethodTextDocumentRangesFormatting = "textDocument/rangesFormatting"
	// A request to format a document on type.
	MethodTextDocumentOnTypeFormatting = "textDocument/onTypeFormatting"
	// A request to rename a symbol.
	MethodTextDocumentRename = "textDocument/rename"
	// A request to test and perform the setup necessary for a rename.  @since 3.16 - support for default behavior
	MethodTextDocumentPrepareRename = "textDocument/prepareRename"
	// A request send from the client to the server to execute a command. The request might return a workspace edit which the client will apply to the workspace.
	MethodWorkspaceExecuteCommand = "workspace/executeCommand"
	// A request sent from the server to the client to modified certain resources.
	MethodWorkspaceApplyEdit = "workspace/applyEdit"
	// The `workspace/didChangeWorkspaceFolders` notification is sent from the client to the server when the workspace folder configuration changes.
	MethodWorkspaceDidChangeWorkspaceFolders = "workspace/didChangeWorkspaceFolders"
	// The `window/workDoneProgress/cancel` notification is sent from  the client to the server to cancel a progress initiated on the server side.
	MethodWindowWorkDoneProgressCancel = "window/workDoneProgress/cancel"
	// The did create files notification is sent from the client to the server when files were created from within the client.  @since 3.16.0
	MethodWorkspaceDidCreateFiles = "workspace/didCreateFiles"
	// The did rename files notification is sent from the client to the server when files were renamed from within the client.  @since 3.16.0
	MethodWorkspaceDidRenameFiles = "workspace/didRenameFiles"
	// The will delete files request is sent from the client to the server before files are actually deleted as long as the deletion is triggered from within the client.  @since 3.16.0
	MethodWorkspaceDidDeleteFiles = "workspace/didDeleteFiles"
	// A notification sent when a notebook opens.  @since 3.17.0
	MethodNotebookDocumentDidOpen   = "notebookDocument/didOpen"
	MethodNotebookDocumentDidChange = "notebookDocument/didChange"
	// A notification sent when a notebook document is saved.  @since 3.17.0
	MethodNotebookDocumentDidSave = "notebookDocument/didSave"
	// A notification sent when a notebook closes.  @since 3.17.0
	MethodNotebookDocumentDidClose = "notebookDocument/didClose"
	// The initialized notification is sent from the client to the server after the client is fully initialized and the server is allowed to send requests from the server to the client.
	MethodInitialized = "initialized"
	// The exit event is sent from the client to the server to ask the server to exit its process.
	MethodExit = "exit"
	// The configuration change notification is sent from the client to the server when the client's configuration has changed. The notification contains the changed configuration as defined by the language client.
	MethodWorkspaceDidChangeConfiguration = "workspace/didChangeConfiguration"
	// The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.
	MethodWindowShowMessage = "window/showMessage"
	// The log message notification is sent from the server to the client to ask the client to log a particular message.
	MethodWindowLogMessage = "window/logMessage"
	// The telemetry event notification is sent from the server to the client to ask the client to log telemetry data.
	MethodTelemetryEvent = "telemetry/event"
	// The document open notification is sent from the client to the server to signal newly opened text documents. The document's truth is now managed by the client and the server must not try to read the document's truth using the document's uri. Open in this sense means it is managed by the client. It doesn't necessarily mean that its content is presented in an editor. An open notification must not be sent more than once without a corresponding close notification send before. This means open and close notification must be balanced and the max open count is one.
	MethodTextDocumentDidOpen = "textDocument/didOpen"
	// The document change notification is sent from the client to the server to signal changes to a text document.
	MethodTextDocumentDidChange = "textDocument/didChange"
	// The document close notification is sent from the client to the server when the document got closed in the client. The document's truth now exists where the document's uri points to (e.g. if the document's uri is a file uri the truth now exists on disk). As with the open notification the close notification is about managing the document's content. Receiving a close notification doesn't mean that the document was open in an editor before. A close notification requires a previous open notification to be sent.
	MethodTextDocumentDidClose = "textDocument/didClose"
	// The document save notification is sent from the client to the server when the document got saved in the client.
	MethodTextDocumentDidSave = "textDocument/didSave"
	// A document will save notification is sent from the client to the server before the document is actually saved.
	MethodTextDocumentWillSave = "textDocument/willSave"
	// The watched files notification is sent from the client to the server when the client detects changes to file watched by the language client.
	MethodWorkspaceDidChangeWatchedFiles = "workspace/didChangeWatchedFiles"
	// Diagnostics notification are sent from the server to the client to signal results of validation runs.
	MethodTextDocumentPublishDiagnostics = "textDocument/publishDiagnostics"
	MethodSetTrace                       = "$/setTrace"
	MethodLogTrace                       = "$/logTrace"
	MethodCancelRequest                  = "$/cancelRequest"
	MethodProgress                       = "$/progress"
)
View Source 
const (
	CodeServerNotInitialized jsonrpc2.ErrorCode = -32002
	CodeUnknownErrorCode     jsonrpc2.ErrorCode = -32001
	CodeRequestFailed        jsonrpc2.ErrorCode = -32803
	CodeServerCancelled      jsonrpc2.ErrorCode = -32802
	CodeContentModified      jsonrpc2.ErrorCode = -32801
	CodeRequestCancelled     jsonrpc2.ErrorCode = -32800
)

LSP-specific error codes defined in the Language Server Protocol (LSP) specification.

Variables

View Source 
var MethodRegistry = map[string]MethodInfo{
	MethodTextDocumentImplementation: {
		Method:           MethodTextDocumentImplementation,
		ServerCapability: CapabilityImplementationProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentTypeDefinition: {
		Method:           MethodTextDocumentTypeDefinition,
		ServerCapability: CapabilityTypeDefinitionProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceWorkspaceFolders: {
		Method:           MethodWorkspaceWorkspaceFolders,
		ServerCapability: CapabilityWorkspace,
		Direction:        "serverToClient",
	},
	MethodWorkspaceConfiguration: {
		Method:    MethodWorkspaceConfiguration,
		Direction: "serverToClient",
	},
	MethodTextDocumentDocumentColor: {
		Method:           MethodTextDocumentDocumentColor,
		ServerCapability: CapabilityColorProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentColorPresentation: {
		Method:           MethodTextDocumentColorPresentation,
		ServerCapability: CapabilityColorProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentFoldingRange: {
		Method:           MethodTextDocumentFoldingRange,
		ServerCapability: CapabilityFoldingRangeProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceFoldingRangeRefresh: {
		Method:    MethodWorkspaceFoldingRangeRefresh,
		Direction: "serverToClient",
	},
	MethodTextDocumentDeclaration: {
		Method:           MethodTextDocumentDeclaration,
		ServerCapability: CapabilityDeclarationProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentSelectionRange: {
		Method:           MethodTextDocumentSelectionRange,
		ServerCapability: CapabilitySelectionRangeProvider,
		Direction:        "clientToServer",
	},
	MethodWindowWorkDoneProgressCreate: {
		Method:    MethodWindowWorkDoneProgressCreate,
		Direction: "serverToClient",
	},
	MethodTextDocumentPrepareCallHierarchy: {
		Method:           MethodTextDocumentPrepareCallHierarchy,
		ServerCapability: CapabilityCallHierarchyProvider,
		Direction:        "clientToServer",
	},
	MethodCallHierarchyIncomingCalls: {
		Method:           MethodCallHierarchyIncomingCalls,
		ServerCapability: CapabilityCallHierarchyProvider,
		Direction:        "clientToServer",
	},
	MethodCallHierarchyOutgoingCalls: {
		Method:           MethodCallHierarchyOutgoingCalls,
		ServerCapability: CapabilityCallHierarchyProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentSemanticTokensFull: {
		Method:           MethodTextDocumentSemanticTokensFull,
		ServerCapability: CapabilitySemanticTokensProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentSemanticTokensFullDelta: {
		Method:           MethodTextDocumentSemanticTokensFullDelta,
		ServerCapability: CapabilitySemanticTokensProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentSemanticTokensRange: {
		Method:           MethodTextDocumentSemanticTokensRange,
		ServerCapability: CapabilitySemanticTokensProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceSemanticTokensRefresh: {
		Method:    MethodWorkspaceSemanticTokensRefresh,
		Direction: "serverToClient",
	},
	MethodWindowShowDocument: {
		Method:    MethodWindowShowDocument,
		Direction: "serverToClient",
	},
	MethodTextDocumentLinkedEditingRange: {
		Method:           MethodTextDocumentLinkedEditingRange,
		ServerCapability: CapabilityLinkedEditingRangeProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceWillCreateFiles: {
		Method:           MethodWorkspaceWillCreateFiles,
		ServerCapability: CapabilityWorkspace,
		Direction:        "clientToServer",
	},
	MethodWorkspaceWillRenameFiles: {
		Method:           MethodWorkspaceWillRenameFiles,
		ServerCapability: CapabilityWorkspace,
		Direction:        "clientToServer",
	},
	MethodWorkspaceWillDeleteFiles: {
		Method:           MethodWorkspaceWillDeleteFiles,
		ServerCapability: CapabilityWorkspace,
		Direction:        "clientToServer",
	},
	MethodTextDocumentMoniker: {
		Method:           MethodTextDocumentMoniker,
		ServerCapability: CapabilityMonikerProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentPrepareTypeHierarchy: {
		Method:           MethodTextDocumentPrepareTypeHierarchy,
		ServerCapability: CapabilityTypeHierarchyProvider,
		Direction:        "clientToServer",
	},
	MethodTypeHierarchySupertypes: {
		Method:    MethodTypeHierarchySupertypes,
		Direction: "clientToServer",
	},
	MethodTypeHierarchySubtypes: {
		Method:    MethodTypeHierarchySubtypes,
		Direction: "clientToServer",
	},
	MethodTextDocumentInlineValue: {
		Method:           MethodTextDocumentInlineValue,
		ServerCapability: CapabilityInlineValueProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceInlineValueRefresh: {
		Method:    MethodWorkspaceInlineValueRefresh,
		Direction: "serverToClient",
	},
	MethodTextDocumentInlayHint: {
		Method:           MethodTextDocumentInlayHint,
		ServerCapability: CapabilityInlayHintProvider,
		Direction:        "clientToServer",
	},
	MethodInlayHintResolve: {
		Method:           MethodInlayHintResolve,
		ServerCapability: CapabilityInlayHintProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceInlayHintRefresh: {
		Method:    MethodWorkspaceInlayHintRefresh,
		Direction: "serverToClient",
	},
	MethodTextDocumentDiagnostic: {
		Method:           MethodTextDocumentDiagnostic,
		ServerCapability: CapabilityDiagnosticProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceDiagnostic: {
		Method:           MethodWorkspaceDiagnostic,
		ServerCapability: CapabilityDiagnosticProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceDiagnosticRefresh: {
		Method:    MethodWorkspaceDiagnosticRefresh,
		Direction: "serverToClient",
	},
	MethodTextDocumentInlineCompletion: {
		Method:           MethodTextDocumentInlineCompletion,
		ServerCapability: CapabilityInlineCompletionProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceTextDocumentContent: {
		Method:           MethodWorkspaceTextDocumentContent,
		ServerCapability: CapabilityWorkspace,
		Direction:        "clientToServer",
	},
	MethodWorkspaceTextDocumentContentRefresh: {
		Method:    MethodWorkspaceTextDocumentContentRefresh,
		Direction: "serverToClient",
	},
	MethodClientRegisterCapability: {
		Method:    MethodClientRegisterCapability,
		Direction: "serverToClient",
	},
	MethodClientUnregisterCapability: {
		Method:    MethodClientUnregisterCapability,
		Direction: "serverToClient",
	},
	MethodInitialize: {
		Method:    MethodInitialize,
		Direction: "clientToServer",
	},
	MethodShutdown: {
		Method:    MethodShutdown,
		Direction: "clientToServer",
	},
	MethodWindowShowMessageRequest: {
		Method:    MethodWindowShowMessageRequest,
		Direction: "serverToClient",
	},
	MethodTextDocumentWillSaveWaitUntil: {
		Method:           MethodTextDocumentWillSaveWaitUntil,
		ServerCapability: CapabilityTextDocumentSync,
		Direction:        "clientToServer",
	},
	MethodTextDocumentCompletion: {
		Method:           MethodTextDocumentCompletion,
		ServerCapability: CapabilityCompletionProvider,
		Direction:        "clientToServer",
	},
	MethodCompletionItemResolve: {
		Method:           MethodCompletionItemResolve,
		ServerCapability: CapabilityCompletionProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentHover: {
		Method:           MethodTextDocumentHover,
		ServerCapability: CapabilityHoverProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentSignatureHelp: {
		Method:           MethodTextDocumentSignatureHelp,
		ServerCapability: CapabilitySignatureHelpProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentDefinition: {
		Method:           MethodTextDocumentDefinition,
		ServerCapability: CapabilityDefinitionProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentReferences: {
		Method:           MethodTextDocumentReferences,
		ServerCapability: CapabilityReferencesProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentDocumentHighlight: {
		Method:           MethodTextDocumentDocumentHighlight,
		ServerCapability: CapabilityDocumentHighlightProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentDocumentSymbol: {
		Method:           MethodTextDocumentDocumentSymbol,
		ServerCapability: CapabilityDocumentSymbolProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentCodeAction: {
		Method:           MethodTextDocumentCodeAction,
		ServerCapability: CapabilityCodeActionProvider,
		Direction:        "clientToServer",
	},
	MethodCodeActionResolve: {
		Method:           MethodCodeActionResolve,
		ServerCapability: CapabilityCodeActionProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceSymbol: {
		Method:           MethodWorkspaceSymbol,
		ServerCapability: CapabilityWorkspaceSymbolProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceSymbolResolve: {
		Method:           MethodWorkspaceSymbolResolve,
		ServerCapability: CapabilityWorkspaceSymbolProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentCodeLens: {
		Method:           MethodTextDocumentCodeLens,
		ServerCapability: CapabilityCodeLensProvider,
		Direction:        "clientToServer",
	},
	MethodCodeLensResolve: {
		Method:           MethodCodeLensResolve,
		ServerCapability: CapabilityCodeLensProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceCodeLensRefresh: {
		Method:    MethodWorkspaceCodeLensRefresh,
		Direction: "serverToClient",
	},
	MethodTextDocumentDocumentLink: {
		Method:           MethodTextDocumentDocumentLink,
		ServerCapability: CapabilityDocumentLinkProvider,
		Direction:        "clientToServer",
	},
	MethodDocumentLinkResolve: {
		Method:           MethodDocumentLinkResolve,
		ServerCapability: CapabilityDocumentLinkProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentFormatting: {
		Method:           MethodTextDocumentFormatting,
		ServerCapability: CapabilityDocumentFormattingProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentRangeFormatting: {
		Method:           MethodTextDocumentRangeFormatting,
		ServerCapability: CapabilityDocumentRangeFormattingProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentRangesFormatting: {
		Method:           MethodTextDocumentRangesFormatting,
		ServerCapability: CapabilityDocumentRangeFormattingProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentOnTypeFormatting: {
		Method:           MethodTextDocumentOnTypeFormatting,
		ServerCapability: CapabilityDocumentOnTypeFormattingProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentRename: {
		Method:           MethodTextDocumentRename,
		ServerCapability: CapabilityRenameProvider,
		Direction:        "clientToServer",
	},
	MethodTextDocumentPrepareRename: {
		Method:           MethodTextDocumentPrepareRename,
		ServerCapability: CapabilityRenameProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceExecuteCommand: {
		Method:           MethodWorkspaceExecuteCommand,
		ServerCapability: CapabilityExecuteCommandProvider,
		Direction:        "clientToServer",
	},
	MethodWorkspaceApplyEdit: {
		Method:    MethodWorkspaceApplyEdit,
		Direction: "serverToClient",
	},
	MethodWorkspaceDidChangeWorkspaceFolders: {
		Method:           MethodWorkspaceDidChangeWorkspaceFolders,
		ServerCapability: CapabilityWorkspace,
		Direction:        "clientToServer",
	},
	MethodWindowWorkDoneProgressCancel: {
		Method:    MethodWindowWorkDoneProgressCancel,
		Direction: "clientToServer",
	},
	MethodWorkspaceDidCreateFiles: {
		Method:           MethodWorkspaceDidCreateFiles,
		ServerCapability: CapabilityWorkspace,
		Direction:        "clientToServer",
	},
	MethodWorkspaceDidRenameFiles: {
		Method:           MethodWorkspaceDidRenameFiles,
		ServerCapability: CapabilityWorkspace,
		Direction:        "clientToServer",
	},
	MethodWorkspaceDidDeleteFiles: {
		Method:           MethodWorkspaceDidDeleteFiles,
		ServerCapability: CapabilityWorkspace,
		Direction:        "clientToServer",
	},
	MethodNotebookDocumentDidOpen: {
		Method:    MethodNotebookDocumentDidOpen,
		Direction: "clientToServer",
	},
	MethodNotebookDocumentDidChange: {
		Method:    MethodNotebookDocumentDidChange,
		Direction: "clientToServer",
	},
	MethodNotebookDocumentDidSave: {
		Method:    MethodNotebookDocumentDidSave,
		Direction: "clientToServer",
	},
	MethodNotebookDocumentDidClose: {
		Method:    MethodNotebookDocumentDidClose,
		Direction: "clientToServer",
	},
	MethodInitialized: {
		Method:    MethodInitialized,
		Direction: "clientToServer",
	},
	MethodExit: {
		Method:    MethodExit,
		Direction: "clientToServer",
	},
	MethodWorkspaceDidChangeConfiguration: {
		Method:    MethodWorkspaceDidChangeConfiguration,
		Direction: "clientToServer",
	},
	MethodWindowShowMessage: {
		Method:    MethodWindowShowMessage,
		Direction: "serverToClient",
	},
	MethodWindowLogMessage: {
		Method:    MethodWindowLogMessage,
		Direction: "serverToClient",
	},
	MethodTelemetryEvent: {
		Method:    MethodTelemetryEvent,
		Direction: "serverToClient",
	},
	MethodTextDocumentDidOpen: {
		Method:           MethodTextDocumentDidOpen,
		ServerCapability: CapabilityTextDocumentSync,
		Direction:        "clientToServer",
	},
	MethodTextDocumentDidChange: {
		Method:           MethodTextDocumentDidChange,
		ServerCapability: CapabilityTextDocumentSync,
		Direction:        "clientToServer",
	},
	MethodTextDocumentDidClose: {
		Method:           MethodTextDocumentDidClose,
		ServerCapability: CapabilityTextDocumentSync,
		Direction:        "clientToServer",
	},
	MethodTextDocumentDidSave: {
		Method:           MethodTextDocumentDidSave,
		ServerCapability: CapabilityTextDocumentSync,
		Direction:        "clientToServer",
	},
	MethodTextDocumentWillSave: {
		Method:           MethodTextDocumentWillSave,
		ServerCapability: CapabilityTextDocumentSync,
		Direction:        "clientToServer",
	},
	MethodWorkspaceDidChangeWatchedFiles: {
		Method:    MethodWorkspaceDidChangeWatchedFiles,
		Direction: "clientToServer",
	},
	MethodTextDocumentPublishDiagnostics: {
		Method:    MethodTextDocumentPublishDiagnostics,
		Direction: "serverToClient",
	},
	MethodSetTrace: {
		Method:    MethodSetTrace,
		Direction: "clientToServer",
	},
	MethodLogTrace: {
		Method:    MethodLogTrace,
		Direction: "serverToClient",
	},
	MethodCancelRequest: {
		Method:    MethodCancelRequest,
		Direction: "both",
	},
	MethodProgress: {
		Method:    MethodProgress,
		Direction: "both",
	},
}

Functions

func Handle 

func Handle[Req any, Resp any](client *Client, method string, f func(ctx context.Context, req *Req) (Resp, error))

Handle registers a strongly-typed request handler to a client using Go generics.

Types

type AggregateOptions 

type AggregateOptions struct {
	Diagnostics bool `json:"diagnostics" toml:"diagnostics"`
	Completions bool `json:"completions" toml:"completions"`
	References  bool `json:"references" toml:"references"`
}

AggregateOptions defines result aggregation rules.

type AnnotatedTextEdit 

type AnnotatedTextEdit struct {
	// The range of the text document to be manipulated. To insert text into a document create a range where start === end.
	Range Range `json:"range"`
	// The string to be inserted. For delete operations use an empty string.
	NewText string `json:"newText"`
	// The actual identifier of the change annotation
	AnnotationID ChangeAnnotationIdentifier `json:"annotationId"`
}

A special text edit with an additional change annotation.

@since 3.16.0.

type ApplyKind 

type ApplyKind uint32

Defines how values from a set of defaults and an individual item will be merged.

@since 3.18.0 

const (
	// The value from the individual item (if provided and not `null`) will be used instead of the default.
	ApplyKindReplace ApplyKind = 1
	// The value from the item will be merged with the default.  The specific rules for mergeing values are defined against each field that supports merging.
	ApplyKindMerge ApplyKind = 2
)

type ApplyWorkspaceEditParams 

type ApplyWorkspaceEditParams struct {
	// An optional label of the workspace edit. This label is presented in the user interface for example on an undo stack to undo the workspace edit.
	Label *string `json:"label,omitempty"`
	// The edits to apply.
	Edit WorkspaceEdit `json:"edit"`
	// Additional data about the edit.  @since 3.18.0
	Metadata *WorkspaceEditMetadata `json:"metadata,omitempty"`
}

The parameters passed via an apply workspace edit request.

type ApplyWorkspaceEditResult 

type ApplyWorkspaceEditResult struct {
	// Indicates whether the edit was applied or not.
	Applied bool `json:"applied"`
	// An optional textual description for why the edit was not applied. This may be used by the server for diagnostic logging or to provide a suitable error for a request that triggered the edit.
	FailureReason *string `json:"failureReason,omitempty"`
	// Depending on the client's failure handling strategy `failedChange` might contain the index of the change that failed. This property is only available if the client signals a `failureHandlingStrategy` in its client capabilities.
	FailedChange *uint32 `json:"failedChange,omitempty"`
}

The result returned from the apply workspace edit request.

@since 3.17 renamed from ApplyWorkspaceEditResponse

type BaseSymbolInformation 

type BaseSymbolInformation struct {
	// The name of this symbol.
	Name string `json:"name"`
	// The kind of this symbol.
	Kind SymbolKind `json:"kind"`
	// Tags for this symbol.  @since 3.16.0
	Tags []SymbolTag `json:"tags,omitempty"`
	// The name of the symbol containing this symbol. This information is for user interface purposes (e.g. to render a qualifier in the user interface if necessary). It can't be used to re-infer a hierarchy for the document symbols.
	ContainerName *string `json:"containerName,omitempty"`
}

A base for all symbol information.

type CallHierarchyClientCapabilities 

type CallHierarchyClientCapabilities struct {
	// Whether implementation supports dynamic registration. If this is set to `true` the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

@since 3.16.0

type CallHierarchyIncomingCall 

type CallHierarchyIncomingCall struct {
	// The item that makes the call.
	From CallHierarchyItem `json:"from"`
	// The ranges at which the calls appear. This is relative to the caller denoted by {@link CallHierarchyIncomingCall.from `this.from`}.
	FromRanges []Range `json:"fromRanges"`
}

Represents an incoming call, e.g. a caller of a method or constructor.

@since 3.16.0

type CallHierarchyIncomingCallsParams 

type CallHierarchyIncomingCallsParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken    `json:"partialResultToken,omitempty"`
	Item               CallHierarchyItem `json:"item"`
}

The parameter of a `callHierarchy/incomingCalls` request.

@since 3.16.0

type CallHierarchyItem 

type CallHierarchyItem struct {
	// The name of this item.
	Name string `json:"name"`
	// The kind of this item.
	Kind SymbolKind `json:"kind"`
	// Tags for this item.
	Tags []SymbolTag `json:"tags,omitempty"`
	// More detail for this item, e.g. the signature of a function.
	Detail *string `json:"detail,omitempty"`
	// The resource identifier of this item.
	URI string `json:"uri"`
	// The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
	Range Range `json:"range"`
	// The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function. Must be contained by the {@link CallHierarchyItem.range `range`}.
	SelectionRange Range `json:"selectionRange"`
	// A data entry field that is preserved between a call hierarchy prepare and incoming calls or outgoing calls requests.
	Data *json.RawMessage `json:"data,omitempty"`
}

Represents programming constructs like functions or constructors in the context of call hierarchy.

@since 3.16.0

type CallHierarchyOptions 

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

Call hierarchy options used during static registration.

@since 3.16.0

type CallHierarchyOutgoingCall 

type CallHierarchyOutgoingCall struct {
	// The item that is called.
	To CallHierarchyItem `json:"to"`
	// The range at which this item is called. This is the range relative to the caller, e.g the item passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`} and not {@link CallHierarchyOutgoingCall.to `this.to`}.
	FromRanges []Range `json:"fromRanges"`
}

Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.

@since 3.16.0

type CallHierarchyOutgoingCallsParams 

type CallHierarchyOutgoingCallsParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken    `json:"partialResultToken,omitempty"`
	Item               CallHierarchyItem `json:"item"`
}

The parameter of a `callHierarchy/outgoingCalls` request.

@since 3.16.0

type CallHierarchyPrepareParams 

type CallHierarchyPrepareParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
}

The parameter of a `textDocument/prepareCallHierarchy` request.

@since 3.16.0

type CallHierarchyRegistrationOptions 

type CallHierarchyRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// 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"`
}

Call hierarchy options used during static or dynamic registration.

@since 3.16.0

type CancelParams 

type CancelParams struct {
	// The request id to cancel.
	ID CancelParamsID `json:"id"`
}

type CancelParamsID 

type CancelParamsID struct {
	Int32  *int32  `json:"-"`
	String *string `json:"-"`
}

func (CancelParamsID) MarshalJSON 

func (u CancelParamsID) MarshalJSON() ([]byte, error)

func (*CancelParamsID) UnmarshalJSON 

func (u *CancelParamsID) UnmarshalJSON(data []byte) error

type Capability 

type Capability string

Capability represents limited server capabilities. 

const (
	// The position encoding the server picked from the encodings offered by the client via the client capability `general.positionEncodings`.  If the client didn't provide any position encodings the only valid value that a server can return is 'utf-16'.  If omitted it defaults to 'utf-16'.  @since 3.17.0
	CapabilityPositionEncoding Capability = "positionEncoding"
	// Defines how text documents are synced. Is either a detailed structure defining each notification or for backwards compatibility the TextDocumentSyncKind number.
	CapabilityTextDocumentSync Capability = "textDocumentSync"
	// Defines how notebook documents are synced.  @since 3.17.0
	CapabilityNotebookDocumentSync Capability = "notebookDocumentSync"
	// The server provides completion support.
	CapabilityCompletionProvider Capability = "completionProvider"
	// The server provides hover support.
	CapabilityHoverProvider Capability = "hoverProvider"
	// The server provides signature help support.
	CapabilitySignatureHelpProvider Capability = "signatureHelpProvider"
	// The server provides Goto Declaration support.
	CapabilityDeclarationProvider Capability = "declarationProvider"
	// The server provides goto definition support.
	CapabilityDefinitionProvider Capability = "definitionProvider"
	// The server provides Goto Type Definition support.
	CapabilityTypeDefinitionProvider Capability = "typeDefinitionProvider"
	// The server provides Goto Implementation support.
	CapabilityImplementationProvider Capability = "implementationProvider"
	// The server provides find references support.
	CapabilityReferencesProvider Capability = "referencesProvider"
	// The server provides document highlight support.
	CapabilityDocumentHighlightProvider Capability = "documentHighlightProvider"
	// The server provides document symbol support.
	CapabilityDocumentSymbolProvider Capability = "documentSymbolProvider"
	// The server provides code actions. CodeActionOptions may only be specified if the client states that it supports `codeActionLiteralSupport` in its initial `initialize` request.
	CapabilityCodeActionProvider Capability = "codeActionProvider"
	// The server provides code lens.
	CapabilityCodeLensProvider Capability = "codeLensProvider"
	// The server provides document link support.
	CapabilityDocumentLinkProvider Capability = "documentLinkProvider"
	// The server provides color provider support.
	CapabilityColorProvider Capability = "colorProvider"
	// The server provides workspace symbol support.
	CapabilityWorkspaceSymbolProvider Capability = "workspaceSymbolProvider"
	// The server provides document formatting.
	CapabilityDocumentFormattingProvider Capability = "documentFormattingProvider"
	// The server provides document range formatting.
	CapabilityDocumentRangeFormattingProvider Capability = "documentRangeFormattingProvider"
	// The server provides document formatting on typing.
	CapabilityDocumentOnTypeFormattingProvider Capability = "documentOnTypeFormattingProvider"
	// The server provides rename support. RenameOptions may only be specified if the client states that it supports `prepareSupport` in its initial `initialize` request.
	CapabilityRenameProvider Capability = "renameProvider"
	// The server provides folding provider support.
	CapabilityFoldingRangeProvider Capability = "foldingRangeProvider"
	// The server provides selection range support.
	CapabilitySelectionRangeProvider Capability = "selectionRangeProvider"
	// The server provides execute command support.
	CapabilityExecuteCommandProvider Capability = "executeCommandProvider"
	// The server provides call hierarchy support.  @since 3.16.0
	CapabilityCallHierarchyProvider Capability = "callHierarchyProvider"
	// The server provides linked editing range support.  @since 3.16.0
	CapabilityLinkedEditingRangeProvider Capability = "linkedEditingRangeProvider"
	// The server provides semantic tokens support.  @since 3.16.0
	CapabilitySemanticTokensProvider Capability = "semanticTokensProvider"
	// The server provides moniker support.  @since 3.16.0
	CapabilityMonikerProvider Capability = "monikerProvider"
	// The server provides type hierarchy support.  @since 3.17.0
	CapabilityTypeHierarchyProvider Capability = "typeHierarchyProvider"
	// The server provides inline values.  @since 3.17.0
	CapabilityInlineValueProvider Capability = "inlineValueProvider"
	// The server provides inlay hints.  @since 3.17.0
	CapabilityInlayHintProvider Capability = "inlayHintProvider"
	// The server has support for pull model diagnostics.  @since 3.17.0
	CapabilityDiagnosticProvider Capability = "diagnosticProvider"
	// Inline completion options used during static registration.  @since 3.18.0
	CapabilityInlineCompletionProvider Capability = "inlineCompletionProvider"
	// Workspace specific server capabilities.
	CapabilityWorkspace Capability = "workspace"
	// Experimental server capabilities.
	CapabilityExperimental Capability = "experimental"
)

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 to refer to a change annotation stored with a workspace edit.

type ChangeAnnotationsSupportOptions 

type ChangeAnnotationsSupportOptions struct {
	// Whether the client groups edits with equal labels into tree nodes, for instance all edits labelled with "Changes in Strings" would be a tree node.
	GroupsOnLabel *bool `json:"groupsOnLabel,omitempty"`
}

@since 3.18.0

type Client 

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

Client is a multiplexing LSP client.

func NewClient 

func NewClient(ctx context.Context, opts ClientOptions) (*Client, error)

func (*Client) CallHierarchyIncomingCalls 

func (c *Client) CallHierarchyIncomingCalls(ctx context.Context, params *CallHierarchyIncomingCallsParams) ([]CallHierarchyIncomingCall, error)

CallHierarchyIncomingCalls auto-generated from meta model

func (*Client) CallHierarchyOutgoingCalls 

func (c *Client) CallHierarchyOutgoingCalls(ctx context.Context, params *CallHierarchyOutgoingCallsParams) ([]CallHierarchyOutgoingCall, error)

CallHierarchyOutgoingCalls auto-generated from meta model

func (*Client) Close 

func (c *Client) Close() error

Close shuts down all connections and terminates the subprocesses.

func (*Client) CodeAction 

func (c *Client) CodeAction(ctx context.Context, params *CodeActionParams) ([]CodeActionResultItem, error)

CodeAction auto-generated from meta model

func (*Client) CodeActionResolve 

func (c *Client) CodeActionResolve(ctx context.Context, params *CodeAction) (*CodeAction, error)

CodeActionResolve auto-generated from meta model

func (*Client) CodeLens 

func (c *Client) CodeLens(ctx context.Context, params *CodeLensParams) ([]CodeLens, error)

CodeLens auto-generated from meta model

func (*Client) ColorPresentation 

func (c *Client) ColorPresentation(ctx context.Context, params *ColorPresentationParams) ([]ColorPresentation, error)

ColorPresentation auto-generated from meta model

func (*Client) Completion 

func (c *Client) Completion(ctx context.Context, params *CompletionParams) (*CompletionList, error)

Completion returns aggregated or first-matching completions based on AggregateOptions.

func (*Client) CompletionItemResolve 

func (c *Client) CompletionItemResolve(ctx context.Context, params *CompletionItem) (*CompletionItem, error)

CompletionItemResolve auto-generated from meta model

func (*Client) Declaration 

func (c *Client) Declaration(ctx context.Context, params *DeclarationParams) (*DeclarationResult, error)

Declaration auto-generated from meta model

func (*Client) Definition 

func (c *Client) Definition(ctx context.Context, params *DefinitionParams) (*DefinitionResult, error)

Definition auto-generated from meta model

func (*Client) Diagnostic 

func (c *Client) Diagnostic(ctx context.Context, params *DocumentDiagnosticParams) (*DocumentDiagnosticReport, error)

Diagnostic auto-generated from meta model

func (*Client) DidChange 

func (c *Client) DidChange(ctx context.Context, params *DidChangeTextDocumentParams) error

DidChange notifies matching servers of content changes.

func (*Client) DidChangeConfiguration 

func (c *Client) DidChangeConfiguration(ctx context.Context, params *DidChangeConfigurationParams) error

DidChangeConfiguration notifies all running backend servers of a configuration change. This sends the workspace/didChangeConfiguration notification per the LSP specification.

func (*Client) DidChangeNotebook 

func (c *Client) DidChangeNotebook(ctx context.Context, params *DidChangeNotebookDocumentParams) error

DidChangeNotebook updates registered cell documents and notifies matching backend servers.

func (*Client) DidClose 

func (c *Client) DidClose(ctx context.Context, params *DidCloseTextDocumentParams) error

DidClose notifies matching servers of document closure.

func (*Client) DidCloseNotebook 

func (c *Client) DidCloseNotebook(ctx context.Context, params *DidCloseNotebookDocumentParams) error

DidCloseNotebook removes registered cell documents and notifies matching backend servers.

func (*Client) DidOpen 

func (c *Client) DidOpen(ctx context.Context, params *DidOpenTextDocumentParams) error

DidOpen registers the text document URI with its language ID and notifies matching servers.

func (*Client) DidOpenNotebook 

func (c *Client) DidOpenNotebook(ctx context.Context, params *DidOpenNotebookDocumentParams) error

DidOpenNotebook registers cell documents and notifies matching backend servers.

func (*Client) DidRenameFiles 

func (c *Client) DidRenameFiles(ctx context.Context, params *RenameFilesParams) error

DidRenameFiles notifies matching servers of document rename operations.

func (*Client) DidSave 

func (c *Client) DidSave(ctx context.Context, params *DidSaveTextDocumentParams) error

DidSave notifies matching servers that a text document was saved.

func (*Client) DidSaveNotebook 

func (c *Client) DidSaveNotebook(ctx context.Context, params *DidSaveNotebookDocumentParams) error

DidSaveNotebook notifies matching servers that a notebook document was saved.

func (*Client) DocumentColor 

func (c *Client) DocumentColor(ctx context.Context, params *DocumentColorParams) ([]ColorInformation, error)

DocumentColor auto-generated from meta model

func (*Client) DocumentHighlight 

func (c *Client) DocumentHighlight(ctx context.Context, params *DocumentHighlightParams) ([]DocumentHighlight, error)

DocumentHighlight auto-generated from meta model 

func (c *Client) DocumentLink(ctx context.Context, params *DocumentLinkParams) ([]DocumentLink, error)

DocumentLink auto-generated from meta model

func (*Client) DocumentLinkResolve 

func (c *Client) DocumentLinkResolve(ctx context.Context, params *DocumentLink) (*DocumentLink, error)

DocumentLinkResolve auto-generated from meta model

func (*Client) DocumentSymbol 

func (c *Client) DocumentSymbol(ctx context.Context, params *DocumentSymbolParams) (*DocumentSymbolResult, error)

DocumentSymbol auto-generated from meta model

func (*Client) FoldingRange 

func (c *Client) FoldingRange(ctx context.Context, params *FoldingRangeParams) ([]FoldingRange, error)

FoldingRange auto-generated from meta model

func (*Client) Formatting 

func (c *Client) Formatting(ctx context.Context, params *DocumentFormattingParams) ([]TextEdit, error)

Formatting auto-generated from meta model

func (*Client) Hover 

func (c *Client) Hover(ctx context.Context, params *HoverParams) (*Hover, error)

Hover auto-generated from meta model

func (*Client) Implementation 

func (c *Client) Implementation(ctx context.Context, params *ImplementationParams) (*ImplementationResult, error)

Implementation auto-generated from meta model

func (*Client) Initialize 

func (c *Client) Initialize(ctx context.Context) error

Initialize is a no-op implementation of the core API lifecycle (servers are initialized on NewClient).

func (*Client) InlayHint 

func (c *Client) InlayHint(ctx context.Context, params *InlayHintParams) ([]InlayHint, error)

InlayHint auto-generated from meta model

func (*Client) InlayHintResolve 

func (c *Client) InlayHintResolve(ctx context.Context, params *InlayHint) (*InlayHint, error)

InlayHintResolve auto-generated from meta model

func (*Client) InlineCompletion 

func (c *Client) InlineCompletion(ctx context.Context, params *InlineCompletionParams) (*InlineCompletionResult, error)

InlineCompletion auto-generated from meta model

func (*Client) InlineValue 

func (c *Client) InlineValue(ctx context.Context, params *InlineValueParams) ([]InlineValue, error)

InlineValue auto-generated from meta model

func (*Client) IsOpened 

func (c *Client) IsOpened(uri string) bool

IsOpened checks if a text document with the given URI is currently open (managed by the client).

func (*Client) LinkedEditingRange 

func (c *Client) LinkedEditingRange(ctx context.Context, params *LinkedEditingRangeParams) (*LinkedEditingRanges, error)

LinkedEditingRange auto-generated from meta model

func (*Client) Moniker 

func (c *Client) Moniker(ctx context.Context, params *MonikerParams) ([]Moniker, error)

Moniker auto-generated from meta model

func (*Client) OnAnyNotification 

func (c *Client) OnAnyNotification(callback func(method string, params json.RawMessage))

OnAnyNotification registers a callback function to handle all server-pushed notifications.

func (*Client) OnAnyRequest 

func (c *Client) OnAnyRequest(callback func(ctx context.Context, method string, params json.RawMessage) (any, error))

OnAnyRequest registers a callback function to handle all server-pushed requests.

func (*Client) OnNotification 

func (c *Client) OnNotification(method string, callback any)

OnNotification registers a callback function to handle server-pushed notifications.

func (*Client) OnRequest 

func (c *Client) OnRequest(method string, handler jsonrpc2.Handler)

OnRequest registers a JSON-RPC handler to process a specific server-pushed request.

func (*Client) OnTypeFormatting 

func (c *Client) OnTypeFormatting(ctx context.Context, params *DocumentOnTypeFormattingParams) ([]TextEdit, error)

OnTypeFormatting auto-generated from meta model

func (*Client) PrepareCallHierarchy 

func (c *Client) PrepareCallHierarchy(ctx context.Context, params *CallHierarchyPrepareParams) ([]CallHierarchyItem, error)

PrepareCallHierarchy auto-generated from meta model

func (*Client) PrepareRename 

func (c *Client) PrepareRename(ctx context.Context, params *PrepareRenameParams) (*PrepareRenameResult, error)

PrepareRename auto-generated from meta model

func (*Client) PrepareTypeHierarchy 

func (c *Client) PrepareTypeHierarchy(ctx context.Context, params *TypeHierarchyPrepareParams) ([]TypeHierarchyItem, error)

PrepareTypeHierarchy auto-generated from meta model

func (*Client) RangeFormatting 

func (c *Client) RangeFormatting(ctx context.Context, params *DocumentRangeFormattingParams) ([]TextEdit, error)

RangeFormatting auto-generated from meta model

func (*Client) RangesFormatting 

func (c *Client) RangesFormatting(ctx context.Context, params *DocumentRangesFormattingParams) ([]TextEdit, error)

RangesFormatting auto-generated from meta model

func (*Client) References 

func (c *Client) References(ctx context.Context, params *ReferenceParams) ([]Location, error)

References returns locations aggregated from all matching servers.

func (*Client) Rename 

func (c *Client) Rename(ctx context.Context, params *RenameParams) (*WorkspaceEdit, error)

Rename auto-generated from meta model

func (*Client) ResolveCodeLens 

func (c *Client) ResolveCodeLens(ctx context.Context, lens *CodeLens) (*CodeLens, error)

ResolveCodeLens resolves the command of a given code lens item. 

func (c *Client) ResolveDocumentLink(ctx context.Context, link *DocumentLink) (*DocumentLink, error)

ResolveDocumentLink resolves the target of a given document link.

func (*Client) SelectionRange 

func (c *Client) SelectionRange(ctx context.Context, params *SelectionRangeParams) ([]SelectionRange, error)

SelectionRange auto-generated from meta model

func (*Client) SemanticTokensFull 

func (c *Client) SemanticTokensFull(ctx context.Context, params *SemanticTokensParams) (*SemanticTokens, error)

SemanticTokensFull auto-generated from meta model

func (*Client) SemanticTokensFullDelta 

func (c *Client) SemanticTokensFullDelta(ctx context.Context, params *SemanticTokensDeltaParams) (*SemanticTokensFullDeltaResult, error)

SemanticTokensFullDelta auto-generated from meta model

func (*Client) SemanticTokensRange 

func (c *Client) SemanticTokensRange(ctx context.Context, params *SemanticTokensRangeParams) (*SemanticTokens, error)

SemanticTokensRange auto-generated from meta model

func (*Client) SetTrace 

func (c *Client) SetTrace(ctx context.Context, value TraceValue)

SetTrace notifies all running backend servers of a change in the trace setting.

func (*Client) SignatureHelp 

func (c *Client) SignatureHelp(ctx context.Context, params *SignatureHelpParams) (*SignatureHelp, error)

SignatureHelp auto-generated from meta model

func (*Client) TypeDefinition 

func (c *Client) TypeDefinition(ctx context.Context, params *TypeDefinitionParams) (*TypeDefinitionResult, error)

TypeDefinition auto-generated from meta model

func (*Client) TypeHierarchySubtypes 

func (c *Client) TypeHierarchySubtypes(ctx context.Context, params *TypeHierarchySubtypesParams) ([]TypeHierarchyItem, error)

TypeHierarchySubtypes auto-generated from meta model

func (*Client) TypeHierarchySupertypes 

func (c *Client) TypeHierarchySupertypes(ctx context.Context, params *TypeHierarchySupertypesParams) ([]TypeHierarchyItem, error)

TypeHierarchySupertypes auto-generated from meta model

func (*Client) WillRenameFiles 

func (c *Client) WillRenameFiles(ctx context.Context, params *RenameFilesParams) (*WorkspaceEdit, error)

WillRenameFiles requests workspace edits for document rename operations.

func (*Client) WillSave 

func (c *Client) WillSave(ctx context.Context, params *WillSaveTextDocumentParams) error

WillSave notifies matching servers that a text document will be saved.

func (*Client) WillSaveWaitUntil 

func (c *Client) WillSaveWaitUntil(ctx context.Context, params *WillSaveTextDocumentParams) ([]TextEdit, error)

WillSaveWaitUntil requests text edits from matching servers before saving.

func (*Client) WorkspaceDiagnostic 

func (c *Client) WorkspaceDiagnostic(ctx context.Context, params *WorkspaceDiagnosticParams) (*WorkspaceDiagnosticReport, error)

WorkspaceDiagnostic auto-generated from meta model

func (*Client) WorkspaceSymbol 

func (c *Client) WorkspaceSymbol(ctx context.Context, params *WorkspaceSymbolParams) (*WorkspaceSymbolResult, error)

WorkspaceSymbol auto-generated from meta model

func (*Client) WorkspaceSymbolResolve 

func (c *Client) WorkspaceSymbolResolve(ctx context.Context, params *WorkspaceSymbol) (*WorkspaceSymbol, error)

WorkspaceSymbolResolve auto-generated from meta model

func (*Client) WorkspaceTextDocumentContent 

func (c *Client) WorkspaceTextDocumentContent(ctx context.Context, params *TextDocumentContentParams) (*TextDocumentContentResult, error)

WorkspaceTextDocumentContent auto-generated from meta model

func (*Client) WorkspaceWillCreateFiles 

func (c *Client) WorkspaceWillCreateFiles(ctx context.Context, params *CreateFilesParams) (*WorkspaceEdit, error)

WorkspaceWillCreateFiles auto-generated from meta model

func (*Client) WorkspaceWillDeleteFiles 

func (c *Client) WorkspaceWillDeleteFiles(ctx context.Context, params *DeleteFilesParams) (*WorkspaceEdit, error)

WorkspaceWillDeleteFiles auto-generated from meta model

func (*Client) WorkspaceWillRenameFiles 

func (c *Client) WorkspaceWillRenameFiles(ctx context.Context, params *RenameFilesParams) (*WorkspaceEdit, error)

WorkspaceWillRenameFiles auto-generated from meta model

type ClientCapabilities 

type ClientCapabilities struct {
	// Workspace specific client capabilities.
	Workspace *WorkspaceClientCapabilities `json:"workspace,omitempty"`
	// Text document specific client capabilities.
	TextDocument *TextDocumentClientCapabilities `json:"textDocument,omitempty"`
	// Capabilities specific to the notebook document support.  @since 3.17.0
	NotebookDocument *NotebookDocumentClientCapabilities `json:"notebookDocument,omitempty"`
	// Window specific client capabilities.
	Window *WindowClientCapabilities `json:"window,omitempty"`
	// General client capabilities.  @since 3.16.0
	General *GeneralClientCapabilities `json:"general,omitempty"`
	// Experimental client capabilities.
	Experimental *json.RawMessage `json:"experimental,omitempty"`
}

Defines the capabilities provided by the client.

func BuildClientCapabilities 

func BuildClientCapabilities(sc ServerConfig) ClientCapabilities

type ClientCodeActionKindOptions 

type ClientCodeActionKindOptions struct {
	// The code action kind values the client supports. When this property exists the client also guarantees that it will handle values outside its set gracefully and falls back to a default value when unknown.
	ValueSet []CodeActionKind `json:"valueSet"`
}

@since 3.18.0

type ClientCodeActionLiteralOptions 

type ClientCodeActionLiteralOptions struct {
	// The code action kind is support with the following value set.
	CodeActionKind ClientCodeActionKindOptions `json:"codeActionKind"`
}

@since 3.18.0

type ClientCodeActionResolveOptions 

type ClientCodeActionResolveOptions struct {
	// The properties that a client can resolve lazily.
	Properties []string `json:"properties"`
}

@since 3.18.0

type ClientCodeLensResolveOptions 

type ClientCodeLensResolveOptions struct {
	// The properties that a client can resolve lazily.
	Properties []string `json:"properties"`
}

@since 3.18.0

type ClientCompletionItemInsertTextModeOptions 

type ClientCompletionItemInsertTextModeOptions struct {
	ValueSet []InsertTextMode `json:"valueSet"`
}

@since 3.18.0

type ClientCompletionItemOptions 

type ClientCompletionItemOptions struct {
	// Client supports snippets as insert text.  A snippet can define tab stops and placeholders with `$1`, `$2` and `${3:foo}`. `$0` defines the final tab stop, it defaults to the end of the snippet. Placeholders with equal identifiers are linked, that is typing in one will update others too.
	SnippetSupport *bool `json:"snippetSupport,omitempty"`
	// Client supports commit characters on a completion item.
	CommitCharactersSupport *bool `json:"commitCharactersSupport,omitempty"`
	// Client supports the following content formats for the documentation property. The order describes the preferred format of the client.
	DocumentationFormat []MarkupKind `json:"documentationFormat,omitempty"`
	// Client supports the deprecated property on a completion item.
	DeprecatedSupport *bool `json:"deprecatedSupport,omitempty"`
	// Client supports the preselect property on a completion item.
	PreselectSupport *bool `json:"preselectSupport,omitempty"`
	// Client supports the tag property on a completion item. Clients supporting tags have to handle unknown tags gracefully. Clients especially need to preserve unknown tags when sending a completion item back to the server in a resolve call.  @since 3.15.0
	TagSupport *CompletionItemTagOptions `json:"tagSupport,omitempty"`
	// Client support insert replace edit to control different behavior if a completion item is inserted in the text or should replace text.  @since 3.16.0
	InsertReplaceSupport *bool `json:"insertReplaceSupport,omitempty"`
	// Indicates which properties a client can resolve lazily on a completion item. Before version 3.16.0 only the predefined properties `documentation` and `details` could be resolved lazily.  @since 3.16.0
	ResolveSupport *ClientCompletionItemResolveOptions `json:"resolveSupport,omitempty"`
	// The client supports the `insertTextMode` property on a completion item to override the whitespace handling mode as defined by the client (see `insertTextMode`).  @since 3.16.0
	InsertTextModeSupport *ClientCompletionItemInsertTextModeOptions `json:"insertTextModeSupport,omitempty"`
	// The client has support for completion item label details (see also `CompletionItemLabelDetails`).  @since 3.17.0
	LabelDetailsSupport *bool `json:"labelDetailsSupport,omitempty"`
}

@since 3.18.0

type ClientCompletionItemOptionsKind 

type ClientCompletionItemOptionsKind struct {
	// The completion item kind values the client supports. When this property exists the client also guarantees that it will handle values outside its set gracefully and falls back to a default value when unknown.  If this property is not present the client only supports the completion items kinds from `Text` to `Reference` as defined in the initial version of the protocol.
	ValueSet []CompletionItemKind `json:"valueSet,omitempty"`
}

@since 3.18.0

type ClientCompletionItemResolveOptions 

type ClientCompletionItemResolveOptions struct {
	// The properties that a client can resolve lazily.
	Properties []string `json:"properties"`
}

@since 3.18.0

type ClientDiagnosticsTagOptions 

type ClientDiagnosticsTagOptions struct {
	// The tags supported by the client.
	ValueSet []DiagnosticTag `json:"valueSet"`
}

@since 3.18.0

type ClientFoldingRangeKindOptions 

type ClientFoldingRangeKindOptions struct {
	// The folding range kind values the client supports. When this property exists the client also guarantees that it will handle values outside its set gracefully and falls back to a default value when unknown.
	ValueSet []FoldingRangeKind `json:"valueSet,omitempty"`
}

@since 3.18.0

type ClientFoldingRangeOptions 

type ClientFoldingRangeOptions struct {
	// If set, the client signals that it supports setting collapsedText on folding ranges to display custom labels instead of the default text.  @since 3.17.0
	CollapsedText *bool `json:"collapsedText,omitempty"`
}

@since 3.18.0

type ClientInfo 

type ClientInfo struct {
	// The name of the client as defined by the client.
	Name string `json:"name"`
	// The client's version as defined by the client.
	Version *string `json:"version,omitempty"`
}

Information about the client

@since 3.15.0 @since 3.18.0 ClientInfo type name added.

type ClientInlayHintResolveOptions 

type ClientInlayHintResolveOptions struct {
	// The properties that a client can resolve lazily.
	Properties []string `json:"properties"`
}

@since 3.18.0

type ClientOptions 

type ClientOptions struct {
	Servers   []ServerConfig   `json:"servers"`
	Aggregate AggregateOptions `json:"aggregate"`
	RootURI   DocumentURI      `json:"rootUri"`

	// TestHook allows unit tests to supply an in-process mock connection
	// instead of executing a subprocess.
	TestHook func(ctx context.Context, cfg ServerConfig) (io.ReadWriteCloser, error)
}

ClientOptions specifies options for NewClient.

type ClientSemanticTokensRequestFullDelta 

type ClientSemanticTokensRequestFullDelta struct {
	// The client will send the `textDocument/semanticTokens/full/delta` request if the server provides a corresponding handler.
	Delta *bool `json:"delta,omitempty"`
}

@since 3.18.0

type ClientSemanticTokensRequestOptions 

type ClientSemanticTokensRequestOptions struct {
	// The client will send the `textDocument/semanticTokens/range` request if the server provides a corresponding handler.
	Range *ClientSemanticTokensRequestOptionsRange `json:"range,omitempty"`
	// The client will send the `textDocument/semanticTokens/full` request if the server provides a corresponding handler.
	Full *ClientSemanticTokensRequestOptionsFull `json:"full,omitempty"`
}

@since 3.18.0

type ClientSemanticTokensRequestOptionsFull 

type ClientSemanticTokensRequestOptionsFull struct {
	Bool                                 *bool                                 `json:"-"`
	ClientSemanticTokensRequestFullDelta *ClientSemanticTokensRequestFullDelta `json:"-"`
}

func (ClientSemanticTokensRequestOptionsFull) MarshalJSON 

func (u ClientSemanticTokensRequestOptionsFull) MarshalJSON() ([]byte, error)

func (*ClientSemanticTokensRequestOptionsFull) UnmarshalJSON 

func (u *ClientSemanticTokensRequestOptionsFull) UnmarshalJSON(data []byte) error

type ClientSemanticTokensRequestOptionsRange 

type ClientSemanticTokensRequestOptionsRange struct {
	Bool         *bool           `json:"-"`
	MapstringAny *map[string]any `json:"-"`
}

func (ClientSemanticTokensRequestOptionsRange) MarshalJSON 

func (u ClientSemanticTokensRequestOptionsRange) MarshalJSON() ([]byte, error)

func (*ClientSemanticTokensRequestOptionsRange) UnmarshalJSON 

func (u *ClientSemanticTokensRequestOptionsRange) UnmarshalJSON(data []byte) error

type ClientShowMessageActionItemOptions 

type ClientShowMessageActionItemOptions struct {
	// Whether the client supports additional attributes which are preserved and send back to the server in the request's response.
	AdditionalPropertiesSupport *bool `json:"additionalPropertiesSupport,omitempty"`
}

@since 3.18.0

type ClientSignatureInformationOptions 

type ClientSignatureInformationOptions struct {
	// Client supports the following content formats for the documentation property. The order describes the preferred format of the client.
	DocumentationFormat []MarkupKind `json:"documentationFormat,omitempty"`
	// Client capabilities specific to parameter information.
	ParameterInformation *ClientSignatureParameterInformationOptions `json:"parameterInformation,omitempty"`
	// The client supports the `activeParameter` property on `SignatureInformation` literal.  @since 3.16.0
	ActiveParameterSupport *bool `json:"activeParameterSupport,omitempty"`
	// The client supports the `activeParameter` property on `SignatureHelp`/`SignatureInformation` being set to `null` to indicate that no parameter should be active.  @since 3.18.0
	NoActiveParameterSupport *bool `json:"noActiveParameterSupport,omitempty"`
}

@since 3.18.0

type ClientSignatureParameterInformationOptions 

type ClientSignatureParameterInformationOptions struct {
	// The client supports processing label offsets instead of a simple label string.  @since 3.14.0
	LabelOffsetSupport *bool `json:"labelOffsetSupport,omitempty"`
}

@since 3.18.0

type ClientSymbolKindOptions 

type ClientSymbolKindOptions struct {
	// The symbol kind values the client supports. When this property exists the client also guarantees that it will handle values outside its set gracefully and falls back to a default value when unknown.  If this property is not present the client only supports the symbol kinds from `File` to `Array` as defined in the initial version of the protocol.
	ValueSet []SymbolKind `json:"valueSet,omitempty"`
}

@since 3.18.0

type ClientSymbolResolveOptions 

type ClientSymbolResolveOptions struct {
	// The properties that a client can resolve lazily. Usually `location.range`
	Properties []string `json:"properties"`
}

@since 3.18.0

type ClientSymbolTagOptions 

type ClientSymbolTagOptions struct {
	// The tags supported by the client.
	ValueSet []SymbolTag `json:"valueSet"`
}

@since 3.18.0

type CodeAction 

type CodeAction struct {
	// A short, human-readable, title for this code action.
	Title string `json:"title"`
	// The kind of the code action.  Used to filter code actions.
	Kind *CodeActionKind `json:"kind,omitempty"`
	// The diagnostics that this code action resolves.
	Diagnostics []Diagnostic `json:"diagnostics,omitempty"`
	// Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted by keybindings.  A quick fix should be marked preferred if it properly addresses the underlying error. A refactoring should be marked preferred if it is the most reasonable choice of actions to take.  @since 3.15.0
	IsPreferred *bool `json:"isPreferred,omitempty"`
	// Marks that the code action cannot currently be applied.  Clients should follow the following guidelines regarding disabled code actions:    - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)     code action menus.    - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type     of code action, such as refactorings.    - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions)     that auto applies a code action and only disabled code actions are returned, the client should show the user an     error message with `reason` in the editor.  @since 3.16.0
	Disabled *CodeActionDisabled `json:"disabled,omitempty"`
	// The workspace edit this code action performs.
	Edit *WorkspaceEdit `json:"edit,omitempty"`
	// A command this code action executes. If a code action provides an edit and a command, first the edit is executed and then the command.
	Command *Command `json:"command,omitempty"`
	// A data entry field that is preserved on a code action between a `textDocument/codeAction` and a `codeAction/resolve` request.  @since 3.16.0
	Data *json.RawMessage `json:"data,omitempty"`
	// Tags for this code action.  @since 3.18.0 - proposed
	Tags []CodeActionTag `json:"tags,omitempty"`
}

A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.

A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.

type CodeActionClientCapabilities 

type CodeActionClientCapabilities struct {
	// Whether code action supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The client support code action literals of type `CodeAction` as a valid response of the `textDocument/codeAction` request. If the property is not set the request can only return `Command` literals.  @since 3.8.0
	CodeActionLiteralSupport *ClientCodeActionLiteralOptions `json:"codeActionLiteralSupport,omitempty"`
	// Whether code action supports the `isPreferred` property.  @since 3.15.0
	IsPreferredSupport *bool `json:"isPreferredSupport,omitempty"`
	// Whether code action supports the `disabled` property.  @since 3.16.0
	DisabledSupport *bool `json:"disabledSupport,omitempty"`
	// Whether code action supports the `data` property which is preserved between a `textDocument/codeAction` and a `codeAction/resolve` request.  @since 3.16.0
	DataSupport *bool `json:"dataSupport,omitempty"`
	// Whether the client supports resolving additional code action properties via a separate `codeAction/resolve` request.  @since 3.16.0
	ResolveSupport *ClientCodeActionResolveOptions `json:"resolveSupport,omitempty"`
	// Whether the client honors the change annotations in text edits and resource operations returned via the `CodeAction#edit` property by for example presenting the workspace edit in the user interface and asking for confirmation.  @since 3.16.0
	HonorsChangeAnnotations *bool `json:"honorsChangeAnnotations,omitempty"`
	// Whether the client supports documentation for a class of code actions.  @since 3.18.0
	DocumentationSupport *bool `json:"documentationSupport,omitempty"`
	// Client supports the tag property on a code action. Clients supporting tags have to handle unknown tags gracefully.  @since 3.18.0 - proposed
	TagSupport *CodeActionTagOptions `json:"tagSupport,omitempty"`
}

The Client Capabilities of a {@link CodeActionRequest}.

type CodeActionContext 

type CodeActionContext struct {
	// An array of diagnostics known on the client side overlapping the range provided to the `textDocument/codeAction` request. They are provided so that the server knows which errors are currently presented to the user for the given range. There is no guarantee that these accurately reflect the error state of the resource. The primary parameter to compute code actions is the provided range.
	Diagnostics []Diagnostic `json:"diagnostics"`
	// Requested kind of actions to return.  Actions not of this kind are filtered out by the client before being shown. So servers can omit computing them.
	Only []CodeActionKind `json:"only,omitempty"`
	// The reason why code actions were requested.  @since 3.17.0
	TriggerKind *CodeActionTriggerKind `json:"triggerKind,omitempty"`
}

Contains additional diagnostic information about the context in which a {@link CodeActionProvider.provideCodeActions code action} is run.

type CodeActionDisabled 

type CodeActionDisabled struct {
	// Human readable description of why the code action is currently disabled.  This is displayed in the code actions UI.
	Reason string `json:"reason"`
}

Captures why the code action is currently disabled.

@since 3.18.0

type CodeActionKind 

type CodeActionKind string

A set of predefined code action kinds 

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 move actions: `refactor.move`  Example move actions:  - Move a function to a new file - Move a property between classes - Move method to base class - ...  @since 3.18.0
	CodeActionKindRefactorMove CodeActionKind = "refactor.move"
	// Base kind for refactoring rewrite actions: 'refactor.rewrite'  Example rewrite actions:  - Convert JavaScript function to class - Add or remove parameter - Encapsulate field - Make method static - Move method to base class - ...
	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"
	// Base kind for auto-fix source actions: `source.fixAll`.  Fix all actions automatically fix errors that have a clear fix that do not require user input. They should not suppress errors or perform unsafe fixes such as generating new types or classes.  @since 3.15.0
	CodeActionKindSourceFixAll CodeActionKind = "source.fixAll"
	// Base kind for all code actions applying to the entire notebook's scope. CodeActionKinds using this should always begin with `notebook.`  @since 3.18.0
	CodeActionKindNotebook CodeActionKind = "notebook"
)

type CodeActionKindDocumentation 

type CodeActionKindDocumentation struct {
	// The kind of the code action being documented.  If the kind is generic, such as `CodeActionKind.Refactor`, the documentation will be shown whenever any refactorings are returned. If the kind if more specific, such as `CodeActionKind.RefactorExtract`, the documentation will only be shown when extract refactoring code actions are returned.
	Kind CodeActionKind `json:"kind"`
	// Command that is ued to display the documentation to the user.  The title of this documentation code action is taken from {@linkcode Command.title}
	Command Command `json:"command"`
}

Documentation for a class of code actions.

@since 3.18.0

type CodeActionOptions 

type CodeActionOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// CodeActionKinds that this server may return.  The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server may list out every specific kind they provide.
	CodeActionKinds []CodeActionKind `json:"codeActionKinds,omitempty"`
	// Static documentation for a class of code actions.  Documentation from the provider should be shown in the code actions menu if either:  - Code actions of `kind` are requested by the editor. In this case, the editor will show the documentation that   most closely matches the requested code action kind. For example, if a provider has documentation for   both `Refactor` and `RefactorExtract`, when the user requests code actions for `RefactorExtract`,   the editor will use the documentation for `RefactorExtract` instead of the documentation for `Refactor`.  - Any code actions of `kind` are returned by the provider.  At most one documentation entry should be shown per provider.  @since 3.18.0
	Documentation []CodeActionKindDocumentation `json:"documentation,omitempty"`
	// The server provides support to resolve additional information for a code action.  @since 3.16.0
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
}

Provider options for a {@link CodeActionRequest}.

type CodeActionParams 

type CodeActionParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// 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"`
}

The parameters of a {@link CodeActionRequest}.

type CodeActionRegistrationOptions 

type CodeActionRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// CodeActionKinds that this server may return.  The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server may list out every specific kind they provide.
	CodeActionKinds []CodeActionKind `json:"codeActionKinds,omitempty"`
	// Static documentation for a class of code actions.  Documentation from the provider should be shown in the code actions menu if either:  - Code actions of `kind` are requested by the editor. In this case, the editor will show the documentation that   most closely matches the requested code action kind. For example, if a provider has documentation for   both `Refactor` and `RefactorExtract`, when the user requests code actions for `RefactorExtract`,   the editor will use the documentation for `RefactorExtract` instead of the documentation for `Refactor`.  - Any code actions of `kind` are returned by the provider.  At most one documentation entry should be shown per provider.  @since 3.18.0
	Documentation []CodeActionKindDocumentation `json:"documentation,omitempty"`
	// The server provides support to resolve additional information for a code action.  @since 3.16.0
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
}

Registration options for a {@link CodeActionRequest}.

type CodeActionResultItem 

type CodeActionResultItem struct {
	Command    *Command    `json:"-"`
	CodeAction *CodeAction `json:"-"`
}

func (CodeActionResultItem) MarshalJSON 

func (u CodeActionResultItem) MarshalJSON() ([]byte, error)

func (*CodeActionResultItem) UnmarshalJSON 

func (u *CodeActionResultItem) UnmarshalJSON(data []byte) error

type CodeActionTag 

type CodeActionTag uint32

Code action tags are extra annotations that tweak the behavior of a code action.

@since 3.18.0 - proposed 

const (
	// Marks the code action as LLM-generated.
	CodeActionTagLLMGenerated CodeActionTag = 1
)

type CodeActionTagOptions 

type CodeActionTagOptions struct {
	// The tags supported by the client.
	ValueSet []CodeActionTag `json:"valueSet"`
}

@since 3.18.0 - proposed

type CodeActionTriggerKind 

type CodeActionTriggerKind uint32

The reason why code actions were requested.

@since 3.17.0 

const (
	// Code actions were explicitly requested by the user or by an extension.
	CodeActionTriggerKindInvoked CodeActionTriggerKind = 1
	// Code actions were requested automatically.  This typically happens when current selection in a file changes, but can also be triggered when file content changes.
	CodeActionTriggerKindAutomatic CodeActionTriggerKind = 2
)

type CodeDescription 

type CodeDescription struct {
	// An URI to open with more information about the diagnostic error.
	Href string `json:"href"`
}

Structure to capture a description for an error code.

@since 3.16.0

type CodeLens 

type CodeLens struct {
	// The range in which this code lens is valid. Should only span a single line.
	Range Range `json:"range"`
	// The command this code lens represents.
	Command *Command `json:"command,omitempty"`
	// A data entry field that is preserved on a code lens item between a {@link CodeLensRequest} and a {@link CodeLensResolveRequest}
	Data *json.RawMessage `json:"data,omitempty"`
}

A code lens represents a {@link Command command} that should be shown along with source text, like the number of references, a way to run tests, etc.

A code lens is _unresolved_ when no command is associated to it. For performance reasons the creation of a code lens and resolving should be done in two stages.

type CodeLensClientCapabilities 

type CodeLensClientCapabilities struct {
	// Whether code lens supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Whether the client supports resolving additional code lens properties via a separate `codeLens/resolve` request.  @since 3.18.0
	ResolveSupport *ClientCodeLensResolveOptions `json:"resolveSupport,omitempty"`
}

The client capabilities of a {@link CodeLensRequest}.

type CodeLensOptions 

type CodeLensOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// Code lens has a resolve provider as well.
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
}

Code Lens provider options of a {@link CodeLensRequest}.

type CodeLensParams 

type CodeLensParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The document to request code lens for.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

The parameters of a {@link CodeLensRequest}.

type CodeLensRegistrationOptions 

type CodeLensRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// Code lens has a resolve provider as well.
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
}

Registration options for a {@link CodeLensRequest}.

type CodeLensWorkspaceClientCapabilities 

type CodeLensWorkspaceClientCapabilities struct {
	// Whether the client implementation supports a refresh request sent from the server to the client.  Note that this event is global and will force the client to refresh all code lenses currently shown. It should be used with absolute care and is useful for situation where a server for example detect a project wide change that requires such a calculation.
	RefreshSupport *bool `json:"refreshSupport,omitempty"`
}

@since 3.16.0

type Color 

type Color struct {
	// The red component of this color in the range [0-1].
	Red float64 `json:"red"`
	// The green component of this color in the range [0-1].
	Green float64 `json:"green"`
	// The blue component of this color in the range [0-1].
	Blue float64 `json:"blue"`
	// The alpha component of this color in the range [0-1].
	Alpha float64 `json:"alpha"`
}

Represents a color in RGBA space.

type ColorInformation 

type ColorInformation struct {
	// The range in the document where this color appears.
	Range Range `json:"range"`
	// The actual color value for this color range.
	Color Color `json:"color"`
}

Represents a color range from a document.

type ColorPresentation 

type ColorPresentation struct {
	// The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation.
	Label string `json:"label"`
	// An {@link TextEdit edit} which is applied to a document when selecting this presentation for the color.  When `falsy` the {@link ColorPresentation.label label} is used.
	TextEdit *TextEdit `json:"textEdit,omitempty"`
	// An optional array of additional {@link TextEdit text edits} that are applied when selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
	AdditionalTextEdits []TextEdit `json:"additionalTextEdits,omitempty"`
}

type ColorPresentationParams 

type ColorPresentationParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The color to request presentations for.
	Color Color `json:"color"`
	// The range where the color would be inserted. Serves as a context.
	Range Range `json:"range"`
}

Parameters for a {@link ColorPresentationRequest}.

type Command 

type Command struct {
	// Title of the command, like `save`.
	Title string `json:"title"`
	// An optional tooltip.  @since 3.18.0
	Tooltip *string `json:"tooltip,omitempty"`
	// The identifier of the actual command handler.
	Command string `json:"command"`
	// Arguments that the command handler should be invoked with.
	Arguments []json.RawMessage `json:"arguments,omitempty"`
}

Represents a reference to a command. Provides a title which will be used to represent a command in the UI and, optionally, an array of arguments which will be passed to the command handler function when invoked.

type CompletionClientCapabilities 

type CompletionClientCapabilities struct {
	// Whether completion supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The client supports the following `CompletionItem` specific capabilities.
	CompletionItem *ClientCompletionItemOptions `json:"completionItem,omitempty"`
	// The client supports the following completion item kinds.
	CompletionItemKind *ClientCompletionItemOptionsKind `json:"completionItemKind,omitempty"`
	// Defines how the client handles whitespace and indentation when accepting a completion item that uses multi line text in either `insertText` or `textEdit`.  @since 3.17.0
	InsertTextMode *InsertTextMode `json:"insertTextMode,omitempty"`
	// The client supports to send additional context information for a `textDocument/completion` request.
	ContextSupport *bool `json:"contextSupport,omitempty"`
	// The client supports the following `CompletionList` specific capabilities.  @since 3.17.0
	CompletionList *CompletionListCapabilities `json:"completionList,omitempty"`
}

Completion client capabilities

type CompletionContext 

type CompletionContext struct {
	// How the completion was triggered.
	TriggerKind CompletionTriggerKind `json:"triggerKind"`
	// The trigger character (a single character) that has trigger code complete. Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
	TriggerCharacter *string `json:"triggerCharacter,omitempty"`
}

Contains additional information about the context in which a completion request is triggered.

type CompletionItem 

type CompletionItem struct {
	// The label of this completion item.  The label property is also by default the text that is inserted when selecting this completion.  If label details are provided the label itself should be an unqualified name of the completion item.
	Label string `json:"label"`
	// Additional details for the label  @since 3.17.0
	LabelDetails *CompletionItemLabelDetails `json:"labelDetails,omitempty"`
	// The kind of this completion item. Based of the kind an icon is chosen by the editor.
	Kind *CompletionItemKind `json:"kind,omitempty"`
	// Tags for this completion item.  @since 3.15.0
	Tags []CompletionItemTag `json:"tags,omitempty"`
	// A human-readable string with additional information about this item, like type or symbol information.
	Detail *string `json:"detail,omitempty"`
	// A human-readable string that represents a doc-comment.
	Documentation *CompletionItemDocumentation `json:"documentation,omitempty"`
	// Indicates if this item is deprecated. @deprecated Use `tags` instead.
	Deprecated *bool `json:"deprecated,omitempty"`
	// Select this item when showing.  *Note* that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the *first* item of those that match best is selected.
	Preselect *bool `json:"preselect,omitempty"`
	// A string that should be used when comparing this item with other items. When `falsy` the {@link CompletionItem.label label} is used.
	SortText *string `json:"sortText,omitempty"`
	// A string that should be used when filtering a set of completion items. When `falsy` the {@link CompletionItem.label label} is used.
	FilterText *string `json:"filterText,omitempty"`
	// A string that should be inserted into a document when selecting this completion. When `falsy` the {@link CompletionItem.label label} is used.  The `insertText` is subject to interpretation by the client side. Some tools might not take the string literally. For example VS Code when code complete is requested in this example `con<cursor position>` and a completion item with an `insertText` of `console` is provided it will only insert `sole`. Therefore it is recommended to use `textEdit` instead since it avoids additional client side interpretation.
	InsertText *string `json:"insertText,omitempty"`
	// The format of the insert text. The format applies to both the `insertText` property and the `newText` property of a provided `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.  Please note that the insertTextFormat doesn't apply to `additionalTextEdits`.
	InsertTextFormat *InsertTextFormat `json:"insertTextFormat,omitempty"`
	// How whitespace and indentation is handled during completion item insertion. If not provided the clients default value depends on the `textDocument.completion.insertTextMode` client capability.  @since 3.16.0
	InsertTextMode *InsertTextMode `json:"insertTextMode,omitempty"`
	// An {@link TextEdit edit} which is applied to a document when selecting this completion. When an edit is provided the value of {@link CompletionItem.insertText insertText} is ignored.  Most editors support two different operations when accepting a completion item. One is to insert a completion text and the other is to replace an existing text with a completion text. Since this can usually not be predetermined by a server it can report both ranges. Clients need to signal support for `InsertReplaceEdits` via the `textDocument.completion.insertReplaceSupport` client capability property.  *Note 1:* The text edit's range as well as both ranges from an insert replace edit must be a [single line] and they must contain the position at which completion has been requested. *Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range must be a prefix of the edit's replace range, that means it must be contained and starting at the same position.  @since 3.16.0 additional type `InsertReplaceEdit`
	TextEdit *CompletionItemTextEdit `json:"textEdit,omitempty"`
	// The edit text used if the completion item is part of a CompletionList and CompletionList defines an item default for the text edit range.  Clients will only honor this property if they opt into completion list item defaults using the capability `completionList.itemDefaults`.  If not provided and a list's default range is provided the label property is used as a text.  @since 3.17.0
	TextEditText *string `json:"textEditText,omitempty"`
	// An optional array of additional {@link TextEdit text edits} that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main {@link CompletionItem.textEdit edit} nor with themselves.  Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).
	AdditionalTextEdits []TextEdit `json:"additionalTextEdits,omitempty"`
	// An optional set of characters that when pressed while this completion is active will accept it first and then type that character. *Note* that all commit characters should have `length=1` and that superfluous characters will be ignored.
	CommitCharacters []string `json:"commitCharacters,omitempty"`
	// An optional {@link Command command} that is executed *after* inserting this completion. *Note* that additional modifications to the current document should be described with the {@link CompletionItem.additionalTextEdits additionalTextEdits}-property.
	Command *Command `json:"command,omitempty"`
	// A data entry field that is preserved on a completion item between a {@link CompletionRequest} and a {@link CompletionResolveRequest}.
	Data *json.RawMessage `json:"data,omitempty"`
}

A completion item represents a text snippet that is proposed to complete text that is being typed.

type CompletionItemApplyKinds 

type CompletionItemApplyKinds struct {
	// Specifies whether commitCharacters on a completion will replace or be merged with those in `completionList.itemDefaults.commitCharacters`.  If ApplyKind.Replace, the commit characters from the completion item will always be used unless not provided, in which case those from `completionList.itemDefaults.commitCharacters` will be used. An empty list can be used if a completion item does not have any commit characters and also should not use those from `completionList.itemDefaults.commitCharacters`.  If ApplyKind.Merge the commitCharacters for the completion will be the union of all values in both `completionList.itemDefaults.commitCharacters` and the completion's own `commitCharacters`.  @since 3.18.0
	CommitCharacters *ApplyKind `json:"commitCharacters,omitempty"`
	// Specifies whether the `data` field on a completion will replace or be merged with data from `completionList.itemDefaults.data`.  If ApplyKind.Replace, the data from the completion item will be used if provided (and not `null`), otherwise `completionList.itemDefaults.data` will be used. An empty object can be used if a completion item does not have any data but also should not use the value from `completionList.itemDefaults.data`.  If ApplyKind.Merge, a shallow merge will be performed between `completionList.itemDefaults.data` and the completion's own data using the following rules:  - If a completion's `data` field is not provided (or `null`), the   entire `data` field from `completionList.itemDefaults.data` will be   used as-is. - If a completion's `data` field is provided, each field will   overwrite the field of the same name in   `completionList.itemDefaults.data` but no merging of nested fields   within that value will occur.  @since 3.18.0
	Data *ApplyKind `json:"data,omitempty"`
}

Specifies how fields from a completion item should be combined with those from `completionList.itemDefaults`.

If unspecified, all fields will be treated as ApplyKind.Replace.

If a field's value is ApplyKind.Replace, the value from a completion item (if provided and not `null`) will always be used instead of the value from `completionItem.itemDefaults`.

If a field's value is ApplyKind.Merge, the values will be merged using the rules defined against each field below.

Servers are only allowed to return `applyKind` if the client signals support for this via the `completionList.applyKindSupport` capability.

@since 3.18.0

type CompletionItemDefaults 

type CompletionItemDefaults struct {
	// A default commit character set.  @since 3.17.0
	CommitCharacters []string `json:"commitCharacters,omitempty"`
	// A default edit range.  @since 3.17.0
	EditRange *CompletionItemDefaultsEditRange `json:"editRange,omitempty"`
	// A default insert text format.  @since 3.17.0
	InsertTextFormat *InsertTextFormat `json:"insertTextFormat,omitempty"`
	// A default insert text mode.  @since 3.17.0
	InsertTextMode *InsertTextMode `json:"insertTextMode,omitempty"`
	// A default data value.  @since 3.17.0
	Data *json.RawMessage `json:"data,omitempty"`
}

In many cases the items of an actual completion result share the same value for properties like `commitCharacters` or the range of a text edit. A completion list can therefore define item defaults which will be used if a completion item itself doesn't specify the value.

If a completion list specifies a default value and a completion item also specifies a corresponding value, the rules for combining these are defined by `applyKinds` (if the client supports it), defaulting to ApplyKind.Replace.

Servers are only allowed to return default values if the client signals support for this via the `completionList.itemDefaults` capability.

@since 3.17.0

type CompletionItemDefaultsEditRange 

type CompletionItemDefaultsEditRange struct {
	Range                      *Range                      `json:"-"`
	EditRangeWithInsertReplace *EditRangeWithInsertReplace `json:"-"`
}

func (CompletionItemDefaultsEditRange) MarshalJSON 

func (u CompletionItemDefaultsEditRange) MarshalJSON() ([]byte, error)

func (*CompletionItemDefaultsEditRange) UnmarshalJSON 

func (u *CompletionItemDefaultsEditRange) UnmarshalJSON(data []byte) error

type CompletionItemDocumentation 

type CompletionItemDocumentation struct {
	String        *string        `json:"-"`
	MarkupContent *MarkupContent `json:"-"`
}

func (CompletionItemDocumentation) MarshalJSON 

func (u CompletionItemDocumentation) MarshalJSON() ([]byte, error)

func (*CompletionItemDocumentation) UnmarshalJSON 

func (u *CompletionItemDocumentation) UnmarshalJSON(data []byte) error

type CompletionItemKind 

type CompletionItemKind uint32

The kind of a completion entry. 

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
)

type CompletionItemLabelDetails 

type CompletionItemLabelDetails struct {
	// An optional string which is rendered less prominently directly after {@link CompletionItem.label label}, without any spacing. Should be used for function signatures and type annotations.
	Detail *string `json:"detail,omitempty"`
	// An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used for fully qualified names and file paths.
	Description *string `json:"description,omitempty"`
}

Additional details for a completion item label.

@since 3.17.0

type CompletionItemTag 

type CompletionItemTag uint32

Completion item tags are extra annotations that tweak the rendering of a completion item.

@since 3.15.0 

const (
	// Render a completion as obsolete, usually using a strike-out.
	CompletionItemTagDeprecated CompletionItemTag = 1
)

type CompletionItemTagOptions 

type CompletionItemTagOptions struct {
	// The tags supported by the client.
	ValueSet []CompletionItemTag `json:"valueSet"`
}

@since 3.18.0

type CompletionItemTextEdit 

type CompletionItemTextEdit struct {
	TextEdit          *TextEdit          `json:"-"`
	InsertReplaceEdit *InsertReplaceEdit `json:"-"`
}

func (CompletionItemTextEdit) MarshalJSON 

func (u CompletionItemTextEdit) MarshalJSON() ([]byte, error)

func (*CompletionItemTextEdit) UnmarshalJSON 

func (u *CompletionItemTextEdit) UnmarshalJSON(data []byte) error

type CompletionList 

type CompletionList struct {
	// This list it not complete. Further typing results in recomputing this list.  Recomputed lists have all their items replaced (not appended) in the incomplete completion sessions.
	IsIncomplete bool `json:"isIncomplete"`
	// In many cases the items of an actual completion result share the same value for properties like `commitCharacters` or the range of a text edit. A completion list can therefore define item defaults which will be used if a completion item itself doesn't specify the value.  If a completion list specifies a default value and a completion item also specifies a corresponding value, the rules for combining these are defined by `applyKinds` (if the client supports it), defaulting to ApplyKind.Replace.  Servers are only allowed to return default values if the client signals support for this via the `completionList.itemDefaults` capability.  @since 3.17.0
	ItemDefaults *CompletionItemDefaults `json:"itemDefaults,omitempty"`
	// Specifies how fields from a completion item should be combined with those from `completionList.itemDefaults`.  If unspecified, all fields will be treated as ApplyKind.Replace.  If a field's value is ApplyKind.Replace, the value from a completion item (if provided and not `null`) will always be used instead of the value from `completionItem.itemDefaults`.  If a field's value is ApplyKind.Merge, the values will be merged using the rules defined against each field below.  Servers are only allowed to return `applyKind` if the client signals support for this via the `completionList.applyKindSupport` capability.  @since 3.18.0
	ApplyKind *CompletionItemApplyKinds `json:"applyKind,omitempty"`
	// The completion items.
	Items []CompletionItem `json:"items"`
}

Represents a collection of {@link CompletionItem completion items} to be presented in the editor.

type CompletionListCapabilities 

type CompletionListCapabilities struct {
	// The client supports the following itemDefaults on a completion list.  The value lists the supported property names of the `CompletionList.itemDefaults` object. If omitted no properties are supported.  @since 3.17.0
	ItemDefaults []string `json:"itemDefaults,omitempty"`
	// Specifies whether the client supports `CompletionList.applyKind` to indicate how supported values from `completionList.itemDefaults` and `completion` will be combined.  If a client supports `applyKind` it must support it for all fields that it supports that are listed in `CompletionList.applyKind`. This means when clients add support for new/future fields in completion items the MUST also support merge for them if those fields are defined in `CompletionList.applyKind`.  @since 3.18.0
	ApplyKindSupport *bool `json:"applyKindSupport,omitempty"`
}

The client supports the following `CompletionList` specific capabilities.

@since 3.17.0

type CompletionOptions 

type CompletionOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// Most tools trigger completion request automatically without explicitly requesting it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user starts to type an identifier. For example if the user types `c` in a JavaScript file code complete will automatically pop up present `console` besides others as a completion item. Characters that make up identifiers don't need to be listed here.  If code complete should automatically be trigger on characters not being valid inside an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
	TriggerCharacters []string `json:"triggerCharacters,omitempty"`
	// The list of all possible characters that commit a completion. This field can be used if clients don't support individual commit characters per completion item. See `ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`  If a server provides both `allCommitCharacters` and commit characters on an individual completion item the ones on the completion item win.  @since 3.2.0
	AllCommitCharacters []string `json:"allCommitCharacters,omitempty"`
	// The server provides support to resolve additional information for a completion item.
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
	// The server supports the following `CompletionItem` specific capabilities.  @since 3.17.0
	CompletionItem *ServerCompletionItemOptions `json:"completionItem,omitempty"`
}

Completion options.

type CompletionParams 

type CompletionParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The completion context. This is only available it the client specifies to send this using the client capability `textDocument.completion.contextSupport === true`
	Context *CompletionContext `json:"context,omitempty"`
}

Completion parameters

type CompletionRegistrationOptions 

type CompletionRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// Most tools trigger completion request automatically without explicitly requesting it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user starts to type an identifier. For example if the user types `c` in a JavaScript file code complete will automatically pop up present `console` besides others as a completion item. Characters that make up identifiers don't need to be listed here.  If code complete should automatically be trigger on characters not being valid inside an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
	TriggerCharacters []string `json:"triggerCharacters,omitempty"`
	// The list of all possible characters that commit a completion. This field can be used if clients don't support individual commit characters per completion item. See `ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`  If a server provides both `allCommitCharacters` and commit characters on an individual completion item the ones on the completion item win.  @since 3.2.0
	AllCommitCharacters []string `json:"allCommitCharacters,omitempty"`
	// The server provides support to resolve additional information for a completion item.
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
	// The server supports the following `CompletionItem` specific capabilities.  @since 3.17.0
	CompletionItem *ServerCompletionItemOptions `json:"completionItem,omitempty"`
}

Registration options for a {@link CompletionRequest}.

type CompletionTriggerKind 

type CompletionTriggerKind uint32

How a completion was triggered 

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 current completion list is incomplete
	CompletionTriggerKindTriggerForIncompleteCompletions CompletionTriggerKind = 3
)

type ConfigurationItem 

type ConfigurationItem struct {
	// The scope to get the configuration section for.
	ScopeURI *string `json:"scopeUri,omitempty"`
	// The configuration section asked for.
	Section *string `json:"section,omitempty"`
}

type ConfigurationParams 

type ConfigurationParams struct {
	Items []ConfigurationItem `json:"items"`
}

The parameters of a configuration request.

type CreateFile 

type CreateFile struct {
	// The resource operation kind.
	Kind string `json:"kind"`
	// An optional annotation identifier describing the operation.  @since 3.16.0
	AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"`
	// The resource to create.
	URI string `json:"uri"`
	// Additional options
	Options *CreateFileOptions `json:"options,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 Declaration 

type Declaration struct {
	Location        *Location   `json:"-"`
	ArrayOfLocation *[]Location `json:"-"`
}

The declaration of a symbol representation as one or many {@link Location locations}.

func (Declaration) MarshalJSON 

func (u Declaration) MarshalJSON() ([]byte, error)

func (*Declaration) UnmarshalJSON 

func (u *Declaration) UnmarshalJSON(data []byte) error

type DeclarationClientCapabilities 

type DeclarationClientCapabilities struct {
	// Whether declaration supports dynamic registration. If this is set to `true` the client supports the new `DeclarationRegistrationOptions` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The client supports additional metadata in the form of declaration links.
	LinkSupport *bool `json:"linkSupport,omitempty"`
}

@since 3.14.0 

type DeclarationLink = LocationLink

Information about where a symbol is declared.

Provides additional metadata over normal {@link Location location} declarations, including the range of the declaring symbol.

Servers should prefer returning `DeclarationLink` over `Declaration` if supported by the client.

type DeclarationOptions 

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

type DeclarationParams 

type DeclarationParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
}

type DeclarationRegistrationOptions 

type DeclarationRegistrationOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// 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"`
	// 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"`
}

type DeclarationResult 

type DeclarationResult struct {
	Declaration            *Declaration       `json:"-"`
	ArrayOfDeclarationLink *[]DeclarationLink `json:"-"`
	RawMessage             *json.RawMessage   `json:"-"`
}

func (DeclarationResult) MarshalJSON 

func (u DeclarationResult) MarshalJSON() ([]byte, error)

func (*DeclarationResult) UnmarshalJSON 

func (u *DeclarationResult) UnmarshalJSON(data []byte) error

type Definition 

type Definition struct {
	Location        *Location   `json:"-"`
	ArrayOfLocation *[]Location `json:"-"`
}

The definition of a symbol represented as one or many {@link Location locations}. For most programming languages there is only one location at which a symbol is defined.

Servers should prefer returning `DefinitionLink` over `Definition` if supported by the client.

func (Definition) MarshalJSON 

func (u Definition) MarshalJSON() ([]byte, error)

func (*Definition) UnmarshalJSON 

func (u *Definition) UnmarshalJSON(data []byte) error

type DefinitionClientCapabilities 

type DefinitionClientCapabilities struct {
	// Whether definition supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The client supports additional metadata in the form of definition links.  @since 3.14.0
	LinkSupport *bool `json:"linkSupport,omitempty"`
}

Client Capabilities for a {@link DefinitionRequest}. 

type DefinitionLink = LocationLink

Information about where a symbol is defined.

Provides additional metadata over normal {@link Location location} definitions, including the range of the defining symbol

type DefinitionOptions 

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

Server Capabilities for a {@link DefinitionRequest}.

type DefinitionParams 

type DefinitionParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
}

Parameters for a {@link DefinitionRequest}.

type DefinitionRegistrationOptions 

type DefinitionRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
}

Registration options for a {@link DefinitionRequest}.

type DefinitionResult 

type DefinitionResult struct {
	Definition            *Definition       `json:"-"`
	ArrayOfDefinitionLink *[]DefinitionLink `json:"-"`
	RawMessage            *json.RawMessage  `json:"-"`
}

func (DefinitionResult) MarshalJSON 

func (u DefinitionResult) MarshalJSON() ([]byte, error)

func (*DefinitionResult) UnmarshalJSON 

func (u *DefinitionResult) UnmarshalJSON(data []byte) error

type DeleteFile 

type DeleteFile struct {
	// The resource operation kind.
	Kind string `json:"kind"`
	// An optional annotation identifier describing the operation.  @since 3.16.0
	AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"`
	// The file to delete.
	URI string `json:"uri"`
	// Delete options.
	Options *DeleteFileOptions `json:"options,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. To avoid interpretation mismatches when a server is used with different clients it is highly recommended that servers always provide a severity value.
	Severity *DiagnosticSeverity `json:"severity,omitempty"`
	// The diagnostic's code, which usually appear in the user interface.
	Code *DiagnosticCode `json:"code,omitempty"`
	// An optional property to describe the error code. Requires the code field (above) to be present/not null.  @since 3.16.0
	CodeDescription *CodeDescription `json:"codeDescription,omitempty"`
	// A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'. It usually appears in the user interface.
	Source *string `json:"source,omitempty"`
	// The diagnostic's message. It usually appears in the user interface.  @since 3.18.0 - support for MarkupContent. This is guarded by the client capability `textDocument.diagnostic.markupMessageSupport`.
	Message DiagnosticMessage `json:"message"`
	// Additional metadata about the diagnostic.  @since 3.15.0
	Tags []DiagnosticTag `json:"tags,omitempty"`
	// An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.
	RelatedInformation []DiagnosticRelatedInformation `json:"relatedInformation,omitempty"`
	// A data entry field that is preserved between a `textDocument/publishDiagnostics` notification and `textDocument/codeAction` request.  @since 3.16.0
	Data *json.RawMessage `json:"data,omitempty"`
}

Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.

type DiagnosticClientCapabilities 

type DiagnosticClientCapabilities struct {
	// Whether the clients accepts diagnostics with related information.
	RelatedInformation *bool `json:"relatedInformation,omitempty"`
	// Client supports the tag property to provide meta data about a diagnostic. Clients supporting tags have to handle unknown tags gracefully.  @since 3.15.0
	TagSupport *ClientDiagnosticsTagOptions `json:"tagSupport,omitempty"`
	// Client supports a codeDescription property  @since 3.16.0
	CodeDescriptionSupport *bool `json:"codeDescriptionSupport,omitempty"`
	// Whether code action supports the `data` property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request.  @since 3.16.0
	DataSupport *bool `json:"dataSupport,omitempty"`
	// Whether implementation supports dynamic registration. If this is set to `true` the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Whether the clients supports related documents for document diagnostic pulls.
	RelatedDocumentSupport *bool `json:"relatedDocumentSupport,omitempty"`
	// Whether the client supports `MarkupContent` in diagnostic messages.  @since 3.18.0
	MarkupMessageSupport *bool `json:"markupMessageSupport,omitempty"`
}

Client capabilities specific to diagnostic pull requests.

@since 3.17.0

type DiagnosticCode 

type DiagnosticCode struct {
	Int32  *int32  `json:"-"`
	String *string `json:"-"`
}

func (DiagnosticCode) MarshalJSON 

func (u DiagnosticCode) MarshalJSON() ([]byte, error)

func (*DiagnosticCode) UnmarshalJSON 

func (u *DiagnosticCode) UnmarshalJSON(data []byte) error

type DiagnosticMessage 

type DiagnosticMessage struct {
	String        *string        `json:"-"`
	MarkupContent *MarkupContent `json:"-"`
}

func (DiagnosticMessage) MarshalJSON 

func (u DiagnosticMessage) MarshalJSON() ([]byte, error)

func (*DiagnosticMessage) UnmarshalJSON 

func (u *DiagnosticMessage) UnmarshalJSON(data []byte) error

type DiagnosticOptions 

type DiagnosticOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// An optional identifier under which the diagnostics are managed by the client.
	Identifier *string `json:"identifier,omitempty"`
	// Whether the language has inter file dependencies meaning that editing code in one file can result in a different diagnostic set in another file. Inter file dependencies are common for most programming languages and typically uncommon for linters.
	InterFileDependencies bool `json:"interFileDependencies"`
	// The server provides support for workspace diagnostics as well.
	WorkspaceDiagnostics bool `json:"workspaceDiagnostics"`
}

Diagnostic options.

@since 3.17.0

type DiagnosticRegistrationOptions 

type DiagnosticRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// An optional identifier under which the diagnostics are managed by the client.
	Identifier *string `json:"identifier,omitempty"`
	// Whether the language has inter file dependencies meaning that editing code in one file can result in a different diagnostic set in another file. Inter file dependencies are common for most programming languages and typically uncommon for linters.
	InterFileDependencies bool `json:"interFileDependencies"`
	// The server provides support for workspace diagnostics as well.
	WorkspaceDiagnostics bool `json:"workspaceDiagnostics"`
	// 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"`
}

Diagnostic registration options.

@since 3.17.0

type DiagnosticRelatedInformation 

type DiagnosticRelatedInformation struct {
	// The location of this related diagnostic information.
	Location Location `json:"location"`
	// The message of this related diagnostic information.
	Message string `json:"message"`
}

Represents a related message and source code location for a diagnostic. This should be used to point to code locations that cause or related to a diagnostics, e.g when duplicating a symbol in a scope.

type DiagnosticServerCancellationData 

type DiagnosticServerCancellationData struct {
	RetriggerRequest bool `json:"retriggerRequest"`
}

Cancellation data returned from a diagnostic request.

@since 3.17.0

type DiagnosticSeverity 

type DiagnosticSeverity uint32

The diagnostic's severity. 

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
)

type DiagnosticTag 

type DiagnosticTag uint32

The diagnostic tags.

@since 3.15.0 

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
)

type DiagnosticWorkspaceClientCapabilities 

type DiagnosticWorkspaceClientCapabilities struct {
	// Whether the client implementation supports a refresh request sent from the server to the client.  Note that this event is global and will force the client to refresh all pulled diagnostics currently shown. It should be used with absolute care and is useful for situation where a server for example detects a project wide change that requires such a calculation.
	RefreshSupport *bool `json:"refreshSupport,omitempty"`
}

Workspace client capabilities specific to diagnostic pull requests.

@since 3.17.0

type DiagnosticsCapabilities 

type DiagnosticsCapabilities struct {
	// Whether the clients accepts diagnostics with related information.
	RelatedInformation *bool `json:"relatedInformation,omitempty"`
	// Client supports the tag property to provide meta data about a diagnostic. Clients supporting tags have to handle unknown tags gracefully.  @since 3.15.0
	TagSupport *ClientDiagnosticsTagOptions `json:"tagSupport,omitempty"`
	// Client supports a codeDescription property  @since 3.16.0
	CodeDescriptionSupport *bool `json:"codeDescriptionSupport,omitempty"`
	// Whether code action supports the `data` property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request.  @since 3.16.0
	DataSupport *bool `json:"dataSupport,omitempty"`
}

General diagnostics capabilities for pull and push model.

type DidChangeConfigurationClientCapabilities 

type DidChangeConfigurationClientCapabilities struct {
	// Did change configuration notification supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

type DidChangeConfigurationParams 

type DidChangeConfigurationParams struct {
	// The actual changed settings
	Settings json.RawMessage `json:"settings"`
}

The parameters of a change configuration notification.

type DidChangeConfigurationRegistrationOptions 

type DidChangeConfigurationRegistrationOptions struct {
	Section *DidChangeConfigurationRegistrationOptionsSection `json:"section,omitempty"`
}

type DidChangeConfigurationRegistrationOptionsSection 

type DidChangeConfigurationRegistrationOptionsSection struct {
	String        *string   `json:"-"`
	ArrayOfstring *[]string `json:"-"`
}

func (DidChangeConfigurationRegistrationOptionsSection) MarshalJSON 

func (u DidChangeConfigurationRegistrationOptionsSection) MarshalJSON() ([]byte, error)

func (*DidChangeConfigurationRegistrationOptionsSection) UnmarshalJSON 

func (u *DidChangeConfigurationRegistrationOptionsSection) UnmarshalJSON(data []byte) error

type DidChangeNotebookDocumentParams 

type DidChangeNotebookDocumentParams struct {
	// The notebook document that did change. The version number points to the version after all provided changes have been applied. If only the text document content of a cell changes the notebook version doesn't necessarily have to change.
	NotebookDocument VersionedNotebookDocumentIdentifier `json:"notebookDocument"`
	// The actual changes to the notebook document.  The changes describe single state changes to the notebook document. So if there are two changes c1 (at array index 0) and c2 (at array index 1) for a notebook in state S then c1 moves the notebook from S to S' and c2 from S' to S”. So c1 is computed on the state S and c2 is computed on the state S'.  To mirror the content of a notebook using change events use the following approach: - start with the same initial content - apply the 'notebookDocument/didChange' notifications in the order you receive them. - apply the `NotebookChangeEvent`s in a single notification in the order   you receive them.
	Change NotebookDocumentChangeEvent `json:"change"`
}

The params sent in a change notebook document notification.

@since 3.17.0

type DidChangeTextDocumentParams 

type DidChangeTextDocumentParams struct {
	// The document that did change. The version number points to the version after all provided content changes have been applied.
	TextDocument VersionedTextDocumentIdentifier `json:"textDocument"`
	// The actual content changes. The content changes describe single state changes to the document. So if there are two content changes c1 (at array index 0) and c2 (at array index 1) for a document in state S then c1 moves the document from S to S' and c2 from S' to S”. So c1 is computed on the state S and c2 is computed on the state S'.  To mirror the content of a document using change events use the following approach: - start with the same initial content - apply the 'textDocument/didChange' notifications in the order you receive them. - apply the `TextDocumentContentChangeEvent`s in a single notification in the order   you receive them.
	ContentChanges []TextDocumentContentChangeEvent `json:"contentChanges"`
}

The change text document notification's parameters.

type DidChangeWatchedFilesClientCapabilities 

type DidChangeWatchedFilesClientCapabilities struct {
	// Did change watched files notification supports dynamic registration. Please note that the current protocol doesn't support static configuration for file changes from the server side.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Whether the client has support for {@link  RelativePattern relative pattern} or not.  @since 3.17.0
	RelativePatternSupport *bool `json:"relativePatternSupport,omitempty"`
}

type DidChangeWatchedFilesParams 

type DidChangeWatchedFilesParams struct {
	// The actual file events.
	Changes []FileEvent `json:"changes"`
}

The watched files change notification's parameters.

type DidChangeWatchedFilesRegistrationOptions 

type DidChangeWatchedFilesRegistrationOptions struct {
	// The watchers to register.
	Watchers []FileSystemWatcher `json:"watchers"`
}

Describe options to be used when registered for text document change events.

type DidChangeWorkspaceFoldersParams 

type DidChangeWorkspaceFoldersParams struct {
	// The actual workspace folder change event.
	Event WorkspaceFoldersChangeEvent `json:"event"`
}

The parameters of a `workspace/didChangeWorkspaceFolders` notification.

type DidCloseNotebookDocumentParams 

type DidCloseNotebookDocumentParams struct {
	// The notebook document that got closed.
	NotebookDocument NotebookDocumentIdentifier `json:"notebookDocument"`
	// The text documents that represent the content of a notebook cell that got closed.
	CellTextDocuments []TextDocumentIdentifier `json:"cellTextDocuments"`
}

The params sent in a close notebook document notification.

@since 3.17.0

type DidCloseTextDocumentParams 

type DidCloseTextDocumentParams struct {
	// The document that was closed.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

The parameters sent in a close text document notification

type DidOpenNotebookDocumentParams 

type DidOpenNotebookDocumentParams struct {
	// The notebook document that got opened.
	NotebookDocument NotebookDocument `json:"notebookDocument"`
	// The text documents that represent the content of a notebook cell.
	CellTextDocuments []TextDocumentItem `json:"cellTextDocuments"`
}

The params sent in an open notebook document notification.

@since 3.17.0

type DidOpenTextDocumentParams 

type DidOpenTextDocumentParams struct {
	// The document that was opened.
	TextDocument TextDocumentItem `json:"textDocument"`
}

The parameters sent in an open text document notification

type DidSaveNotebookDocumentParams 

type DidSaveNotebookDocumentParams struct {
	// The notebook document that got saved.
	NotebookDocument NotebookDocumentIdentifier `json:"notebookDocument"`
}

The params sent in a save notebook document notification.

@since 3.17.0

type DidSaveTextDocumentParams 

type DidSaveTextDocumentParams struct {
	// The document that was saved.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// Optional the content when saved. Depends on the includeText value when the save notification was requested.
	Text *string `json:"text,omitempty"`
}

The parameters sent in a save text document notification

type DocumentColorClientCapabilities 

type DocumentColorClientCapabilities struct {
	// Whether implementation supports dynamic registration. If this is set to `true` the client supports the new `DocumentColorRegistrationOptions` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

type DocumentColorOptions 

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

type DocumentColorParams 

type DocumentColorParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

Parameters for a {@link DocumentColorRequest}.

type DocumentColorRegistrationOptions 

type DocumentColorRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// 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"`
}

type DocumentDiagnosticParams 

type DocumentDiagnosticParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The additional identifier  provided during registration.
	Identifier *string `json:"identifier,omitempty"`
	// The result id of a previous response if provided.
	PreviousResultID *string `json:"previousResultId,omitempty"`
}

Parameters of the document diagnostic request.

@since 3.17.0

type DocumentDiagnosticReport 

type DocumentDiagnosticReport struct {
	RelatedFullDocumentDiagnosticReport      *RelatedFullDocumentDiagnosticReport      `json:"-"`
	RelatedUnchangedDocumentDiagnosticReport *RelatedUnchangedDocumentDiagnosticReport `json:"-"`
}

The result of a document diagnostic pull request. A report can either be a full report containing all diagnostics for the requested document or an unchanged report indicating that nothing has changed in terms of diagnostics in comparison to the last pull request.

@since 3.17.0

func (DocumentDiagnosticReport) MarshalJSON 

func (u DocumentDiagnosticReport) MarshalJSON() ([]byte, error)

func (*DocumentDiagnosticReport) UnmarshalJSON 

func (u *DocumentDiagnosticReport) UnmarshalJSON(data []byte) error

type DocumentDiagnosticReportKind 

type DocumentDiagnosticReportKind string

The document diagnostic report kinds.

@since 3.17.0 

const (
	// A diagnostic report with a full set of problems.
	DocumentDiagnosticReportKindFull DocumentDiagnosticReportKind = "full"
	// A report indicating that the last returned report is still accurate.
	DocumentDiagnosticReportKindUnchanged DocumentDiagnosticReportKind = "unchanged"
)

type DocumentDiagnosticReportPartialResult 

type DocumentDiagnosticReportPartialResult struct {
	RelatedDocuments map[string]DocumentDiagnosticReportPartialResultRelatedDocumentsValue `json:"relatedDocuments"`
}

A partial result for a document diagnostic report.

@since 3.17.0

type DocumentDiagnosticReportPartialResultRelatedDocumentsValue 

type DocumentDiagnosticReportPartialResultRelatedDocumentsValue struct {
	FullDocumentDiagnosticReport      *FullDocumentDiagnosticReport      `json:"-"`
	UnchangedDocumentDiagnosticReport *UnchangedDocumentDiagnosticReport `json:"-"`
}

func (DocumentDiagnosticReportPartialResultRelatedDocumentsValue) MarshalJSON 

func (u DocumentDiagnosticReportPartialResultRelatedDocumentsValue) MarshalJSON() ([]byte, error)

func (*DocumentDiagnosticReportPartialResultRelatedDocumentsValue) UnmarshalJSON 

func (u *DocumentDiagnosticReportPartialResultRelatedDocumentsValue) UnmarshalJSON(data []byte) error

type DocumentFilter 

type DocumentFilter struct {
	TextDocumentFilter             *TextDocumentFilter             `json:"-"`
	NotebookCellTextDocumentFilter *NotebookCellTextDocumentFilter `json:"-"`
}

A document filter describes a top level text document or a notebook cell document.

@since 3.17.0 - support for NotebookCellTextDocumentFilter.

func (DocumentFilter) MarshalJSON 

func (u DocumentFilter) MarshalJSON() ([]byte, error)

func (*DocumentFilter) UnmarshalJSON 

func (u *DocumentFilter) UnmarshalJSON(data []byte) error

type DocumentFormattingClientCapabilities 

type DocumentFormattingClientCapabilities struct {
	// Whether formatting supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

Client capabilities of a {@link DocumentFormattingRequest}.

type DocumentFormattingOptions 

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

Provider options for a {@link DocumentFormattingRequest}.

type DocumentFormattingParams 

type DocumentFormattingParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// The document to format.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The format options.
	Options FormattingOptions `json:"options"`
}

The parameters of a {@link DocumentFormattingRequest}.

type DocumentFormattingRegistrationOptions 

type DocumentFormattingRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
}

Registration options for a {@link DocumentFormattingRequest}.

type DocumentHighlight 

type DocumentHighlight struct {
	// The range this highlight applies to.
	Range Range `json:"range"`
	// The highlight kind, default is {@link DocumentHighlightKind.Text text}.
	Kind *DocumentHighlightKind `json:"kind,omitempty"`
}

A document highlight is a range inside a text document which deserves special attention. Usually a document highlight is visualized by changing the background color of its range.

type DocumentHighlightClientCapabilities 

type DocumentHighlightClientCapabilities struct {
	// Whether document highlight supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

Client Capabilities for a {@link DocumentHighlightRequest}.

type DocumentHighlightKind 

type DocumentHighlightKind uint32

A document highlight kind. 

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
)

type DocumentHighlightOptions 

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

Provider options for a {@link DocumentHighlightRequest}.

type DocumentHighlightParams 

type DocumentHighlightParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
}

Parameters for a {@link DocumentHighlightRequest}.

type DocumentHighlightRegistrationOptions 

type DocumentHighlightRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
}

Registration options for a {@link DocumentHighlightRequest}. 

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 *string `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 *json.RawMessage `json:"data,omitempty"`
}

A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.

type DocumentLinkClientCapabilities 

type DocumentLinkClientCapabilities struct {
	// Whether document link supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Whether the client supports the `tooltip` property on `DocumentLink`.  @since 3.15.0
	TooltipSupport *bool `json:"tooltipSupport,omitempty"`
}

The client capabilities of a {@link DocumentLinkRequest}.

type DocumentLinkOptions 

type DocumentLinkOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// Document links have a resolve provider as well.
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
}

Provider options for a {@link DocumentLinkRequest}.

type DocumentLinkParams 

type DocumentLinkParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The document to provide document links for.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

The parameters of a {@link DocumentLinkRequest}.

type DocumentLinkRegistrationOptions 

type DocumentLinkRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// Document links have a resolve provider as well.
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
}

Registration options for a {@link DocumentLinkRequest}.

type DocumentOnTypeFormattingClientCapabilities 

type DocumentOnTypeFormattingClientCapabilities struct {
	// Whether on type formatting supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

Client capabilities of a {@link DocumentOnTypeFormattingRequest}.

type DocumentOnTypeFormattingOptions 

type DocumentOnTypeFormattingOptions struct {
	// A character on which formatting should be triggered, like `{`.
	FirstTriggerCharacter string `json:"firstTriggerCharacter"`
	// More trigger characters.
	MoreTriggerCharacter []string `json:"moreTriggerCharacter,omitempty"`
}

Provider options for a {@link DocumentOnTypeFormattingRequest}.

type DocumentOnTypeFormattingParams 

type DocumentOnTypeFormattingParams struct {
	// The document to format.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position around which the on type formatting should happen. This is not necessarily the exact position where the character denoted by the property `ch` got typed.
	Position Position `json:"position"`
	// The character that has been typed that triggered the formatting on type request. That is not necessarily the last character that got inserted into the document since the client could auto insert characters as well (e.g. like automatic brace completion).
	Ch string `json:"ch"`
	// The formatting options.
	Options FormattingOptions `json:"options"`
}

The parameters of a {@link DocumentOnTypeFormattingRequest}.

type DocumentOnTypeFormattingRegistrationOptions 

type DocumentOnTypeFormattingRegistrationOptions struct {
	// 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"`
	// A character on which formatting should be triggered, like `{`.
	FirstTriggerCharacter string `json:"firstTriggerCharacter"`
	// More trigger characters.
	MoreTriggerCharacter []string `json:"moreTriggerCharacter,omitempty"`
}

Registration options for a {@link DocumentOnTypeFormattingRequest}.

type DocumentRangeFormattingClientCapabilities 

type DocumentRangeFormattingClientCapabilities struct {
	// Whether range formatting supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Whether the client supports formatting multiple ranges at once.  @since 3.18.0
	RangesSupport *bool `json:"rangesSupport,omitempty"`
}

Client capabilities of a {@link DocumentRangeFormattingRequest}.

type DocumentRangeFormattingOptions 

type DocumentRangeFormattingOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// Whether the server supports formatting multiple ranges at once.  @since 3.18.0
	RangesSupport *bool `json:"rangesSupport,omitempty"`
}

Provider options for a {@link DocumentRangeFormattingRequest}.

type DocumentRangeFormattingParams 

type DocumentRangeFormattingParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// The document to format.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The range to format
	Range Range `json:"range"`
	// The format options
	Options FormattingOptions `json:"options"`
}

The parameters of a {@link DocumentRangeFormattingRequest}.

type DocumentRangeFormattingRegistrationOptions 

type DocumentRangeFormattingRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// Whether the server supports formatting multiple ranges at once.  @since 3.18.0
	RangesSupport *bool `json:"rangesSupport,omitempty"`
}

Registration options for a {@link DocumentRangeFormattingRequest}.

type DocumentRangesFormattingParams 

type DocumentRangesFormattingParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// The document to format.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The ranges to format
	Ranges []Range `json:"ranges"`
	// The format options
	Options FormattingOptions `json:"options"`
}

The parameters of a {@link DocumentRangesFormattingRequest}.

@since 3.18.0

type DocumentSelector 

type DocumentSelector = []DocumentFilter

A document selector is the combination of one or many document filters.

@sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;

The use of a string as a document filter is deprecated @since 3.16.0.

type DocumentSymbol 

type DocumentSymbol struct {
	// The name of this symbol. Will be displayed in the user interface and therefore must not be an empty string or a string only consisting of white spaces.
	Name string `json:"name"`
	// More detail for this symbol, e.g the signature of a function.
	Detail *string `json:"detail,omitempty"`
	// The kind of this symbol.
	Kind SymbolKind `json:"kind"`
	// Tags for this document symbol.  @since 3.16.0
	Tags []SymbolTag `json:"tags,omitempty"`
	// Indicates if this symbol is deprecated.  @deprecated Use tags instead
	Deprecated *bool `json:"deprecated,omitempty"`
	// The range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the clients cursor is inside the symbol to reveal in the symbol in the UI.
	Range Range `json:"range"`
	// The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. Must be contained by the `range`.
	SelectionRange Range `json:"selectionRange"`
	// Children of this symbol, e.g. properties of a class.
	Children []DocumentSymbol `json:"children,omitempty"`
}

Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier.

type DocumentSymbolClientCapabilities 

type DocumentSymbolClientCapabilities struct {
	// Whether document symbol supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Specific capabilities for the `SymbolKind` in the `textDocument/documentSymbol` request.
	SymbolKind *ClientSymbolKindOptions `json:"symbolKind,omitempty"`
	// The client supports hierarchical document symbols.
	HierarchicalDocumentSymbolSupport *bool `json:"hierarchicalDocumentSymbolSupport,omitempty"`
	// The client supports tags on `SymbolInformation`. Tags are supported on `DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true. Clients supporting tags have to handle unknown tags gracefully.  @since 3.16.0
	TagSupport *ClientSymbolTagOptions `json:"tagSupport,omitempty"`
	// The client supports an additional label presented in the UI when registering a document symbol provider.  @since 3.16.0
	LabelSupport *bool `json:"labelSupport,omitempty"`
}

Client Capabilities for a {@link DocumentSymbolRequest}.

type DocumentSymbolOptions 

type DocumentSymbolOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// 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"`
}

Provider options for a {@link DocumentSymbolRequest}.

type DocumentSymbolParams 

type DocumentSymbolParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

Parameters for a {@link DocumentSymbolRequest}.

type DocumentSymbolRegistrationOptions 

type DocumentSymbolRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// 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"`
}

Registration options for a {@link DocumentSymbolRequest}.

type DocumentSymbolResult 

type DocumentSymbolResult struct {
	ArrayOfSymbolInformation *[]SymbolInformation `json:"-"`
	ArrayOfDocumentSymbol    *[]DocumentSymbol    `json:"-"`
	RawMessage               *json.RawMessage     `json:"-"`
}

func (DocumentSymbolResult) MarshalJSON 

func (u DocumentSymbolResult) MarshalJSON() ([]byte, error)

func (*DocumentSymbolResult) UnmarshalJSON 

func (u *DocumentSymbolResult) UnmarshalJSON(data []byte) error

type DocumentURI 

type DocumentURI = string

type EditRangeWithInsertReplace 

type EditRangeWithInsertReplace struct {
	Insert  Range `json:"insert"`
	Replace Range `json:"replace"`
}

Edit range variant that includes ranges for insert and replace operations.

@since 3.18.0

type Empty 

type Empty struct{}

Empty represents an empty parameter or response payload.

type ErrorCodes 

type ErrorCodes int32

Predefined error codes. 

const (
	ErrorCodesParseError     ErrorCodes = -32700
	ErrorCodesInvalidRequest ErrorCodes = -32600
	ErrorCodesMethodNotFound ErrorCodes = -32601
	ErrorCodesInvalidParams  ErrorCodes = -32602
	ErrorCodesInternalError  ErrorCodes = -32603
	// Error code indicating that a server received a notification or request before the server has received the `initialize` request.
	ErrorCodesServerNotInitialized ErrorCodes = -32002
	ErrorCodesUnknownErrorCode     ErrorCodes = -32001
)

type ExecuteCommandClientCapabilities 

type ExecuteCommandClientCapabilities struct {
	// Execute command supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

The client capabilities of a {@link ExecuteCommandRequest}.

type ExecuteCommandOptions 

type ExecuteCommandOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// The commands to be executed on the server
	Commands []string `json:"commands"`
}

The server capabilities of a {@link ExecuteCommandRequest}.

type ExecuteCommandParams 

type ExecuteCommandParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// The identifier of the actual command handler.
	Command string `json:"command"`
	// Arguments that the command should be invoked with.
	Arguments []json.RawMessage `json:"arguments,omitempty"`
}

The parameters of a {@link ExecuteCommandRequest}.

type ExecuteCommandRegistrationOptions 

type ExecuteCommandRegistrationOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// The commands to be executed on the server
	Commands []string `json:"commands"`
}

Registration options for a {@link ExecuteCommandRequest}.

type ExecutionSummary 

type ExecutionSummary struct {
	// A strict monotonically increasing value indicating the execution order of a cell inside a notebook.
	ExecutionOrder uint32 `json:"executionOrder"`
	// Whether the execution was successful or not if known by the client.
	Success *bool `json:"success,omitempty"`
}

type FailureHandlingKind 

type FailureHandlingKind string
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"
)

type FileChangeType 

type FileChangeType uint32

The file event type 

const (
	// The file got created.
	FileChangeTypeCreated FileChangeType = 1
	// The file got changed.
	FileChangeTypeChanged FileChangeType = 2
	// The file got deleted.
	FileChangeTypeDeleted FileChangeType = 3
)

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 string `json:"uri"`
	// The change type.
	Type FileChangeType `json:"type"`
}

An event describing a file change.

type FileOperationClientCapabilities 

type FileOperationClientCapabilities struct {
	// Whether the client supports dynamic registration for file requests/notifications.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The client has support for sending didCreateFiles notifications.
	DidCreate *bool `json:"didCreate,omitempty"`
	// The client has support for sending willCreateFiles requests.
	WillCreate *bool `json:"willCreate,omitempty"`
	// The client has support for sending didRenameFiles notifications.
	DidRename *bool `json:"didRename,omitempty"`
	// The client has support for sending willRenameFiles requests.
	WillRename *bool `json:"willRename,omitempty"`
	// The client has support for sending didDeleteFiles notifications.
	DidDelete *bool `json:"didDelete,omitempty"`
	// The client has support for sending willDeleteFiles requests.
	WillDelete *bool `json:"willDelete,omitempty"`
}

Capabilities relating to events from file operations by the user in the client.

These events do not come from the file system, they come from user operations like renaming a file in the UI.

@since 3.16.0

type FileOperationFilter 

type FileOperationFilter struct {
	// A Uri scheme like `file` or `untitled`.
	Scheme *string `json:"scheme,omitempty"`
	// The actual file operation pattern.
	Pattern FileOperationPattern `json:"pattern"`
}

A filter to describe in which file operation requests or notifications the server is interested in receiving.

@since 3.16.0

type FileOperationOptions 

type FileOperationOptions struct {
	// The server is interested in receiving didCreateFiles notifications.
	DidCreate *FileOperationRegistrationOptions `json:"didCreate,omitempty"`
	// The server is interested in receiving willCreateFiles requests.
	WillCreate *FileOperationRegistrationOptions `json:"willCreate,omitempty"`
	// The server is interested in receiving didRenameFiles notifications.
	DidRename *FileOperationRegistrationOptions `json:"didRename,omitempty"`
	// The server is interested in receiving willRenameFiles requests.
	WillRename *FileOperationRegistrationOptions `json:"willRename,omitempty"`
	// The server is interested in receiving didDeleteFiles file notifications.
	DidDelete *FileOperationRegistrationOptions `json:"didDelete,omitempty"`
	// The server is interested in receiving willDeleteFiles file requests.
	WillDelete *FileOperationRegistrationOptions `json:"willDelete,omitempty"`
}

Options for notifications/requests for user operations on files.

@since 3.16.0

type FileOperationPattern 

type FileOperationPattern struct {
	// The glob pattern to match. Glob patterns can have the following syntax: - `*` to match zero or more characters in a path segment - `?` to match on one character in a path segment - `**` to match any number of path segments, including none - `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files) - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …) - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
	Glob string `json:"glob"`
	// Whether to match files or folders with this pattern.  Matches both if undefined.
	Matches *FileOperationPatternKind `json:"matches,omitempty"`
	// Additional options used during matching.
	Options *FileOperationPatternOptions `json:"options,omitempty"`
}

A pattern to describe in which file operation requests or notifications the server is interested in receiving.

@since 3.16.0

type FileOperationPatternKind 

type FileOperationPatternKind string

A pattern kind describing if a glob pattern matches a file a folder or both.

@since 3.16.0 

const (
	// The pattern matches a file only.
	FileOperationPatternKindFile FileOperationPatternKind = "file"
	// The pattern matches a folder only.
	FileOperationPatternKindFolder FileOperationPatternKind = "folder"
)

type FileOperationPatternOptions 

type FileOperationPatternOptions struct {
	// The pattern should be matched ignoring casing.
	IgnoreCase *bool `json:"ignoreCase,omitempty"`
}

Matching options for the file operation pattern.

@since 3.16.0

type FileOperationRegistrationOptions 

type FileOperationRegistrationOptions struct {
	// The actual filters.
	Filters []FileOperationFilter `json:"filters"`
}

The options to register for file operations.

@since 3.16.0

type FileRename 

type FileRename struct {
	// A file:// URI for the original location of the file/folder being renamed.
	OldURI string `json:"oldUri"`
	// A file:// URI for the new location of the file/folder being renamed.
	NewURI string `json:"newUri"`
}

Represents information on a file/folder rename.

@since 3.16.0

type FileSystemWatcher 

type FileSystemWatcher struct {
	// The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.  @since 3.17.0 support for relative patterns.
	GlobPattern GlobPattern `json:"globPattern"`
	// The kind of events of interest. If omitted it defaults to WatchKind.Create | WatchKind.Change | WatchKind.Delete which is 7.
	Kind *WatchKind `json:"kind,omitempty"`
}

type FoldingRange 

type FoldingRange struct {
	// The zero-based start line of the range to fold. The folded area starts after the line's last character. To be valid, the end must be zero or larger and smaller than the number of lines in the document.
	StartLine uint32 `json:"startLine"`
	// The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
	StartCharacter *uint32 `json:"startCharacter,omitempty"`
	// The zero-based end line of the range to fold. The folded area ends with the line's last character. To be valid, the end must be zero or larger and smaller than the number of lines in the document.
	EndLine uint32 `json:"endLine"`
	// The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
	EndCharacter *uint32 `json:"endCharacter,omitempty"`
	// Describes the kind of the folding range such as 'comment' or 'region'. The kind is used to categorize folding ranges and used by commands like 'Fold all comments'. See {@link FoldingRangeKind} for an enumeration of standardized kinds.
	Kind *FoldingRangeKind `json:"kind,omitempty"`
	// The text that the client should show when the specified range is collapsed. If not defined or not supported by the client, a default will be chosen by the client.  @since 3.17.0
	CollapsedText *string `json:"collapsedText,omitempty"`
}

Represents a folding range. To be valid, start and end line must be bigger than zero and smaller than the number of lines in the document. Clients are free to ignore invalid ranges.

type FoldingRangeClientCapabilities 

type FoldingRangeClientCapabilities struct {
	// Whether implementation supports dynamic registration for folding range providers. If this is set to `true` the client supports the new `FoldingRangeRegistrationOptions` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The maximum number of folding ranges that the client prefers to receive per document. The value serves as a hint, servers are free to follow the limit.
	RangeLimit *uint32 `json:"rangeLimit,omitempty"`
	// If set, the client signals that it only supports folding complete lines. If set, client will ignore specified `startCharacter` and `endCharacter` properties in a FoldingRange.
	LineFoldingOnly *bool `json:"lineFoldingOnly,omitempty"`
	// Specific options for the folding range kind.  @since 3.17.0
	FoldingRangeKind *ClientFoldingRangeKindOptions `json:"foldingRangeKind,omitempty"`
	// Specific options for the folding range.  @since 3.17.0
	FoldingRange *ClientFoldingRangeOptions `json:"foldingRange,omitempty"`
}

type FoldingRangeKind 

type FoldingRangeKind string

A set of predefined range kinds. 

const (
	// Folding range for a comment
	FoldingRangeKindComment FoldingRangeKind = "comment"
	// Folding range for an import or include
	FoldingRangeKindImports FoldingRangeKind = "imports"
	// Folding range for a region (e.g. `#region`)
	FoldingRangeKindRegion FoldingRangeKind = "region"
)

type FoldingRangeOptions 

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

type FoldingRangeParams 

type FoldingRangeParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

Parameters for a {@link FoldingRangeRequest}.

type FoldingRangeRegistrationOptions 

type FoldingRangeRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// 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"`
}

type FoldingRangeWorkspaceClientCapabilities 

type FoldingRangeWorkspaceClientCapabilities struct {
	// Whether the client implementation supports a refresh request sent from the server to the client.  Note that this event is global and will force the client to refresh all folding ranges currently shown. It should be used with absolute care and is useful for situation where a server for example detects a project wide change that requires such a calculation.  @since 3.18.0
	RefreshSupport *bool `json:"refreshSupport,omitempty"`
}

Client workspace capabilities specific to folding ranges

@since 3.18.0

type FormattingOptions 

type FormattingOptions struct {
	// Size of a tab in spaces.
	TabSize uint32 `json:"tabSize"`
	// Prefer spaces over tabs.
	InsertSpaces bool `json:"insertSpaces"`
	// Trim trailing whitespace on a line.  @since 3.15.0
	TrimTrailingWhitespace *bool `json:"trimTrailingWhitespace,omitempty"`
	// Insert a newline character at the end of the file if one does not exist.  @since 3.15.0
	InsertFinalNewline *bool `json:"insertFinalNewline,omitempty"`
	// Trim all newlines after the final newline at the end of the file.  @since 3.15.0
	TrimFinalNewlines *bool `json:"trimFinalNewlines,omitempty"`
}

Value-object describing what options formatting should use.

type FullDocumentDiagnosticReport 

type FullDocumentDiagnosticReport struct {
	// A full document diagnostic report.
	Kind string `json:"kind"`
	// An optional result id. If provided it will be sent on the next diagnostic request for the same document.
	ResultID *string `json:"resultId,omitempty"`
	// The actual items.
	Items []Diagnostic `json:"items"`
}

A diagnostic report with a full set of problems.

@since 3.17.0

type GeneralClientCapabilities 

type GeneralClientCapabilities struct {
	// Client capability that signals how the client handles stale requests (e.g. a request for which the client will not process the response anymore since the information is outdated).  @since 3.17.0
	StaleRequestSupport *StaleRequestSupportOptions `json:"staleRequestSupport,omitempty"`
	// Client capabilities specific to regular expressions.  @since 3.16.0
	RegularExpressions *RegularExpressionsClientCapabilities `json:"regularExpressions,omitempty"`
	// Client capabilities specific to the client's markdown parser.  @since 3.16.0
	Markdown *MarkdownClientCapabilities `json:"markdown,omitempty"`
	// The position encodings supported by the client. Client and server have to agree on the same position encoding to ensure that offsets (e.g. character position in a line) are interpreted the same on both sides.  To keep the protocol backwards compatible the following applies: if the value 'utf-16' is missing from the array of position encodings servers can assume that the client supports UTF-16. UTF-16 is therefore a mandatory encoding.  If omitted it defaults to ['utf-16'].  Implementation considerations: since the conversion from one encoding into another requires the content of the file / line the conversion is best done where the file is read which is usually on the server side.  @since 3.17.0
	PositionEncodings []PositionEncodingKind `json:"positionEncodings,omitempty"`
}

General client capabilities.

@since 3.16.0

type GlobPattern 

type GlobPattern struct {
	Pattern         *Pattern         `json:"-"`
	RelativePattern *RelativePattern `json:"-"`
}

The glob pattern. Either a string pattern or a relative pattern.

@since 3.17.0

func (GlobPattern) MarshalJSON 

func (u GlobPattern) MarshalJSON() ([]byte, error)

func (*GlobPattern) UnmarshalJSON 

func (u *GlobPattern) UnmarshalJSON(data []byte) error

type Hover 

type Hover struct {
	// The hover's content
	Contents HoverContents `json:"contents"`
	// An optional range inside the text document that is used to visualize the hover, e.g. by changing the background color.
	Range *Range `json:"range,omitempty"`
}

The result of a hover request.

type HoverClientCapabilities 

type HoverClientCapabilities struct {
	// Whether hover supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Client supports the following content formats for the content property. The order describes the preferred format of the client.
	ContentFormat []MarkupKind `json:"contentFormat,omitempty"`
}

type HoverContents 

type HoverContents struct {
	MarkupContent       *MarkupContent  `json:"-"`
	MarkedString        *MarkedString   `json:"-"`
	ArrayOfMarkedString *[]MarkedString `json:"-"`
}

func (HoverContents) MarshalJSON 

func (u HoverContents) MarshalJSON() ([]byte, error)

func (*HoverContents) UnmarshalJSON 

func (u *HoverContents) UnmarshalJSON(data []byte) error

type HoverOptions 

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

Hover options.

type HoverParams 

type HoverParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
}

Parameters for a {@link HoverRequest}.

type HoverRegistrationOptions 

type HoverRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
}

Registration options for a {@link HoverRequest}.

type ImplementationClientCapabilities 

type ImplementationClientCapabilities struct {
	// Whether implementation supports dynamic registration. If this is set to `true` the client supports the new `ImplementationRegistrationOptions` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The client supports additional metadata in the form of definition links.  @since 3.14.0
	LinkSupport *bool `json:"linkSupport,omitempty"`
}

@since 3.6.0

type ImplementationOptions 

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

type ImplementationParams 

type ImplementationParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
}

type ImplementationRegistrationOptions 

type ImplementationRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// 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"`
}

type ImplementationResult 

type ImplementationResult struct {
	Definition            *Definition       `json:"-"`
	ArrayOfDefinitionLink *[]DefinitionLink `json:"-"`
	RawMessage            *json.RawMessage  `json:"-"`
}

func (ImplementationResult) MarshalJSON 

func (u ImplementationResult) MarshalJSON() ([]byte, error)

func (*ImplementationResult) UnmarshalJSON 

func (u *ImplementationResult) UnmarshalJSON(data []byte) error

type InitializeError 

type InitializeError struct {
	// Indicates whether the client execute the following retry logic: (1) show the message provided by the ResponseError to the user (2) user selects retry or cancel (3) if user selected retry the initialize method is sent again.
	Retry bool `json:"retry"`
}

The data type of the ResponseError if the initialize request fails.

type InitializeParams 

type InitializeParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// The process Id of the parent process that started the server.  Is `null` if the process has not been started by another process. If the parent process is not alive then the server should exit.
	ProcessID int32 `json:"processId"`
	// Information about the client  @since 3.15.0
	ClientInfo *ClientInfo `json:"clientInfo,omitempty"`
	// The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system.  Uses IETF language tags as the value's syntax (See https://en.wikipedia.org/wiki/IETF_language_tag)  @since 3.16.0
	Locale *string `json:"locale,omitempty"`
	// The rootPath of the workspace. Is null if no folder is open.  @deprecated in favour of rootUri.
	RootPath *string `json:"rootPath,omitempty"`
	// The rootUri of the workspace. Is null if no folder is open. If both `rootPath` and `rootUri` are set `rootUri` wins.  @deprecated in favour of workspaceFolders.
	RootURI string `json:"rootUri"`
	// The capabilities provided by the client (editor or tool)
	Capabilities ClientCapabilities `json:"capabilities"`
	// User provided initialization options.
	InitializationOptions *json.RawMessage `json:"initializationOptions,omitempty"`
	// 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 *ServerInfo `json:"serverInfo,omitempty"`
}

The result returned from an initialize request.

type InitializedParams 

type InitializedParams struct {
}

type InlayHint 

type InlayHint struct {
	// The position of this hint.  If multiple hints have the same position, they will be shown in the order they appear in the response.
	Position Position `json:"position"`
	// The label of this hint. A human readable string or an array of InlayHintLabelPart label parts.  *Note* that neither the string nor the label part can be empty.
	Label InlayHintLabel `json:"label"`
	// The kind of this hint. Can be omitted in which case the client should fall back to a reasonable default.
	Kind *InlayHintKind `json:"kind,omitempty"`
	// Optional text edits that are performed when accepting this inlay hint.  *Note* that edits are expected to change the document so that the inlay hint (or its nearest variant) is now part of the document and the inlay hint itself is now obsolete.
	TextEdits []TextEdit `json:"textEdits,omitempty"`
	// The tooltip text when you hover over this item.
	Tooltip *InlayHintTooltip `json:"tooltip,omitempty"`
	// Render padding before the hint.  Note: Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.
	PaddingLeft *bool `json:"paddingLeft,omitempty"`
	// Render padding after the hint.  Note: Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.
	PaddingRight *bool `json:"paddingRight,omitempty"`
	// A data entry field that is preserved on an inlay hint between a `textDocument/inlayHint` and a `inlayHint/resolve` request.
	Data *json.RawMessage `json:"data,omitempty"`
}

Inlay hint information.

@since 3.17.0

type InlayHintClientCapabilities 

type InlayHintClientCapabilities struct {
	// Whether inlay hints support dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Indicates which properties a client can resolve lazily on an inlay hint.
	ResolveSupport *ClientInlayHintResolveOptions `json:"resolveSupport,omitempty"`
}

Inlay hint client capabilities.

@since 3.17.0

type InlayHintKind 

type InlayHintKind uint32

Inlay hint kinds.

@since 3.17.0 

const (
	// An inlay hint that for a type annotation.
	InlayHintKindType InlayHintKind = 1
	// An inlay hint that is for a parameter.
	InlayHintKindParameter InlayHintKind = 2
)

type InlayHintLabel 

type InlayHintLabel struct {
	String                    *string               `json:"-"`
	ArrayOfInlayHintLabelPart *[]InlayHintLabelPart `json:"-"`
}

func (InlayHintLabel) MarshalJSON 

func (u InlayHintLabel) MarshalJSON() ([]byte, error)

func (*InlayHintLabel) UnmarshalJSON 

func (u *InlayHintLabel) UnmarshalJSON(data []byte) error

type InlayHintLabelPart 

type InlayHintLabelPart struct {
	// The value of this label part.
	Value string `json:"value"`
	// The tooltip text when you hover over this label part. Depending on the client capability `inlayHint.resolveSupport` clients might resolve this property late using the resolve request.
	Tooltip *InlayHintLabelPartTooltip `json:"tooltip,omitempty"`
	// An optional source code location that represents this label part.  The editor will use this location for the hover and for code navigation features: This part will become a clickable link that resolves to the definition of the symbol at the given location (not necessarily the location itself), it shows the hover that shows at the given location, and it shows a context menu with further code navigation commands.  Depending on the client capability `inlayHint.resolveSupport` clients might resolve this property late using the resolve request.
	Location *Location `json:"location,omitempty"`
	// An optional command for this label part.  Depending on the client capability `inlayHint.resolveSupport` clients might resolve this property late using the resolve request.
	Command *Command `json:"command,omitempty"`
}

An inlay hint label part allows for interactive and composite labels of inlay hints.

@since 3.17.0

type InlayHintLabelPartTooltip 

type InlayHintLabelPartTooltip struct {
	String        *string        `json:"-"`
	MarkupContent *MarkupContent `json:"-"`
}

func (InlayHintLabelPartTooltip) MarshalJSON 

func (u InlayHintLabelPartTooltip) MarshalJSON() ([]byte, error)

func (*InlayHintLabelPartTooltip) UnmarshalJSON 

func (u *InlayHintLabelPartTooltip) UnmarshalJSON(data []byte) error

type InlayHintOptions 

type InlayHintOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// The server provides support to resolve additional information for an inlay hint item.
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
}

Inlay hint options used during static registration.

@since 3.17.0

type InlayHintParams 

type InlayHintParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The document range for which inlay hints should be computed.
	Range Range `json:"range"`
}

A parameter literal used in inlay hint requests.

@since 3.17.0

type InlayHintRegistrationOptions 

type InlayHintRegistrationOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// The server provides support to resolve additional information for an inlay hint item.
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
	// 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"`
	// 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"`
}

Inlay hint options used during static or dynamic registration.

@since 3.17.0

type InlayHintTooltip 

type InlayHintTooltip struct {
	String        *string        `json:"-"`
	MarkupContent *MarkupContent `json:"-"`
}

func (InlayHintTooltip) MarshalJSON 

func (u InlayHintTooltip) MarshalJSON() ([]byte, error)

func (*InlayHintTooltip) UnmarshalJSON 

func (u *InlayHintTooltip) UnmarshalJSON(data []byte) error

type InlayHintWorkspaceClientCapabilities 

type InlayHintWorkspaceClientCapabilities struct {
	// Whether the client implementation supports a refresh request sent from the server to the client.  Note that this event is global and will force the client to refresh all inlay hints currently shown. It should be used with absolute care and is useful for situation where a server for example detects a project wide change that requires such a calculation.
	RefreshSupport *bool `json:"refreshSupport,omitempty"`
}

Client workspace capabilities specific to inlay hints.

@since 3.17.0

type InlineCompletionClientCapabilities 

type InlineCompletionClientCapabilities struct {
	// Whether implementation supports dynamic registration for inline completion providers.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

Client capabilities specific to inline completions.

@since 3.18.0

type InlineCompletionContext 

type InlineCompletionContext struct {
	// Describes how the inline completion was triggered.
	TriggerKind InlineCompletionTriggerKind `json:"triggerKind"`
	// Provides information about the currently selected item in the autocomplete widget if it is visible.
	SelectedCompletionInfo *SelectedCompletionInfo `json:"selectedCompletionInfo,omitempty"`
}

Provides information about the context in which an inline completion was requested.

@since 3.18.0

type InlineCompletionItem 

type InlineCompletionItem struct {
	// The text to replace the range with. Must be set.
	InsertText InlineCompletionItemInsertText `json:"insertText"`
	// A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used.
	FilterText *string `json:"filterText,omitempty"`
	// The range to replace. Must begin and end on the same line.
	Range *Range `json:"range,omitempty"`
	// An optional {@link Command} that is executed *after* inserting this completion.
	Command *Command `json:"command,omitempty"`
}

An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.

@since 3.18.0

type InlineCompletionItemInsertText 

type InlineCompletionItemInsertText struct {
	String      *string      `json:"-"`
	StringValue *StringValue `json:"-"`
}

func (InlineCompletionItemInsertText) MarshalJSON 

func (u InlineCompletionItemInsertText) MarshalJSON() ([]byte, error)

func (*InlineCompletionItemInsertText) UnmarshalJSON 

func (u *InlineCompletionItemInsertText) UnmarshalJSON(data []byte) error

type InlineCompletionList 

type InlineCompletionList struct {
	// The inline completion items
	Items []InlineCompletionItem `json:"items"`
}

Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.

@since 3.18.0

type InlineCompletionOptions 

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

Inline completion options used during static registration.

@since 3.18.0

type InlineCompletionParams 

type InlineCompletionParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// Additional information about the context in which inline completions were requested.
	Context InlineCompletionContext `json:"context"`
}

A parameter literal used in inline completion requests.

@since 3.18.0

type InlineCompletionRegistrationOptions 

type InlineCompletionRegistrationOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// 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"`
	// 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"`
}

Inline completion options used during static or dynamic registration.

@since 3.18.0

type InlineCompletionResult 

type InlineCompletionResult struct {
	InlineCompletionList        *InlineCompletionList   `json:"-"`
	ArrayOfInlineCompletionItem *[]InlineCompletionItem `json:"-"`
	RawMessage                  *json.RawMessage        `json:"-"`
}

func (InlineCompletionResult) MarshalJSON 

func (u InlineCompletionResult) MarshalJSON() ([]byte, error)

func (*InlineCompletionResult) UnmarshalJSON 

func (u *InlineCompletionResult) UnmarshalJSON(data []byte) error

type InlineCompletionTriggerKind 

type InlineCompletionTriggerKind uint32

Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.

@since 3.18.0 

const (
	// Completion was triggered explicitly by a user gesture.
	InlineCompletionTriggerKindInvoked InlineCompletionTriggerKind = 1
	// Completion was triggered automatically while editing.
	InlineCompletionTriggerKindAutomatic InlineCompletionTriggerKind = 2
)

type InlineValue 

type InlineValue struct {
	Text                  *InlineValueText                  `json:"-"`
	VariableLookup        *InlineValueVariableLookup        `json:"-"`
	EvaluatableExpression *InlineValueEvaluatableExpression `json:"-"`
}

Inline value information can be provided by different means: - directly as a text value (class InlineValueText). - as a name to use for a variable lookup (class InlineValueVariableLookup) - as an evaluatable expression (class InlineValueEvaluatableExpression) The InlineValue types combines all inline value types into one type.

@since 3.17.0

func (InlineValue) MarshalJSON 

func (u InlineValue) MarshalJSON() ([]byte, error)

func (*InlineValue) UnmarshalJSON 

func (u *InlineValue) UnmarshalJSON(data []byte) error

type InlineValueClientCapabilities 

type InlineValueClientCapabilities struct {
	// Whether implementation supports dynamic registration for inline value providers.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

Client capabilities specific to inline values.

@since 3.17.0

type InlineValueContext 

type InlineValueContext struct {
	// The stack frame (as a DAP Id) where the execution has stopped.
	FrameID int32 `json:"frameId"`
	// The document range where execution has stopped. Typically the end position of the range denotes the line where the inline values are shown.
	StoppedLocation Range `json:"stoppedLocation"`
}

@since 3.17.0

type InlineValueEvaluatableExpression 

type InlineValueEvaluatableExpression struct {
	// The document range for which the inline value applies.  The range could be used to extract the evaluatable expression from the underlying document.
	Range Range `json:"range"`
	// If specified the expression could be evaluated instead.
	Expression *string `json:"expression,omitempty"`
}

To compute an inline value through an expression evaluation.

If only a range is specified, the expression should be extracted from the underlying document.

An optional expression could be evaluated instead of the extracted expression.

@since 3.17.0

type InlineValueOptions 

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

Inline value options used during static registration.

@since 3.17.0

type InlineValueParams 

type InlineValueParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The document range for which inline values information will be returned.
	Range Range `json:"range"`
	// Additional information about the context in which inline values information was requested.
	Context InlineValueContext `json:"context"`
}

A parameter literal used in inline value requests.

@since 3.17.0

type InlineValueRegistrationOptions 

type InlineValueRegistrationOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// 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"`
	// 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"`
}

Inline value options used during static or dynamic registration.

@since 3.17.0

type InlineValueText 

type InlineValueText struct {
	// The document range for which the inline value applies.
	Range Range `json:"range"`
	// The text of the inline value.
	Text string `json:"text"`
}

Returns inline value information as the complete text to be shown.

@since 3.17.0

type InlineValueVariableLookup 

type InlineValueVariableLookup struct {
	// The document range for which the inline value applies.  The range could be used to extract the variable name from the underlying document.
	Range Range `json:"range"`
	// If specified the name of the variable to look up.
	VariableName *string `json:"variableName,omitempty"`
	// How to perform the lookup.
	CaseSensitiveLookup bool `json:"caseSensitiveLookup"`
}

To compute inline value through a variable lookup.

If only a range is specified, the variable name should be extracted from the underlying document.

An optional variable name could be used to lookup instead of the extracted name.

@since 3.17.0

type InlineValueWorkspaceClientCapabilities 

type InlineValueWorkspaceClientCapabilities struct {
	// Whether the client implementation supports a refresh request sent from the server to the client.  Note that this event is global and will force the client to refresh all inline values currently shown. It should be used with absolute care and is useful for situation where a server for example detects a project wide change that requires such a calculation.
	RefreshSupport *bool `json:"refreshSupport,omitempty"`
}

Client workspace capabilities specific to inline values.

@since 3.17.0

type InsertReplaceEdit 

type InsertReplaceEdit struct {
	// The string to be inserted.
	NewText string `json:"newText"`
	// The range if the insert is requested
	Insert Range `json:"insert"`
	// The range if the replace is requested.
	Replace Range `json:"replace"`
}

A special text edit to provide an insert and a replace operation.

@since 3.16.0

type InsertTextFormat 

type InsertTextFormat uint32

Defines whether the insert text in a completion item should be interpreted as plain text or a snippet. 

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.  See also: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#snippet_syntax
	InsertTextFormatSnippet InsertTextFormat = 2
)

type InsertTextMode 

type InsertTextMode uint32

How whitespace and indentation is handled during completion item insertion.

@since 3.16.0 

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
)

type LSPAny 

type LSPAny struct {
	MapstringAny *map[string]any  `json:"-"`
	ArrayOfAny   *[]any           `json:"-"`
	String       *string          `json:"-"`
	Int32        *int32           `json:"-"`
	Uint32       *uint32          `json:"-"`
	Float64      *float64         `json:"-"`
	Bool         *bool            `json:"-"`
	RawMessage   *json.RawMessage `json:"-"`
}

The LSP any type. Please note that strictly speaking a property with the value `undefined` can't be converted into JSON preserving the property name. However for convenience it is allowed and assumed that all these properties are optional as well. @since 3.17.0

func (LSPAny) MarshalJSON 

func (u LSPAny) MarshalJSON() ([]byte, error)

func (*LSPAny) UnmarshalJSON 

func (u *LSPAny) UnmarshalJSON(data []byte) error

type LSPArray 

type LSPArray = []json.RawMessage

LSP arrays. @since 3.17.0

type LSPErrorCodes 

type LSPErrorCodes int32
const (
	// A request failed but it was syntactically correct, e.g the method name was known and the parameters were valid. The error message should contain human readable information about why the request failed.  @since 3.17.0
	LSPErrorCodesRequestFailed LSPErrorCodes = -32803
	// The server cancelled the request. This error code should only be used for requests that explicitly support being server cancellable.  @since 3.17.0
	LSPErrorCodesServerCancelled LSPErrorCodes = -32802
	// The server detected that the content of a document got modified outside normal conditions. A server should NOT send this error code if it detects a content change in it unprocessed messages. The result even computed on an older state might still be useful for the client.  If a client decides that a result is not of any use anymore the client should cancel the request.
	LSPErrorCodesContentModified LSPErrorCodes = -32801
	// The client has canceled a request and a server has detected the cancel.
	LSPErrorCodesRequestCancelled LSPErrorCodes = -32800
)

type LSPObject 

type LSPObject = map[string]json.RawMessage

LSP object definition. @since 3.17.0

type LanguageKind 

type LanguageKind string

Predefined Language kinds @since 3.18.0 

const (
	LanguageKindABAP         LanguageKind = "abap"
	LanguageKindWindowsBat   LanguageKind = "bat"
	LanguageKindBibTeX       LanguageKind = "bibtex"
	LanguageKindClojure      LanguageKind = "clojure"
	LanguageKindCoffeescript LanguageKind = "coffeescript"
	LanguageKindC            LanguageKind = "c"
	LanguageKindCPP          LanguageKind = "cpp"
	LanguageKindCSharp       LanguageKind = "csharp"
	LanguageKindCSS          LanguageKind = "css"
	// @since 3.18.0
	LanguageKindD LanguageKind = "d"
	// @since 3.18.0
	LanguageKindDelphi          LanguageKind = "pascal"
	LanguageKindDiff            LanguageKind = "diff"
	LanguageKindDart            LanguageKind = "dart"
	LanguageKindDockerfile      LanguageKind = "dockerfile"
	LanguageKindElixir          LanguageKind = "elixir"
	LanguageKindErlang          LanguageKind = "erlang"
	LanguageKindFSharp          LanguageKind = "fsharp"
	LanguageKindGitCommit       LanguageKind = "git-commit"
	LanguageKindGitRebase       LanguageKind = "git-rebase"
	LanguageKindGo              LanguageKind = "go"
	LanguageKindGroovy          LanguageKind = "groovy"
	LanguageKindHandlebars      LanguageKind = "handlebars"
	LanguageKindHaskell         LanguageKind = "haskell"
	LanguageKindHTML            LanguageKind = "html"
	LanguageKindIni             LanguageKind = "ini"
	LanguageKindJava            LanguageKind = "java"
	LanguageKindJavaScript      LanguageKind = "javascript"
	LanguageKindJavaScriptReact LanguageKind = "javascriptreact"
	LanguageKindJSON            LanguageKind = "json"
	LanguageKindLaTeX           LanguageKind = "latex"
	LanguageKindLess            LanguageKind = "less"
	LanguageKindLua             LanguageKind = "lua"
	LanguageKindMakefile        LanguageKind = "makefile"
	LanguageKindMarkdown        LanguageKind = "markdown"
	LanguageKindObjectiveC      LanguageKind = "objective-c"
	LanguageKindObjectiveCPP    LanguageKind = "objective-cpp"
	// @since 3.18.0
	LanguageKindPascal          LanguageKind = "pascal"
	LanguageKindPerl            LanguageKind = "perl"
	LanguageKindPerl6           LanguageKind = "perl6"
	LanguageKindPHP             LanguageKind = "php"
	LanguageKindPlaintext       LanguageKind = "plaintext"
	LanguageKindPowershell      LanguageKind = "powershell"
	LanguageKindPug             LanguageKind = "jade"
	LanguageKindPython          LanguageKind = "python"
	LanguageKindR               LanguageKind = "r"
	LanguageKindRazor           LanguageKind = "razor"
	LanguageKindRuby            LanguageKind = "ruby"
	LanguageKindRust            LanguageKind = "rust"
	LanguageKindSCSS            LanguageKind = "scss"
	LanguageKindSASS            LanguageKind = "sass"
	LanguageKindScala           LanguageKind = "scala"
	LanguageKindShaderLab       LanguageKind = "shaderlab"
	LanguageKindShellScript     LanguageKind = "shellscript"
	LanguageKindSQL             LanguageKind = "sql"
	LanguageKindSwift           LanguageKind = "swift"
	LanguageKindTypeScript      LanguageKind = "typescript"
	LanguageKindTypeScriptReact LanguageKind = "typescriptreact"
	LanguageKindTeX             LanguageKind = "tex"
	LanguageKindVisualBasic     LanguageKind = "vb"
	LanguageKindXML             LanguageKind = "xml"
	LanguageKindXSL             LanguageKind = "xsl"
	LanguageKindYAML            LanguageKind = "yaml"
)

type LinkedEditingRangeClientCapabilities 

type LinkedEditingRangeClientCapabilities struct {
	// Whether implementation supports dynamic registration. If this is set to `true` the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

Client capabilities for the linked editing range request.

@since 3.16.0

type LinkedEditingRangeOptions 

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

type LinkedEditingRangeParams 

type LinkedEditingRangeParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
}

type LinkedEditingRangeRegistrationOptions 

type LinkedEditingRangeRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// 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"`
}

type LinkedEditingRanges 

type LinkedEditingRanges struct {
	// A list of ranges that can be edited together. The ranges must have identical length and contain identical text content. The ranges cannot overlap.
	Ranges []Range `json:"ranges"`
	// An optional word pattern (regular expression) that describes valid contents for the given ranges. If no pattern is provided, the client configuration's word pattern will be used.
	WordPattern *string `json:"wordPattern,omitempty"`
}

The result of a linked editing range request.

@since 3.16.0

type Location 

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

Represents a location inside a resource, such as a line inside a text file. 

type LocationLink struct {
	// Span of the origin of this link.  Used as the underlined span for mouse interaction. Defaults to the word range at the definition position.
	OriginSelectionRange *Range `json:"originSelectionRange,omitempty"`
	// The target resource identifier of this link.
	TargetURI string `json:"targetUri"`
	// The full target range of this link. If the target for example is a symbol then target range is the range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to highlight the range in the editor.
	TargetRange Range `json:"targetRange"`
	// The range that should be selected and revealed when this link is being followed, e.g the name of a function. Must be contained by the `targetRange`. See also `DocumentSymbol#range`
	TargetSelectionRange Range `json:"targetSelectionRange"`
}

Represents the connection of two locations. Provides additional metadata over normal {@link Location locations}, including an origin range.

type LocationUriOnly 

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

Location with only uri and does not include range.

@since 3.18.0

type LogMessageParams 

type LogMessageParams struct {
	// The message type. See {@link MessageType}
	Type MessageType `json:"type"`
	// The actual message.
	Message string `json:"message"`
}

The log message parameters.

type LogTraceParams 

type LogTraceParams struct {
	Message string  `json:"message"`
	Verbose *string `json:"verbose,omitempty"`
}

type MarkdownClientCapabilities 

type MarkdownClientCapabilities struct {
	// The name of the parser.
	Parser string `json:"parser"`
	// The version of the parser.
	Version *string `json:"version,omitempty"`
	// A list of HTML tags that the client allows / supports in Markdown.  @since 3.17.0
	AllowedTags []string `json:"allowedTags,omitempty"`
}

Client capabilities specific to the used markdown parser.

@since 3.16.0

type MarkedString 

type MarkedString struct {
	String       *string                   `json:"-"`
	WithLanguage *MarkedStringWithLanguage `json:"-"`
}

MarkedString can be used to render human readable text. It is either a markdown string or a code-block that provides a language and a code snippet. The language identifier is semantically equal to the optional language identifier in fenced code blocks in GitHub issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting

The pair of a language and a value is an equivalent to markdown: ```${language} ${value} ```

Note that markdown strings will be sanitized - that means html will be escaped. @deprecated use MarkupContent instead.

func (MarkedString) MarshalJSON 

func (u MarkedString) MarshalJSON() ([]byte, error)

func (*MarkedString) UnmarshalJSON 

func (u *MarkedString) UnmarshalJSON(data []byte) error

type MarkedStringWithLanguage 

type MarkedStringWithLanguage struct {
	Language string `json:"language"`
	Value    string `json:"value"`
}

@since 3.18.0 @deprecated use MarkupContent instead.

type MarkupContent 

type MarkupContent struct {
	// The type of the Markup
	Kind MarkupKind `json:"kind"`
	// The content itself
	Value string `json:"value"`
}

A `MarkupContent` literal represents a string value which content is interpreted base on its kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.

If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting

Here is an example how such a string can be constructed using JavaScript / TypeScript: ```ts 

let markdown: MarkdownContent = {
 kind: MarkupKind.Markdown,
 value: [
   '# Header',
   'Some text',
   '```typescript',
   'someCode();',
   '```'
 ].join('\n')
};

```

*Please Note* that clients might sanitize the return markdown. A client could decide to remove HTML from the markdown to avoid script execution.

type MarkupKind 

type MarkupKind string

Describes the content type that a client supports in various result literals like `Hover`, `ParameterInfo` or `CompletionItem`.

Please note that `MarkupKinds` must not start with a `$`. This kinds are reserved for internal usage. 

const (
	// Plain text is supported as a content format
	MarkupKindPlainText MarkupKind = "plaintext"
	// Markdown is supported as a content format
	MarkupKindMarkdown MarkupKind = "markdown"
)

type MessageActionItem 

type MessageActionItem struct {
	// A short title like 'Retry', 'Open Log' etc.
	Title string `json:"title"`
}

type MessageType 

type MessageType uint32

The message type 

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
	// A debug message.  @since 3.18.0
	MessageTypeDebug MessageType = 5
)

type MethodInfo 

type MethodInfo struct {
	Method           string
	ServerCapability Capability
	Direction        string
}

type Moniker 

type Moniker struct {
	// The scheme of the moniker. For example tsc or .Net
	Scheme string `json:"scheme"`
	// The identifier of the moniker. The value is opaque in LSIF however schema owners are allowed to define the structure if they want.
	Identifier string `json:"identifier"`
	// The scope in which the moniker is unique
	Unique UniquenessLevel `json:"unique"`
	// The moniker kind if known.
	Kind *MonikerKind `json:"kind,omitempty"`
}

Moniker definition to match LSIF 0.5 moniker definition.

@since 3.16.0

type MonikerClientCapabilities 

type MonikerClientCapabilities struct {
	// Whether moniker supports dynamic registration. If this is set to `true` the client supports the new `MonikerRegistrationOptions` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

Client capabilities specific to the moniker request.

@since 3.16.0

type MonikerKind 

type MonikerKind string

The moniker kind.

@since 3.16.0 

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"
)

type MonikerOptions 

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

type MonikerParams 

type MonikerParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
}

type MonikerRegistrationOptions 

type MonikerRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
}

type NotebookCell 

type NotebookCell struct {
	// The cell's kind
	Kind NotebookCellKind `json:"kind"`
	// The URI of the cell's text document content.
	Document string `json:"document"`
	// Additional metadata stored with the cell.  Note: should always be an object literal (e.g. LSPObject)
	Metadata map[string]any `json:"metadata,omitempty"`
	// Additional execution summary information if supported by the client.
	ExecutionSummary *ExecutionSummary `json:"executionSummary,omitempty"`
}

A notebook cell.

A cell's document URI must be unique across ALL notebook cells and can therefore be used to uniquely identify a notebook cell or the cell's text document.

@since 3.17.0

type NotebookCellArrayChange 

type NotebookCellArrayChange struct {
	// The start oftest of the cell that changed.
	Start uint32 `json:"start"`
	// The deleted cells
	DeleteCount uint32 `json:"deleteCount"`
	// The new cells, if any
	Cells []NotebookCell `json:"cells,omitempty"`
}

A change describing how to move a `NotebookCell` array from state S to S'.

@since 3.17.0

type NotebookCellKind 

type NotebookCellKind uint32

A notebook cell kind.

@since 3.17.0 

const (
	// A markup-cell is formatted source that is used for display.
	NotebookCellKindMarkup NotebookCellKind = 1
	// A code-cell is source code.
	NotebookCellKindCode NotebookCellKind = 2
)

type NotebookCellLanguage 

type NotebookCellLanguage struct {
	Language string `json:"language"`
}

@since 3.18.0

type NotebookCellTextDocumentFilter 

type NotebookCellTextDocumentFilter struct {
	// A filter that matches against the notebook containing the notebook cell. If a string value is provided it matches against the notebook type. '*' matches every notebook.
	Notebook NotebookCellTextDocumentFilterNotebook `json:"notebook"`
	// A language id like `python`.  Will be matched against the language id of the notebook cell document. '*' matches every language.
	Language *string `json:"language,omitempty"`
}

A notebook cell text document filter denotes a cell text document by different properties.

@since 3.17.0

type NotebookCellTextDocumentFilterNotebook 

type NotebookCellTextDocumentFilterNotebook struct {
	String                 *string                 `json:"-"`
	NotebookDocumentFilter *NotebookDocumentFilter `json:"-"`
}

func (NotebookCellTextDocumentFilterNotebook) MarshalJSON 

func (u NotebookCellTextDocumentFilterNotebook) MarshalJSON() ([]byte, error)

func (*NotebookCellTextDocumentFilterNotebook) UnmarshalJSON 

func (u *NotebookCellTextDocumentFilterNotebook) UnmarshalJSON(data []byte) error

type NotebookDocument 

type NotebookDocument struct {
	// The notebook document's uri.
	URI string `json:"uri"`
	// The type of the notebook.
	NotebookType string `json:"notebookType"`
	// The version number of this document (it will increase after each change, including undo/redo).
	Version int32 `json:"version"`
	// Additional metadata stored with the notebook document.  Note: should always be an object literal (e.g. LSPObject)
	Metadata map[string]any `json:"metadata,omitempty"`
	// The cells of a notebook.
	Cells []NotebookCell `json:"cells"`
}

A notebook document.

@since 3.17.0

type NotebookDocumentCellChangeStructure 

type NotebookDocumentCellChangeStructure struct {
	// The change to the cell array.
	Array NotebookCellArrayChange `json:"array"`
	// Additional opened cell text documents.
	DidOpen []TextDocumentItem `json:"didOpen,omitempty"`
	// Additional closed cell text documents.
	DidClose []TextDocumentIdentifier `json:"didClose,omitempty"`
}

Structural changes to cells in a notebook document.

@since 3.18.0

type NotebookDocumentCellChanges 

type NotebookDocumentCellChanges struct {
	// Changes to the cell structure to add or remove cells.
	Structure *NotebookDocumentCellChangeStructure `json:"structure,omitempty"`
	// Changes to notebook cells properties like its kind, execution summary or metadata.
	Data []NotebookCell `json:"data,omitempty"`
	// Changes to the text content of notebook cells.
	TextContent []NotebookDocumentCellContentChanges `json:"textContent,omitempty"`
}

Cell changes to a notebook document.

@since 3.18.0

type NotebookDocumentCellContentChanges 

type NotebookDocumentCellContentChanges struct {
	Document VersionedTextDocumentIdentifier  `json:"document"`
	Changes  []TextDocumentContentChangeEvent `json:"changes"`
}

Content changes to a cell in a notebook document.

@since 3.18.0

type NotebookDocumentChangeEvent 

type NotebookDocumentChangeEvent struct {
	// The changed meta data if any.  Note: should always be an object literal (e.g. LSPObject)
	Metadata map[string]any `json:"metadata,omitempty"`
	// Changes to cells
	Cells *NotebookDocumentCellChanges `json:"cells,omitempty"`
}

A change event for a notebook document.

@since 3.17.0

type NotebookDocumentClientCapabilities 

type NotebookDocumentClientCapabilities struct {
	// Capabilities specific to notebook document synchronization  @since 3.17.0
	Synchronization NotebookDocumentSyncClientCapabilities `json:"synchronization"`
}

Capabilities specific to the notebook document support.

@since 3.17.0

type NotebookDocumentFilter 

type NotebookDocumentFilter struct {
	NotebookType *NotebookDocumentFilterNotebookType `json:"-"`
	Scheme       *NotebookDocumentFilterScheme       `json:"-"`
	Pattern      *NotebookDocumentFilterPattern      `json:"-"`
}

A notebook document filter denotes a notebook document by different properties. The properties will be match against the notebook's URI (same as with documents)

@since 3.17.0

func (NotebookDocumentFilter) MarshalJSON 

func (u NotebookDocumentFilter) MarshalJSON() ([]byte, error)

func (*NotebookDocumentFilter) UnmarshalJSON 

func (u *NotebookDocumentFilter) UnmarshalJSON(data []byte) error

type NotebookDocumentFilterNotebookType 

type NotebookDocumentFilterNotebookType struct {
	// The type of the enclosing notebook.
	NotebookType string `json:"notebookType"`
	// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
	Scheme *string `json:"scheme,omitempty"`
	// A glob pattern.
	Pattern *GlobPattern `json:"pattern,omitempty"`
}

A notebook document filter where `notebookType` is required field.

@since 3.18.0

type NotebookDocumentFilterPattern 

type NotebookDocumentFilterPattern struct {
	// The type of the enclosing notebook.
	NotebookType *string `json:"notebookType,omitempty"`
	// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
	Scheme *string `json:"scheme,omitempty"`
	// A glob pattern.
	Pattern GlobPattern `json:"pattern"`
}

A notebook document filter where `pattern` is required field.

@since 3.18.0

type NotebookDocumentFilterScheme 

type NotebookDocumentFilterScheme struct {
	// The type of the enclosing notebook.
	NotebookType *string `json:"notebookType,omitempty"`
	// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
	Scheme string `json:"scheme"`
	// A glob pattern.
	Pattern *GlobPattern `json:"pattern,omitempty"`
}

A notebook document filter where `scheme` is required field.

@since 3.18.0

type NotebookDocumentFilterWithCells 

type NotebookDocumentFilterWithCells struct {
	// The notebook to be synced If a string value is provided it matches against the notebook type. '*' matches every notebook.
	Notebook *NotebookDocumentFilterWithCellsNotebook `json:"notebook,omitempty"`
	// The cells of the matching notebook to be synced.
	Cells []NotebookCellLanguage `json:"cells"`
}

@since 3.18.0

type NotebookDocumentFilterWithCellsNotebook 

type NotebookDocumentFilterWithCellsNotebook struct {
	String                 *string                 `json:"-"`
	NotebookDocumentFilter *NotebookDocumentFilter `json:"-"`
}

func (NotebookDocumentFilterWithCellsNotebook) MarshalJSON 

func (u NotebookDocumentFilterWithCellsNotebook) MarshalJSON() ([]byte, error)

func (*NotebookDocumentFilterWithCellsNotebook) UnmarshalJSON 

func (u *NotebookDocumentFilterWithCellsNotebook) UnmarshalJSON(data []byte) error

type NotebookDocumentFilterWithNotebook 

type NotebookDocumentFilterWithNotebook struct {
	// The notebook to be synced If a string value is provided it matches against the notebook type. '*' matches every notebook.
	Notebook NotebookDocumentFilterWithNotebookNotebook `json:"notebook"`
	// The cells of the matching notebook to be synced.
	Cells []NotebookCellLanguage `json:"cells,omitempty"`
}

@since 3.18.0

type NotebookDocumentFilterWithNotebookNotebook 

type NotebookDocumentFilterWithNotebookNotebook struct {
	String                 *string                 `json:"-"`
	NotebookDocumentFilter *NotebookDocumentFilter `json:"-"`
}

func (NotebookDocumentFilterWithNotebookNotebook) MarshalJSON 

func (u NotebookDocumentFilterWithNotebookNotebook) MarshalJSON() ([]byte, error)

func (*NotebookDocumentFilterWithNotebookNotebook) UnmarshalJSON 

func (u *NotebookDocumentFilterWithNotebookNotebook) UnmarshalJSON(data []byte) error

type NotebookDocumentIdentifier 

type NotebookDocumentIdentifier struct {
	// The notebook document's uri.
	URI string `json:"uri"`
}

A literal to identify a notebook document in the client.

@since 3.17.0

type NotebookDocumentSyncClientCapabilities 

type NotebookDocumentSyncClientCapabilities struct {
	// Whether implementation supports dynamic registration. If this is set to `true` the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The client supports sending execution summary data per cell.
	ExecutionSummarySupport *bool `json:"executionSummarySupport,omitempty"`
}

Notebook specific client capabilities.

@since 3.17.0

type NotebookDocumentSyncOptions 

type NotebookDocumentSyncOptions struct {
	// The notebooks to be synced
	NotebookSelector []NotebookDocumentSyncOptionsNotebookSelectorItem `json:"notebookSelector"`
	// Whether save notification should be forwarded to the server. Will only be honored if mode === `notebook`.
	Save *bool `json:"save,omitempty"`
}

Options specific to a notebook plus its cells to be synced to the server.

If a selector provides a notebook document filter but no cell selector all cells of a matching notebook document will be synced.

If a selector provides no notebook document filter but only a cell selector all notebook document that contain at least one matching cell will be synced.

@since 3.17.0

type NotebookDocumentSyncOptionsNotebookSelectorItem 

type NotebookDocumentSyncOptionsNotebookSelectorItem struct {
	NotebookDocumentFilterWithNotebook *NotebookDocumentFilterWithNotebook `json:"-"`
	NotebookDocumentFilterWithCells    *NotebookDocumentFilterWithCells    `json:"-"`
}

func (NotebookDocumentSyncOptionsNotebookSelectorItem) MarshalJSON 

func (u NotebookDocumentSyncOptionsNotebookSelectorItem) MarshalJSON() ([]byte, error)

func (*NotebookDocumentSyncOptionsNotebookSelectorItem) UnmarshalJSON 

func (u *NotebookDocumentSyncOptionsNotebookSelectorItem) UnmarshalJSON(data []byte) error

type NotebookDocumentSyncRegistrationOptions 

type NotebookDocumentSyncRegistrationOptions struct {
	// The notebooks to be synced
	NotebookSelector []NotebookDocumentSyncRegistrationOptionsNotebookSelectorItem `json:"notebookSelector"`
	// Whether save notification should be forwarded to the server. Will only be honored if mode === `notebook`.
	Save *bool `json:"save,omitempty"`
	// 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"`
}

Registration options specific to a notebook.

@since 3.17.0

type NotebookDocumentSyncRegistrationOptionsNotebookSelectorItem 

type NotebookDocumentSyncRegistrationOptionsNotebookSelectorItem struct {
	NotebookDocumentFilterWithNotebook *NotebookDocumentFilterWithNotebook `json:"-"`
	NotebookDocumentFilterWithCells    *NotebookDocumentFilterWithCells    `json:"-"`
}

func (NotebookDocumentSyncRegistrationOptionsNotebookSelectorItem) MarshalJSON 

func (u NotebookDocumentSyncRegistrationOptionsNotebookSelectorItem) MarshalJSON() ([]byte, error)

func (*NotebookDocumentSyncRegistrationOptionsNotebookSelectorItem) UnmarshalJSON 

func (u *NotebookDocumentSyncRegistrationOptionsNotebookSelectorItem) UnmarshalJSON(data []byte) error

type OptionalVersionedTextDocumentIdentifier 

type OptionalVersionedTextDocumentIdentifier struct {
	// The text document's uri.
	URI string `json:"uri"`
	// The version number of this document. If a versioned text document identifier is sent from the server to the client and the file is not open in the editor (the server has not received an open notification before) the server can send `null` to indicate that the version is unknown and the content on disk is the truth (as specified with document content ownership).
	Version int32 `json:"version"`
}

A text document identifier to optionally denote a specific version of a text document.

type ParameterInformation 

type ParameterInformation struct {
	// The label of this parameter information.  Either a string or an inclusive start and exclusive end offsets within its containing signature label. (see SignatureInformation.label). The offsets are based on a UTF-16 string representation as `Position` and `Range` does.  To avoid ambiguities a server should use the [start, end] offset value instead of using a substring. Whether a client support this is controlled via `labelOffsetSupport` client capability.  *Note*: a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
	Label ParameterInformationLabel `json:"label"`
	// The human-readable doc-comment of this parameter. Will be shown in the UI but can be omitted.
	Documentation *ParameterInformationDocumentation `json:"documentation,omitempty"`
}

Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.

type ParameterInformationDocumentation 

type ParameterInformationDocumentation struct {
	String        *string        `json:"-"`
	MarkupContent *MarkupContent `json:"-"`
}

func (ParameterInformationDocumentation) MarshalJSON 

func (u ParameterInformationDocumentation) MarshalJSON() ([]byte, error)

func (*ParameterInformationDocumentation) UnmarshalJSON 

func (u *ParameterInformationDocumentation) UnmarshalJSON(data []byte) error

type ParameterInformationLabel 

type ParameterInformationLabel struct {
	String            *string            `json:"-"`
	ArrayOfRawMessage *[]json.RawMessage `json:"-"`
}

func (ParameterInformationLabel) MarshalJSON 

func (u ParameterInformationLabel) MarshalJSON() ([]byte, error)

func (*ParameterInformationLabel) UnmarshalJSON 

func (u *ParameterInformationLabel) UnmarshalJSON(data []byte) error

type PartialResultParams 

type PartialResultParams struct {
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
}

type Pattern 

type Pattern = string

The glob pattern to watch relative to the base path. Glob patterns can have the following syntax: - `*` to match zero or more characters in a path segment - `?` to match on one character in a path segment - `**` to match any number of path segments, including none - `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files) - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …) - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)

@since 3.17.0

type Position 

type Position struct {
	// Line position in a document (zero-based).
	Line uint32 `json:"line"`
	// Character offset on a line in a document (zero-based).  The meaning of this offset is determined by the negotiated `PositionEncodingKind`.
	Character uint32 `json:"character"`
}

Position in a text document expressed as zero-based line and character offset. Prior to 3.17 the offsets were always based on a UTF-16 string representation. So a string of the form `a𐐀b` the character offset of the character `a` is 0, the character offset of `𐐀` is 1 and the character offset of b is 3 since `𐐀` is represented using two code units in UTF-16. Since 3.17 clients and servers can agree on a different string encoding representation (e.g. UTF-8). The client announces it's supported encoding via the client capability [`general.positionEncodings`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#clientCapabilities). The value is an array of position encodings the client supports, with decreasing preference (e.g. the encoding at index `0` is the most preferred one). To stay backwards compatible the only mandatory encoding is UTF-16 represented via the string `utf-16`. The server can pick one of the encodings offered by the client and signals that encoding back to the client via the initialize result's property [`capabilities.positionEncoding`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#serverCapabilities). If the string value `utf-16` is missing from the client's capability `general.positionEncodings` servers can safely assume that the client supports UTF-16. If the server omits the position encoding in its initialize result the encoding defaults to the string value `utf-16`. Implementation considerations: since the conversion from one encoding into another requires the content of the file / line the conversion is best done where the file is read which is usually on the server side.

Positions are line end character agnostic. So you can not specify a position that denotes `\r|\n` or `\n|` where `|` represents the character offset.

@since 3.17.0 - support for negotiated position encoding.

type PositionEncodingKind 

type PositionEncodingKind string

A set of predefined position encoding kinds.

@since 3.17.0 

const (
	// Character offsets count UTF-8 code units (e.g. bytes).
	PositionEncodingKindUTF8 PositionEncodingKind = "utf-8"
	// Character offsets count UTF-16 code units.  This is the default and must always be supported by servers
	PositionEncodingKindUTF16 PositionEncodingKind = "utf-16"
	// Character offsets count UTF-32 code units.  Implementation note: these are the same as Unicode codepoints, so this `PositionEncodingKind` may also be used for an encoding-agnostic representation of character offsets.
	PositionEncodingKindUTF32 PositionEncodingKind = "utf-32"
)

type PrepareRenameDefaultBehavior 

type PrepareRenameDefaultBehavior struct {
	DefaultBehavior bool `json:"defaultBehavior"`
}

@since 3.18.0

type PrepareRenameParams 

type PrepareRenameParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
}

type PrepareRenamePlaceholder 

type PrepareRenamePlaceholder struct {
	Range       Range  `json:"range"`
	Placeholder string `json:"placeholder"`
}

@since 3.18.0

type PrepareRenameResult 

type PrepareRenameResult struct {
	Range                        *Range                        `json:"-"`
	PrepareRenamePlaceholder     *PrepareRenamePlaceholder     `json:"-"`
	PrepareRenameDefaultBehavior *PrepareRenameDefaultBehavior `json:"-"`
}

func (PrepareRenameResult) MarshalJSON 

func (u PrepareRenameResult) MarshalJSON() ([]byte, error)

func (*PrepareRenameResult) UnmarshalJSON 

func (u *PrepareRenameResult) UnmarshalJSON(data []byte) error

type PrepareSupportDefaultBehavior 

type PrepareSupportDefaultBehavior uint32
const (
	// The client's default behavior is to select the identifier according the to language's syntax rule.
	PrepareSupportDefaultBehaviorIdentifier PrepareSupportDefaultBehavior = 1
)

type PreviousResultId 

type PreviousResultId struct {
	// The URI for which the client knowns a result id.
	URI string `json:"uri"`
	// The value of the previous result id.
	Value string `json:"value"`
}

A previous result id in a workspace pull request.

@since 3.17.0

type ProgressParams 

type ProgressParams struct {
	// The progress token provided by the client or server.
	Token ProgressToken `json:"token"`
	// The progress data.
	Value json.RawMessage `json:"value"`
}

type ProgressToken 

type ProgressToken struct {
	Int32  *int32  `json:"-"`
	String *string `json:"-"`
}

func (ProgressToken) MarshalJSON 

func (u ProgressToken) MarshalJSON() ([]byte, error)

func (*ProgressToken) UnmarshalJSON 

func (u *ProgressToken) UnmarshalJSON(data []byte) error

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 *ClientDiagnosticsTagOptions `json:"tagSupport,omitempty"`
	// Client supports a codeDescription property  @since 3.16.0
	CodeDescriptionSupport *bool `json:"codeDescriptionSupport,omitempty"`
	// Whether code action supports the `data` property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request.  @since 3.16.0
	DataSupport *bool `json:"dataSupport,omitempty"`
	// Whether the client interprets the version property of the `textDocument/publishDiagnostics` notification's parameter.  @since 3.15.0
	VersionSupport *bool `json:"versionSupport,omitempty"`
}

The publish diagnostic client capabilities.

type PublishDiagnosticsParams 

type PublishDiagnosticsParams struct {
	// The URI for which diagnostic information is reported.
	URI string `json:"uri"`
	// Optional the version number of the document the diagnostics are published for.  @since 3.15.0
	Version *int32 `json:"version,omitempty"`
	// An array of diagnostic information items.
	Diagnostics []Diagnostic `json:"diagnostics"`
}

The publish diagnostic notification's parameters.

type Range 

type Range struct {
	// The range's start position.
	Start Position `json:"start"`
	// The range's end position.
	End Position `json:"end"`
}

A range in a text document expressed as (zero-based) start and end positions.

If you want to specify a range that contains a line including the line ending character(s) then use an end position denoting the start of the next line. For example: ```ts 

{
    start: { line: 5, character: 23 }
    end : { line 6, character : 0 }
}

```

type ReferenceClientCapabilities 

type ReferenceClientCapabilities struct {
	// Whether references supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

Client Capabilities for a {@link ReferencesRequest}.

type ReferenceContext 

type ReferenceContext struct {
	// Include the declaration of the current symbol.
	IncludeDeclaration bool `json:"includeDeclaration"`
}

Value-object that contains additional information when requesting references.

type ReferenceOptions 

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

Reference options.

type ReferenceParams 

type ReferenceParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken   `json:"partialResultToken,omitempty"`
	Context            ReferenceContext `json:"context"`
}

Parameters for a {@link ReferencesRequest}.

type ReferenceRegistrationOptions 

type ReferenceRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
}

Registration options for a {@link ReferencesRequest}.

type Registration 

type Registration struct {
	// The id used to register the request. The id can be used to deregister the request again.
	ID string `json:"id"`
	// The method / capability to register for.
	Method string `json:"method"`
	// Options necessary for the registration.
	RegisterOptions *json.RawMessage `json:"registerOptions,omitempty"`
}

General parameters to register for a notification or to register a provider.

type RegistrationParams 

type RegistrationParams struct {
	Registrations []Registration `json:"registrations"`
}

type RegularExpressionEngineKind 

type RegularExpressionEngineKind = string

type RegularExpressionsClientCapabilities 

type RegularExpressionsClientCapabilities struct {
	// The engine's name.
	Engine RegularExpressionEngineKind `json:"engine"`
	// The engine's version.
	Version *string `json:"version,omitempty"`
}

Client capabilities specific to regular expressions.

@since 3.16.0

type RelatedFullDocumentDiagnosticReport 

type RelatedFullDocumentDiagnosticReport struct {
	// A full document diagnostic report.
	Kind string `json:"kind"`
	// An optional result id. If provided it will be sent on the next diagnostic request for the same document.
	ResultID *string `json:"resultId,omitempty"`
	// The actual items.
	Items []Diagnostic `json:"items"`
	// Diagnostics of related documents. This information is useful in programming languages where code in a file A can generate diagnostics in a file B which A depends on. An example of such a language is C/C++ where marco definitions in a file a.cpp and result in errors in a header file b.hpp.  @since 3.17.0
	RelatedDocuments map[string]RelatedFullDocumentDiagnosticReportRelatedDocumentsValue `json:"relatedDocuments,omitempty"`
}

A full diagnostic report with a set of related documents.

@since 3.17.0

type RelatedFullDocumentDiagnosticReportRelatedDocumentsValue 

type RelatedFullDocumentDiagnosticReportRelatedDocumentsValue struct {
	FullDocumentDiagnosticReport      *FullDocumentDiagnosticReport      `json:"-"`
	UnchangedDocumentDiagnosticReport *UnchangedDocumentDiagnosticReport `json:"-"`
}

func (RelatedFullDocumentDiagnosticReportRelatedDocumentsValue) MarshalJSON 

func (u RelatedFullDocumentDiagnosticReportRelatedDocumentsValue) MarshalJSON() ([]byte, error)

func (*RelatedFullDocumentDiagnosticReportRelatedDocumentsValue) UnmarshalJSON 

func (u *RelatedFullDocumentDiagnosticReportRelatedDocumentsValue) UnmarshalJSON(data []byte) error

type RelatedUnchangedDocumentDiagnosticReport 

type RelatedUnchangedDocumentDiagnosticReport struct {
	// A document diagnostic report indicating no changes to the last result. A server can only return `unchanged` if result ids are provided.
	Kind string `json:"kind"`
	// A result id which will be sent on the next diagnostic request for the same document.
	ResultID string `json:"resultId"`
	// Diagnostics of related documents. This information is useful in programming languages where code in a file A can generate diagnostics in a file B which A depends on. An example of such a language is C/C++ where marco definitions in a file a.cpp and result in errors in a header file b.hpp.  @since 3.17.0
	RelatedDocuments map[string]RelatedUnchangedDocumentDiagnosticReportRelatedDocumentsValue `json:"relatedDocuments,omitempty"`
}

An unchanged diagnostic report with a set of related documents.

@since 3.17.0

type RelatedUnchangedDocumentDiagnosticReportRelatedDocumentsValue 

type RelatedUnchangedDocumentDiagnosticReportRelatedDocumentsValue struct {
	FullDocumentDiagnosticReport      *FullDocumentDiagnosticReport      `json:"-"`
	UnchangedDocumentDiagnosticReport *UnchangedDocumentDiagnosticReport `json:"-"`
}

func (RelatedUnchangedDocumentDiagnosticReportRelatedDocumentsValue) MarshalJSON 

func (u RelatedUnchangedDocumentDiagnosticReportRelatedDocumentsValue) MarshalJSON() ([]byte, error)

func (*RelatedUnchangedDocumentDiagnosticReportRelatedDocumentsValue) UnmarshalJSON 

func (u *RelatedUnchangedDocumentDiagnosticReportRelatedDocumentsValue) UnmarshalJSON(data []byte) error

type RelativePattern 

type RelativePattern struct {
	// A workspace folder or a base URI to which this pattern will be matched against relatively.
	BaseURI RelativePatternBaseURI `json:"baseUri"`
	// The actual glob pattern;
	Pattern Pattern `json:"pattern"`
}

A relative pattern is a helper to construct glob patterns that are matched relatively to a base URI. The common value for a `baseUri` is a workspace folder root, but it can be another absolute URI as well.

@since 3.17.0

type RelativePatternBaseURI 

type RelativePatternBaseURI struct {
	WorkspaceFolder *WorkspaceFolder `json:"-"`
	String          *string          `json:"-"`
}

func (RelativePatternBaseURI) MarshalJSON 

func (u RelativePatternBaseURI) MarshalJSON() ([]byte, error)

func (*RelativePatternBaseURI) UnmarshalJSON 

func (u *RelativePatternBaseURI) UnmarshalJSON(data []byte) error

type RenameClientCapabilities 

type RenameClientCapabilities struct {
	// Whether rename supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Client supports testing for validity of rename operations before execution.  @since 3.12.0
	PrepareSupport *bool `json:"prepareSupport,omitempty"`
	// Client supports the default behavior result.  The value indicates the default behavior used by the client.  @since 3.16.0
	PrepareSupportDefaultBehavior *PrepareSupportDefaultBehavior `json:"prepareSupportDefaultBehavior,omitempty"`
	// Whether the client honors the change annotations in text edits and resource operations returned via the rename request's workspace edit by for example presenting the workspace edit in the user interface and asking for confirmation.  @since 3.16.0
	HonorsChangeAnnotations *bool `json:"honorsChangeAnnotations,omitempty"`
}

type RenameFile 

type RenameFile struct {
	// The resource operation kind.
	Kind string `json:"kind"`
	// An optional annotation identifier describing the operation.  @since 3.16.0
	AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"`
	// The old (existing) location.
	OldURI string `json:"oldUri"`
	// The new location.
	NewURI string `json:"newUri"`
	// Rename options.
	Options *RenameFileOptions `json:"options,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 {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// Renames should be checked and tested before being executed.  @since version 3.12.0
	PrepareProvider *bool `json:"prepareProvider,omitempty"`
}

Provider options for a {@link RenameRequest}.

type RenameParams 

type RenameParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// The new name of the symbol. If the given name is not valid the request must return a {@link ResponseError} with an appropriate message set.
	NewName string `json:"newName"`
}

The parameters of a {@link RenameRequest}.

type RenameRegistrationOptions 

type RenameRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// Renames should be checked and tested before being executed.  @since version 3.12.0
	PrepareProvider *bool `json:"prepareProvider,omitempty"`
}

Registration options for a {@link RenameRequest}.

type ResourceOperation 

type ResourceOperation struct {
	// The resource operation kind.
	Kind string `json:"kind"`
	// An optional annotation identifier describing the operation.  @since 3.16.0
	AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"`
}

A generic resource operation.

type ResourceOperationKind 

type ResourceOperationKind string
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"
)

type SaveOptions 

type SaveOptions struct {
	// The client is supposed to include the content on save.
	IncludeText *bool `json:"includeText,omitempty"`
}

Save options.

type SelectedCompletionInfo 

type SelectedCompletionInfo struct {
	// The range that will be replaced if this completion item is accepted.
	Range Range `json:"range"`
	// The text the range will be replaced with if this completion is accepted.
	Text string `json:"text"`
}

Describes the currently selected completion item.

@since 3.18.0

type SelectionRange 

type SelectionRange struct {
	// The {@link Range range} of this selection range.
	Range Range `json:"range"`
	// The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.
	Parent *SelectionRange `json:"parent,omitempty"`
}

A selection range represents a part of a selection hierarchy. A selection range may have a parent selection range that contains it.

type SelectionRangeClientCapabilities 

type SelectionRangeClientCapabilities struct {
	// Whether implementation supports dynamic registration for selection range providers. If this is set to `true` the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

type SelectionRangeOptions 

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

type SelectionRangeParams 

type SelectionRangeParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The positions inside the text document.
	Positions []Position `json:"positions"`
}

A parameter literal used in selection range requests.

type SelectionRangeRegistrationOptions 

type SelectionRangeRegistrationOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// 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"`
	// 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"`
}

type SemanticTokenModifiers 

type SemanticTokenModifiers string

A set of predefined token modifiers. This set is not fixed an clients can specify additional token types via the corresponding client capabilities.

@since 3.16.0 

const (
	SemanticTokenModifiersDeclaration    SemanticTokenModifiers = "declaration"
	SemanticTokenModifiersDefinition     SemanticTokenModifiers = "definition"
	SemanticTokenModifiersReadonly       SemanticTokenModifiers = "readonly"
	SemanticTokenModifiersStatic         SemanticTokenModifiers = "static"
	SemanticTokenModifiersDeprecated     SemanticTokenModifiers = "deprecated"
	SemanticTokenModifiersAbstract       SemanticTokenModifiers = "abstract"
	SemanticTokenModifiersAsync          SemanticTokenModifiers = "async"
	SemanticTokenModifiersModification   SemanticTokenModifiers = "modification"
	SemanticTokenModifiersDocumentation  SemanticTokenModifiers = "documentation"
	SemanticTokenModifiersDefaultLibrary SemanticTokenModifiers = "defaultLibrary"
)

type SemanticTokenTypes 

type SemanticTokenTypes string

A set of predefined token types. This set is not fixed an clients can specify additional token types via the corresponding client capabilities.

@since 3.16.0 

const (
	SemanticTokenTypesNamespace SemanticTokenTypes = "namespace"
	// Represents a generic type. Acts as a fallback for types which can't be mapped to a specific type like class or enum.
	SemanticTokenTypesType          SemanticTokenTypes = "type"
	SemanticTokenTypesClass         SemanticTokenTypes = "class"
	SemanticTokenTypesEnum          SemanticTokenTypes = "enum"
	SemanticTokenTypesInterface     SemanticTokenTypes = "interface"
	SemanticTokenTypesStruct        SemanticTokenTypes = "struct"
	SemanticTokenTypesTypeParameter SemanticTokenTypes = "typeParameter"
	SemanticTokenTypesParameter     SemanticTokenTypes = "parameter"
	SemanticTokenTypesVariable      SemanticTokenTypes = "variable"
	SemanticTokenTypesProperty      SemanticTokenTypes = "property"
	SemanticTokenTypesEnumMember    SemanticTokenTypes = "enumMember"
	SemanticTokenTypesEvent         SemanticTokenTypes = "event"
	SemanticTokenTypesFunction      SemanticTokenTypes = "function"
	SemanticTokenTypesMethod        SemanticTokenTypes = "method"
	SemanticTokenTypesMacro         SemanticTokenTypes = "macro"
	SemanticTokenTypesKeyword       SemanticTokenTypes = "keyword"
	SemanticTokenTypesModifier      SemanticTokenTypes = "modifier"
	SemanticTokenTypesComment       SemanticTokenTypes = "comment"
	SemanticTokenTypesString        SemanticTokenTypes = "string"
	SemanticTokenTypesNumber        SemanticTokenTypes = "number"
	SemanticTokenTypesRegexp        SemanticTokenTypes = "regexp"
	SemanticTokenTypesOperator      SemanticTokenTypes = "operator"
	// @since 3.17.0
	SemanticTokenTypesDecorator SemanticTokenTypes = "decorator"
	// @since 3.18.0
	SemanticTokenTypesLabel SemanticTokenTypes = "label"
)

type SemanticTokens 

type SemanticTokens struct {
	// An optional result id. If provided and clients support delta updating the client will include the result id in the next semantic token request. A server can then instead of computing all semantic tokens again simply send a delta.
	ResultID *string `json:"resultId,omitempty"`
	// The actual tokens.
	Data []uint32 `json:"data"`
}

@since 3.16.0

type SemanticTokensClientCapabilities 

type SemanticTokensClientCapabilities struct {
	// Whether implementation supports dynamic registration. If this is set to `true` the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Which requests the client supports and might send to the server depending on the server's capability. Please note that clients might not show semantic tokens or degrade some of the user experience if a range or full request is advertised by the client but not provided by the server. If for example the client capability `requests.full` and `request.range` are both set to true but the server only provides a range provider the client might not render a minimap correctly or might even decide to not show any semantic tokens at all.
	Requests ClientSemanticTokensRequestOptions `json:"requests"`
	// The token types that the client supports.
	TokenTypes []string `json:"tokenTypes"`
	// The token modifiers that the client supports.
	TokenModifiers []string `json:"tokenModifiers"`
	// The token formats the clients supports.
	Formats []TokenFormat `json:"formats"`
	// Whether the client supports tokens that can overlap each other.
	OverlappingTokenSupport *bool `json:"overlappingTokenSupport,omitempty"`
	// Whether the client supports tokens that can span multiple lines.
	MultilineTokenSupport *bool `json:"multilineTokenSupport,omitempty"`
	// Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning LSPErrorCodes.ServerCancelled. If a server does the client needs to retrigger the request.  @since 3.17.0
	ServerCancelSupport *bool `json:"serverCancelSupport,omitempty"`
	// Whether the client uses semantic tokens to augment existing syntax tokens. If set to `true` client side created syntax tokens and semantic tokens are both used for colorization. If set to `false` the client only uses the returned semantic tokens for colorization.  If the value is `undefined` then the client behavior is not specified.  @since 3.17.0
	AugmentsSyntaxTokens *bool `json:"augmentsSyntaxTokens,omitempty"`
}

@since 3.16.0

type SemanticTokensDelta 

type SemanticTokensDelta struct {
	ResultID *string `json:"resultId,omitempty"`
	// The semantic token edits to transform a previous result into a new result.
	Edits []SemanticTokensEdit `json:"edits"`
}

@since 3.16.0

type SemanticTokensDeltaParams 

type SemanticTokensDeltaParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// 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"`
}

@since 3.16.0

type SemanticTokensDeltaPartialResult 

type SemanticTokensDeltaPartialResult struct {
	Edits []SemanticTokensEdit `json:"edits"`
}

@since 3.16.0

type SemanticTokensEdit 

type SemanticTokensEdit struct {
	// The start offset of the edit.
	Start uint32 `json:"start"`
	// The count of elements to remove.
	DeleteCount uint32 `json:"deleteCount"`
	// The elements to insert.
	Data []uint32 `json:"data,omitempty"`
}

@since 3.16.0

type SemanticTokensFullDelta 

type SemanticTokensFullDelta struct {
	// The server supports deltas for full documents.
	Delta *bool `json:"delta,omitempty"`
}

Semantic tokens options to support deltas for full documents

@since 3.18.0

type SemanticTokensFullDeltaResult 

type SemanticTokensFullDeltaResult struct {
	SemanticTokens      *SemanticTokens      `json:"-"`
	SemanticTokensDelta *SemanticTokensDelta `json:"-"`
	RawMessage          *json.RawMessage     `json:"-"`
}

func (SemanticTokensFullDeltaResult) MarshalJSON 

func (u SemanticTokensFullDeltaResult) MarshalJSON() ([]byte, error)

func (*SemanticTokensFullDeltaResult) UnmarshalJSON 

func (u *SemanticTokensFullDeltaResult) UnmarshalJSON(data []byte) error

type SemanticTokensLegend 

type SemanticTokensLegend struct {
	// The token types a server uses.
	TokenTypes []string `json:"tokenTypes"`
	// The token modifiers a server uses.
	TokenModifiers []string `json:"tokenModifiers"`
}

@since 3.16.0

type SemanticTokensOptions 

type SemanticTokensOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// The legend used by the server
	Legend SemanticTokensLegend `json:"legend"`
	// Server supports providing semantic tokens for a specific range of a document.
	Range *SemanticTokensOptionsRange `json:"range,omitempty"`
	// Server supports providing semantic tokens for a full document.
	Full *SemanticTokensOptionsFull `json:"full,omitempty"`
}

@since 3.16.0

type SemanticTokensOptionsFull 

type SemanticTokensOptionsFull struct {
	Bool                    *bool                    `json:"-"`
	SemanticTokensFullDelta *SemanticTokensFullDelta `json:"-"`
}

func (SemanticTokensOptionsFull) MarshalJSON 

func (u SemanticTokensOptionsFull) MarshalJSON() ([]byte, error)

func (*SemanticTokensOptionsFull) UnmarshalJSON 

func (u *SemanticTokensOptionsFull) UnmarshalJSON(data []byte) error

type SemanticTokensOptionsRange 

type SemanticTokensOptionsRange struct {
	Bool         *bool           `json:"-"`
	MapstringAny *map[string]any `json:"-"`
}

func (SemanticTokensOptionsRange) MarshalJSON 

func (u SemanticTokensOptionsRange) MarshalJSON() ([]byte, error)

func (*SemanticTokensOptionsRange) UnmarshalJSON 

func (u *SemanticTokensOptionsRange) UnmarshalJSON(data []byte) error

type SemanticTokensParams 

type SemanticTokensParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

@since 3.16.0

type SemanticTokensPartialResult 

type SemanticTokensPartialResult struct {
	Data []uint32 `json:"data"`
}

@since 3.16.0

type SemanticTokensRangeParams 

type SemanticTokensRangeParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The range the semantic tokens are requested for.
	Range Range `json:"range"`
}

@since 3.16.0

type SemanticTokensRegistrationOptions 

type SemanticTokensRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// The legend used by the server
	Legend SemanticTokensLegend `json:"legend"`
	// Server supports providing semantic tokens for a specific range of a document.
	Range *SemanticTokensRegistrationOptionsRange `json:"range,omitempty"`
	// Server supports providing semantic tokens for a full document.
	Full *SemanticTokensRegistrationOptionsFull `json:"full,omitempty"`
	// 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"`
}

@since 3.16.0

type SemanticTokensRegistrationOptionsFull 

type SemanticTokensRegistrationOptionsFull struct {
	Bool                    *bool                    `json:"-"`
	SemanticTokensFullDelta *SemanticTokensFullDelta `json:"-"`
}

func (SemanticTokensRegistrationOptionsFull) MarshalJSON 

func (u SemanticTokensRegistrationOptionsFull) MarshalJSON() ([]byte, error)

func (*SemanticTokensRegistrationOptionsFull) UnmarshalJSON 

func (u *SemanticTokensRegistrationOptionsFull) UnmarshalJSON(data []byte) error

type SemanticTokensRegistrationOptionsRange 

type SemanticTokensRegistrationOptionsRange struct {
	Bool         *bool           `json:"-"`
	MapstringAny *map[string]any `json:"-"`
}

func (SemanticTokensRegistrationOptionsRange) MarshalJSON 

func (u SemanticTokensRegistrationOptionsRange) MarshalJSON() ([]byte, error)

func (*SemanticTokensRegistrationOptionsRange) UnmarshalJSON 

func (u *SemanticTokensRegistrationOptionsRange) UnmarshalJSON(data []byte) error

type SemanticTokensWorkspaceClientCapabilities 

type SemanticTokensWorkspaceClientCapabilities struct {
	// Whether the client implementation supports a refresh request sent from the server to the client.  Note that this event is global and will force the client to refresh all semantic tokens currently shown. It should be used with absolute care and is useful for situation where a server for example detects a project wide change that requires such a calculation.
	RefreshSupport *bool `json:"refreshSupport,omitempty"`
}

@since 3.16.0

type Server 

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

Server is a multiplexing LSP Server that listens to editor client requests (e.g., over stdio) and handles them via a multiplexed Client.

func NewServer 

func NewServer(rwc io.ReadWriteCloser, client *Client) *Server

NewServer wraps the multiplexed Client in an LSP Server communicating over rwc.

func (*Server) Close 

func (s *Server) Close() error

Close closes the server connection.

func (*Server) Serve 

func (s *Server) Serve(ctx context.Context) error

Serve runs the server connection loop, blocking until the connection is closed.

type ServerCapabilities 

type ServerCapabilities struct {
	// The position encoding the server picked from the encodings offered by the client via the client capability `general.positionEncodings`.  If the client didn't provide any position encodings the only valid value that a server can return is 'utf-16'.  If omitted it defaults to 'utf-16'.  @since 3.17.0
	PositionEncoding *PositionEncodingKind `json:"positionEncoding,omitempty"`
	// Defines how text documents are synced. Is either a detailed structure defining each notification or for backwards compatibility the TextDocumentSyncKind number.
	TextDocumentSync *ServerCapabilitiesTextDocumentSync `json:"textDocumentSync,omitempty"`
	// Defines how notebook documents are synced.  @since 3.17.0
	NotebookDocumentSync *ServerCapabilitiesNotebookDocumentSync `json:"notebookDocumentSync,omitempty"`
	// The server provides completion support.
	CompletionProvider *CompletionOptions `json:"completionProvider,omitempty"`
	// The server provides hover support.
	HoverProvider *ServerCapabilitiesHoverProvider `json:"hoverProvider,omitempty"`
	// The server provides signature help support.
	SignatureHelpProvider *SignatureHelpOptions `json:"signatureHelpProvider,omitempty"`
	// The server provides Goto Declaration support.
	DeclarationProvider *ServerCapabilitiesDeclarationProvider `json:"declarationProvider,omitempty"`
	// The server provides goto definition support.
	DefinitionProvider *ServerCapabilitiesDefinitionProvider `json:"definitionProvider,omitempty"`
	// The server provides Goto Type Definition support.
	TypeDefinitionProvider *ServerCapabilitiesTypeDefinitionProvider `json:"typeDefinitionProvider,omitempty"`
	// The server provides Goto Implementation support.
	ImplementationProvider *ServerCapabilitiesImplementationProvider `json:"implementationProvider,omitempty"`
	// The server provides find references support.
	ReferencesProvider *ServerCapabilitiesReferencesProvider `json:"referencesProvider,omitempty"`
	// The server provides document highlight support.
	DocumentHighlightProvider *ServerCapabilitiesDocumentHighlightProvider `json:"documentHighlightProvider,omitempty"`
	// The server provides document symbol support.
	DocumentSymbolProvider *ServerCapabilitiesDocumentSymbolProvider `json:"documentSymbolProvider,omitempty"`
	// The server provides code actions. CodeActionOptions may only be specified if the client states that it supports `codeActionLiteralSupport` in its initial `initialize` request.
	CodeActionProvider *ServerCapabilitiesCodeActionProvider `json:"codeActionProvider,omitempty"`
	// The server provides code lens.
	CodeLensProvider *CodeLensOptions `json:"codeLensProvider,omitempty"`
	// The server provides document link support.
	DocumentLinkProvider *DocumentLinkOptions `json:"documentLinkProvider,omitempty"`
	// The server provides color provider support.
	ColorProvider *ServerCapabilitiesColorProvider `json:"colorProvider,omitempty"`
	// The server provides workspace symbol support.
	WorkspaceSymbolProvider *ServerCapabilitiesWorkspaceSymbolProvider `json:"workspaceSymbolProvider,omitempty"`
	// The server provides document formatting.
	DocumentFormattingProvider *ServerCapabilitiesDocumentFormattingProvider `json:"documentFormattingProvider,omitempty"`
	// The server provides document range formatting.
	DocumentRangeFormattingProvider *ServerCapabilitiesDocumentRangeFormattingProvider `json:"documentRangeFormattingProvider,omitempty"`
	// The server provides document formatting on typing.
	DocumentOnTypeFormattingProvider *DocumentOnTypeFormattingOptions `json:"documentOnTypeFormattingProvider,omitempty"`
	// The server provides rename support. RenameOptions may only be specified if the client states that it supports `prepareSupport` in its initial `initialize` request.
	RenameProvider *ServerCapabilitiesRenameProvider `json:"renameProvider,omitempty"`
	// The server provides folding provider support.
	FoldingRangeProvider *ServerCapabilitiesFoldingRangeProvider `json:"foldingRangeProvider,omitempty"`
	// The server provides selection range support.
	SelectionRangeProvider *ServerCapabilitiesSelectionRangeProvider `json:"selectionRangeProvider,omitempty"`
	// The server provides execute command support.
	ExecuteCommandProvider *ExecuteCommandOptions `json:"executeCommandProvider,omitempty"`
	// The server provides call hierarchy support.  @since 3.16.0
	CallHierarchyProvider *ServerCapabilitiesCallHierarchyProvider `json:"callHierarchyProvider,omitempty"`
	// The server provides linked editing range support.  @since 3.16.0
	LinkedEditingRangeProvider *ServerCapabilitiesLinkedEditingRangeProvider `json:"linkedEditingRangeProvider,omitempty"`
	// The server provides semantic tokens support.  @since 3.16.0
	SemanticTokensProvider *ServerCapabilitiesSemanticTokensProvider `json:"semanticTokensProvider,omitempty"`
	// The server provides moniker support.  @since 3.16.0
	MonikerProvider *ServerCapabilitiesMonikerProvider `json:"monikerProvider,omitempty"`
	// The server provides type hierarchy support.  @since 3.17.0
	TypeHierarchyProvider *ServerCapabilitiesTypeHierarchyProvider `json:"typeHierarchyProvider,omitempty"`
	// The server provides inline values.  @since 3.17.0
	InlineValueProvider *ServerCapabilitiesInlineValueProvider `json:"inlineValueProvider,omitempty"`
	// The server provides inlay hints.  @since 3.17.0
	InlayHintProvider *ServerCapabilitiesInlayHintProvider `json:"inlayHintProvider,omitempty"`
	// The server has support for pull model diagnostics.  @since 3.17.0
	DiagnosticProvider *ServerCapabilitiesDiagnosticProvider `json:"diagnosticProvider,omitempty"`
	// Inline completion options used during static registration.  @since 3.18.0
	InlineCompletionProvider *ServerCapabilitiesInlineCompletionProvider `json:"inlineCompletionProvider,omitempty"`
	// Workspace specific server capabilities.
	Workspace *WorkspaceOptions `json:"workspace,omitempty"`
	// Experimental server capabilities.
	Experimental *json.RawMessage `json:"experimental,omitempty"`
}

Defines the capabilities provided by a language server.

type ServerCapabilitiesCallHierarchyProvider 

type ServerCapabilitiesCallHierarchyProvider struct {
	Bool                             *bool                             `json:"-"`
	CallHierarchyOptions             *CallHierarchyOptions             `json:"-"`
	CallHierarchyRegistrationOptions *CallHierarchyRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesCallHierarchyProvider) MarshalJSON 

func (u ServerCapabilitiesCallHierarchyProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesCallHierarchyProvider) UnmarshalJSON 

func (u *ServerCapabilitiesCallHierarchyProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesCodeActionProvider 

type ServerCapabilitiesCodeActionProvider struct {
	Bool              *bool              `json:"-"`
	CodeActionOptions *CodeActionOptions `json:"-"`
}

func (ServerCapabilitiesCodeActionProvider) MarshalJSON 

func (u ServerCapabilitiesCodeActionProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesCodeActionProvider) UnmarshalJSON 

func (u *ServerCapabilitiesCodeActionProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesColorProvider 

type ServerCapabilitiesColorProvider struct {
	Bool                             *bool                             `json:"-"`
	DocumentColorOptions             *DocumentColorOptions             `json:"-"`
	DocumentColorRegistrationOptions *DocumentColorRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesColorProvider) MarshalJSON 

func (u ServerCapabilitiesColorProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesColorProvider) UnmarshalJSON 

func (u *ServerCapabilitiesColorProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesDeclarationProvider 

type ServerCapabilitiesDeclarationProvider struct {
	Bool                           *bool                           `json:"-"`
	DeclarationOptions             *DeclarationOptions             `json:"-"`
	DeclarationRegistrationOptions *DeclarationRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesDeclarationProvider) MarshalJSON 

func (u ServerCapabilitiesDeclarationProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesDeclarationProvider) UnmarshalJSON 

func (u *ServerCapabilitiesDeclarationProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesDefinitionProvider 

type ServerCapabilitiesDefinitionProvider struct {
	Bool              *bool              `json:"-"`
	DefinitionOptions *DefinitionOptions `json:"-"`
}

func (ServerCapabilitiesDefinitionProvider) MarshalJSON 

func (u ServerCapabilitiesDefinitionProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesDefinitionProvider) UnmarshalJSON 

func (u *ServerCapabilitiesDefinitionProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesDiagnosticProvider 

type ServerCapabilitiesDiagnosticProvider struct {
	DiagnosticOptions             *DiagnosticOptions             `json:"-"`
	DiagnosticRegistrationOptions *DiagnosticRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesDiagnosticProvider) MarshalJSON 

func (u ServerCapabilitiesDiagnosticProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesDiagnosticProvider) UnmarshalJSON 

func (u *ServerCapabilitiesDiagnosticProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesDocumentFormattingProvider 

type ServerCapabilitiesDocumentFormattingProvider struct {
	Bool                      *bool                      `json:"-"`
	DocumentFormattingOptions *DocumentFormattingOptions `json:"-"`
}

func (ServerCapabilitiesDocumentFormattingProvider) MarshalJSON 

func (u ServerCapabilitiesDocumentFormattingProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesDocumentFormattingProvider) UnmarshalJSON 

func (u *ServerCapabilitiesDocumentFormattingProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesDocumentHighlightProvider 

type ServerCapabilitiesDocumentHighlightProvider struct {
	Bool                     *bool                     `json:"-"`
	DocumentHighlightOptions *DocumentHighlightOptions `json:"-"`
}

func (ServerCapabilitiesDocumentHighlightProvider) MarshalJSON 

func (u ServerCapabilitiesDocumentHighlightProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesDocumentHighlightProvider) UnmarshalJSON 

func (u *ServerCapabilitiesDocumentHighlightProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesDocumentRangeFormattingProvider 

type ServerCapabilitiesDocumentRangeFormattingProvider struct {
	Bool                           *bool                           `json:"-"`
	DocumentRangeFormattingOptions *DocumentRangeFormattingOptions `json:"-"`
}

func (ServerCapabilitiesDocumentRangeFormattingProvider) MarshalJSON 

func (u ServerCapabilitiesDocumentRangeFormattingProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesDocumentRangeFormattingProvider) UnmarshalJSON 

func (u *ServerCapabilitiesDocumentRangeFormattingProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesDocumentSymbolProvider 

type ServerCapabilitiesDocumentSymbolProvider struct {
	Bool                  *bool                  `json:"-"`
	DocumentSymbolOptions *DocumentSymbolOptions `json:"-"`
}

func (ServerCapabilitiesDocumentSymbolProvider) MarshalJSON 

func (u ServerCapabilitiesDocumentSymbolProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesDocumentSymbolProvider) UnmarshalJSON 

func (u *ServerCapabilitiesDocumentSymbolProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesFoldingRangeProvider 

type ServerCapabilitiesFoldingRangeProvider struct {
	Bool                            *bool                            `json:"-"`
	FoldingRangeOptions             *FoldingRangeOptions             `json:"-"`
	FoldingRangeRegistrationOptions *FoldingRangeRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesFoldingRangeProvider) MarshalJSON 

func (u ServerCapabilitiesFoldingRangeProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesFoldingRangeProvider) UnmarshalJSON 

func (u *ServerCapabilitiesFoldingRangeProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesHoverProvider 

type ServerCapabilitiesHoverProvider struct {
	Bool         *bool         `json:"-"`
	HoverOptions *HoverOptions `json:"-"`
}

func (ServerCapabilitiesHoverProvider) MarshalJSON 

func (u ServerCapabilitiesHoverProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesHoverProvider) UnmarshalJSON 

func (u *ServerCapabilitiesHoverProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesImplementationProvider 

type ServerCapabilitiesImplementationProvider struct {
	Bool                              *bool                              `json:"-"`
	ImplementationOptions             *ImplementationOptions             `json:"-"`
	ImplementationRegistrationOptions *ImplementationRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesImplementationProvider) MarshalJSON 

func (u ServerCapabilitiesImplementationProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesImplementationProvider) UnmarshalJSON 

func (u *ServerCapabilitiesImplementationProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesInlayHintProvider 

type ServerCapabilitiesInlayHintProvider struct {
	Bool                         *bool                         `json:"-"`
	InlayHintOptions             *InlayHintOptions             `json:"-"`
	InlayHintRegistrationOptions *InlayHintRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesInlayHintProvider) MarshalJSON 

func (u ServerCapabilitiesInlayHintProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesInlayHintProvider) UnmarshalJSON 

func (u *ServerCapabilitiesInlayHintProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesInlineCompletionProvider 

type ServerCapabilitiesInlineCompletionProvider struct {
	Bool                    *bool                    `json:"-"`
	InlineCompletionOptions *InlineCompletionOptions `json:"-"`
}

func (ServerCapabilitiesInlineCompletionProvider) MarshalJSON 

func (u ServerCapabilitiesInlineCompletionProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesInlineCompletionProvider) UnmarshalJSON 

func (u *ServerCapabilitiesInlineCompletionProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesInlineValueProvider 

type ServerCapabilitiesInlineValueProvider struct {
	Bool                           *bool                           `json:"-"`
	InlineValueOptions             *InlineValueOptions             `json:"-"`
	InlineValueRegistrationOptions *InlineValueRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesInlineValueProvider) MarshalJSON 

func (u ServerCapabilitiesInlineValueProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesInlineValueProvider) UnmarshalJSON 

func (u *ServerCapabilitiesInlineValueProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesLinkedEditingRangeProvider 

type ServerCapabilitiesLinkedEditingRangeProvider struct {
	Bool                                  *bool                                  `json:"-"`
	LinkedEditingRangeOptions             *LinkedEditingRangeOptions             `json:"-"`
	LinkedEditingRangeRegistrationOptions *LinkedEditingRangeRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesLinkedEditingRangeProvider) MarshalJSON 

func (u ServerCapabilitiesLinkedEditingRangeProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesLinkedEditingRangeProvider) UnmarshalJSON 

func (u *ServerCapabilitiesLinkedEditingRangeProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesMonikerProvider 

type ServerCapabilitiesMonikerProvider struct {
	Bool                       *bool                       `json:"-"`
	MonikerOptions             *MonikerOptions             `json:"-"`
	MonikerRegistrationOptions *MonikerRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesMonikerProvider) MarshalJSON 

func (u ServerCapabilitiesMonikerProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesMonikerProvider) UnmarshalJSON 

func (u *ServerCapabilitiesMonikerProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesNotebookDocumentSync 

type ServerCapabilitiesNotebookDocumentSync struct {
	NotebookDocumentSyncOptions             *NotebookDocumentSyncOptions             `json:"-"`
	NotebookDocumentSyncRegistrationOptions *NotebookDocumentSyncRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesNotebookDocumentSync) MarshalJSON 

func (u ServerCapabilitiesNotebookDocumentSync) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesNotebookDocumentSync) UnmarshalJSON 

func (u *ServerCapabilitiesNotebookDocumentSync) UnmarshalJSON(data []byte) error

type ServerCapabilitiesReferencesProvider 

type ServerCapabilitiesReferencesProvider struct {
	Bool             *bool             `json:"-"`
	ReferenceOptions *ReferenceOptions `json:"-"`
}

func (ServerCapabilitiesReferencesProvider) MarshalJSON 

func (u ServerCapabilitiesReferencesProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesReferencesProvider) UnmarshalJSON 

func (u *ServerCapabilitiesReferencesProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesRenameProvider 

type ServerCapabilitiesRenameProvider struct {
	Bool          *bool          `json:"-"`
	RenameOptions *RenameOptions `json:"-"`
}

func (ServerCapabilitiesRenameProvider) MarshalJSON 

func (u ServerCapabilitiesRenameProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesRenameProvider) UnmarshalJSON 

func (u *ServerCapabilitiesRenameProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesSelectionRangeProvider 

type ServerCapabilitiesSelectionRangeProvider struct {
	Bool                              *bool                              `json:"-"`
	SelectionRangeOptions             *SelectionRangeOptions             `json:"-"`
	SelectionRangeRegistrationOptions *SelectionRangeRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesSelectionRangeProvider) MarshalJSON 

func (u ServerCapabilitiesSelectionRangeProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesSelectionRangeProvider) UnmarshalJSON 

func (u *ServerCapabilitiesSelectionRangeProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesSemanticTokensProvider 

type ServerCapabilitiesSemanticTokensProvider struct {
	SemanticTokensOptions             *SemanticTokensOptions             `json:"-"`
	SemanticTokensRegistrationOptions *SemanticTokensRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesSemanticTokensProvider) MarshalJSON 

func (u ServerCapabilitiesSemanticTokensProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesSemanticTokensProvider) UnmarshalJSON 

func (u *ServerCapabilitiesSemanticTokensProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesTextDocumentSync 

type ServerCapabilitiesTextDocumentSync struct {
	TextDocumentSyncOptions *TextDocumentSyncOptions `json:"-"`
	TextDocumentSyncKind    *TextDocumentSyncKind    `json:"-"`
}

func (ServerCapabilitiesTextDocumentSync) MarshalJSON 

func (u ServerCapabilitiesTextDocumentSync) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesTextDocumentSync) UnmarshalJSON 

func (u *ServerCapabilitiesTextDocumentSync) UnmarshalJSON(data []byte) error

type ServerCapabilitiesTypeDefinitionProvider 

type ServerCapabilitiesTypeDefinitionProvider struct {
	Bool                              *bool                              `json:"-"`
	TypeDefinitionOptions             *TypeDefinitionOptions             `json:"-"`
	TypeDefinitionRegistrationOptions *TypeDefinitionRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesTypeDefinitionProvider) MarshalJSON 

func (u ServerCapabilitiesTypeDefinitionProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesTypeDefinitionProvider) UnmarshalJSON 

func (u *ServerCapabilitiesTypeDefinitionProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesTypeHierarchyProvider 

type ServerCapabilitiesTypeHierarchyProvider struct {
	Bool                             *bool                             `json:"-"`
	TypeHierarchyOptions             *TypeHierarchyOptions             `json:"-"`
	TypeHierarchyRegistrationOptions *TypeHierarchyRegistrationOptions `json:"-"`
}

func (ServerCapabilitiesTypeHierarchyProvider) MarshalJSON 

func (u ServerCapabilitiesTypeHierarchyProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesTypeHierarchyProvider) UnmarshalJSON 

func (u *ServerCapabilitiesTypeHierarchyProvider) UnmarshalJSON(data []byte) error

type ServerCapabilitiesWorkspaceSymbolProvider 

type ServerCapabilitiesWorkspaceSymbolProvider struct {
	Bool                   *bool                   `json:"-"`
	WorkspaceSymbolOptions *WorkspaceSymbolOptions `json:"-"`
}

func (ServerCapabilitiesWorkspaceSymbolProvider) MarshalJSON 

func (u ServerCapabilitiesWorkspaceSymbolProvider) MarshalJSON() ([]byte, error)

func (*ServerCapabilitiesWorkspaceSymbolProvider) UnmarshalJSON 

func (u *ServerCapabilitiesWorkspaceSymbolProvider) UnmarshalJSON(data []byte) error

type ServerCompletionItemOptions 

type ServerCompletionItemOptions struct {
	// The server has support for completion item label details (see also `CompletionItemLabelDetails`) when receiving a completion item in a resolve call.  @since 3.17.0
	LabelDetailsSupport *bool `json:"labelDetailsSupport,omitempty"`
}

@since 3.18.0

type ServerConfig 

type ServerConfig struct {
	Name          string            `json:"name" toml:"name"`
	Command       []string          `json:"command" toml:"command"`
	FileTypes     []string          `json:"filetypes" toml:"filetypes"`
	Env           map[string]string `json:"env" toml:"env"`
	Capabilities  []Capability      `json:"capabilities" toml:"capabilities"`
	ShareSessions bool              `json:"share_sessions" toml:"share_sessions"`
	// InitializationOptions are raw user-provided options forwarded as
	// initializationOptions in the LSP initialize request. For example,
	// gopls settings like staticcheck, directoryFilters, and analyses.
	InitializationOptions any `json:"initialization_options,omitempty" toml:"initialization_options,omitempty"`
}

ServerConfig configures a language server managed by the multiplexer.

type ServerInfo 

type ServerInfo struct {
	// The name of the server as defined by the server.
	Name string `json:"name"`
	// The server's version as defined by the server.
	Version *string `json:"version,omitempty"`
}

Information about the server

@since 3.15.0 @since 3.18.0 ServerInfo type name added.

type SetTraceParams 

type SetTraceParams struct {
	Value TraceValue `json:"value"`
}

type ShowDocumentClientCapabilities 

type ShowDocumentClientCapabilities struct {
	// The client has support for the showDocument request.
	Support bool `json:"support"`
}

Client capabilities for the showDocument request.

@since 3.16.0

type ShowDocumentParams 

type ShowDocumentParams struct {
	// The uri to show.
	URI string `json:"uri"`
	// Indicates to show the resource in an external program. To show, for example, `https://code.visualstudio.com/` in the default WEB browser set `external` to `true`.
	External *bool `json:"external,omitempty"`
	// An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.
	TakeFocus *bool `json:"takeFocus,omitempty"`
	// An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.
	Selection *Range `json:"selection,omitempty"`
}

Params to show a resource in the UI.

@since 3.16.0

type ShowDocumentResult 

type ShowDocumentResult struct {
	// A boolean indicating if the show was successful.
	Success bool `json:"success"`
}

The result of a showDocument request.

@since 3.16.0

type ShowMessageParams 

type ShowMessageParams struct {
	// The message type. See {@link MessageType}
	Type MessageType `json:"type"`
	// The actual message.
	Message string `json:"message"`
}

The parameters of a notification message.

type ShowMessageRequestClientCapabilities 

type ShowMessageRequestClientCapabilities struct {
	// Capabilities specific to the `MessageActionItem` type.
	MessageActionItem *ClientShowMessageActionItemOptions `json:"messageActionItem,omitempty"`
}

Show message request client capabilities

type ShowMessageRequestParams 

type ShowMessageRequestParams struct {
	// The message type. See {@link MessageType}
	Type MessageType `json:"type"`
	// The actual message.
	Message string `json:"message"`
	// The message action items to present.
	Actions []MessageActionItem `json:"actions,omitempty"`
}

type SignatureHelp 

type SignatureHelp struct {
	// One or more signatures.
	Signatures []SignatureInformation `json:"signatures"`
	// The active signature. If omitted or the value lies outside the range of `signatures` the value defaults to zero or is ignored if the `SignatureHelp` has no signatures.  Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value.  In future version of the protocol this property might become mandatory to better express this.
	ActiveSignature *uint32 `json:"activeSignature,omitempty"`
	// The active parameter of the active signature.  If `null`, no parameter of the signature is active (for example a named argument that does not match any declared parameters). This is only valid if the client specifies the client capability `textDocument.signatureHelp.noActiveParameterSupport === true`  If omitted or the value lies outside the range of `signatures[activeSignature].parameters` defaults to 0 if the active signature has parameters.  If the active signature has no parameters it is ignored.  In future version of the protocol this property might become mandatory (but still nullable) to better express the active parameter if the active signature does have any.  Since version 3.16.0 the `SignatureInformation` itself provides a `activeParameter` property and it should be used instead of this one.
	ActiveParameter *uint32 `json:"activeParameter,omitempty"`
}

Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.

type SignatureHelpClientCapabilities 

type SignatureHelpClientCapabilities struct {
	// Whether signature help supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The client supports the following `SignatureInformation` specific properties.
	SignatureInformation *ClientSignatureInformationOptions `json:"signatureInformation,omitempty"`
	// The client supports to send additional context information for a `textDocument/signatureHelp` request. A client that opts into contextSupport will also support the `retriggerCharacters` on `SignatureHelpOptions`.  @since 3.15.0
	ContextSupport *bool `json:"contextSupport,omitempty"`
}

Client Capabilities for a {@link SignatureHelpRequest}.

type SignatureHelpContext 

type SignatureHelpContext struct {
	// Action that caused signature help to be triggered.
	TriggerKind SignatureHelpTriggerKind `json:"triggerKind"`
	// Character that caused signature help to be triggered.  This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`
	TriggerCharacter *string `json:"triggerCharacter,omitempty"`
	// `true` if signature help was already showing when it was triggered.  Retriggers occurs when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.
	IsRetrigger bool `json:"isRetrigger"`
	// The currently active `SignatureHelp`.  The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on the user navigating through available signatures.
	ActiveSignatureHelp *SignatureHelp `json:"activeSignatureHelp,omitempty"`
}

Additional information about the context in which a signature help request was triggered.

@since 3.15.0

type SignatureHelpOptions 

type SignatureHelpOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// List of characters that trigger signature help automatically.
	TriggerCharacters []string `json:"triggerCharacters,omitempty"`
	// List of characters that re-trigger signature help.  These trigger characters are only active when signature help is already showing. All trigger characters are also counted as re-trigger characters.  @since 3.15.0
	RetriggerCharacters []string `json:"retriggerCharacters,omitempty"`
}

Server Capabilities for a {@link SignatureHelpRequest}.

type SignatureHelpParams 

type SignatureHelpParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// 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"`
}

Parameters for a {@link SignatureHelpRequest}.

type SignatureHelpRegistrationOptions 

type SignatureHelpRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// List of characters that trigger signature help automatically.
	TriggerCharacters []string `json:"triggerCharacters,omitempty"`
	// List of characters that re-trigger signature help.  These trigger characters are only active when signature help is already showing. All trigger characters are also counted as re-trigger characters.  @since 3.15.0
	RetriggerCharacters []string `json:"retriggerCharacters,omitempty"`
}

Registration options for a {@link SignatureHelpRequest}.

type SignatureHelpTriggerKind 

type SignatureHelpTriggerKind uint32

How a signature help was triggered.

@since 3.15.0 

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
)

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 *SignatureInformationDocumentation `json:"documentation,omitempty"`
	// The parameters of this signature.
	Parameters []ParameterInformation `json:"parameters,omitempty"`
	// The index of the active parameter.  If `null`, no parameter of the signature is active (for example a named argument that does not match any declared parameters). This is only valid if the client specifies the client capability `textDocument.signatureHelp.noActiveParameterSupport === true`  If provided (or `null`), this is used in place of `SignatureHelp.activeParameter`.  @since 3.16.0
	ActiveParameter *uint32 `json:"activeParameter,omitempty"`
}

Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.

type SignatureInformationDocumentation 

type SignatureInformationDocumentation struct {
	String        *string        `json:"-"`
	MarkupContent *MarkupContent `json:"-"`
}

func (SignatureInformationDocumentation) MarshalJSON 

func (u SignatureInformationDocumentation) MarshalJSON() ([]byte, error)

func (*SignatureInformationDocumentation) UnmarshalJSON 

func (u *SignatureInformationDocumentation) UnmarshalJSON(data []byte) error

type SnippetTextEdit 

type SnippetTextEdit struct {
	// The range of the text document to be manipulated.
	Range Range `json:"range"`
	// The snippet to be inserted.
	Snippet StringValue `json:"snippet"`
	// The actual identifier of the snippet edit.
	AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"`
}

An interactive text edit.

@since 3.18.0

type StaleRequestSupportOptions 

type StaleRequestSupportOptions struct {
	// The client will actively cancel the request.
	Cancel bool `json:"cancel"`
	// The list of requests for which the client will retry the request if it receives a response with error code `ContentModified`
	RetryOnContentModified []string `json:"retryOnContentModified"`
}

@since 3.18.0

type StaticRegistrationOptions 

type StaticRegistrationOptions struct {
	// The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
	ID *string `json:"id,omitempty"`
}

Static registration options to be returned in the initialize request.

type StringValue 

type StringValue struct {
	// The kind of string value.
	Kind string `json:"kind"`
	// The snippet string.
	Value string `json:"value"`
}

A string value used as a snippet is a template which allows to insert text and to control the editor cursor when insertion happens.

A snippet can define tab stops and placeholders with `$1`, `$2` and `${3:foo}`. `$0` defines the final tab stop, it defaults to the end of the snippet. Variables are defined with `$name` and `${name:default value}`.

@since 3.18.0

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 symbol.  @since 3.16.0
	Tags []SymbolTag `json:"tags,omitempty"`
	// The name of the symbol containing this symbol. This information is for user interface purposes (e.g. to render a qualifier in the user interface if necessary). It can't be used to re-infer a hierarchy for the document symbols.
	ContainerName *string `json:"containerName,omitempty"`
	// Indicates if this symbol is deprecated.  @deprecated Use tags instead
	Deprecated *bool `json:"deprecated,omitempty"`
	// The location of this symbol. The location's range is used by a tool to reveal the location in the editor. If the symbol is selected in the tool the range's start information is used to position the cursor. So the range usually spans more than the actual symbol's name and does normally include things like visibility modifiers.  The range doesn't have to denote a node range in the sense of an abstract syntax tree. It can therefore not be used to re-construct a hierarchy of the symbols.
	Location Location `json:"location"`
}

Represents information about programming constructs like variables, classes, interfaces etc.

type SymbolKind 

type SymbolKind uint32

A symbol kind. 

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
)

type SymbolTag 

type SymbolTag uint32

Symbol tags are extra annotations that tweak the rendering of a symbol.

@since 3.16 

const (
	// Render a symbol as obsolete, usually using a strike-out.
	SymbolTagDeprecated SymbolTag = 1
)

type TextDocumentChangeRegistrationOptions 

type TextDocumentChangeRegistrationOptions 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"`
	// How documents are synced to the server.
	SyncKind TextDocumentSyncKind `json:"syncKind"`
}

Describe options to be used when registered for text document change events.

type TextDocumentClientCapabilities 

type TextDocumentClientCapabilities struct {
	// Defines which synchronization capabilities the client supports.
	Synchronization *TextDocumentSyncClientCapabilities `json:"synchronization,omitempty"`
	// Defines which filters the client supports.  @since 3.18.0
	Filters *TextDocumentFilterClientCapabilities `json:"filters,omitempty"`
	// Capabilities specific to the `textDocument/completion` request.
	Completion *CompletionClientCapabilities `json:"completion,omitempty"`
	// Capabilities specific to the `textDocument/hover` request.
	Hover *HoverClientCapabilities `json:"hover,omitempty"`
	// Capabilities specific to the `textDocument/signatureHelp` request.
	SignatureHelp *SignatureHelpClientCapabilities `json:"signatureHelp,omitempty"`
	// Capabilities specific to the `textDocument/declaration` request.  @since 3.14.0
	Declaration *DeclarationClientCapabilities `json:"declaration,omitempty"`
	// Capabilities specific to the `textDocument/definition` request.
	Definition *DefinitionClientCapabilities `json:"definition,omitempty"`
	// Capabilities specific to the `textDocument/typeDefinition` request.  @since 3.6.0
	TypeDefinition *TypeDefinitionClientCapabilities `json:"typeDefinition,omitempty"`
	// Capabilities specific to the `textDocument/implementation` request.  @since 3.6.0
	Implementation *ImplementationClientCapabilities `json:"implementation,omitempty"`
	// Capabilities specific to the `textDocument/references` request.
	References *ReferenceClientCapabilities `json:"references,omitempty"`
	// Capabilities specific to the `textDocument/documentHighlight` request.
	DocumentHighlight *DocumentHighlightClientCapabilities `json:"documentHighlight,omitempty"`
	// Capabilities specific to the `textDocument/documentSymbol` request.
	DocumentSymbol *DocumentSymbolClientCapabilities `json:"documentSymbol,omitempty"`
	// Capabilities specific to the `textDocument/codeAction` request.
	CodeAction *CodeActionClientCapabilities `json:"codeAction,omitempty"`
	// Capabilities specific to the `textDocument/codeLens` request.
	CodeLens *CodeLensClientCapabilities `json:"codeLens,omitempty"`
	// Capabilities specific to the `textDocument/documentLink` request.
	DocumentLink *DocumentLinkClientCapabilities `json:"documentLink,omitempty"`
	// Capabilities specific to the `textDocument/documentColor` and the `textDocument/colorPresentation` request.  @since 3.6.0
	ColorProvider *DocumentColorClientCapabilities `json:"colorProvider,omitempty"`
	// Capabilities specific to the `textDocument/formatting` request.
	Formatting *DocumentFormattingClientCapabilities `json:"formatting,omitempty"`
	// Capabilities specific to the `textDocument/rangeFormatting` request.
	RangeFormatting *DocumentRangeFormattingClientCapabilities `json:"rangeFormatting,omitempty"`
	// Capabilities specific to the `textDocument/onTypeFormatting` request.
	OnTypeFormatting *DocumentOnTypeFormattingClientCapabilities `json:"onTypeFormatting,omitempty"`
	// Capabilities specific to the `textDocument/rename` request.
	Rename *RenameClientCapabilities `json:"rename,omitempty"`
	// Capabilities specific to the `textDocument/foldingRange` request.  @since 3.10.0
	FoldingRange *FoldingRangeClientCapabilities `json:"foldingRange,omitempty"`
	// Capabilities specific to the `textDocument/selectionRange` request.  @since 3.15.0
	SelectionRange *SelectionRangeClientCapabilities `json:"selectionRange,omitempty"`
	// Capabilities specific to the `textDocument/publishDiagnostics` notification.
	PublishDiagnostics *PublishDiagnosticsClientCapabilities `json:"publishDiagnostics,omitempty"`
	// Capabilities specific to the various call hierarchy requests.  @since 3.16.0
	CallHierarchy *CallHierarchyClientCapabilities `json:"callHierarchy,omitempty"`
	// Capabilities specific to the various semantic token request.  @since 3.16.0
	SemanticTokens *SemanticTokensClientCapabilities `json:"semanticTokens,omitempty"`
	// Capabilities specific to the `textDocument/linkedEditingRange` request.  @since 3.16.0
	LinkedEditingRange *LinkedEditingRangeClientCapabilities `json:"linkedEditingRange,omitempty"`
	// Client capabilities specific to the `textDocument/moniker` request.  @since 3.16.0
	Moniker *MonikerClientCapabilities `json:"moniker,omitempty"`
	// Capabilities specific to the various type hierarchy requests.  @since 3.17.0
	TypeHierarchy *TypeHierarchyClientCapabilities `json:"typeHierarchy,omitempty"`
	// Capabilities specific to the `textDocument/inlineValue` request.  @since 3.17.0
	InlineValue *InlineValueClientCapabilities `json:"inlineValue,omitempty"`
	// Capabilities specific to the `textDocument/inlayHint` request.  @since 3.17.0
	InlayHint *InlayHintClientCapabilities `json:"inlayHint,omitempty"`
	// Capabilities specific to the diagnostic pull model.  @since 3.17.0
	Diagnostic *DiagnosticClientCapabilities `json:"diagnostic,omitempty"`
	// Client capabilities specific to inline completions.  @since 3.18.0
	InlineCompletion *InlineCompletionClientCapabilities `json:"inlineCompletion,omitempty"`
}

Text document specific client capabilities.

type TextDocumentContentChangeEvent 

type TextDocumentContentChangeEvent struct {
	TextDocumentContentChangePartial       *TextDocumentContentChangePartial       `json:"-"`
	TextDocumentContentChangeWholeDocument *TextDocumentContentChangeWholeDocument `json:"-"`
}

An event describing a change to a text document. If only a text is provided it is considered to be the full content of the document.

func (TextDocumentContentChangeEvent) MarshalJSON 

func (u TextDocumentContentChangeEvent) MarshalJSON() ([]byte, error)

func (*TextDocumentContentChangeEvent) UnmarshalJSON 

func (u *TextDocumentContentChangeEvent) UnmarshalJSON(data []byte) error

type TextDocumentContentChangePartial 

type TextDocumentContentChangePartial 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 *uint32 `json:"rangeLength,omitempty"`
	// The new text for the provided range.
	Text string `json:"text"`
}

@since 3.18.0

type TextDocumentContentChangeWholeDocument 

type TextDocumentContentChangeWholeDocument struct {
	// The new text of the whole document.
	Text string `json:"text"`
}

@since 3.18.0

type TextDocumentContentClientCapabilities 

type TextDocumentContentClientCapabilities struct {
	// Text document content provider supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

Client capabilities for a text document content provider.

@since 3.18.0

type TextDocumentContentOptions 

type TextDocumentContentOptions struct {
	// The schemes for which the server provides content.
	Schemes []string `json:"schemes"`
}

Text document content provider options.

@since 3.18.0

type TextDocumentContentParams 

type TextDocumentContentParams struct {
	// The uri of the text document.
	URI string `json:"uri"`
}

Parameters for the `workspace/textDocumentContent` request.

@since 3.18.0

type TextDocumentContentRefreshParams 

type TextDocumentContentRefreshParams struct {
	// The uri of the text document to refresh.
	URI string `json:"uri"`
}

Parameters for the `workspace/textDocumentContent/refresh` request.

@since 3.18.0

type TextDocumentContentRegistrationOptions 

type TextDocumentContentRegistrationOptions struct {
	// The schemes for which the server provides content.
	Schemes []string `json:"schemes"`
	// 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"`
}

Text document content provider registration options.

@since 3.18.0

type TextDocumentContentResult 

type TextDocumentContentResult struct {
	// The text content of the text document. Please note, that the content of any subsequent open notifications for the text document might differ from the returned content due to whitespace and line ending normalizations done on the client
	Text string `json:"text"`
}

Result of the `workspace/textDocumentContent` request.

@since 3.18.0

type TextDocumentEdit 

type TextDocumentEdit struct {
	// The text document to change.
	TextDocument OptionalVersionedTextDocumentIdentifier `json:"textDocument"`
	// The edits to be applied.  @since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a client capability.  @since 3.18.0 - support for SnippetTextEdit. This is guarded using a client capability.
	Edits []TextDocumentEditEditsItem `json:"edits"`
}

Describes textual changes on a text document. A TextDocumentEdit describes all changes on a document version Si and after they are applied move the document to version Si+1. So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any kind of ordering. However the edits must be non overlapping.

type TextDocumentEditEditsItem 

type TextDocumentEditEditsItem struct {
	TextEdit          *TextEdit          `json:"-"`
	AnnotatedTextEdit *AnnotatedTextEdit `json:"-"`
	SnippetTextEdit   *SnippetTextEdit   `json:"-"`
}

func (TextDocumentEditEditsItem) MarshalJSON 

func (u TextDocumentEditEditsItem) MarshalJSON() ([]byte, error)

func (*TextDocumentEditEditsItem) UnmarshalJSON 

func (u *TextDocumentEditEditsItem) UnmarshalJSON(data []byte) error

type TextDocumentFilter 

type TextDocumentFilter struct {
	Language *TextDocumentFilterLanguage `json:"-"`
	Scheme   *TextDocumentFilterScheme   `json:"-"`
	Pattern  *TextDocumentFilterPattern  `json:"-"`
}

A document filter denotes a document by different properties like the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.

Glob patterns can have the following syntax: - `*` to match zero or more characters in a path segment - `?` to match on one character in a path segment - `**` to match any number of path segments, including none - `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files) - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …) - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)

@sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }` @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`

@since 3.17.0

func (TextDocumentFilter) MarshalJSON 

func (u TextDocumentFilter) MarshalJSON() ([]byte, error)

func (*TextDocumentFilter) UnmarshalJSON 

func (u *TextDocumentFilter) UnmarshalJSON(data []byte) error

type TextDocumentFilterClientCapabilities 

type TextDocumentFilterClientCapabilities struct {
	// The client supports Relative Patterns.  @since 3.18.0
	RelativePatternSupport *bool `json:"relativePatternSupport,omitempty"`
}

type TextDocumentFilterLanguage 

type TextDocumentFilterLanguage struct {
	// A language id, like `typescript`.
	Language string `json:"language"`
	// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
	Scheme *string `json:"scheme,omitempty"`
	// A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.  @since 3.18.0 - support for relative patterns. Whether clients support relative patterns depends on the client capability `textDocuments.filters.relativePatternSupport`.
	Pattern *GlobPattern `json:"pattern,omitempty"`
}

A document filter where `language` is required field.

@since 3.18.0

type TextDocumentFilterPattern 

type TextDocumentFilterPattern struct {
	// A language id, like `typescript`.
	Language *string `json:"language,omitempty"`
	// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
	Scheme *string `json:"scheme,omitempty"`
	// A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.  @since 3.18.0 - support for relative patterns. Whether clients support relative patterns depends on the client capability `textDocuments.filters.relativePatternSupport`.
	Pattern GlobPattern `json:"pattern"`
}

A document filter where `pattern` is required field.

@since 3.18.0

type TextDocumentFilterScheme 

type TextDocumentFilterScheme struct {
	// A language id, like `typescript`.
	Language *string `json:"language,omitempty"`
	// A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
	Scheme string `json:"scheme"`
	// A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.  @since 3.18.0 - support for relative patterns. Whether clients support relative patterns depends on the client capability `textDocuments.filters.relativePatternSupport`.
	Pattern *GlobPattern `json:"pattern,omitempty"`
}

A document filter where `scheme` is required field.

@since 3.18.0

type TextDocumentIdentifier 

type TextDocumentIdentifier struct {
	// The text document's uri.
	URI string `json:"uri"`
}

A literal to identify a text document in the client.

type TextDocumentItem 

type TextDocumentItem struct {
	// The text document's uri.
	URI string `json:"uri"`
	// The text document's language identifier.
	LanguageID LanguageKind `json:"languageId"`
	// The version number of this document (it will increase after each change, including undo/redo).
	Version int32 `json:"version"`
	// The content of the opened text document.
	Text string `json:"text"`
}

An item to transfer a text document from the client to the server.

type TextDocumentPositionParams 

type TextDocumentPositionParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
}

A parameter literal used in requests to pass a text document and a position inside that document.

type TextDocumentRegistrationOptions 

type TextDocumentRegistrationOptions struct {
	// A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
	DocumentSelector DocumentSelector `json:"documentSelector"`
}

General text document registration options.

type TextDocumentSaveReason 

type TextDocumentSaveReason uint32

Represents reasons why a text document is saved. 

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
)

type TextDocumentSaveRegistrationOptions 

type TextDocumentSaveRegistrationOptions 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"`
	// The client is supposed to include the content on save.
	IncludeText *bool `json:"includeText,omitempty"`
}

Save registration options.

type TextDocumentSyncClientCapabilities 

type TextDocumentSyncClientCapabilities struct {
	// Whether text document synchronization supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The client supports sending will save notifications.
	WillSave *bool `json:"willSave,omitempty"`
	// The client supports sending a will save request and waits for a response providing text edits which will be applied to the document before it is saved.
	WillSaveWaitUntil *bool `json:"willSaveWaitUntil,omitempty"`
	// The client supports did save notifications.
	DidSave *bool `json:"didSave,omitempty"`
}

type TextDocumentSyncKind 

type TextDocumentSyncKind uint32

Defines how the host (editor) should sync document changes to the language server. 

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
)

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 *TextDocumentSyncOptionsSave `json:"save,omitempty"`
}

type TextDocumentSyncOptionsSave 

type TextDocumentSyncOptionsSave struct {
	Bool        *bool        `json:"-"`
	SaveOptions *SaveOptions `json:"-"`
}

func (TextDocumentSyncOptionsSave) MarshalJSON 

func (u TextDocumentSyncOptionsSave) MarshalJSON() ([]byte, error)

func (*TextDocumentSyncOptionsSave) UnmarshalJSON 

func (u *TextDocumentSyncOptionsSave) UnmarshalJSON(data []byte) error

type TextEdit 

type TextEdit struct {
	// The range of the text document to be manipulated. To insert text into a document create a range where start === end.
	Range Range `json:"range"`
	// The string to be inserted. For delete operations use an empty string.
	NewText string `json:"newText"`
}

A text edit applicable to a text document.

type TokenFormat 

type TokenFormat string
const (
	TokenFormatRelative TokenFormat = "relative"
)

type TraceValue 

type TraceValue string
const (
	// Turn tracing off.
	TraceValueOff TraceValue = "off"
	// Trace messages only.
	TraceValueMessages TraceValue = "messages"
	// Verbose message tracing.
	TraceValueVerbose TraceValue = "verbose"
)

type TypeDefinitionClientCapabilities 

type TypeDefinitionClientCapabilities struct {
	// Whether implementation supports dynamic registration. If this is set to `true` the client supports the new `TypeDefinitionRegistrationOptions` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// The client supports additional metadata in the form of definition links.  Since 3.14.0
	LinkSupport *bool `json:"linkSupport,omitempty"`
}

Since 3.6.0

type TypeDefinitionOptions 

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

type TypeDefinitionParams 

type TypeDefinitionParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
}

type TypeDefinitionRegistrationOptions 

type TypeDefinitionRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// 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"`
}

type TypeDefinitionResult 

type TypeDefinitionResult struct {
	Definition            *Definition       `json:"-"`
	ArrayOfDefinitionLink *[]DefinitionLink `json:"-"`
	RawMessage            *json.RawMessage  `json:"-"`
}

func (TypeDefinitionResult) MarshalJSON 

func (u TypeDefinitionResult) MarshalJSON() ([]byte, error)

func (*TypeDefinitionResult) UnmarshalJSON 

func (u *TypeDefinitionResult) UnmarshalJSON(data []byte) error

type TypeHierarchyClientCapabilities 

type TypeHierarchyClientCapabilities struct {
	// Whether implementation supports dynamic registration. If this is set to `true` the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` return value for the corresponding server capability as well.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
}

@since 3.17.0

type TypeHierarchyItem 

type TypeHierarchyItem struct {
	// The name of this item.
	Name string `json:"name"`
	// The kind of this item.
	Kind SymbolKind `json:"kind"`
	// Tags for this item.
	Tags []SymbolTag `json:"tags,omitempty"`
	// More detail for this item, e.g. the signature of a function.
	Detail *string `json:"detail,omitempty"`
	// The resource identifier of this item.
	URI string `json:"uri"`
	// The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
	Range Range `json:"range"`
	// The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function. Must be contained by the {@link TypeHierarchyItem.range `range`}.
	SelectionRange Range `json:"selectionRange"`
	// A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requests. It could also be used to identify the type hierarchy in the server, helping improve the performance on resolving supertypes and subtypes.
	Data *json.RawMessage `json:"data,omitempty"`
}

@since 3.17.0

type TypeHierarchyOptions 

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

Type hierarchy options used during static registration.

@since 3.17.0

type TypeHierarchyPrepareParams 

type TypeHierarchyPrepareParams struct {
	// The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The position inside the text document.
	Position Position `json:"position"`
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
}

The parameter of a `textDocument/prepareTypeHierarchy` request.

@since 3.17.0

type TypeHierarchyRegistrationOptions 

type TypeHierarchyRegistrationOptions 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"`
	WorkDoneProgress *bool            `json:"workDoneProgress,omitempty"`
	// 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"`
}

Type hierarchy options used during static or dynamic registration.

@since 3.17.0

type TypeHierarchySubtypesParams 

type TypeHierarchySubtypesParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken    `json:"partialResultToken,omitempty"`
	Item               TypeHierarchyItem `json:"item"`
}

The parameter of a `typeHierarchy/subtypes` request.

@since 3.17.0

type TypeHierarchySupertypesParams 

type TypeHierarchySupertypesParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken    `json:"partialResultToken,omitempty"`
	Item               TypeHierarchyItem `json:"item"`
}

The parameter of a `typeHierarchy/supertypes` request.

@since 3.17.0

type UnchangedDocumentDiagnosticReport 

type UnchangedDocumentDiagnosticReport struct {
	// A document diagnostic report indicating no changes to the last result. A server can only return `unchanged` if result ids are provided.
	Kind string `json:"kind"`
	// A result id which will be sent on the next diagnostic request for the same document.
	ResultID string `json:"resultId"`
}

A diagnostic report indicating that the last returned report is still accurate.

@since 3.17.0

type UniquenessLevel 

type UniquenessLevel string

Moniker uniqueness level to define scope of the moniker.

@since 3.16.0 

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"
)

type Unregistration 

type Unregistration struct {
	// The id used to unregister the request or notification. Usually an id provided during the register request.
	ID string `json:"id"`
	// The method to unregister for.
	Method string `json:"method"`
}

General parameters to unregister a request or notification.

type UnregistrationParams 

type UnregistrationParams struct {
	Unregisterations []Unregistration `json:"unregisterations"`
}

type VersionedNotebookDocumentIdentifier 

type VersionedNotebookDocumentIdentifier struct {
	// The version number of this notebook document.
	Version int32 `json:"version"`
	// The notebook document's uri.
	URI string `json:"uri"`
}

A versioned notebook document identifier.

@since 3.17.0

type VersionedTextDocumentIdentifier 

type VersionedTextDocumentIdentifier struct {
	// The text document's uri.
	URI string `json:"uri"`
	// The version number of this document.
	Version int32 `json:"version"`
}

A text document identifier to denote a specific version of a text document.

type WatchKind 

type WatchKind uint32
const (
	// Interested in create events.
	WatchKindCreate WatchKind = 1
	// Interested in change events
	WatchKindChange WatchKind = 2
	// Interested in delete events
	WatchKindDelete WatchKind = 4
)

type WillSaveTextDocumentParams 

type WillSaveTextDocumentParams struct {
	// The document that will be saved.
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	// The 'TextDocumentSaveReason'.
	Reason TextDocumentSaveReason `json:"reason"`
}

The parameters sent in a will save text document notification.

type WindowClientCapabilities 

type WindowClientCapabilities struct {
	// It indicates whether the client supports server initiated progress using the `window/workDoneProgress/create` request.  The capability also controls Whether client supports handling of progress notifications. If set servers are allowed to report a `workDoneProgress` property in the request specific server capabilities.  @since 3.15.0
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// Capabilities specific to the showMessage request.  @since 3.16.0
	ShowMessage *ShowMessageRequestClientCapabilities `json:"showMessage,omitempty"`
	// Capabilities specific to the showDocument request.  @since 3.16.0
	ShowDocument *ShowDocumentClientCapabilities `json:"showDocument,omitempty"`
}

type WorkDoneProgressBegin 

type WorkDoneProgressBegin struct {
	Kind string `json:"kind"`
	// Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed.  Examples: "Indexing" or "Linking dependencies".
	Title string `json:"title"`
	// Controls if a cancel button should show to allow the user to cancel the long running operation. Clients that don't support cancellation are allowed to ignore the setting.
	Cancellable *bool `json:"cancellable,omitempty"`
	// Optional, more detailed associated progress message. Contains complementary information to the `title`.  Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.
	Message *string `json:"message,omitempty"`
	// Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the `percentage` value in subsequent in report notifications.  The value should be steadily rising. Clients are free to ignore values that are not following this rule. The value range is [0, 100].
	Percentage *uint32 `json:"percentage,omitempty"`
}

type WorkDoneProgressCancelParams 

type WorkDoneProgressCancelParams struct {
	// The token to be used to report progress.
	Token ProgressToken `json:"token"`
}

type WorkDoneProgressCreateParams 

type WorkDoneProgressCreateParams struct {
	// The token to be used to report progress.
	Token ProgressToken `json:"token"`
}

type WorkDoneProgressEnd 

type WorkDoneProgressEnd struct {
	Kind string `json:"kind"`
	// Optional, a final message indicating to for example indicate the outcome of the operation.
	Message *string `json:"message,omitempty"`
}

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"`
	// Controls enablement state of a cancel button.  Clients that don't support cancellation or don't support controlling the button's enablement state are allowed to ignore the property.
	Cancellable *bool `json:"cancellable,omitempty"`
	// Optional, more detailed associated progress message. Contains complementary information to the `title`.  Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.
	Message *string `json:"message,omitempty"`
	// Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the `percentage` value in subsequent in report notifications.  The value should be steadily rising. Clients are free to ignore values that are not following this rule. The value range is [0, 100]
	Percentage *uint32 `json:"percentage,omitempty"`
}

type WorkspaceClientCapabilities 

type WorkspaceClientCapabilities struct {
	// The client supports applying batch edits to the workspace by supporting the request 'workspace/applyEdit'
	ApplyEdit *bool `json:"applyEdit,omitempty"`
	// Capabilities specific to `WorkspaceEdit`s.
	WorkspaceEdit *WorkspaceEditClientCapabilities `json:"workspaceEdit,omitempty"`
	// Capabilities specific to the `workspace/didChangeConfiguration` notification.
	DidChangeConfiguration *DidChangeConfigurationClientCapabilities `json:"didChangeConfiguration,omitempty"`
	// Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
	DidChangeWatchedFiles *DidChangeWatchedFilesClientCapabilities `json:"didChangeWatchedFiles,omitempty"`
	// Capabilities specific to the `workspace/symbol` request.
	Symbol *WorkspaceSymbolClientCapabilities `json:"symbol,omitempty"`
	// Capabilities specific to the `workspace/executeCommand` request.
	ExecuteCommand *ExecuteCommandClientCapabilities `json:"executeCommand,omitempty"`
	// The client has support for workspace folders.  @since 3.6.0
	WorkspaceFolders *bool `json:"workspaceFolders,omitempty"`
	// The client supports `workspace/configuration` requests.  @since 3.6.0
	Configuration *bool `json:"configuration,omitempty"`
	// Capabilities specific to the semantic token requests scoped to the workspace.  @since 3.16.0.
	SemanticTokens *SemanticTokensWorkspaceClientCapabilities `json:"semanticTokens,omitempty"`
	// Capabilities specific to the code lens requests scoped to the workspace.  @since 3.16.0.
	CodeLens *CodeLensWorkspaceClientCapabilities `json:"codeLens,omitempty"`
	// The client has support for file notifications/requests for user operations on files.  Since 3.16.0
	FileOperations *FileOperationClientCapabilities `json:"fileOperations,omitempty"`
	// Capabilities specific to the inline values requests scoped to the workspace.  @since 3.17.0.
	InlineValue *InlineValueWorkspaceClientCapabilities `json:"inlineValue,omitempty"`
	// Capabilities specific to the inlay hint requests scoped to the workspace.  @since 3.17.0.
	InlayHint *InlayHintWorkspaceClientCapabilities `json:"inlayHint,omitempty"`
	// Capabilities specific to the diagnostic requests scoped to the workspace.  @since 3.17.0.
	Diagnostics *DiagnosticWorkspaceClientCapabilities `json:"diagnostics,omitempty"`
	// Capabilities specific to the folding range requests scoped to the workspace.  @since 3.18.0
	FoldingRange *FoldingRangeWorkspaceClientCapabilities `json:"foldingRange,omitempty"`
	// Capabilities specific to the `workspace/textDocumentContent` request.  @since 3.18.0
	TextDocumentContent *TextDocumentContentClientCapabilities `json:"textDocumentContent,omitempty"`
}

Workspace specific client capabilities.

type WorkspaceDiagnosticParams 

type WorkspaceDiagnosticParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// The additional identifier provided during registration.
	Identifier *string `json:"identifier,omitempty"`
	// The currently known diagnostic reports with their previous result ids.
	PreviousResultIds []PreviousResultId `json:"previousResultIds"`
}

Parameters of the workspace diagnostic request.

@since 3.17.0

type WorkspaceDiagnosticReport 

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

A workspace diagnostic report.

@since 3.17.0

type WorkspaceDiagnosticReportPartialResult 

type WorkspaceDiagnosticReportPartialResult struct {
	Items []WorkspaceDocumentDiagnosticReport `json:"items"`
}

A partial result for a workspace diagnostic report.

@since 3.17.0

type WorkspaceDocumentDiagnosticReport 

type WorkspaceDocumentDiagnosticReport struct {
	WorkspaceFullDocumentDiagnosticReport      *WorkspaceFullDocumentDiagnosticReport      `json:"-"`
	WorkspaceUnchangedDocumentDiagnosticReport *WorkspaceUnchangedDocumentDiagnosticReport `json:"-"`
}

A workspace diagnostic document report.

@since 3.17.0

func (WorkspaceDocumentDiagnosticReport) MarshalJSON 

func (u WorkspaceDocumentDiagnosticReport) MarshalJSON() ([]byte, error)

func (*WorkspaceDocumentDiagnosticReport) UnmarshalJSON 

func (u *WorkspaceDocumentDiagnosticReport) UnmarshalJSON(data []byte) error

type WorkspaceEdit 

type WorkspaceEdit struct {
	// Holds changes to existing resources.
	Changes map[string][]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 []WorkspaceEditDocumentChangesItem `json:"documentChanges,omitempty"`
	// A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and delete file / folder operations.  Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`.  @since 3.16.0
	ChangeAnnotations map[ChangeAnnotationIdentifier]ChangeAnnotation `json:"changeAnnotations,omitempty"`
}

A workspace edit represents changes to many resources managed in the workspace. The edit should either provide `changes` or `documentChanges`. If documentChanges are present they are preferred over `changes` if the client can handle versioned document edits.

Since version 3.13.0 a workspace edit can contain resource operations as well. If resource operations are present clients need to execute the operations in the order in which they are provided. So a workspace edit for example can consist of the following two changes: (1) a create file a.txt and (2) a text document edit which insert text into file a.txt.

An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will cause failure of the operation. How the client recovers from the failure is described by the client capability: `workspace.workspaceEdit.failureHandling`

type WorkspaceEditClientCapabilities 

type WorkspaceEditClientCapabilities struct {
	// The client supports versioned document changes in `WorkspaceEdit`s
	DocumentChanges *bool `json:"documentChanges,omitempty"`
	// The resource operations the client supports. Clients should at least support 'create', 'rename' and 'delete' files and folders.  @since 3.13.0
	ResourceOperations []ResourceOperationKind `json:"resourceOperations,omitempty"`
	// The failure handling strategy of a client if applying the workspace edit fails.  @since 3.13.0
	FailureHandling *FailureHandlingKind `json:"failureHandling,omitempty"`
	// Whether the client normalizes line endings to the client specific setting. If set to `true` the client will normalize line ending characters in a workspace edit to the client-specified new line character.  @since 3.16.0
	NormalizesLineEndings *bool `json:"normalizesLineEndings,omitempty"`
	// Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes.  @since 3.16.0
	ChangeAnnotationSupport *ChangeAnnotationsSupportOptions `json:"changeAnnotationSupport,omitempty"`
	// Whether the client supports `WorkspaceEditMetadata` in `WorkspaceEdit`s.  @since 3.18.0
	MetadataSupport *bool `json:"metadataSupport,omitempty"`
	// Whether the client supports snippets as text edits.  @since 3.18.0
	SnippetEditSupport *bool `json:"snippetEditSupport,omitempty"`
}

type WorkspaceEditDocumentChangesItem 

type WorkspaceEditDocumentChangesItem struct {
	TextDocumentEdit *TextDocumentEdit `json:"-"`
	CreateFile       *CreateFile       `json:"-"`
	RenameFile       *RenameFile       `json:"-"`
	DeleteFile       *DeleteFile       `json:"-"`
}

func (WorkspaceEditDocumentChangesItem) MarshalJSON 

func (u WorkspaceEditDocumentChangesItem) MarshalJSON() ([]byte, error)

func (*WorkspaceEditDocumentChangesItem) UnmarshalJSON 

func (u *WorkspaceEditDocumentChangesItem) UnmarshalJSON(data []byte) error

type WorkspaceEditMetadata 

type WorkspaceEditMetadata struct {
	// Signal to the editor that this edit is a refactoring.
	IsRefactoring *bool `json:"isRefactoring,omitempty"`
}

Additional data about a workspace edit.

@since 3.18.0

type WorkspaceFolder 

type WorkspaceFolder struct {
	// The associated URI for this workspace folder.
	URI string `json:"uri"`
	// The name of the workspace folder. Used to refer to this workspace folder in the user interface.
	Name string `json:"name"`
}

A workspace folder inside a client.

type WorkspaceFoldersChangeEvent 

type WorkspaceFoldersChangeEvent struct {
	// The array of added workspace folders
	Added []WorkspaceFolder `json:"added"`
	// The array of the removed workspace folders
	Removed []WorkspaceFolder `json:"removed"`
}

The workspace folder change event.

type WorkspaceFoldersInitializeParams 

type WorkspaceFoldersInitializeParams struct {
	// The workspace folders configured in the client when the server starts.  This property is only available if the client supports workspace folders. It can be `null` if the client supports workspace folders but none are configured.  @since 3.6.0
	WorkspaceFolders []WorkspaceFolder `json:"workspaceFolders,omitempty"`
}

type WorkspaceFoldersServerCapabilities 

type WorkspaceFoldersServerCapabilities struct {
	// The server has support for workspace folders
	Supported *bool `json:"supported,omitempty"`
	// Whether the server wants to receive workspace folder change notifications.  If a string is provided the string is treated as an ID under which the notification is registered on the client side. The ID can be used to unregister for these events using the `client/unregisterCapability` request.
	ChangeNotifications *WorkspaceFoldersServerCapabilitiesChangeNotifications `json:"changeNotifications,omitempty"`
}

type WorkspaceFoldersServerCapabilitiesChangeNotifications 

type WorkspaceFoldersServerCapabilitiesChangeNotifications struct {
	String *string `json:"-"`
	Bool   *bool   `json:"-"`
}

func (WorkspaceFoldersServerCapabilitiesChangeNotifications) MarshalJSON 

func (u WorkspaceFoldersServerCapabilitiesChangeNotifications) MarshalJSON() ([]byte, error)

func (*WorkspaceFoldersServerCapabilitiesChangeNotifications) UnmarshalJSON 

func (u *WorkspaceFoldersServerCapabilitiesChangeNotifications) UnmarshalJSON(data []byte) error

type WorkspaceFullDocumentDiagnosticReport 

type WorkspaceFullDocumentDiagnosticReport struct {
	// A full document diagnostic report.
	Kind string `json:"kind"`
	// An optional result id. If provided it will be sent on the next diagnostic request for the same document.
	ResultID *string `json:"resultId,omitempty"`
	// The actual items.
	Items []Diagnostic `json:"items"`
	// The URI for which diagnostic information is reported.
	URI string `json:"uri"`
	// The version number for which the diagnostics are reported. If the document is not marked as open `null` can be provided.
	Version int32 `json:"version"`
}

A full document diagnostic report for a workspace diagnostic result.

@since 3.17.0

type WorkspaceOptions 

type WorkspaceOptions struct {
	// The server supports workspace folder.  @since 3.6.0
	WorkspaceFolders *WorkspaceFoldersServerCapabilities `json:"workspaceFolders,omitempty"`
	// The server is interested in notifications/requests for operations on files.  @since 3.16.0
	FileOperations *FileOperationOptions `json:"fileOperations,omitempty"`
	// The server supports the `workspace/textDocumentContent` request.  @since 3.18.0
	TextDocumentContent *WorkspaceOptionsTextDocumentContent `json:"textDocumentContent,omitempty"`
}

Defines workspace specific capabilities of the server.

@since 3.18.0

type WorkspaceOptionsTextDocumentContent 

type WorkspaceOptionsTextDocumentContent struct {
	TextDocumentContentOptions             *TextDocumentContentOptions             `json:"-"`
	TextDocumentContentRegistrationOptions *TextDocumentContentRegistrationOptions `json:"-"`
}

func (WorkspaceOptionsTextDocumentContent) MarshalJSON 

func (u WorkspaceOptionsTextDocumentContent) MarshalJSON() ([]byte, error)

func (*WorkspaceOptionsTextDocumentContent) UnmarshalJSON 

func (u *WorkspaceOptionsTextDocumentContent) UnmarshalJSON(data []byte) error

type WorkspaceSymbol 

type WorkspaceSymbol struct {
	// The name of this symbol.
	Name string `json:"name"`
	// The kind of this symbol.
	Kind SymbolKind `json:"kind"`
	// Tags for this symbol.  @since 3.16.0
	Tags []SymbolTag `json:"tags,omitempty"`
	// The name of the symbol containing this symbol. This information is for user interface purposes (e.g. to render a qualifier in the user interface if necessary). It can't be used to re-infer a hierarchy for the document symbols.
	ContainerName *string `json:"containerName,omitempty"`
	// The location of the symbol. Whether a server is allowed to return a location without a range depends on the client capability `workspace.symbol.resolveSupport`.  See SymbolInformation#location for more details.
	Location WorkspaceSymbolLocation `json:"location"`
	// A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.
	Data *json.RawMessage `json:"data,omitempty"`
}

A special workspace symbol that supports locations without a range.

See also SymbolInformation.

@since 3.17.0

type WorkspaceSymbolClientCapabilities 

type WorkspaceSymbolClientCapabilities struct {
	// Symbol request supports dynamic registration.
	DynamicRegistration *bool `json:"dynamicRegistration,omitempty"`
	// Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
	SymbolKind *ClientSymbolKindOptions `json:"symbolKind,omitempty"`
	// The client supports tags on `SymbolInformation`. Clients supporting tags have to handle unknown tags gracefully.  @since 3.16.0
	TagSupport *ClientSymbolTagOptions `json:"tagSupport,omitempty"`
	// The client support partial workspace symbols. The client will send the request `workspaceSymbol/resolve` to the server to resolve additional properties.  @since 3.17.0
	ResolveSupport *ClientSymbolResolveOptions `json:"resolveSupport,omitempty"`
}

Client capabilities for a {@link WorkspaceSymbolRequest}.

type WorkspaceSymbolLocation 

type WorkspaceSymbolLocation struct {
	Location        *Location        `json:"-"`
	LocationUriOnly *LocationUriOnly `json:"-"`
}

func (WorkspaceSymbolLocation) MarshalJSON 

func (u WorkspaceSymbolLocation) MarshalJSON() ([]byte, error)

func (*WorkspaceSymbolLocation) UnmarshalJSON 

func (u *WorkspaceSymbolLocation) UnmarshalJSON(data []byte) error

type WorkspaceSymbolOptions 

type WorkspaceSymbolOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// The server provides support to resolve additional information for a workspace symbol.  @since 3.17.0
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
}

Server capabilities for a {@link WorkspaceSymbolRequest}.

type WorkspaceSymbolParams 

type WorkspaceSymbolParams struct {
	// An optional token that a server can use to report work done progress.
	WorkDoneToken *ProgressToken `json:"workDoneToken,omitempty"`
	// An optional token that a server can use to report partial results (e.g. streaming) to the client.
	PartialResultToken *ProgressToken `json:"partialResultToken,omitempty"`
	// A query string to filter symbols by. Clients may send an empty string here to request all symbols.  The `query`-parameter should be interpreted in a *relaxed way* as editors will apply their own highlighting and scoring on the results. A good rule of thumb is to match case-insensitive and to simply check that the characters of *query* appear in their order in a candidate symbol. Servers shouldn't use prefix, substring, or similar strict matching.
	Query string `json:"query"`
}

The parameters of a {@link WorkspaceSymbolRequest}.

type WorkspaceSymbolRegistrationOptions 

type WorkspaceSymbolRegistrationOptions struct {
	WorkDoneProgress *bool `json:"workDoneProgress,omitempty"`
	// The server provides support to resolve additional information for a workspace symbol.  @since 3.17.0
	ResolveProvider *bool `json:"resolveProvider,omitempty"`
}

Registration options for a {@link WorkspaceSymbolRequest}.

type WorkspaceSymbolResult 

type WorkspaceSymbolResult struct {
	ArrayOfSymbolInformation *[]SymbolInformation `json:"-"`
	ArrayOfWorkspaceSymbol   *[]WorkspaceSymbol   `json:"-"`
	RawMessage               *json.RawMessage     `json:"-"`
}

func (WorkspaceSymbolResult) MarshalJSON 

func (u WorkspaceSymbolResult) MarshalJSON() ([]byte, error)

func (*WorkspaceSymbolResult) UnmarshalJSON 

func (u *WorkspaceSymbolResult) UnmarshalJSON(data []byte) error

type WorkspaceUnchangedDocumentDiagnosticReport 

type WorkspaceUnchangedDocumentDiagnosticReport struct {
	// A document diagnostic report indicating no changes to the last result. A server can only return `unchanged` if result ids are provided.
	Kind string `json:"kind"`
	// A result id which will be sent on the next diagnostic request for the same document.
	ResultID string `json:"resultId"`
	// The URI for which diagnostic information is reported.
	URI string `json:"uri"`
	// The version number for which the diagnostics are reported. If the document is not marked as open `null` can be provided.
	Version int32 `json:"version"`
}

An unchanged document diagnostic report for a workspace diagnostic result.

@since 3.17.0

Source Files

View all Source files

Directories

Path Synopsis
cmd
generator command
examples
gopls_client command
Package jsonrpc2 implements the JSON-RPC 2.0 specification (https://www.jsonrpc.org/specification).
 Package jsonrpc2 implements the JSON-RPC 2.0 specification (https://www.jsonrpc.org/specification).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.