language_server-protocol 3.14.0.0 → 3.15.0.2

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

@@ -18,7 +18,8 @@ module LanguageServer
         end
 
         #
-        # One or more signatures.
+        # One or more signatures. If no signaures are availabe the signature help
+        # request should return `null`.
         #
         # @return [SignatureInformation[]]
         def signatures
@@ -27,10 +28,12 @@ module LanguageServer
 
         #
         # The active signature. If omitted or the value lies outside the
-        # range of `signatures` the value defaults to zero or is ignored if
-        # `signatures.length === 0`. Whenever possible implementors should
-        # make an active decision about the active signature and shouldn't
-        # rely on a default value.
+        # range of `signatures` the value defaults to zero or is ignore if
+        # the `SignatureHelp` as no signatures.
+        #
+        # Whenever possible implementors should make an active decision about
+        # the active signature and shouldn't rely on a default value.
+        #
         # In future version of the protocol this property might become
         # mandatory to better express this.
         #

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

@@ -0,0 +1,55 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class SignatureHelpClientCapabilities
+        def initialize(dynamic_registration: nil, signature_information: nil, context_support: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:signatureInformation] = signature_information if signature_information
+          @attributes[:contextSupport] = context_support if context_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether signature help supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # The client supports the following `SignatureInformation`
+        # specific properties.
+        #
+        # @return [{ documentationFormat?: MarkupKind[]; parameterInformation?: { labelOffsetSupport?: boolean; }; }]
+        def signature_information
+          attributes.fetch(:signatureInformation)
+        end
+
+        #
+        # The client supports to send additional context information for a
+        # `textDocument/signatureHelp` request. A client that opts into
+        # contextSupport will also support the `retriggerCharacters` on
+        # `SignatureHelpOptions`.
+        #
+        # @return [boolean]
+        def context_support
+          attributes.fetch(:contextSupport)
+        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/signature_help_context.rb

@@ -0,0 +1,71 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Additional information about the context in which a signature help request was triggered.
+      #
+      class SignatureHelpContext
+        def initialize(trigger_kind:, trigger_character: nil, is_retrigger:, active_signature_help: nil)
+          @attributes = {}
+
+          @attributes[:triggerKind] = trigger_kind
+          @attributes[:triggerCharacter] = trigger_character if trigger_character
+          @attributes[:isRetrigger] = is_retrigger
+          @attributes[:activeSignatureHelp] = active_signature_help if active_signature_help
+
+          @attributes.freeze
+        end
+
+        #
+        # Action that caused signature help to be triggered.
+        #
+        # @return [CompletionTriggerKind]
+        def trigger_kind
+          attributes.fetch(:triggerKind)
+        end
+
+        #
+        # Character that caused signature help to be triggered.
+        #
+        # This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`
+        #
+        # @return [string]
+        def trigger_character
+          attributes.fetch(:triggerCharacter)
+        end
+
+        #
+        # `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.
+        #
+        # @return [boolean]
+        def is_retrigger
+          attributes.fetch(:isRetrigger)
+        end
+
+        #
+        # The currently active `SignatureHelp`.
+        #
+        # The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on
+        # the user navigating through available signatures.
+        #
+        # @return [SignatureHelp]
+        def active_signature_help
+          attributes.fetch(:activeSignatureHelp)
+        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/signature_help_options.rb

@@ -1,14 +1,13 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Signature help options.
-      #
-      class SignatureHelpOptions
-        def initialize(trigger_characters: nil)
+      class SignatureHelpOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil, trigger_characters: nil, retrigger_characters: 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.freeze
         end
@@ -22,6 +21,17 @@ module LanguageServer
           attributes.fetch(:triggerCharacters)
         end
 
