language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -5,8 +5,6 @@ module LanguageServer
       # An inlay hint label part allows for interactive and composite labels
       # of inlay hints.
       #
-      # @since 3.17.0
-      #
       class InlayHintLabelPart
         def initialize(value:, tooltip: nil, location: nil, command: nil)
           @attributes = {}
@@ -32,7 +30,7 @@ module LanguageServer
         # the client capability `inlayHint.resolveSupport` clients might resolve
         # this property late using the resolve request.
         #
-        # @return [string | MarkupContent | nil]
+        # @return [string | MarkupContent]
         def tooltip
           attributes.fetch(:tooltip)
         end
@@ -50,7 +48,7 @@ module LanguageServer
         # Depending on the client capability `inlayHint.resolveSupport` clients
         # might resolve this property late using the resolve request.
         #
-        # @return [Location | nil]
+        # @return [Location]
         def location
           attributes.fetch(:location)
         end
@@ -61,7 +59,7 @@ module LanguageServer
         # Depending on the client capability `inlayHint.resolveSupport` clients
         # might resolve this property late using the resolve request.
         #
-        # @return [Command | nil]
+        # @return [Command]
         def command
           attributes.fetch(:command)
         end

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

@@ -4,32 +4,30 @@ module LanguageServer
       #
       # Inlay hint options used during static registration.
       #
-      # @since 3.17.0
-      #
       class InlayHintOptions
-        def initialize(resolve_provider: nil, work_done_progress: nil)
+        def initialize(work_done_progress: nil, resolve_provider: nil)
           @attributes = {}
 
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @attributes.freeze
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # The server provides support to resolve additional
         # information for an inlay hint item.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
-        # @return [boolean | nil]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -4,19 +4,25 @@ module LanguageServer
       #
       # A parameter literal used in inlay hint requests.
       #
-      # @since 3.17.0
-      #
       class InlayHintParams
-        def initialize(text_document:, range:, work_done_token: nil)
+        def initialize(work_done_token: nil, text_document:, range:)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
-          @attributes[:workDoneToken] = work_done_token if work_done_token
 
           @attributes.freeze
         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 text document.
         #
@@ -26,21 +32,13 @@ module LanguageServer
         end
 
         #
-        # The document range for which inlay hints should be computed.
+        # The visible document range for which inlay hints should be computed.
         #
         # @return [Range]
         def range
           attributes.fetch(:range)
         end
 
-        #
-        # An optional token that a server can use to report work done progress.
-        #
-        # @return [ProgressToken | nil]
-        def work_done_token
-          attributes.fetch(:workDoneToken)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -4,39 +4,37 @@ module LanguageServer
       #
       # Inlay hint options used during static or dynamic registration.
       #
-      # @since 3.17.0
-      #
       class InlayHintRegistrationOptions
-        def initialize(resolve_provider: nil, work_done_progress: nil, document_selector:, id: nil)
+        def initialize(work_done_progress: nil, resolve_provider: nil, document_selector:, id: nil)
           @attributes = {}
 
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
           @attributes[:documentSelector] = document_selector
           @attributes[:id] = id if id
 
           @attributes.freeze
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # The server provides support to resolve additional
         # information for an inlay hint item.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
-        # @return [boolean | nil]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        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 | null]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end
@@ -45,7 +43,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 | nil]
+        # @return [string]
         def id
           attributes.fetch(:id)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Client workspace capabilities specific to inlay hints.
       #
-      # @since 3.17.0
-      #
       class InlayHintWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}
@@ -24,7 +22,7 @@ module LanguageServer
         # is useful for situation where a server for example detects a project wide
         # change that requires such a calculation.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def refresh_support
           attributes.fetch(:refreshSupport)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Client capabilities specific to inline values.
       #
-      # @since 3.17.0
-      #
       class InlineValueClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -16,9 +14,10 @@ module LanguageServer
         end
 
         #
-        # Whether implementation supports dynamic registration for inline value providers.
+        # Whether implementation supports dynamic registration for inline
+        # value providers.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # @since 3.17.0
-      #
       class InlineValueContext
         def initialize(frame_id:, stopped_location:)
           @attributes = {}
@@ -17,14 +14,15 @@ module LanguageServer
         #
         # The stack frame (as a DAP Id) where the execution has stopped.
         #
-        # @return [integer]
+        # @return [number]
         def frame_id
           attributes.fetch(:frameId)
         end
 
         #
         # The document range where execution has stopped.
-        # Typically the end position of the range denotes the line where the inline values are shown.
+        # Typically the end position of the range denotes the line where the
+        # inline values are shown.
         #
         # @return [Range]
         def stopped_location

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

@@ -3,10 +3,11 @@ module LanguageServer
     module Interface
       #
       # Provide an inline value through an expression evaluation.
-      # If only a range is specified, the expression will be extracted from the underlying document.
-      # An optional expression can be used to override the extracted expression.
       #
-      # @since 3.17.0
+      # If only a range is specified, the expression will be extracted from the
+      # underlying document.
+      #
+      # An optional expression can be used to override the extracted expression.
       #
       class InlineValueEvaluatableExpression
         def initialize(range:, expression: nil)
@@ -20,7 +21,8 @@ module LanguageServer
 
         #
         # The document range for which the inline value applies.
-        # The range is used to extract the evaluatable expression from the underlying document.
+        # The range is used to extract the evaluatable expression from the
+        # underlying document.
         #
         # @return [Range]
         def range
@@ -30,7 +32,7 @@ module LanguageServer
         #
         # If specified the expression overrides the extracted expression.
         #
