language_server-protocol 3.16.0.1 → 3.17.0.0

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 [SignatureHelpRequest](#SignatureHelpRequest).
+      #
       class SignatureHelpClientCapabilities
         def initialize(dynamic_registration: nil, signature_information: nil, context_support: nil)
           @attributes = {}
@@ -15,7 +18,7 @@ module LanguageServer
         #
         # Whether signature help supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -24,7 +27,7 @@ module LanguageServer
         # The client supports the following `SignatureInformation`
         # specific properties.
         #
-        # @return [{ documentationFormat?: MarkupKind[]; parameterInformation?: { labelOffsetSupport?: boolean; }; activeParameterSupport?: boolean; }]
+        # @return [{ documentationFormat:MarkupKind[], parameterInformation:{ labelOffsetSupport:boolean }, activeParameterSupport:boolean } | nil]
         def signature_information
           attributes.fetch(:signatureInformation)
         end
@@ -35,7 +38,9 @@ module LanguageServer
         # contextSupport will also support the `retriggerCharacters` on
         # `SignatureHelpOptions`.
         #
-        # @return [boolean]
+        # @since 3.15.0
+        #
+        # @return [boolean | nil]
         def context_support
           attributes.fetch(:contextSupport)
         end

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,10 +29,9 @@ 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]
+        # @return [string | nil]
         def trigger_character
           attributes.fetch(:triggerCharacter)
         end
@@ -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,10 +50,10 @@ 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]
+        # @return [SignatureHelp | nil]
         def active_signature_help
           attributes.fetch(:activeSignatureHelp)
         end

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

