language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -4,25 +4,19 @@ module LanguageServer
       #
       # A parameter literal used in inlay hint requests.
       #
+      # @since 3.17.0
+      #
       class InlayHintParams
-        def initialize(work_done_token: nil, text_document:, range:)
+        def initialize(text_document:, range:, work_done_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @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.
         #
@@ -32,13 +26,21 @@ module LanguageServer
         end
 
         #
-        # The visible document range for which inlay hints should be computed.
+        # The 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]
+        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,23 +4,20 @@ module LanguageServer
       #
       # Inlay hint options used during static or dynamic registration.
       #
+      # @since 3.17.0
+      #
       class InlayHintRegistrationOptions
-        def initialize(work_done_progress: nil, resolve_provider: nil, document_selector:, id: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil, document_selector:, id: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:resolveProvider] = resolve_provider unless resolve_provider.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
           @attributes[:documentSelector] = document_selector
-          @attributes[:id] = id if id
+          @attributes[:id] = id unless id.nil?
 
           @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.
@@ -30,11 +27,16 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        # @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]
+        # @return [DocumentSelector | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -4,11 +4,13 @@ module LanguageServer
       #
       # Client workspace capabilities specific to inlay hints.
       #
+      # @since 3.17.0
+      #
       class InlayHintWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}
 
-          @attributes[:refreshSupport] = refresh_support if refresh_support
+          @attributes[:refreshSupport] = refresh_support unless refresh_support.nil?
 
           @attributes.freeze
         end

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities specific to inline completions.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether implementation supports dynamic registration for inline completion providers.
+        #
+        # @return [boolean]
+        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_completion_context.rb

@@ -0,0 +1,47 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Provides information about the context in which an inline completion was requested.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionContext
+        def initialize(trigger_kind:, selected_completion_info: nil)
+          @attributes = {}
+
+          @attributes[:triggerKind] = trigger_kind
+          @attributes[:selectedCompletionInfo] = selected_completion_info unless selected_completion_info.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Describes how the inline completion was triggered.
+        #
+        # @return [InlineCompletionTriggerKind]
+        def trigger_kind
+          attributes.fetch(:triggerKind)
+        end
+
+        #
+        # Provides information about the currently selected item in the autocomplete widget if it is visible.
+        #
+        # @return [SelectedCompletionInfo]
+        def selected_completion_info
+          attributes.fetch(:selectedCompletionInfo)
+        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_completion_item.rb

@@ -0,0 +1,65 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionItem
+        def initialize(insert_text:, filter_text: nil, range: nil, command: nil)
+          @attributes = {}
+
+          @attributes[:insertText] = insert_text
+          @attributes[:filterText] = filter_text unless filter_text.nil?
+          @attributes[:range] = range unless range.nil?
+          @attributes[:command] = command unless command.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The text to replace the range with. Must be set.
+        #
+        # @return [string | StringValue]
+        def insert_text
+          attributes.fetch(:insertText)
+        end
+
+        #
+        # A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used.
+        #
+        # @return [string]
+        def filter_text
+          attributes.fetch(:filterText)
+        end
+
+        #
+        # The range to replace. Must begin and end on the same line.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # An optional {@link Command} that is executed *after* inserting this completion.
+        #
+        # @return [Command]
+        def command
+          attributes.fetch(:command)
+        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_completion_list.rb

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionList
+        def initialize(items:)
+          @attributes = {}
+
+          @attributes[:items] = items
+
+          @attributes.freeze
+        end
+
+        #
+        # The inline completion items
+        #
+        # @return [InlineCompletionItem[]]
+        def items
+          attributes.fetch(:items)
+        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_completion_options.rb

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline completion options used during static registration.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        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_completion_params.rb

@@ -0,0 +1,66 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A parameter literal used in inline completion requests.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionParams
+        def initialize(context:, text_document:, position:, work_done_token: nil)
+          @attributes = {}
+
+          @attributes[:context] = context
+          @attributes[:textDocument] = text_document
+          @attributes[:position] = position
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Additional information about the context in which inline completions were
+        # requested.
+        #
+        # @return [InlineCompletionContext]
+        def context
+          attributes.fetch(:context)
+        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
+
+        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_completion_registration_options.rb