-        # @return [string | nil]
+        # @return [string]
         def expression
           attributes.fetch(:expression)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Inline value options used during static registration.
       #
-      # @since 3.17.0
-      #
       class InlineValueOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
@@ -15,7 +13,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -4,20 +4,26 @@ module LanguageServer
       #
       # A parameter literal used in inline value requests.
       #
-      # @since 3.17.0
-      #
       class InlineValueParams
-        def initialize(text_document:, range:, context:, work_done_token: nil)
+        def initialize(work_done_token: nil, text_document:, range:, context:)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
           @attributes[:context] = context
-          @attributes[:workDoneToken] = work_done_token if work_done_token
 
           @attributes.freeze
         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 text document.
         #
@@ -43,14 +49,6 @@ module LanguageServer
           attributes.fetch(:context)
         end
 
-        #
-        # An optional token that a server can use to report work done progress.
-        #
-        # @return [ProgressToken | nil]
-        def work_done_token
-          attributes.fetch(:workDoneToken)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Inline value options used during static or dynamic registration.
       #
-      # @since 3.17.0
-      #
       class InlineValueRegistrationOptions
         def initialize(work_done_progress: nil, document_selector:, id: nil)
           @attributes = {}
@@ -17,16 +15,16 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         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 | null]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end
@@ -35,7 +33,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 | nil]
+        # @return [string]
         def id
           attributes.fetch(:id)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Provide inline value as text.
       #
-      # @since 3.17.0
-      #
       class InlineValueText
         def initialize(range:, text:)
           @attributes = {}

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

@@ -3,10 +3,11 @@ module LanguageServer
     module Interface
       #
       # Provide inline value through a variable lookup.
-      # If only a range is specified, the variable name will be extracted from the underlying document.
-      # An optional variable name can be used to override the extracted name.
       #
-      # @since 3.17.0
+      # If only a range is specified, the variable name will be extracted from
+      # the underlying document.
+      #
+      # An optional variable name can be used to override the extracted name.
       #
       class InlineValueVariableLookup
         def initialize(range:, variable_name: nil, case_sensitive_lookup:)
@@ -21,7 +22,8 @@ module LanguageServer
 
         #
         # The document range for which the inline value applies.
-        # The range is used to extract the variable name from the underlying document.
+        # The range is used to extract the variable name from the underlying
+        # document.
         #
         # @return [Range]
         def range
@@ -31,7 +33,7 @@ module LanguageServer
         #
         # If specified the name of the variable to look up.
         #
-        # @return [string | nil]
+        # @return [string]
         def variable_name
           attributes.fetch(:variableName)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Client workspace capabilities specific to inline values.
       #
-      # @since 3.17.0
-      #
       class InlineValueWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}
@@ -16,15 +14,15 @@ module LanguageServer
         end
 
         #
-        # Whether the client implementation supports a refresh request sent from the
-        # server to the client.
+        # Whether the client implementation supports a refresh request sent from
+        # the server to the client.
         #
         # Note that this event is global and will force the client to refresh all
-        # inline values currently shown. It should be used with absolute care and is
-        # useful for situation where a server for example detects a project wide
+        # inline values currently shown. It should be used with absolute care and
+        # is useful for situation where a server for example detect a project wide
         # change that requires such a calculation.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def refresh_support
           attributes.fetch(:refreshSupport)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # A special text edit to provide an insert and a replace operation.
       #
-      # @since 3.16.0
-      #
       class InsertReplaceEdit
         def initialize(new_text:, insert:, replace:)
           @attributes = {}

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

@@ -1,11 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Client capabilities for the linked editing range request.
-      #
-      # @since 3.16.0
-      #
       class LinkedEditingRangeClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -16,11 +11,12 @@ module LanguageServer
         end
 
         #
-        # Whether implementation supports dynamic registration. If this is set to `true`
-        # the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+        # Whether implementation supports dynamic registration.
+        # If this is set to `true` the client supports the new
+        # `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
         # return value for the corresponding server capability as well.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -10,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -31,7 +31,7 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken | nil]
+        # @return [ProgressToken]
         def work_done_token
           attributes.fetch(:workDoneToken)
         end

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

@@ -13,15 +13,15 @@ module LanguageServer
         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 | null]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end
@@ -30,7 +30,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 | nil]
+        # @return [string]
         def id
           attributes.fetch(:id)
         end

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

@@ -1,11 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The result of a linked editing range request.
-      #
-      # @since 3.16.0
-      #
       class LinkedEditingRanges
         def initialize(ranges:, word_pattern: nil)
           @attributes = {}
@@ -17,8 +12,9 @@ module LanguageServer
         end
 
         #
-        # A list of ranges that can be edited together. The ranges must have
-        # identical length and contain identical text content. The ranges cannot overlap.
+        # A list of ranges that can be renamed together. The ranges must have
+        # identical length and contain identical text content. The ranges cannot
+        # overlap.
         #
         # @return [Range[]]
         def ranges
@@ -26,11 +22,11 @@ module LanguageServer
         end
 
         #
-        # An optional word pattern (regular expression) that describes valid contents for
-        # the given ranges. If no pattern is provided, the client configuration's word
-        # pattern will be used.
+        # An optional word pattern (regular expression) that describes valid
+        # contents for the given ranges. If no pattern is provided, the client
+        # configuration's word pattern will be used.
         #
-        # @return [string | nil]
+        # @return [string]
         def word_pattern
           attributes.fetch(:wordPattern)
         end

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

@@ -1,10 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Represents a location inside a resource, such as a line
-      # inside a text file.
-      #
       class Location
         def initialize(uri:, range:)
           @attributes = {}
@@ -15,7 +11,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [DocumentUri]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end