language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities specific to inline values.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether implementation supports dynamic registration for inline value providers.
+        #
+        # @return [boolean | nil]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        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/inline_value_context.rb

@@ -0,0 +1,46 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.17.0
+      #
+      class InlineValueContext
+        def initialize(frame_id:, stopped_location:)
+          @attributes = {}
+
+          @attributes[:frameId] = frame_id
+          @attributes[:stoppedLocation] = stopped_location
+
+          @attributes.freeze
+        end
+
+        #
+        # The stack frame (as a DAP Id) where the execution has stopped.
+        #
+        # @return [integer]
+        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.
+        #
+        # @return [Range]
+        def stopped_location
+          attributes.fetch(:stoppedLocation)
+        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/inline_value_evaluatable_expression.rb

@@ -0,0 +1,50 @@
+module LanguageServer
+  module Protocol
+    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
+      #
+      class InlineValueEvaluatableExpression
+        def initialize(range:, expression: nil)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:expression] = expression if expression
+
+          @attributes.freeze
+        end
+
+        #
+        # The document range for which the inline value applies.
+        # The range is used to extract the evaluatable expression from the underlying document.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # If specified the expression overrides the extracted expression.
+        #
+        # @return [string | nil]
+        def expression
+          attributes.fetch(:expression)
+        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/inline_value_options.rb

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline value options used during static registration.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        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/inline_value_params.rb

@@ -0,0 +1,66 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A parameter literal used in inline value requests.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueParams
+        def initialize(text_document:, range:, context:, work_done_token: nil)
+          @attributes = {}
+
+          @attributes[:textDocument] = text_document
+          @attributes[:range] = range
+          @attributes[:context] = context
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+
+          @attributes.freeze
+        end
+
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
+        #
+        # The document range for which inline values should be computed.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # Additional information about the context in which inline values were
+        # requested.
+        #
+        # @return [InlineValueContext]
+        def context
+          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
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # 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 = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:documentSelector] = document_selector
+          @attributes[:id] = id if id
+
+          @attributes.freeze
+        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.
+        #
+        # @return [DocumentSelector | null]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        #
+        # The id used to register the request. The id can be used to deregister
+        # the request again. See also Registration#id.
+        #
+        # @return [string | nil]
+        def id
+          attributes.fetch(:id)
+        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/inline_value_text.rb

@@ -0,0 +1,47 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Provide inline value as text.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueText
+        def initialize(range:, text:)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:text] = text
+
+          @attributes.freeze
+        end
+
+        #
+        # The document range for which the inline value applies.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The text of the inline value.
+        #
+        # @return [string]
+        def text
+          attributes.fetch(:text)
+        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/inline_value_variable_lookup.rb

@@ -0,0 +1,59 @@
+module LanguageServer
+  module Protocol
+    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
+      #
+      class InlineValueVariableLookup
+        def initialize(range:, variable_name: nil, case_sensitive_lookup:)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:variableName] = variable_name if variable_name
+          @attributes[:caseSensitiveLookup] = case_sensitive_lookup
+
+          @attributes.freeze
+        end
+
+        #
+        # The document range for which the inline value applies.
+        # The range is used to extract the variable name from the underlying document.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # If specified the name of the variable to look up.
+        #
+        # @return [string | nil]
+        def variable_name
+          attributes.fetch(:variableName)
+        end
+
+        #
+        # How to perform the lookup.
+        #
+        # @return [boolean]
+        def case_sensitive_lookup
+          attributes.fetch(:caseSensitiveLookup)
+        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/inline_value_workspace_client_capabilities.rb

@@ -0,0 +1,44 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client workspace capabilities specific to inline values.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueWorkspaceClientCapabilities
+        def initialize(refresh_support: nil)
+          @attributes = {}
+
+          @attributes[:refreshSupport] = refresh_support if refresh_support
+
+          @attributes.freeze
+        end
+
+        #
+        # 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
+        # change that requires such a calculation.
+        #
+        # @return [boolean | nil]
+        def refresh_support
+          attributes.fetch(:refreshSupport)
+        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/insert_replace_edit.rb

@@ -4,6 +4,8 @@ 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,6 +1,11 @@
 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 = {}
@@ -11,12 +16,11 @@ 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]
+        # @return [boolean | nil]
         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]
+        # @return [boolean | nil]
         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]
+        # @return [ProgressToken | nil]
         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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         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]
+        # @return [string | nil]
         def id
           attributes.fetch(:id)
         end

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

@@ -1,6 +1,11 @@
 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 = {}
@@ -12,7 +17,7 @@ module LanguageServer
         end
 
         #
-        # A list of ranges that can be renamed together. The ranges must have
+        # A list of ranges that can be edited together. The ranges must have
         # identical length and contain identical text content. The ranges cannot overlap.
         #
         # @return [Range[]]
@@ -25,7 +30,7 @@ module LanguageServer
         # the given ranges. If no pattern is provided, the client configuration's word
         # pattern will be used.
         #
-        # @return [string]
+        # @return [string | nil]
         def word_pattern
           attributes.fetch(:wordPattern)
         end

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

@@ -1,6 +1,10 @@
 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 = {}
@@ -11,7 +15,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents the connection of two locations. Provides additional metadata over normal [locations](#Location),
+      # including an origin range.
+      #
       class LocationLink
         def initialize(origin_selection_range: nil, target_uri:, target_range:, target_selection_range:)
           @attributes = {}
@@ -16,10 +20,10 @@ module LanguageServer
         #
         # Span of the origin of this link.
         #
-        # Used as the underlined span for mouse interaction. Defaults to the word
-        # range at the mouse position.
+        # Used as the underlined span for mouse interaction. Defaults to the word range at
+        # the definition position.
         #
-        # @return [Range]
+        # @return [Range | nil]
         def origin_selection_range
           attributes.fetch(:originSelectionRange)
         end
@@ -27,16 +31,15 @@ module LanguageServer
         #
         # The target resource identifier of this link.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def target_uri
           attributes.fetch(:targetUri)
         end
 
         #
-        # The full target range of this link. If the target for example is a symbol
-        # then target range is the range enclosing this symbol not including
-        # leading/trailing whitespace but everything else like comments. This
-        # information is typically used to highlight the range in the editor.
+        # The full target range of this link. If the target for example is a symbol then target range is the
+        # range enclosing this symbol not including leading/trailing whitespace but everything else
+        # like comments. This information is typically used to highlight the range in the editor.
         #
         # @return [Range]
         def target_range
@@ -44,9 +47,8 @@ module LanguageServer
         end
 
         #
-        # The range that should be selected and revealed when this link is being
-        # followed, e.g the name of a function. Must be contained by the the
-        # `targetRange`. See also `DocumentSymbol#range`
+        # The range that should be selected and revealed when this link is being followed, e.g the name of a function.
+        # Must be contained by the `targetRange`. See also `DocumentSymbol#range`
         #
         # @return [Range]
         def target_selection_range

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The log message parameters.
+      #
       class LogMessageParams
         def initialize(type:, message:)
           @attributes = {}
@@ -20,7 +23,7 @@ module LanguageServer
         end
 
         #
-        # The actual message
+        # The actual message.
         #
         # @return [string]
         def message

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

@@ -11,19 +11,12 @@ module LanguageServer
           @attributes.freeze
         end
 
-        #
-        # The message to be logged.
-        #
         # @return [string]
         def message
           attributes.fetch(:message)
         end
 
-        #
-        # Additional information that can be computed if the `trace` configuration
-        # is set to `'verbose'`
-        #
-        # @return [string]
+        # @return [string | nil]
         def verbose
           attributes.fetch(:verbose)
         end