language_server-protocol 3.14.0.2 → 3.16.0.1

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The result of an show document request.
+      #
+      class ShowDocumentResult
+        def initialize(success:)
+          @attributes = {}
+
+          @attributes[:success] = success
+
+          @attributes.freeze
+        end
+
+        #
+        # A boolean indicating if the show was successful.
+        #
+        # @return [boolean]
+        def success
+          attributes.fetch(:success)
+        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/show_message_params.rb

@@ -14,7 +14,7 @@ module LanguageServer
         #
         # The message type. See {@link MessageType}.
         #
-        # @return [number]
+        # @return [MessageType]
         def type
           attributes.fetch(:type)
         end

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Show message request client capabilities
+      #
+      class ShowMessageRequestClientCapabilities
+        def initialize(message_action_item: nil)
+          @attributes = {}
+
+          @attributes[:messageActionItem] = message_action_item if message_action_item
+
+          @attributes.freeze
+        end
+
+        #
+        # Capabilities specific to the `MessageActionItem` type.
+        #
+        # @return [{ additionalPropertiesSupport?: boolean; }]
+        def message_action_item
+          attributes.fetch(:messageActionItem)
+        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/show_message_request_params.rb

@@ -15,7 +15,7 @@ module LanguageServer
         #
         # The message type. See {@link MessageType}
         #
-        # @return [number]
+        # @return [MessageType]
         def type
           attributes.fetch(:type)
         end

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 signatures are available the signature help
+        # request should return `null`.
         #
         # @return [SignatureInformation[]]
         def signatures
@@ -28,9 +29,11 @@ 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.
+        # 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.
+        #
         # 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; }; activeParameterSupport?: 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,74 @@
+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 [SignatureHelpTriggerKind]
+        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,18 +1,22 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Signature help options.
-      #
       class SignatureHelpOptions
-        def initialize(trigger_characters: nil)
+        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
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # The characters that trigger signature help
         # automatically.
@@ -22,6 +26,18 @@ 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,62 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class SignatureHelpParams
+        def initialize(text_document:, position:, work_done_token: nil, context: nil)
+          @attributes = {}
+
+          @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 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
+
+        #
+        # 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,16 +1,32 @@
 module LanguageServer
   module Protocol
     module Interface
-      class SignatureHelpRegistrationOptions < TextDocumentRegistrationOptions
-        def initialize(document_selector:, trigger_characters: nil)
+      class SignatureHelpRegistrationOptions
+        def initialize(document_selector:, work_done_progress: nil, trigger_characters: nil, retrigger_characters: 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.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 characters that trigger signature help
         # automatically.
@@ -20,6 +36,18 @@ 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_information.rb

@@ -7,12 +7,13 @@ module LanguageServer
       # a set of parameters.
       #
       class SignatureInformation
-        def initialize(label:, documentation: nil, parameters: nil)
+        def initialize(label:, documentation: nil, parameters: nil, active_parameter: nil)
           @attributes = {}
 
           @attributes[:label] = label
           @attributes[:documentation] = documentation if documentation
           @attributes[:parameters] = parameters if parameters
+          @attributes[:activeParameter] = active_parameter if active_parameter
 
           @attributes.freeze
         end
@@ -43,6 +44,16 @@ module LanguageServer
           attributes.fetch(:parameters)
         end
 
+        #
+        # The index of the active parameter.
+        #
+        # If provided, this is used in place of `SignatureHelp.activeParameter`.
+        #
+        # @return [number]
+        def active_parameter
+          attributes.fetch(:activeParameter)
+        end
+
         attr_reader :attributes
 
         def to_hash