+        #
+        # 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.
+        #
+        # @return [string[]]
+        def retrigger_characters
+          attributes.fetch(:retriggerCharacters)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class SignatureHelpParams < WorkDoneProgressParams
+        def initialize(work_done_token: nil, context: nil)
+          @attributes = {}
+
+          @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`
+        #
+        # @return [SignatureHelpContext]
+        def context
+          attributes.fetch(:context)
+        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/signature_help_registration_options.rb

@@ -1,24 +1,17 @@
 module LanguageServer
   module Protocol
     module Interface
-      class SignatureHelpRegistrationOptions < TextDocumentRegistrationOptions
-        def initialize(document_selector:, trigger_characters: nil)
+      class SignatureHelpRegistrationOptions < SignatureHelpOptions
+        def initialize(work_done_progress: nil, trigger_characters: nil, retrigger_characters: 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.freeze
         end
 
-        #
-        # The characters that trigger signature help
-        # automatically.
-        #
-        # @return [string[]]
-        def trigger_characters
-          attributes.fetch(:triggerCharacters)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -29,7 +29,7 @@ module LanguageServer
         #
         # The kind of this symbol.
         #
-        # @return [number]
+        # @return [any]
         def kind
           attributes.fetch(:kind)
         end

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

@@ -8,6 +8,7 @@ module LanguageServer
         def initialize(document_selector:, sync_kind:)
           @attributes = {}
 
+          @attributes[:documentSelector] = document_selector
           @attributes[:syncKind] = sync_kind
 
           @attributes.freeze
@@ -17,7 +18,7 @@ module LanguageServer
         # How documents are synced to the server. See TextDocumentSyncKind.Full
         # and TextDocumentSyncKind.Incremental.
         #
-        # @return [number]
+        # @return [any]
         def sync_kind
           attributes.fetch(:syncKind)
         end

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

@@ -5,210 +5,210 @@ module LanguageServer
       # Text document specific client capabilities.
       #
       class TextDocumentClientCapabilities
-        def initialize(synchronization: nil, completion: nil, hover: nil, signature_help: nil, references: nil, document_highlight: nil, document_symbol: nil, formatting: nil, range_formatting: nil, on_type_formatting: nil, declaration: nil, definition: nil, type_definition: nil, implementation: nil, code_action: nil, code_lens: nil, document_link: nil, color_provider: nil, rename: nil, publish_diagnostics: nil, folding_range: nil)
+        def initialize(synchronization: nil, completion: nil, hover: nil, signature_help: nil, declaration: nil, definition: nil, type_definition: nil, implementation: nil, references: nil, document_highlight: nil, document_symbol: nil, code_action: nil, code_lens: nil, document_link: nil, color_provider: nil, formatting: nil, range_formatting: nil, on_type_formatting: nil, rename: nil, publish_diagnostics: nil, folding_range: nil, selection_range: nil)
           @attributes = {}
 
           @attributes[:synchronization] = synchronization if synchronization
           @attributes[:completion] = completion if completion
           @attributes[:hover] = hover if hover
           @attributes[:signatureHelp] = signature_help if signature_help
-          @attributes[:references] = references if references
-          @attributes[:documentHighlight] = document_highlight if document_highlight
-          @attributes[:documentSymbol] = document_symbol if document_symbol
-          @attributes[:formatting] = formatting if formatting
-          @attributes[:rangeFormatting] = range_formatting if range_formatting
-          @attributes[:onTypeFormatting] = on_type_formatting if on_type_formatting
           @attributes[:declaration] = declaration if declaration
           @attributes[:definition] = definition if definition
           @attributes[:typeDefinition] = type_definition if type_definition
           @attributes[:implementation] = implementation if implementation
+          @attributes[:references] = references if references
+          @attributes[:documentHighlight] = document_highlight if document_highlight
+          @attributes[:documentSymbol] = document_symbol if document_symbol
           @attributes[:codeAction] = code_action if code_action
           @attributes[:codeLens] = code_lens if code_lens
           @attributes[:documentLink] = document_link if document_link
           @attributes[:colorProvider] = color_provider if color_provider
+          @attributes[:formatting] = formatting if formatting
+          @attributes[:rangeFormatting] = range_formatting if range_formatting
+          @attributes[:onTypeFormatting] = on_type_formatting if on_type_formatting
           @attributes[:rename] = rename if rename
           @attributes[:publishDiagnostics] = publish_diagnostics if publish_diagnostics
           @attributes[:foldingRange] = folding_range if folding_range
+          @attributes[:selectionRange] = selection_range if selection_range
 
           @attributes.freeze
         end
 
-        # @return [{ dynamicRegistration?: boolean; willSave?: boolean; willSaveWaitUntil?: boolean; didSave?: boole...]
+        # @return [TextDocumentSyncClientCapabilities]
         def synchronization
           attributes.fetch(:synchronization)
         end
 
         #
-        # Capabilities specific to the `textDocument/completion`
+        # Capabilities specific to the `textDocument/completion` request.
         #
-        # @return [{ dynamicRegistration?: boolean; completionItem?: { snippetSupport?: boolean; commitCharactersSup...]
+        # @return [CompletionClientCapabilities]
         def completion
           attributes.fetch(:completion)
         end
 
         #
-        # Capabilities specific to the `textDocument/hover`
+        # Capabilities specific to the `textDocument/hover` request.
         #
-        # @return [{ dynamicRegistration?: boolean; contentFormat?: MarkupKind[]; }]
+        # @return [HoverClientCapabilities]
         def hover
           attributes.fetch(:hover)
         end
 
         #
-        # Capabilities specific to the `textDocument/signatureHelp`
+        # Capabilities specific to the `textDocument/signatureHelp` request.
         #
-        # @return [{ dynamicRegistration?: boolean; signatureInformation?: { documentationFormat?: MarkupKind[]; par...]
+        # @return [SignatureHelpClientCapabilities]
         def signature_help
           attributes.fetch(:signatureHelp)
         end
 
         #
-        # Capabilities specific to the `textDocument/references`
+        # Capabilities specific to the `textDocument/declaration` request.
         #
-        # @return [{ dynamicRegistration?: boolean; }]
-        def references
-          attributes.fetch(:references)
+        # @return [DeclarationClientCapabilities]
+        def declaration
+          attributes.fetch(:declaration)
         end
 
         #
-        # Capabilities specific to the `textDocument/documentHighlight`
+        # Capabilities specific to the `textDocument/definition` request.
         #
-        # @return [{ dynamicRegistration?: boolean; }]
-        def document_highlight
-          attributes.fetch(:documentHighlight)
+        # @return [DefinitionClientCapabilities]
+        def definition
+          attributes.fetch(:definition)
         end
 
         #
-        # Capabilities specific to the `textDocument/documentSymbol`
+        # Capabilities specific to the `textDocument/typeDefinition` request.
         #
-        # @return [{ dynamicRegistration?: boolean; symbolKind?: { valueSet?: any[]; }; hierarchicalDocumentSymbolSu...]
-        def document_symbol
-          attributes.fetch(:documentSymbol)
+        # @return [TypeDefinitionClientCapabilities]
+        def type_definition
+          attributes.fetch(:typeDefinition)
         end
 
         #
-        # Capabilities specific to the `textDocument/formatting`
+        # Capabilities specific to the `textDocument/implementation` request.
         #
-        # @return [{ dynamicRegistration?: boolean; }]
-        def formatting
-          attributes.fetch(:formatting)
+        # @return [ImplementationClientCapabilities]
+        def implementation
+          attributes.fetch(:implementation)
         end
 
         #
-        # Capabilities specific to the `textDocument/rangeFormatting`
+        # Capabilities specific to the `textDocument/references` request.
         #
-        # @return [{ dynamicRegistration?: boolean; }]
-        def range_formatting
-          attributes.fetch(:rangeFormatting)
+        # @return [ReferenceClientCapabilities]
+        def references
+          attributes.fetch(:references)
         end
 
         #
-        # Capabilities specific to the `textDocument/onTypeFormatting`
+        # Capabilities specific to the `textDocument/documentHighlight` request.
         #
-        # @return [{ dynamicRegistration?: boolean; }]
-        def on_type_formatting
-          attributes.fetch(:onTypeFormatting)
+        # @return [DocumentHighlightClientCapabilities]
+        def document_highlight
+          attributes.fetch(:documentHighlight)
         end
 
         #
-        # Capabilities specific to the `textDocument/declaration`
+        # Capabilities specific to the `textDocument/documentSymbol` request.
         #
-        # @return [{ dynamicRegistration?: boolean; linkSupport?: boolean; }]
-        def declaration
-          attributes.fetch(:declaration)
+        # @return [DocumentSymbolClientCapabilities]
+        def document_symbol
+          attributes.fetch(:documentSymbol)
         end
 
         #
-        # Capabilities specific to the `textDocument/definition`.
-        #
-        # Since 3.14.0
+        # Capabilities specific to the `textDocument/codeAction` request.
         #
-        # @return [{ dynamicRegistration?: boolean; linkSupport?: boolean; }]
-        def definition
-          attributes.fetch(:definition)
+        # @return [CodeActionClientCapabilities]
+        def code_action
+          attributes.fetch(:codeAction)
         end
 
         #
-        # Capabilities specific to the `textDocument/typeDefinition`
-        #
-        # Since 3.6.0
+        # Capabilities specific to the `textDocument/codeLens` request.
         #
-        # @return [{ dynamicRegistration?: boolean; linkSupport?: boolean; }]
-        def type_definition
-          attributes.fetch(:typeDefinition)
+        # @return [CodeLensClientCapabilities]
+        def code_lens
+          attributes.fetch(:codeLens)
         end
 
         #
-        # Capabilities specific to the `textDocument/implementation`.
-        #
-        # Since 3.6.0
+        # Capabilities specific to the `textDocument/documentLink` request.
         #
-        # @return [{ dynamicRegistration?: boolean; linkSupport?: boolean; }]
-        def implementation
-          attributes.fetch(:implementation)
+        # @return [DocumentLinkClientCapabilities]
+        def document_link
+          attributes.fetch(:documentLink)
         end
 
         #
-        # Capabilities specific to the `textDocument/codeAction`
+        # Capabilities specific to the `textDocument/documentColor` and the
+        # `textDocument/colorPresentation` request.
         #
-        # @return [{ dynamicRegistration?: boolean; codeActionLiteralSupport?: { codeActionKind: { valueSet: string[...]
-        def code_action
-          attributes.fetch(:codeAction)
+        # @return [DocumentColorClientCapabilities]
+        def color_provider
+          attributes.fetch(:colorProvider)
         end
 
         #
-        # Capabilities specific to the `textDocument/codeLens`
+        # Capabilities specific to the `textDocument/formatting` request.
         #
-        # @return [{ dynamicRegistration?: boolean; }]
-        def code_lens
-          attributes.fetch(:codeLens)
+        # @return [DocumentFormattingClientCapabilities]
+        def formatting
+          attributes.fetch(:formatting)
         end
 
         #
-        # Capabilities specific to the `textDocument/documentLink`
+        # Capabilities specific to the `textDocument/rangeFormatting` request.
         #
-        # @return [{ dynamicRegistration?: boolean; }]
-        def document_link
-          attributes.fetch(:documentLink)
+        # @return [DocumentRangeFormattingClientCapabilities]
+        def range_formatting
+          attributes.fetch(:rangeFormatting)
         end
 
         #
-        # Capabilities specific to the `textDocument/documentColor` and the
-        # `textDocument/colorPresentation` request.
-        #
-        # Since 3.6.0
+        # request.
+        # Capabilities specific to the `textDocument/onTypeFormatting` request.
         #
-        # @return [{ dynamicRegistration?: boolean; }]
-        def color_provider
-          attributes.fetch(:colorProvider)
+        # @return [DocumentOnTypeFormattingClientCapabilities]
+        def on_type_formatting
+          attributes.fetch(:onTypeFormatting)
         end
 
         #
-        # Capabilities specific to the `textDocument/rename`
+        # Capabilities specific to the `textDocument/rename` request.
         #
-        # @return [{ dynamicRegistration?: boolean; prepareSupport?: boolean; }]
+        # @return [RenameClientCapabilities]
         def rename
           attributes.fetch(:rename)
         end
 
         #
-        # Capabilities specific to `textDocument/publishDiagnostics`.
+        # Capabilities specific to the `textDocument/publishDiagnostics` notification.
         #
-        # @return [{ relatedInformation?: boolean; }]
+        # @return [PublishDiagnosticsClientCapabilities]
         def publish_diagnostics
           attributes.fetch(:publishDiagnostics)
         end
 
         #
-        # Capabilities specific to `textDocument/foldingRange` requests.
+        # Capabilities specific to the `textDocument/foldingRange` request.
         #
-        # Since 3.10.0
-        #
-        # @return [{ dynamicRegistration?: boolean; rangeLimit?: number; lineFoldingOnly?: boolean; }]
+        # @return [FoldingRangeClientCapabilities]
         def folding_range
           attributes.fetch(:foldingRange)
         end
 
+        #
+        # Capabilities specific to the `textDocument/selectionRange` request.
+        #
+        # @return [SelectionRangeClientCapabilities]
+        def selection_range
+          attributes.fetch(:selectionRange)
+        end
+
         attr_reader :attributes
 
         def to_hash