language_server-protocol 3.14.0.2 → 3.15.0.0

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

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ImplementationParams < PartialResultParams
+        def initialize(partial_result_token: nil)
+          @attributes = {}
+
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+
+          @attributes.freeze
+        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,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ImplementationRegistrationOptions < StaticRegistrationOptions
+        def initialize(id: nil)
+          @attributes = {}
+
+          @attributes[:id] = id if id
+
+          @attributes.freeze
+        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

@@ -1,11 +1,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)
+      class InitializeParams < WorkDoneProgressParams
+        def initialize(work_done_token: nil, process_id:, client_info: 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[:rootPath] = root_path if root_path
           @attributes[:rootUri] = root_uri
           @attributes[:initializationOptions] = initialization_options if initialization_options
@@ -26,6 +28,14 @@ module LanguageServer
           attributes.fetch(:processId)
         end
 
+        #
+        # Information about the client
+        #
+        # @return [{ name: string; version?: string; }]
+        def client_info
+          attributes.fetch(:clientInfo)
+        end
+
         #
         # The rootPath of the workspace. Is null
         # if no folder is open.
@@ -75,8 +85,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/location_link.rb

@@ -2,13 +2,13 @@ module LanguageServer
   module Protocol
     module Interface
       class LocationLink
-        def initialize(origin_selection_range: nil, target_uri:, target_range:, target_selection_range: nil)
+        def initialize(origin_selection_range: nil, target_uri:, target_range:, target_selection_range:)
           @attributes = {}
 
           @attributes[:originSelectionRange] = origin_selection_range if origin_selection_range
           @attributes[:targetUri] = target_uri
           @attributes[:targetRange] = target_range
-          @attributes[:targetSelectionRange] = target_selection_range if target_selection_range
+          @attributes[:targetSelectionRange] = target_selection_range
 
           @attributes.freeze
         end
@@ -33,7 +33,9 @@ module LanguageServer
         end
 
         #
-        # The full target range of this link.
+        # 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.
         #
         # @return [Range]
         def target_range
@@ -41,7 +43,8 @@ module LanguageServer
         end
 
         #
-        # The span of this link.
+        # The range that should be selected and revealed when this link is being followed, e.g the name of a function.
+        # Must be contained by the the `targetRange`. See also `DocumentSymbol#range`
         #
         # @return [Range]
         def target_selection_range

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

@@ -23,7 +23,7 @@ module LanguageServer
         #
         # The notification's params.
         #
-        # @return [object | any[]]
+        # @return [any]
         def params
           attributes.fetch(:params)
         end

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

@@ -0,0 +1,34 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class PartialResultParams
+        def initialize(partial_result_token: nil)
+          @attributes = {}
+
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+
+          @attributes.freeze
+        end
+
+        #
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
+        #
+        # @return [string | number]
+        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/prepare_rename_params.rb

@@ -0,0 +1,26 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class PrepareRenameParams < TextDocumentPositionParams
+        def initialize(text_document:, position:)
+          @attributes = {}
+
+          @attributes[:textDocument] = text_document
+          @attributes[:position] = position
+
+          @attributes.freeze
+        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/progress_params.rb

@@ -0,0 +1,42 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ProgressParams
+        def initialize(token:, value:)
+          @attributes = {}
+
+          @attributes[:token] = token
+          @attributes[:value] = value
+
+          @attributes.freeze
+        end
+
+        #
+        # The progress token provided by the client or server.
+        #
+        # @return [string | number]
+        def token
+          attributes.fetch(:token)
+        end
+
+        #
+        # The progress data.
+        #
+        # @return [T]
+        def value
+          attributes.fetch(:value)
+        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/publish_diagnostics_client_capabilities.rb

@@ -0,0 +1,53 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class PublishDiagnosticsClientCapabilities
+        def initialize(related_information: nil, tag_support: nil, version_support: nil)
+          @attributes = {}
+
+          @attributes[:relatedInformation] = related_information if related_information
+          @attributes[:tagSupport] = tag_support if tag_support
+          @attributes[:versionSupport] = version_support if version_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether the clients accepts diagnostics with related information.
+        #
+        # @return [boolean]
+        def related_information
+          attributes.fetch(:relatedInformation)
+        end
+
+        #
+        # Client supports the tag property to provide meta data about a diagnostic.
+        # Clients supporting tags have to handle unknown tags gracefully.
+        #
+        # @return [{ valueSet: DiagnosticTag[]; }]
+        def tag_support
+          attributes.fetch(:tagSupport)
+        end
+
+        #
+        # Whether the client interprets the version property of the
+        # `textDocument/publishDiagnostics` notification's parameter.
+        #
+        # @return [boolean]
+        def version_support
+          attributes.fetch(:versionSupport)
+        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/publish_diagnostics_params.rb

@@ -2,10 +2,11 @@ module LanguageServer
   module Protocol
     module Interface
       class PublishDiagnosticsParams
-        def initialize(uri:, diagnostics:)
+        def initialize(uri:, version: nil, diagnostics:)
           @attributes = {}
 
           @attributes[:uri] = uri
+          @attributes[:version] = version if version
           @attributes[:diagnostics] = diagnostics
 
           @attributes.freeze
@@ -19,6 +20,14 @@ module LanguageServer
           attributes.fetch(:uri)
         end
 
+        #
+        # Optional the version number of the document the diagnostics are published for.
+        #
+        # @return [number]
+        def version
+          attributes.fetch(:version)
+        end
+
         #
         # An array of diagnostic information items.
         #

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

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ReferenceClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether references supports dynamic registration.
+        #
+        # @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/reference_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ReferenceOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        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/reference_params.rb

@@ -1,12 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      class ReferenceParams < TextDocumentPositionParams
-        def initialize(text_document:, position:, context:)
+      class ReferenceParams < PartialResultParams
+        def initialize(partial_result_token: nil, context:)
           @attributes = {}
 
-          @attributes[:textDocument] = text_document
-          @attributes[:position] = position
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:context] = context
 
           @attributes.freeze

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

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ReferenceRegistrationOptions < ReferenceOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end