language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -1,17 +1,27 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameter of a `callHierarchy/incomingCalls` request.
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyIncomingCallsParams
-        def initialize(work_done_token: nil, partial_result_token: nil, item:)
+        def initialize(item:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:item] = item
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end
 
+        # @return [CallHierarchyItem]
+        def item
+          attributes.fetch(:item)
+        end
+
         #
         # An optional token that a server can use to report work done progress.
         #
@@ -21,19 +31,14 @@ module LanguageServer
         end
 
         #
-        # An optional token that a server can use to report partial results (e.g.
-        # streaming) to the client.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
         # @return [ProgressToken]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end
 
-        # @return [CallHierarchyItem]
-        def item
-          attributes.fetch(:item)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,18 +1,24 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents programming constructs like functions or constructors in the context
+      # of call hierarchy.
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyItem
         def initialize(name:, kind:, tags: nil, detail: nil, uri:, range:, selection_range:, data: nil)
           @attributes = {}
 
           @attributes[:name] = name
           @attributes[:kind] = kind
-          @attributes[:tags] = tags if tags
-          @attributes[:detail] = detail if detail
+          @attributes[:tags] = tags unless tags.nil?
+          @attributes[:detail] = detail unless detail.nil?
           @attributes[:uri] = uri
           @attributes[:range] = range
           @attributes[:selectionRange] = selection_range
-          @attributes[:data] = data if data
+          @attributes[:data] = data unless data.nil?
 
           @attributes.freeze
         end
@@ -36,7 +42,7 @@ module LanguageServer
         #
         # Tags for this item.
         #
-        # @return [1[]]
+        # @return [SymbolTag[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -52,14 +58,13 @@ module LanguageServer
         #
         # The resource identifier of this item.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end
 
         #
-        # The range enclosing this symbol not including leading/trailing whitespace
-        # but everything else, e.g. comments and code.
+        # The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
         #
         # @return [Range]
         def range
@@ -67,9 +72,8 @@ module LanguageServer
         end
 
         #
-        # The range that should be selected and revealed when this symbol is being
-        # picked, e.g. the name of a function. Must be contained by the
-        # [`range`](#CallHierarchyItem.range).
+        # The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function.
+        # Must be contained by the {@link CallHierarchyItem.range `range`}.
         #
         # @return [Range]
         def selection_range
@@ -80,7 +84,7 @@ module LanguageServer
         # A data entry field that is preserved between a call hierarchy prepare and
         # incoming calls or outgoing calls requests.
         #
-        # @return [unknown]
+        # @return [LSPAny]
         def data
           attributes.fetch(:data)
         end

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

@@ -1,11 +1,16 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Call hierarchy options used during static registration.
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyOptions
         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

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyOutgoingCall
         def initialize(to:, from_ranges:)
           @attributes = {}
@@ -20,8 +25,9 @@ module LanguageServer
         end
 
         #
-        # The range at which this item is called. This is the range relative to
-        # the caller, e.g the item passed to `callHierarchy/outgoingCalls` request.
+        # The range at which this item is called. This is the range relative to the caller, e.g the item
+        # passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`}
+        # and not {@link CallHierarchyOutgoingCall.to `this.to`}.
         #
         # @return [Range[]]
         def from_ranges

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

@@ -1,17 +1,27 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameter of a `callHierarchy/outgoingCalls` request.
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyOutgoingCallsParams
-        def initialize(work_done_token: nil, partial_result_token: nil, item:)
+        def initialize(item:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:item] = item
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end
 
+        # @return [CallHierarchyItem]
+        def item
+          attributes.fetch(:item)
+        end
+
         #
         # An optional token that a server can use to report work done progress.
         #
@@ -21,19 +31,14 @@ module LanguageServer
         end
 
         #
-        # An optional token that a server can use to report partial results (e.g.
-        # streaming) to the client.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
         # @return [ProgressToken]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end
 
-        # @return [CallHierarchyItem]
-        def item
-          attributes.fetch(:item)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,13 +1,18 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameter of a `textDocument/prepareCallHierarchy` request.
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyPrepareParams
         def initialize(text_document:, position:, work_done_token: nil)
           @attributes = {}
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @attributes.freeze
         end

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

@@ -1,22 +1,27 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Call hierarchy options used during static or dynamic registration.
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil, id: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:id] = id if id
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+          @attributes[:id] = id unless id.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

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

@@ -13,7 +13,7 @@ module LanguageServer
         #
         # The request id to cancel.
         #
-        # @return [string | number]
+        # @return [integer | string]
         def id
           attributes.fetch(:id)
         end

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

@@ -4,13 +4,15 @@ module LanguageServer
       #
       # Additional information that describes document changes.
       #
+      # @since 3.16.0
+      #
       class ChangeAnnotation
         def initialize(label:, needs_confirmation: nil, description: nil)
           @attributes = {}
 
           @attributes[:label] = label
