language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -1,8 +1,12 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Defines the capabilities provided by a language
+      # server.
+      #
       class ServerCapabilities
-        def initialize(position_encoding: nil, text_document_sync: nil, notebook_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, linked_editing_range_provider: nil, call_hierarchy_provider: nil, semantic_tokens_provider: nil, moniker_provider: nil, type_hierarchy_provider: nil, inline_value_provider: nil, inlay_hint_provider: nil, diagnostic_provider: nil, workspace_symbol_provider: nil, workspace: nil, experimental: nil)
+        def initialize(position_encoding: nil, text_document_sync: nil, notebook_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, workspace_symbol_provider: nil, document_formatting_provider: nil, document_range_formatting_provider: nil, document_on_type_formatting_provider: nil, rename_provider: nil, folding_range_provider: nil, selection_range_provider: nil, execute_command_provider: nil, call_hierarchy_provider: nil, linked_editing_range_provider: nil, semantic_tokens_provider: nil, moniker_provider: nil, type_hierarchy_provider: nil, inline_value_provider: nil, inlay_hint_provider: nil, diagnostic_provider: nil, workspace: nil, experimental: nil)
           @attributes = {}
 
           @attributes[:positionEncoding] = position_encoding if position_encoding
@@ -22,22 +26,22 @@ module LanguageServer
           @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[:workspaceSymbolProvider] = workspace_symbol_provider if workspace_symbol_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[: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[:linkedEditingRangeProvider] = linked_editing_range_provider if linked_editing_range_provider
+          @attributes[:executeCommandProvider] = execute_command_provider if execute_command_provider
           @attributes[:callHierarchyProvider] = call_hierarchy_provider if call_hierarchy_provider
+          @attributes[:linkedEditingRangeProvider] = linked_editing_range_provider if linked_editing_range_provider
           @attributes[:semanticTokensProvider] = semantic_tokens_provider if semantic_tokens_provider
           @attributes[:monikerProvider] = moniker_provider if moniker_provider
           @attributes[:typeHierarchyProvider] = type_hierarchy_provider if type_hierarchy_provider
           @attributes[:inlineValueProvider] = inline_value_provider if inline_value_provider
           @attributes[:inlayHintProvider] = inlay_hint_provider if inlay_hint_provider
           @attributes[:diagnosticProvider] = diagnostic_provider if diagnostic_provider
-          @attributes[:workspaceSymbolProvider] = workspace_symbol_provider if workspace_symbol_provider
           @attributes[:workspace] = workspace if workspace
           @attributes[:experimental] = experimental if experimental
 
@@ -53,7 +57,9 @@ module LanguageServer
         #
         # If omitted it defaults to 'utf-16'.
         #
-        # @return [string]
+        # @since 3.17.0
+        #
+        # @return [PositionEncodingKind]
         def position_encoding
           attributes.fetch(:positionEncoding)
         end
@@ -61,8 +67,7 @@ module LanguageServer
         #
         # Defines how text documents are synced. Is either a detailed structure
         # defining each notification or for backwards compatibility the
-        # TextDocumentSyncKind number. If omitted it defaults to
-        # `TextDocumentSyncKind.None`.
+        # TextDocumentSyncKind number.
         #
         # @return [TextDocumentSyncOptions | TextDocumentSyncKind]
         def text_document_sync
@@ -72,6 +77,8 @@ module LanguageServer
         #
         # Defines how notebook documents are synced.
         #
+        # @since 3.17.0
+        #
         # @return [NotebookDocumentSyncOptions | NotebookDocumentSyncRegistrationOptions]
         def notebook_document_sync
           attributes.fetch(:notebookDocumentSync)
@@ -102,7 +109,7 @@ module LanguageServer
         end
 
         #
-        # The server provides go to declaration support.
+        # The server provides Goto Declaration support.
         #
         # @return [boolean | DeclarationOptions | DeclarationRegistrationOptions]
         def declaration_provider
@@ -118,7 +125,7 @@ module LanguageServer
         end
 
         #
-        # The server provides goto type definition support.
+        # The server provides Goto Type Definition support.
         #
         # @return [boolean | TypeDefinitionOptions | TypeDefinitionRegistrationOptions]
         def type_definition_provider
@@ -126,7 +133,7 @@ module LanguageServer
         end
 
         #
-        # The server provides goto implementation support.
+        # The server provides Goto Implementation support.
         #
         # @return [boolean | ImplementationOptions | ImplementationRegistrationOptions]
         def implementation_provider
@@ -158,9 +165,9 @@ module LanguageServer
         end
 
         #
-        # The server provides code actions. The `CodeActionOptions` return type is
-        # only valid if the client signals code action literal support via the
-        # property `textDocument.codeAction.codeActionLiteralSupport`.
+        # The server provides code actions. CodeActionOptions may only be
+        # specified if the client states that it supports
+        # `codeActionLiteralSupport` in its initial `initialize` request.
         #
         # @return [boolean | CodeActionOptions]
         def code_action_provider
@@ -191,6 +198,14 @@ module LanguageServer
           attributes.fetch(:colorProvider)
         end
 
+        #
+        # The server provides workspace symbol support.
+        #
+        # @return [boolean | WorkspaceSymbolOptions]
+        def workspace_symbol_provider
+          attributes.fetch(:workspaceSymbolProvider)
+        end
+
         #
         # The server provides document formatting.
         #
@@ -233,14 +248,6 @@ module LanguageServer
           attributes.fetch(:foldingRangeProvider)
         end
 
-        #
-        # The server provides execute command support.
-        #
-        # @return [ExecuteCommandOptions]
-        def execute_command_provider
-          attributes.fetch(:executeCommandProvider)
-        end
-
         #
         # The server provides selection range support.
         #
@@ -250,31 +257,47 @@ module LanguageServer
         end
 
         #
-        # The server provides linked editing range support.
+        # The server provides execute command support.
         #
-        # @return [boolean | LinkedEditingRangeOptions | LinkedEditingRangeRegistrationOptions]
-        def linked_editing_range_provider
-          attributes.fetch(:linkedEditingRangeProvider)
+        # @return [ExecuteCommandOptions]
+        def execute_command_provider
+          attributes.fetch(:executeCommandProvider)
         end
 
         #
         # The server provides call hierarchy support.
         #
+        # @since 3.16.0
+        #
         # @return [boolean | CallHierarchyOptions | CallHierarchyRegistrationOptions]
         def call_hierarchy_provider
           attributes.fetch(:callHierarchyProvider)
         end
 
+        #
+        # The server provides linked editing range support.
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean | LinkedEditingRangeOptions | LinkedEditingRangeRegistrationOptions]
+        def linked_editing_range_provider
+          attributes.fetch(:linkedEditingRangeProvider)
+        end
+
         #
         # The server provides semantic tokens support.
         #
