language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -2,16 +2,18 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Params to show a resource.
+      # Params to show a resource in the UI.
+      #
+      # @since 3.16.0
       #
       class ShowDocumentParams
         def initialize(uri:, external: nil, take_focus: nil, selection: nil)
           @attributes = {}
 
           @attributes[:uri] = uri
-          @attributes[:external] = external if external
-          @attributes[:takeFocus] = take_focus if take_focus
-          @attributes[:selection] = selection if selection
+          @attributes[:external] = external unless external.nil?
+          @attributes[:takeFocus] = take_focus unless take_focus.nil?
+          @attributes[:selection] = selection unless selection.nil?
 
           @attributes.freeze
         end
@@ -19,7 +21,7 @@ module LanguageServer
         #
         # The uri to show.
         #
-        # @return [string]
+        # @return [URI]
         def uri
           attributes.fetch(:uri)
         end

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_client_capabilities.rb

@@ -8,7 +8,7 @@ module LanguageServer
         def initialize(message_action_item: nil)
           @attributes = {}
 
-          @attributes[:messageActionItem] = message_action_item if message_action_item
+          @attributes[:messageActionItem] = message_action_item unless message_action_item.nil?
 
           @attributes.freeze
         end
@@ -16,7 +16,7 @@ module LanguageServer
         #
         # Capabilities specific to the `MessageActionItem` type.
         #
-        # @return [{ additionalPropertiesSupport?: boolean; }]
+        # @return [ClientShowMessageActionItemOptions]
         def message_action_item
           attributes.fetch(:messageActionItem)
         end

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

@@ -7,7 +7,7 @@ module LanguageServer
 
           @attributes[:type] = type
           @attributes[:message] = message
-          @attributes[:actions] = actions if actions
+          @attributes[:actions] = actions unless actions.nil?
 
           @attributes.freeze
         end
@@ -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

@@ -11,15 +11,14 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:signatures] = signatures
-          @attributes[:activeSignature] = active_signature if active_signature
-          @attributes[:activeParameter] = active_parameter if active_parameter
+          @attributes[:activeSignature] = active_signature unless active_signature.nil?
+          @attributes[:activeParameter] = active_parameter unless active_parameter.nil?
 
           @attributes.freeze
         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,21 +36,33 @@ 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
 
         #
-        # The active parameter of the active signature. If omitted or the value
-        # lies outside the range of `signatures[activeSignature].parameters`
-        # defaults to 0 if the active signature has parameters. If
-        # the active signature has no parameters it is ignored.
+        # The active parameter of the active signature.
+        #
+        # If `null`, no parameter of the signature is active (for example a named
+        # argument that does not match any declared parameters). This is only valid
+        # if the client specifies the client capability
+        # `textDocument.signatureHelp.noActiveParameterSupport === true`
+        #
+        # If omitted or the value lies outside the range of
+        # `signatures[activeSignature].parameters` defaults to 0 if the active
+        # signature has parameters.
+        #
+        # If the active signature has no parameters it is ignored.
+        #
         # In future version of the protocol this property might become
-        # mandatory to better express the active parameter if the
-        # active signature does have any.
+        # mandatory (but still nullable) to better express the active parameter if
+        # the active signature does have any.
+        #
+        # Since version 3.16.0 the `SignatureInformation` itself provides a
+        # `activeParameter` property and it should be used instead of this one.
         #
-        # @return [number]
+        # @return [uinteger]
         def active_parameter
           attributes.fetch(:activeParameter)
         end

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

@@ -1,13 +1,16 @@
 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 = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:signatureInformation] = signature_information if signature_information
-          @attributes[:contextSupport] = context_support if context_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:signatureInformation] = signature_information unless signature_information.nil?
+          @attributes[:contextSupport] = context_support unless context_support.nil?
 
           @attributes.freeze
         end
@@ -24,7 +27,7 @@ module LanguageServer
         # The client supports the following `SignatureInformation`
         # specific properties.
         #
-        # @return [{ documentationFormat?: MarkupKind[]; parameterInformation?: { labelOffsetSupport?: boolean; }; activeParameterSupport?: boolean; }]
+        # @return [ClientSignatureInformationOptions]
         def signature_information
           attributes.fetch(:signatureInformation)
         end
@@ -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,17 +2,18 @@ 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)
           @attributes = {}
 
           @attributes[:triggerKind] = trigger_kind
