language_server-protocol 3.14.0.2 → 3.15.0.0

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

@@ -0,0 +1,43 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class RenameClientCapabilities
+        def initialize(dynamic_registration: nil, prepare_support: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:prepareSupport] = prepare_support if prepare_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether rename supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # Client supports testing for validity of rename operations
+        # before execution.
+        #
+        # @return [boolean]
+        def prepare_support
+          attributes.fetch(:prepareSupport)
+        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/rename_options.rb

@@ -1,13 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Rename options
-      #
-      class RenameOptions
-        def initialize(prepare_provider: nil)
+      class RenameOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil, prepare_provider: nil)
           @attributes = {}
 
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:prepareProvider] = prepare_provider if prepare_provider
 
           @attributes.freeze

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

@@ -1,33 +1,16 @@
 module LanguageServer
   module Protocol
     module Interface
-      class RenameParams
-        def initialize(text_document:, position:, new_name:)
+      class RenameParams < WorkDoneProgressParams
+        def initialize(work_done_token: nil, new_name:)
           @attributes = {}
 
-          @attributes[:textDocument] = text_document
-          @attributes[:position] = position
+          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:newName] = new_name
 
           @attributes.freeze
         end
 
-        #
-        # The document to rename.
-        #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
-        end
-
-        #
-        # The position at which this request was sent.
-        #
-        # @return [Position]
-        def position
-          attributes.fetch(:position)
-        end
-
         #
         # The new name of the symbol. If the given name is not valid the
         # request must return a [ResponseError](#ResponseError) with an

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

@@ -1,24 +1,16 @@
 module LanguageServer
   module Protocol
     module Interface
-      class RenameRegistrationOptions < TextDocumentRegistrationOptions
-        def initialize(document_selector:, prepare_provider: nil)
+      class RenameRegistrationOptions < RenameOptions
+        def initialize(work_done_progress: nil, prepare_provider: nil)
           @attributes = {}
 
-          @attributes[:documentSelector] = document_selector
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:prepareProvider] = prepare_provider if prepare_provider
 
           @attributes.freeze
         end
 
-        #
-        # Renames should be checked and tested for validity before being executed.
-        #
-        # @return [boolean]
-        def prepare_provider
-          attributes.fetch(:prepareProvider)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

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

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

@@ -29,10 +29,10 @@ module LanguageServer
         end
 
         #
-        # A Primitive or Structured value that contains additional
+        # A primitive or structured value that contains additional
         # information about the error. Can be omitted.
         #
-        # @return [D]
+        # @return [any]
         def data
           attributes.fetch(:data)
         end

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

@@ -22,10 +22,10 @@ module LanguageServer
         end
 
         #
-        # The result of a request. This can be omitted in
-        # the case of an error.
+        # The result of a request. This member is REQUIRED on success.
+        # This member MUST NOT exist if there was an error invoking the method.
         #
-        # @return [any]
+        # @return [string | number | boolean | object]
         def result
           attributes.fetch(:result)
         end
@@ -33,7 +33,7 @@ module LanguageServer
         #
         # The error object in case a request fails.
         #
-        # @return [ResponseError<any>]
+        # @return [ResponseError]
         def error
           attributes.fetch(:error)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Save options.
-      #
       class SaveOptions
         def initialize(include_text: nil)
           @attributes = {}

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

@@ -0,0 +1,42 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class SelectionRange
+        def initialize(range:, parent: nil)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:parent] = parent if parent
+
+          @attributes.freeze
+        end
+
+        #
+        # The [range](#Range) of this selection range.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.
+        #
+        # @return [SelectionRange]
+        def parent
+          attributes.fetch(:parent)
+        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/selection_range_client_capabilities.rb

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class SelectionRangeClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # 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.
+        #
+        # @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/selection_range_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class SelectionRangeOptions < 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/selection_range_params.rb

@@ -0,0 +1,43 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class SelectionRangeParams < PartialResultParams
+        def initialize(partial_result_token: nil, text_document:, positions:)
+          @attributes = {}
+
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:textDocument] = text_document
+          @attributes[:positions] = positions
+
+          @attributes.freeze
+        end
+
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
+        #
+        # The positions inside the text document.
+        #
+        # @return [Position[]]
+        def positions
+          attributes.fetch(:positions)
+        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/selection_range_registration_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class SelectionRangeRegistrationOptions < 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/server_capabilities.rb

@@ -2,30 +2,32 @@ module LanguageServer
   module Protocol
     module Interface
       class ServerCapabilities