+        # @since 3.16.0
+        #
         # @return [SemanticTokensOptions | SemanticTokensRegistrationOptions]
         def semantic_tokens_provider
           attributes.fetch(:semanticTokensProvider)
         end
 
         #
-        # Whether server provides moniker support.
+        # The server provides moniker support.
+        #
+        # @since 3.16.0
         #
         # @return [boolean | MonikerOptions | MonikerRegistrationOptions]
         def moniker_provider
@@ -284,6 +307,8 @@ module LanguageServer
         #
         # The server provides type hierarchy support.
         #
+        # @since 3.17.0
+        #
         # @return [boolean | TypeHierarchyOptions | TypeHierarchyRegistrationOptions]
         def type_hierarchy_provider
           attributes.fetch(:typeHierarchyProvider)
@@ -292,6 +317,8 @@ module LanguageServer
         #
         # The server provides inline values.
         #
+        # @since 3.17.0
+        #
         # @return [boolean | InlineValueOptions | InlineValueRegistrationOptions]
         def inline_value_provider
           attributes.fetch(:inlineValueProvider)
@@ -300,6 +327,8 @@ module LanguageServer
         #
         # The server provides inlay hints.
         #
+        # @since 3.17.0
+        #
         # @return [boolean | InlayHintOptions | InlayHintRegistrationOptions]
         def inlay_hint_provider
           attributes.fetch(:inlayHintProvider)
@@ -308,23 +337,17 @@ module LanguageServer
         #
         # The server has support for pull model diagnostics.
         #
+        # @since 3.17.0
+        #
         # @return [DiagnosticOptions | DiagnosticRegistrationOptions]
         def diagnostic_provider
           attributes.fetch(:diagnosticProvider)
         end
 
         #
