class LSProtocol::InitializeParams

Included Modules

Defined in:

lsprotocol/types.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(capabilities : ClientCapabilities | Nil, process_id : Int32 | Nil, root_uri : URI | Nil, client_info : ClientInfo | Nil = nil, initialization_options : LSPAny | Nil = nil, locale : String | Nil = nil, root_path : String | Nil = nil, trace : TraceValue | Nil = nil, work_done_token : ProgressToken | Nil = nil, workspace_folders : Array(WorkspaceFolder) | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def capabilities : ClientCapabilities #

The capabilities provided by the client (editor or tool)


[View source]
def client_info : ClientInfo | Nil #

Information about the client

@since 3.15.0


[View source]
def initialization_options : LSPAny | Nil #

User provided initialization options.


[View source]
def locale : String | Nil #

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


[View source]
def process_id : Int32 | Nil #

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.


[View source]
def root_path : String | Nil #

The rootPath of the workspace. Is null if no folder is open.

@deprecated in favour of rootUri.


[View source]
def root_uri : URI | Nil #

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.


[View source]
def trace : TraceValue | Nil #

The initial trace setting. If omitted trace is disabled ('off').


[View source]
def work_done_token : ProgressToken | Nil #

An optional token that a server can use to report work done progress.


[View source]
def workspace_folders : Array(WorkspaceFolder) | Nil #

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


[View source]