-        def initialize(text_document_sync: nil, hover_provider: nil, completion_provider: nil, signature_help_provider: nil, definition_provider: nil, type_definition_provider: nil, implementation_provider: nil, references_provider: nil, document_highlight_provider: nil, document_symbol_provider: nil, workspace_symbol_provider: nil, code_action_provider: nil, code_lens_provider: nil, document_formatting_provider: nil, document_range_formatting_provider: nil, document_on_type_formatting_provider: nil, rename_provider: nil, document_link_provider: nil, color_provider: nil, folding_range_provider: nil, execute_command_provider: nil, workspace: nil, experimental: nil)
+        def initialize(text_document_sync: nil, completion_provider: nil, hover_provider: nil, signature_help_provider: nil, declaration_provider: nil, definition_provider: nil, type_definition_provider: nil, implementation_provider: nil, references_provider: nil, document_highlight_provider: nil, document_symbol_provider: nil, code_action_provider: nil, code_lens_provider: nil, document_link_provider: nil, color_provider: nil, document_formatting_provider: nil, document_range_formatting_provider: nil, document_on_type_formatting_provider: nil, rename_provider: nil, folding_range_provider: nil, execute_command_provider: nil, selection_range_provider: nil, workspace_symbol_provider: nil, workspace: nil, experimental: nil)
           @attributes = {}
 
           @attributes[:textDocumentSync] = text_document_sync if text_document_sync
-          @attributes[:hoverProvider] = hover_provider if hover_provider
           @attributes[:completionProvider] = completion_provider if completion_provider
+          @attributes[:hoverProvider] = hover_provider if hover_provider
           @attributes[:signatureHelpProvider] = signature_help_provider if signature_help_provider
+          @attributes[:declarationProvider] = declaration_provider if declaration_provider
           @attributes[:definitionProvider] = definition_provider if definition_provider
           @attributes[:typeDefinitionProvider] = type_definition_provider if type_definition_provider
           @attributes[:implementationProvider] = implementation_provider if implementation_provider
           @attributes[:referencesProvider] = references_provider if references_provider
           @attributes[:documentHighlightProvider] = document_highlight_provider if document_highlight_provider
           @attributes[:documentSymbolProvider] = document_symbol_provider if document_symbol_provider
-          @attributes[:workspaceSymbolProvider] = workspace_symbol_provider if workspace_symbol_provider
           @attributes[:codeActionProvider] = code_action_provider if code_action_provider
           @attributes[:codeLensProvider] = code_lens_provider if code_lens_provider
+          @attributes[:documentLinkProvider] = document_link_provider if document_link_provider
+          @attributes[:colorProvider] = color_provider if color_provider
           @attributes[:documentFormattingProvider] = document_formatting_provider if document_formatting_provider
           @attributes[:documentRangeFormattingProvider] = document_range_formatting_provider if document_range_formatting_provider
           @attributes[:documentOnTypeFormattingProvider] = document_on_type_formatting_provider if document_on_type_formatting_provider
           @attributes[:renameProvider] = rename_provider if rename_provider
-          @attributes[:documentLinkProvider] = document_link_provider if document_link_provider
-          @attributes[:colorProvider] = color_provider if color_provider
           @attributes[:foldingRangeProvider] = folding_range_provider if folding_range_provider
           @attributes[:executeCommandProvider] = execute_command_provider if execute_command_provider
+          @attributes[:selectionRangeProvider] = selection_range_provider if selection_range_provider
+          @attributes[:workspaceSymbolProvider] = workspace_symbol_provider if workspace_symbol_provider
           @attributes[:workspace] = workspace if workspace
           @attributes[:experimental] = experimental if experimental
 
@@ -41,14 +43,6 @@ module LanguageServer
           attributes.fetch(:textDocumentSync)
         end
 
-        #
-        # The server provides hover support.
-        #
-        # @return [boolean]
-        def hover_provider
-          attributes.fetch(:hoverProvider)
-        end
-
         #
         # The server provides completion support.
         #
@@ -57,6 +51,14 @@ module LanguageServer
           attributes.fetch(:completionProvider)
         end
 
+        #
+        # The server provides hover support.
+        #
+        # @return [boolean | HoverOptions]
+        def hover_provider
+          attributes.fetch(:hoverProvider)
+        end
+
         #
         # The server provides signature help support.
         #
@@ -65,30 +67,34 @@ module LanguageServer
           attributes.fetch(:signatureHelpProvider)
         end
 
+        #
+        # The server provides go to declaration support.
+        #
+        # @return [boolean | DeclarationOptions | DeclarationRegistrationOptions]
+        def declaration_provider
+          attributes.fetch(:declarationProvider)
+        end
+
         #
         # The server provides goto definition support.
         #
-        # @return [boolean]
+        # @return [boolean | DefinitionOptions]
         def definition_provider
           attributes.fetch(:definitionProvider)
         end
 
         #
-        # The server provides Goto Type Definition support.
+        # The server provides goto type definition support.
         #
-        # Since 3.6.0
-        #
-        # @return [boolean | (TextDocumentRegistrationOptions & StaticRegistrationOptions)]
+        # @return [boolean | TypeDefinitionOptions | TypeDefinitionRegistrationOptions]
         def type_definition_provider
           attributes.fetch(:typeDefinitionProvider)
         end
 
         #