-        # The server provides workspace symbol support.
-        #
-        # @return [boolean | WorkspaceSymbolOptions]
-        def workspace_symbol_provider
-          attributes.fetch(:workspaceSymbolProvider)
-        end
-
-        #
-        # Workspace specific server capabilities
+        # Workspace specific server capabilities.
         #
-        # @return [{ workspaceFolders?: WorkspaceFoldersServerCapabilities; fileOperations?: { didCreate?: FileOperationRegistrationOptions; ... 4 more ...; willDelete?: FileOperationRegistrationOptions; }; }]
+        # @return [{ workspaceFolders?: WorkspaceFoldersServerCapabilities; fileOperations?: FileOperationOptions; }]
         def workspace
           attributes.fetch(:workspace)
         end

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

@@ -10,10 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        #
-        # The new value that should be assigned to the trace setting.
-        #
-        # @return [TraceValue]
+        # @return [TraceValues]
         def value
           attributes.fetch(:value)
         end

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

@@ -2,7 +2,9 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Client capabilities for the show document request.
+      # Client capabilities for the showDocument request.
+      #
+      # @since 3.16.0
       #
       class ShowDocumentClientCapabilities
         def initialize(support:)
@@ -14,7 +16,7 @@ module LanguageServer
         end
 
         #
-        # The client has support for the show document
+        # The client has support for the showDocument
         # request.
         #
         # @return [boolean]

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

@@ -2,7 +2,9 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Params to show a resource.
+      # Params to show a document.
+      #
+      # @since 3.16.0
       #
       class ShowDocumentParams
         def initialize(uri:, external: nil, take_focus: nil, selection: nil)
@@ -17,16 +19,16 @@ module LanguageServer
         end
 
         #
-        # The uri to show.
+        # The document uri to show.
         #
-        # @return [string]
+        # @return [URI]
         def uri
           attributes.fetch(:uri)
         end
 
         #
         # Indicates to show the resource in an external program.
-        # To show, for example, `https://code.visualstudio.com/`
+        # To show for example `https://code.visualstudio.com/`
         # in the default WEB browser set `external` to `true`.
         #
         # @return [boolean]

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

@@ -2,7 +2,9 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The result of an show document request.
+      # The result of a showDocument request.
+      #
+      # @since 3.16.0
       #
       class ShowDocumentResult
         def initialize(success:)

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a notification message.
+      #
       class ShowMessageParams
         def initialize(type:, message:)
           @attributes = {}
@@ -12,7 +15,7 @@ module LanguageServer
         end
 
         #
-        # The message type. See {@link MessageType}.
+        # The message type. See {@link MessageType}
         #
         # @return [MessageType]
         def type

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

@@ -21,7 +21,7 @@ module LanguageServer
         end
 
         #
-        # The actual message
+        # The actual message.
         #
         # @return [string]
         def message

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

@@ -18,8 +18,7 @@ module LanguageServer
         end
 
         #
-        # One or more signatures. If no signatures are available the signature help
-        # request should return `null`.
+        # One or more signatures.
         #
         # @return [SignatureInformation[]]
         def signatures
@@ -28,8 +27,8 @@ module LanguageServer
 
         #
         # The active signature. If omitted or the value lies outside the
-        # range of `signatures` the value defaults to zero or is ignore if
-        # the `SignatureHelp` as no signatures.
+        # 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.
@@ -37,7 +36,7 @@ module LanguageServer
         # In future version of the protocol this property might become
         # mandatory to better express this.
         #
-        # @return [number]
+        # @return [uinteger]
         def active_signature
           attributes.fetch(:activeSignature)
         end
@@ -51,7 +50,7 @@ module LanguageServer
         # mandatory to better express the active parameter if the
         # active signature does have any.
         #
-        # @return [number]
+        # @return [uinteger]
         def active_parameter
           attributes.fetch(:activeParameter)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client Capabilities for a {@link SignatureHelpRequest}.
+      #
       class SignatureHelpClientCapabilities
         def initialize(dynamic_registration: nil, signature_information: nil, context_support: nil)
           @attributes = {}
@@ -35,6 +38,8 @@ module LanguageServer
         # contextSupport will also support the `retriggerCharacters` on
         # `SignatureHelpOptions`.
         #
+        # @since 3.15.0
+        #
         # @return [boolean]
         def context_support
           attributes.fetch(:contextSupport)

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

