language_server-protocol 3.14.0.2 → 3.16.0.1

data/lib/language_server/protocol/interface/hover_registration_options.rb

@@ -0,0 +1,40 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class HoverRegistrationOptions
+        def initialize(document_selector:, work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:documentSelector] = document_selector
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        #
+        # 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.
+        #
+        # @return [DocumentSelector]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/implementation_client_capabilities.rb

@@ -0,0 +1,44 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ImplementationClientCapabilities
+        def initialize(dynamic_registration: nil, link_support: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:linkSupport] = link_support if link_support
+
+          @attributes.freeze
+        end
+
+        #
+        # 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.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # The client supports additional metadata in the form of definition links.
+        #
+        # @return [boolean]
+        def link_support
+          attributes.fetch(:linkSupport)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/implementation_options.rb

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ImplementationOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/implementation_params.rb

@@ -0,0 +1,61 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ImplementationParams
+        def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil)
+          @attributes = {}
+
+          @attributes[:textDocument] = text_document
+          @attributes[:position] = position
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+
+          @attributes.freeze
+        end
+
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
+        #
+        # The position inside the text document.
+        #
+        # @return [Position]
+        def position
+          attributes.fetch(:position)
+        end
+
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
+        #
+        # An optional token that a server can use to report partial results (e.g.
+        # streaming) to the client.
+        #
+        # @return [ProgressToken]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/implementation_registration_options.rb

@@ -0,0 +1,50 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ImplementationRegistrationOptions
+        def initialize(document_selector:, work_done_progress: nil, id: nil)
+          @attributes = {}
+
+          @attributes[:documentSelector] = document_selector
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:id] = id if id
+
+          @attributes.freeze
+        end
+
+        #
+        # 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.
+        #
+        # @return [DocumentSelector]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        #
+        # The id used to register the request. The id can be used to deregister
+        # the request again. See also Registration#id.
+        #
+        # @return [string]
+        def id
+          attributes.fetch(:id)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/initialize_params.rb

@@ -2,10 +2,13 @@ module LanguageServer
   module Protocol
     module Interface
       class InitializeParams
-        def initialize(process_id:, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil)
+        def initialize(work_done_token: nil, process_id:, client_info: nil, locale: nil, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:processId] = process_id
+          @attributes[:clientInfo] = client_info if client_info
+          @attributes[:locale] = locale if locale
           @attributes[:rootPath] = root_path if root_path
           @attributes[:rootUri] = root_uri
           @attributes[:initializationOptions] = initialization_options if initialization_options
@@ -17,15 +20,45 @@ module LanguageServer
         end
 
         #
-        # The process Id of the parent process that started
-        # the server. Is null if the process has not been started by another process.
-        # If the parent process is not alive then the server should exit (see exit notification) its process.
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
+        #
+        # The process Id of the parent process that started the server. Is null if
+        # the process has not been started by another process. If the parent
+        # process is not alive then the server should exit (see exit notification)
+        # its process.
         #
         # @return [number]
         def process_id
           attributes.fetch(:processId)
         end
 
+        #
+        # Information about the client
+        #
+        # @return [{ name: string; version?: string; }]
+        def client_info
+          attributes.fetch(:clientInfo)
+        end
+
+        #
+        # 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)
+        #
+        # @return [string]
+        def locale
+          attributes.fetch(:locale)
+        end
+
         #
         # The rootPath of the workspace. Is null
         # if no folder is open.
@@ -64,7 +97,7 @@ module LanguageServer
         #
         # The initial trace setting. If omitted trace is disabled ('off').
         #
-        # @return ["off" | "messages" | "verbose"]
+        # @return [TraceValue]
         def trace
           attributes.fetch(:trace)
         end
@@ -75,8 +108,6 @@ module LanguageServer
         # It can be `null` if the client supports workspace folders but none are
         # configured.
         #
-        # Since 3.6.0
-        #
         # @return [WorkspaceFolder[]]
         def workspace_folders
           attributes.fetch(:workspaceFolders)

data/lib/language_server/protocol/interface/initialize_result.rb

@@ -2,10 +2,11 @@ module LanguageServer
   module Protocol
     module Interface
       class InitializeResult
-        def initialize(capabilities:)
+        def initialize(capabilities:, server_info: nil)
           @attributes = {}
 
           @attributes[:capabilities] = capabilities
+          @attributes[:serverInfo] = server_info if server_info
 
           @attributes.freeze
         end
@@ -18,6 +19,14 @@ module LanguageServer
           attributes.fetch(:capabilities)
         end
 
+        #
+        # Information about the server.
+        #
+        # @return [{ name: string; version?: string; }]
+        def server_info
+          attributes.fetch(:serverInfo)
+        end
+
         attr_reader :attributes
 
         def to_hash

data/lib/language_server/protocol/interface/insert_replace_edit.rb

@@ -0,0 +1,54 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A special text edit to provide an insert and a replace operation.
+      #
+      class InsertReplaceEdit
+        def initialize(new_text:, insert:, replace:)
+          @attributes = {}
+
+          @attributes[:newText] = new_text
+          @attributes[:insert] = insert
+          @attributes[:replace] = replace
+
+          @attributes.freeze
+        end
+
+        #
+        # The string to be inserted.
+        #
+        # @return [string]
+        def new_text
+          attributes.fetch(:newText)
+        end
+
+        #
+        # The range if the insert is requested
+        #
+        # @return [Range]
+        def insert
+          attributes.fetch(:insert)
+        end
+
+        #
+        # The range if the replace is requested.
+        #
+        # @return [Range]
+        def replace
+          attributes.fetch(:replace)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/linked_editing_range_client_capabilities.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRangeClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # 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.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/linked_editing_range_options.rb

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRangeOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end