-        # The server provides Goto Implementation support.
-        #
-        # Since 3.6.0
+        # The server provides goto implementation support.
         #
-        # @return [boolean | (TextDocumentRegistrationOptions & StaticRegistrationOptions)]
+        # @return [boolean | ImplementationOptions | ImplementationRegistrationOptions]
         def implementation_provider
           attributes.fetch(:implementationProvider)
         end
@@ -96,7 +102,7 @@ module LanguageServer
         #
         # The server provides find references support.
         #
-        # @return [boolean]
+        # @return [boolean | ReferenceOptions]
         def references_provider
           attributes.fetch(:referencesProvider)
         end
@@ -104,7 +110,7 @@ module LanguageServer
         #
         # The server provides document highlight support.
         #
-        # @return [boolean]
+        # @return [boolean | DocumentHighlightOptions]
         def document_highlight_provider
           attributes.fetch(:documentHighlightProvider)
         end
@@ -112,19 +118,11 @@ module LanguageServer
         #
         # The server provides document symbol support.
         #
-        # @return [boolean]
+        # @return [boolean | DocumentSymbolOptions]
         def document_symbol_provider
           attributes.fetch(:documentSymbolProvider)
         end
 
-        #
-        # The server provides workspace symbol support.
-        #
-        # @return [boolean]
-        def workspace_symbol_provider
-          attributes.fetch(:workspaceSymbolProvider)
-        end
-
         #
         # The server provides code actions. The `CodeActionOptions` return type is only
         # valid if the client signals code action literal support via the property
@@ -143,10 +141,26 @@ module LanguageServer
           attributes.fetch(:codeLensProvider)
         end
 
+        #
+        # The server provides document link support.
+        #
+        # @return [DocumentLinkOptions]
+        def document_link_provider
+          attributes.fetch(:documentLinkProvider)
+        end
+
+        #
+        # The server provides color provider support.
+        #
+        # @return [boolean | DocumentColorOptions | DocumentColorRegistrationOptions]
+        def color_provider
+          attributes.fetch(:colorProvider)
+        end
+
         #
         # The server provides document formatting.
         #
-        # @return [boolean]
+        # @return [boolean | DocumentFormattingOptions]
         def document_formatting_provider
           attributes.fetch(:documentFormattingProvider)
         end
@@ -154,7 +168,7 @@ module LanguageServer
         #
         # The server provides document range formatting.
         #
-        # @return [boolean]
+        # @return [boolean | DocumentRangeFormattingOptions]
         def document_range_formatting_provider
           attributes.fetch(:documentRangeFormattingProvider)
         end
@@ -178,45 +192,41 @@ module LanguageServer
         end
 
         #
-        # The server provides document link support.
+        # The server provides folding provider support.
         #
-        # @return [DocumentLinkOptions]
-        def document_link_provider
-          attributes.fetch(:documentLinkProvider)
+        # @return [boolean | FoldingRangeOptions | FoldingRangeRegistrationOptions]
+        def folding_range_provider
+          attributes.fetch(:foldingRangeProvider)
         end
 
         #
-        # The server provides color provider support.
-        #
-        # Since 3.6.0
+        # The server provides execute command support.
         #
-        # @return [boolean | ColorProviderOptions | (ColorProviderOptions & TextDocumentRegistrationOptions & Static...]
-        def color_provider
-          attributes.fetch(:colorProvider)
+        # @return [ExecuteCommandOptions]
+        def execute_command_provider
+          attributes.fetch(:executeCommandProvider)
         end
 
         #
-        # The server provides folding provider support.
-        #
-        # Since 3.10.0
+        # The server provides selection range support.
         #
-        # @return [boolean | FoldingRangeProviderOptions | (FoldingRangeProviderOptions & TextDocumentRegistrationOp...]
-        def folding_range_provider
-          attributes.fetch(:foldingRangeProvider)
+        # @return [boolean | SelectionRangeOptions | SelectionRangeRegistrationOptions]
+        def selection_range_provider
+          attributes.fetch(:selectionRangeProvider)
         end
 
         #
-        # The server provides execute command support.
+        # The server provides workspace symbol support.
         #
-        # @return [ExecuteCommandOptions]
-        def execute_command_provider
-          attributes.fetch(:executeCommandProvider)
+        # @return [boolean]
+        def workspace_symbol_provider
+          attributes.fetch(:workspaceSymbolProvider)
         end
 
         #
         # Workspace specific server capabilities
         #
-        # @return [{ workspaceFolders?: { supported?: boolean; changeNotifications?: string | boolean; }; }]
+        # @return [{ workspaceFolders?: WorkspaceFoldersServerCapabilities; }]
         def workspace
           attributes.fetch(:workspace)
         end