@@ -2,8 +2,9 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Additional information about the context in which a signature help request
-      # was triggered.
+      # Additional information about the context in which a signature help request was triggered.
+      #
+      # @since 3.15.0
       #
       class SignatureHelpContext
         def initialize(trigger_kind:, trigger_character: nil, is_retrigger:, active_signature_help: nil)
@@ -28,8 +29,7 @@ module LanguageServer
         #
         # Character that caused signature help to be triggered.
         #
-        # This is undefined when triggerKind !==
-        # SignatureHelpTriggerKind.TriggerCharacter
+        # This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`
         #
         # @return [string]
         def trigger_character
@@ -39,9 +39,8 @@ module LanguageServer
         #
         # `true` if signature help was already showing when it was triggered.
         #
-        # Retriggers occur 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.
+        # 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.
         #
         # @return [boolean]
         def is_retrigger
@@ -51,8 +50,8 @@ module LanguageServer
         #
         # The currently active `SignatureHelp`.
         #
-        # The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field
-        # updated based on the user navigating through available signatures.
+        # The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on
+        # the user navigating through available signatures.
         #
         # @return [SignatureHelp]
         def active_signature_help

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

@@ -1,25 +1,22 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Server Capabilities for a {@link SignatureHelpRequest}.
+      #
       class SignatureHelpOptions
-        def initialize(work_done_progress: nil, trigger_characters: nil, retrigger_characters: nil)
+        def initialize(trigger_characters: nil, retrigger_characters: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:triggerCharacters] = trigger_characters if trigger_characters
           @attributes[:retriggerCharacters] = retrigger_characters if retrigger_characters
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
-        # The characters that trigger signature help
-        # automatically.
+        # List of characters that trigger signature help automatically.
         #
         # @return [string[]]
         def trigger_characters
@@ -29,15 +26,21 @@ module LanguageServer
         #
         # 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.
+        # 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
         #
         # @return [string[]]
         def retrigger_characters
           attributes.fetch(:retriggerCharacters)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,18 +1,32 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link SignatureHelpRequest}.
+      #
       class SignatureHelpParams
-        def initialize(text_document:, position:, work_done_token: nil, context: nil)
+        def initialize(context: nil, text_document:, position:, work_done_token: nil)
           @attributes = {}
 
+          @attributes[:context] = context if context
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
           @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:context] = context if context
 
           @attributes.freeze
         end
 
+        #
+        # 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
+        #
+        # @return [SignatureHelpContext]
+        def context
+          attributes.fetch(:context)
+        end
+
         #
         # The text document.
         #
@@ -37,16 +51,6 @@ module LanguageServer
           attributes.fetch(:workDoneToken)
         end
 
-        #
-        # The signature help context. This is only available if the client
-        # specifies to send this using the client capability
-        # `textDocument.signatureHelp.contextSupport === true`
-        #
-        # @return [SignatureHelpContext]
-        def context
-          attributes.fetch(:context)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,35 +1,32 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link SignatureHelpRequest}.
+      #
       class SignatureHelpRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, trigger_characters: nil, retrigger_characters: nil)
+        def initialize(document_selector:, trigger_characters: nil, retrigger_characters: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:triggerCharacters] = trigger_characters if trigger_characters
           @attributes[:retriggerCharacters] = retrigger_characters if retrigger_characters
+          @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.
+        # 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]
+        # @return [DocumentSelector | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
-        # The characters that trigger signature help
-        # automatically.
+        # List of characters that trigger signature help automatically.
         #
         # @return [string[]]
         def trigger_characters
@@ -39,15 +36,21 @@ module LanguageServer
         #
         # 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.
+        # 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
         #
         # @return [string[]]
         def retrigger_characters
           attributes.fetch(:retriggerCharacters)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -49,7 +49,9 @@ module LanguageServer
         #
         # If provided, this is used in place of `SignatureHelp.activeParameter`.
         #
-        # @return [number]
+        # @since 3.16.0
+        #
+        # @return [uinteger]
         def active_parameter
           attributes.fetch(:activeParameter)
         end

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

@@ -2,7 +2,8 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Static registration options to be returned in the initialize request.
+      # Static registration options to be returned in the initialize
+      # request.
       #
       class StaticRegistrationOptions
         def initialize(id: nil)