@@ -1,27 +1,24 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Server Capabilities for a [SignatureHelpRequest](#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[]]
+        # @return [string[] | nil]
         def trigger_characters
           attributes.fetch(:triggerCharacters)
         end
@@ -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.
         #
-        # @return [string[]]
+        # @since 3.15.0
+        #
+        # @return [string[] | nil]
         def retrigger_characters
           attributes.fetch(:retriggerCharacters)
         end
 
+        # @return [boolean | nil]
+        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 [SignatureHelpRequest](#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 | nil]
+        def context
+          attributes.fetch(:context)
+        end
+
         #
         # The text document.
         #
@@ -32,21 +46,11 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         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

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

@@ -1,37 +1,34 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [SignatureHelpRequest](#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 | null]
         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[]]
+        # @return [string[] | nil]
         def trigger_characters
           attributes.fetch(:triggerCharacters)
         end
@@ -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.
         #
-        # @return [string[]]
+        # @since 3.15.0
+        #
+        # @return [string[] | nil]
         def retrigger_characters
           attributes.fetch(:retriggerCharacters)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -31,7 +31,7 @@ module LanguageServer
         # The human-readable doc-comment of this signature. Will be shown
         # in the UI but can be omitted.
         #
-        # @return [string | MarkupContent]
+        # @return [string | MarkupContent | nil]
         def documentation
           attributes.fetch(:documentation)
         end
@@ -39,7 +39,7 @@ module LanguageServer
         #
         # The parameters of this signature.
         #
-        # @return [ParameterInformation[]]
+        # @return [ParameterInformation[] | nil]
         def parameters
           attributes.fetch(:parameters)
         end
@@ -49,7 +49,9 @@ module LanguageServer
         #
         # If provided, this is used in place of `SignatureHelp.activeParameter`.
         #
-        # @return [number]
+        # @since 3.16.0
+        #
+        # @return [uinteger | nil]
         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)
@@ -17,7 +18,7 @@ module LanguageServer
         # The id used to register the request. The id can be used to deregister
         # the request again. See also Registration#id.
         #
-        # @return [string]
+        # @return [string | nil]
         def id
           attributes.fetch(:id)
         end

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

@@ -6,19 +6,45 @@ module LanguageServer
       # interfaces etc.
       #
       class SymbolInformation
-        def initialize(name:, kind:, tags: nil, deprecated: nil, location:, container_name: nil)
+        def initialize(deprecated: nil, location:, name:, kind:, tags: nil, container_name: nil)
           @attributes = {}
 
+          @attributes[:deprecated] = deprecated if deprecated
+          @attributes[:location] = location
           @attributes[:name] = name
           @attributes[:kind] = kind
           @attributes[:tags] = tags if tags
-          @attributes[:deprecated] = deprecated if deprecated
-          @attributes[:location] = location
           @attributes[:containerName] = container_name if container_name
 
           @attributes.freeze
         end
 
+        #
+        # Indicates if this symbol is deprecated.
+        #
+        # @deprecated Use tags instead
+        #
+        # @return [boolean | nil]
+        def deprecated
+          attributes.fetch(:deprecated)
+        end
+
+        #
+        # The location of this symbol. The location's range is used by a tool
+        # to reveal the location in the editor. If the symbol is selected in the
+        # tool the range's start information is used to position the cursor. So
+        # the range usually spans more than the actual symbol's name and does
+        # normally include things like visibility modifiers.
+        #
+        # The range doesn't have to denote a node range in the sense of an abstract
+        # syntax tree. It can therefore not be used to re-construct a hierarchy of
+        # the symbols.
+        #
+        # @return [Location]
+        def location
+          attributes.fetch(:location)
+        end
+
         #
         # The name of this symbol.
         #
@@ -30,7 +56,7 @@ module LanguageServer
         #
         # The kind of this symbol.
         #
-        # @return [any]
+        # @return [SymbolKind]
         def kind
           attributes.fetch(:kind)
         end
@@ -38,42 +64,20 @@ module LanguageServer
         #
         # Tags for this symbol.
         #
-        # @return [1[]]
+        # @since 3.16.0
+        #
+        # @return [SymbolTag[] | nil]
         def tags
           attributes.fetch(:tags)
         end
 
-        #
-        # Indicates if this symbol is deprecated.
-        #
-        # @return [boolean]
-        def deprecated
-          attributes.fetch(:deprecated)
-        end
-
-        #
-        # The location of this symbol. The location's range is used by a tool
-        # to reveal the location in the editor. If the symbol is selected in the
-        # tool the range's start information is used to position the cursor. So
-        # the range usually spans more then the actual symbol's name and does
-        # normally include things like visibility modifiers.
-        #
-        # The range doesn't have to denote a node range in the sense of a abstract
-        # syntax tree. It can therefore not be used to re-construct a hierarchy of
-        # the symbols.
-        #
-        # @return [Location]
-        def location
-          attributes.fetch(:location)
-        end
-
         #
         # The name of the symbol containing this symbol. This information is for
         # user interface purposes (e.g. to render a qualifier in the user interface
         # if necessary). It can't be used to re-infer a hierarchy for the document
         # symbols.
         #
-        # @return [string]
+        # @return [string | nil]
         def container_name
           attributes.fetch(:containerName)
         end

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

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class T
+        def initialize()
+          @attributes = {}
+
+
+          @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/text_document_change_registration_options.rb

@@ -2,34 +2,33 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Describe options to be used when registering for text document change events.
+      # Describe options to be used when registered for text document change events.
       #
       class TextDocumentChangeRegistrationOptions
-        def initialize(document_selector:, sync_kind:)
+        def initialize(sync_kind:, document_selector:)
           @attributes = {}
 
-          @attributes[:documentSelector] = document_selector
           @attributes[:syncKind] = sync_kind
+          @attributes[:documentSelector] = document_selector
 
           @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.
+        # How documents are synced to the server.
         #
-        # @return [DocumentSelector]
-        def document_selector
-          attributes.fetch(:documentSelector)
+        # @return [TextDocumentSyncKind]
+        def sync_kind
+          attributes.fetch(:syncKind)
         end
 
         #
-        # How documents are synced to the server. See TextDocumentSyncKind.Full
-        # and TextDocumentSyncKind.Incremental.
+        # 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 [TextDocumentSyncKind]
-        def sync_kind
-          attributes.fetch(:syncKind)
+        # @return [DocumentSelector | null]
+        def document_selector
+          attributes.fetch(:documentSelector)
         end
 
         attr_reader :attributes