@@ -0,0 +1,55 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline completion options used during static or dynamic registration.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionRegistrationOptions
+        def initialize(work_done_progress: nil, document_selector:, id: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+          @attributes[:documentSelector] = document_selector
+          @attributes[:id] = id unless id.nil?
+
+          @attributes.freeze
+        end
+
+        # @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.
+        #
+        # @return [DocumentSelector | nil]
+        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]
+        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.rb

@@ -0,0 +1,92 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline value information can be provided by different means:
+      # - directly as a text value (class InlineValueText).
+      # - as a name to use for a variable lookup (class InlineValueVariableLookup)
+      # - as an evaluatable expression (class InlineValueEvaluatableExpression)
+      # The InlineValue types combines all inline value types into one type.
+      #
+      # @since 3.17.0
+      #
+      class InlineValue
+        def initialize(range:, text: nil, variable_name: nil, case_sensitive_lookup: nil, expression: nil)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:text] = text unless text.nil?
+          @attributes[:variableName] = variable_name unless variable_name.nil?
+          @attributes[:caseSensitiveLookup] = case_sensitive_lookup unless case_sensitive_lookup.nil?
+          @attributes[:expression] = expression unless expression.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The document range for which the inline value applies.
+        #
+        # --- OR ---
+        #
+        # The document range for which the inline value applies.
+        #
+        # The range could be used to extract the variable name
+        # from the underlying document.
+        #
+        # --- OR ---
+        #
+        # The document range for which the inline value applies.
+        #
+        # The range could be used to extract the evaluatable expression
+        # from the underlying document.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The text of the inline value.
+        #
+        # @return [string]
+        def text
+          attributes.fetch(:text)
+        end
+
+        #
+        # If specified the name of the variable to look up.
+        #
+        # @return [string]
+        def variable_name
+          attributes.fetch(:variableName)
+        end
+
+        #
+        # How to perform the lookup.
+        #
+        # @return [boolean]
+        def case_sensitive_lookup
+          attributes.fetch(:caseSensitiveLookup)
+        end
+
+        #
+        # If specified the expression could be evaluated instead.
+        #
+        # @return [string]
+        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_client_capabilities.rb

@@ -4,18 +4,19 @@ module LanguageServer
       #
       # 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[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end
 
         #
-        # Whether implementation supports dynamic registration for inline
-        # value providers.
+        # Whether implementation supports dynamic registration for inline value providers.
         #
         # @return [boolean]
         def dynamic_registration

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.17.0
+      #
       class InlineValueContext
         def initialize(frame_id:, stopped_location:)
           @attributes = {}
@@ -14,15 +17,14 @@ module LanguageServer
         #
         # The stack frame (as a DAP Id) where the execution has stopped.
         #
-        # @return [number]
+        # @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.
+        # 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

@@ -2,27 +2,31 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Provide an inline value through an expression evaluation.
+      # To compute an inline value through an expression evaluation.
       #
-      # If only a range is specified, the expression will be extracted from the
-      # underlying document.
+      # If only a range is specified, the expression should be
+      # extracted from the underlying document.
       #
-      # An optional expression can be used to override the extracted expression.
+      # An optional expression could be evaluated instead of
+      # the extracted expression.
+      #
+      # @since 3.17.0
       #
       class InlineValueEvaluatableExpression
         def initialize(range:, expression: nil)
           @attributes = {}
 
           @attributes[:range] = range
-          @attributes[:expression] = expression if expression
+          @attributes[:expression] = expression unless expression.nil?
 
           @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.
+        #
+        # The range could be used to extract the evaluatable expression
+        # from the underlying document.
         #
         # @return [Range]
         def range
@@ -30,7 +34,7 @@ module LanguageServer
         end
 
         #
-        # If specified the expression overrides the extracted expression.
+        # If specified the expression could be evaluated instead.
         #
         # @return [string]
         def expression

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

@@ -4,11 +4,13 @@ module LanguageServer
       #
       # 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[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end