-          @attributes[:triggerCharacter] = trigger_character if trigger_character
+          @attributes[:triggerCharacter] = trigger_character unless trigger_character.nil?
           @attributes[:isRetrigger] = is_retrigger
-          @attributes[:activeSignatureHelp] = active_signature_help if active_signature_help
+          @attributes[:activeSignatureHelp] = active_signature_help unless active_signature_help.nil?
 
           @attributes.freeze
         end
@@ -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[:triggerCharacters] = trigger_characters unless trigger_characters.nil?
+          @attributes[:retriggerCharacters] = retrigger_characters unless retrigger_characters.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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 unless context.nil?
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:context] = context if context
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @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[:triggerCharacters] = trigger_characters unless trigger_characters.nil?
+          @attributes[:retriggerCharacters] = retrigger_characters unless retrigger_characters.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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

@@ -11,9 +11,9 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:label] = label
-          @attributes[:documentation] = documentation if documentation
-          @attributes[:parameters] = parameters if parameters
-          @attributes[:activeParameter] = active_parameter if active_parameter
+          @attributes[:documentation] = documentation unless documentation.nil?
+          @attributes[:parameters] = parameters unless parameters.nil?
+          @attributes[:activeParameter] = active_parameter unless active_parameter.nil?
 
           @attributes.freeze
         end
@@ -47,9 +47,17 @@ module LanguageServer
         #
         # The index of the active parameter.
         #
-        # If provided, this is used in place of `SignatureHelp.activeParameter`.
+        # If `null`, no parameter of the signature is active (for example a named
+        # argument that does not match any declared parameters). This is only valid
+        # if the client specifies the client capability
+        # `textDocument.signatureHelp.noActiveParameterSupport === true`
         #
-        # @return [number]
+        # If provided (or `null`), this is used in place of
+        # `SignatureHelp.activeParameter`.
+        #
+        # @since 3.16.0
+        #
+        # @return [uinteger]
         def active_parameter
           attributes.fetch(:activeParameter)
         end

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

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # An interactive text edit.
+      #
+      # @since 3.18.0
+      #
+      class SnippetTextEdit
+        def initialize(range:, snippet:, annotation_id: nil)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:snippet] = snippet
+          @attributes[:annotationId] = annotation_id unless annotation_id.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The range of the text document to be manipulated.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The snippet to be inserted.
+        #
+        # @return [StringValue]
+        def snippet
+          attributes.fetch(:snippet)
+        end
+
+        #
+        # The actual identifier of the snippet edit.
+        #
+        # @return [ChangeAnnotationIdentifier]
+        def annotation_id
+          attributes.fetch(:annotationId)
+        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/stale_request_support_options.rb

@@ -0,0 +1,47 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class StaleRequestSupportOptions
+        def initialize(cancel:, retry_on_content_modified:)
+          @attributes = {}
+
+          @attributes[:cancel] = cancel
+          @attributes[:retryOnContentModified] = retry_on_content_modified
+
+          @attributes.freeze
+        end
+
+        #
+        # The client will actively cancel the request.
+        #
+        # @return [boolean]
+        def cancel
+          attributes.fetch(:cancel)
+        end
+
+        #
+        # The list of requests for which the client
+        # will retry the request if it receives a
+        # response with error code `ContentModified`
+        #
+        # @return [string[]]
+        def retry_on_content_modified
+          attributes.fetch(:retryOnContentModified)
+        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/static_registration_options.rb

@@ -2,13 +2,14 @@ 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)
           @attributes = {}
 
-          @attributes[:id] = id if id
+          @attributes[:id] = id unless id.nil?
 
           @attributes.freeze
         end

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

@@ -0,0 +1,53 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A string value used as a snippet is a template which allows to insert text
+      # and to control the editor cursor when insertion happens.
+      #
+      # A snippet can define tab stops and placeholders with `$1`, `$2`
+      # and `${3:foo}`. `$0` defines the final tab stop, it defaults to
+      # the end of the snippet. Variables are defined with `$name` and
+      # `${name:default value}`.
+      #
+      # @since 3.18.0
+      #
+      class StringValue
+        def initialize(kind:, value:)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:value] = value
+
+          @attributes.freeze
+        end
+
+        #
+        # The kind of string value.
+        #
+        # @return ["snippet"]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # The snippet string.
+        #
+        # @return [string]
+        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