-          @attributes[:needsConfirmation] = needs_confirmation if needs_confirmation
-          @attributes[:description] = description if description
+          @attributes[:needsConfirmation] = needs_confirmation unless needs_confirmation.nil?
+          @attributes[:description] = description unless description.nil?
 
           @attributes.freeze
         end

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ChangeAnnotationsSupportOptions
+        def initialize(groups_on_label: nil)
+          @attributes = {}
+
+          @attributes[:groupsOnLabel] = groups_on_label unless groups_on_label.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether the client groups edits with equal labels into tree nodes,
+        # for instance all edits labelled with "Changes in Strings" would
+        # be a tree node.
+        #
+        # @return [boolean]
+        def groups_on_label
+          attributes.fetch(:groupsOnLabel)
+        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/client_capabilities.rb

@@ -1,16 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Defines the capabilities provided by the client.
+      #
       class ClientCapabilities
         def initialize(workspace: nil, text_document: nil, notebook_document: nil, window: nil, general: nil, experimental: nil)
           @attributes = {}
 
-          @attributes[:workspace] = workspace if workspace
-          @attributes[:textDocument] = text_document if text_document
-          @attributes[:notebookDocument] = notebook_document if notebook_document
-          @attributes[:window] = window if window
-          @attributes[:general] = general if general
-          @attributes[:experimental] = experimental if experimental
+          @attributes[:workspace] = workspace unless workspace.nil?
+          @attributes[:textDocument] = text_document unless text_document.nil?
+          @attributes[:notebookDocument] = notebook_document unless notebook_document.nil?
+          @attributes[:window] = window unless window.nil?
+          @attributes[:general] = general unless general.nil?
+          @attributes[:experimental] = experimental unless experimental.nil?
 
           @attributes.freeze
         end
@@ -18,7 +21,7 @@ module LanguageServer
         #
         # Workspace specific client capabilities.
         #
-        # @return [{ applyEdit?: boolean; workspaceEdit?: WorkspaceEditClientCapabilities; didChangeConfiguration?: DidChangeConfigurationClientCapabilities; ... 10 more ...; diagnostics?: DiagnosticWorkspaceClientCapabilities; }]
+        # @return [WorkspaceClientCapabilities]
         def workspace
           attributes.fetch(:workspace)
         end
@@ -34,6 +37,8 @@ module LanguageServer
         #
         # Capabilities specific to the notebook document support.
         #
+        # @since 3.17.0
+        #
         # @return [NotebookDocumentClientCapabilities]
         def notebook_document
           attributes.fetch(:notebookDocument)
@@ -42,7 +47,7 @@ module LanguageServer
         #
         # Window specific client capabilities.
         #
-        # @return [{ workDoneProgress?: boolean; showMessage?: ShowMessageRequestClientCapabilities; showDocument?: ShowDocumentClientCapabilities; }]
+        # @return [WindowClientCapabilities]
         def window
           attributes.fetch(:window)
         end
@@ -50,7 +55,9 @@ module LanguageServer
         #
         # General client capabilities.
         #
-        # @return [{ staleRequestSupport?: { cancel: boolean; retryOnContentModified: string[]; }; regularExpressions?: RegularExpressionsClientCapabilities; markdown?: any; positionEncodings?: string[]; }]
+        # @since 3.16.0
+        #
+        # @return [GeneralClientCapabilities]
         def general
           attributes.fetch(:general)
         end

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

@@ -0,0 +1,39 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientCodeActionKindOptions
+        def initialize(value_set:)
+          @attributes = {}
+
+          @attributes[:valueSet] = value_set
+
+          @attributes.freeze
+        end
+
+        #
+        # The code action kind values the client supports. When this
+        # property exists the client also guarantees that it will
+        # handle values outside its set gracefully and falls back
+        # to a default value when unknown.
+        #
+        # @return [CodeActionKind[]]
+        def value_set
+          attributes.fetch(:valueSet)
+        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/client_code_action_literal_options.rb

@@ -0,0 +1,37 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientCodeActionLiteralOptions
+        def initialize(code_action_kind:)
+          @attributes = {}
+
+          @attributes[:codeActionKind] = code_action_kind
+
+          @attributes.freeze
+        end
+
+        #
+        # The code action kind is support with the following value
+        # set.
+        #
+        # @return [ClientCodeActionKindOptions]
+        def code_action_kind
+          attributes.fetch(:codeActionKind)
+        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/client_code_action_resolve_options.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientCodeActionResolveOptions
+        def initialize(properties:)
+          @attributes = {}
+
+          @attributes[:properties] = properties
+
+          @attributes.freeze
+        end
+
+        #
+        # The properties that a client can resolve lazily.
+        #
+        # @return [string[]]
+        def properties
+          attributes.fetch(:properties)
+        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/client_code_lens_resolve_options.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientCodeLensResolveOptions
+        def initialize(properties:)
+          @attributes = {}
+
+          @attributes[:properties] = properties
+
+          @attributes.freeze
+        end
+
+        #
+        # The properties that a client can resolve lazily.
+        #
+        # @return [string[]]
+        def properties
+          attributes.fetch(:properties)
+        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/client_completion_item_insert_text_mode_options.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientCompletionItemInsertTextModeOptions
+        def initialize(value_set:)
+          @attributes = {}
+
+          @attributes[:valueSet] = value_set
+
+          @attributes.freeze
+        end
+
+        # @return [InsertTextMode[]]
+        def value_set
+          attributes.fetch(:valueSet)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end