language_server-protocol 3.17.0.5 → 3.17.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b320d5f9cf8f0feb38122b5226bb9b30ac55250eefaa09fa1bcdec5daa234cb2
-  data.tar.gz: 45278348448e07bc4771b4e5319bebf764b89c1fc117f0b6c990657c559e941c
+  metadata.gz: 1fbc8279c869f3327e44c0c32d09832e1fdd51892c1e1363b2467e7d27bdc7aa
+  data.tar.gz: c7edd15ef2266a3379e2f282b7bbab454459fd81b6a0af42b9039e1ada21d376
 SHA512:
-  metadata.gz: 17291732e8ae0cf36609a6335e214395c7f510fe0e4763ec203a80f0ac8bbbe7a0c01cc1f8ce9900726aa07d2bf7be25304f9ed49d04bfa6cb15f45123553e8a
-  data.tar.gz: 93247dc83eff9cf2c55e76b75e1ac15178ba5d3f062034be0ffc6cbcb5ad6efa28cc8196ae8e7be9a07d816daefd9d77489bc3883c2bc8307fb79a53a21fc4c0
+  metadata.gz: 6909cef7d67685c825aad2d24de897c2953c2568de981812864ae6cc0e307e427933933e60aa4ce63026e9b7eaa3c64383dc84754879d864dd09728d3ac5f345
+  data.tar.gz: 1a23d1c1a6c54c959d145f5d76741b8c7b5082a06e79540bf922adfa3c7e2930ce0d357a5528e2406810ab6933953db9f88b9bf5787dc8669306471f3bd0807a

data/lib/language_server/protocol/constant/initialize_error_codes.rb

@@ -9,6 +9,8 @@ module LanguageServer
         # If the protocol version provided by the client can't be handled by
         # the server.
         #
+        # There is no version handshake in version 3.0x
+        #
         UNKNOWN_PROTOCOL_VERSION = 1
       end
     end

data/lib/language_server/protocol/constant/lsp_error_codes.rb

@@ -0,0 +1,41 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module LSPErrorCodes
+        #
+        # A request failed but it was syntactically correct, e.g the
+        # method name was known and the parameters were valid. The error
+        # message should contain human readable information about why
+        # the request failed.
+        #
+        # @since 3.17.0
+        #
+        REQUEST_FAILED = -32803
+        #
+        # The server cancelled the request. This error code should
+        # only be used for requests that explicitly support being
+        # server cancellable.
+        #
+        # @since 3.17.0
+        #
+        SERVER_CANCELLED = -32802
+        #
+        # The server detected that the content of a document got
+        # modified outside normal conditions. A server should
+        # NOT send this error code if it detects a content change
+        # in it unprocessed messages. The result even computed
+        # on an older state might still be useful for the client.
+        #
+        # If a client decides that a result is not of any use anymore
+        # the client should cancel the request.
+        #
+        CONTENT_MODIFIED = -32801
+        #
+        # The client has canceled a request and a server as detected
+        # the cancel.
+        #
+        REQUEST_CANCELLED = -32800
+      end
+    end
+  end
+end

data/lib/language_server/protocol/constant/trace_values.rb

@@ -0,0 +1,20 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module TraceValues
+        #
+        # Turn tracing off.
+        #
+        OFF = "off"
+        #
+        # Trace messages only.
+        #
+        MESSAGES = "messages"
+        #
+        # Verbose message tracing.
+        #
+        VERBOSE = "verbose"
+      end
+    end
+  end
+end

data/lib/language_server/protocol/constant.rb

@@ -19,6 +19,7 @@ module LanguageServer
       autoload :InlayHintKind, "language_server/protocol/constant/inlay_hint_kind"
       autoload :InsertTextFormat, "language_server/protocol/constant/insert_text_format"
       autoload :InsertTextMode, "language_server/protocol/constant/insert_text_mode"
+      autoload :LSPErrorCodes, "language_server/protocol/constant/lsp_error_codes"
       autoload :MarkupKind, "language_server/protocol/constant/markup_kind"
       autoload :MessageType, "language_server/protocol/constant/message_type"
       autoload :MonikerKind, "language_server/protocol/constant/moniker_kind"
@@ -34,6 +35,7 @@ module LanguageServer
       autoload :TextDocumentSaveReason, "language_server/protocol/constant/text_document_save_reason"
       autoload :TextDocumentSyncKind, "language_server/protocol/constant/text_document_sync_kind"
       autoload :TokenFormat, "language_server/protocol/constant/token_format"
+      autoload :TraceValues, "language_server/protocol/constant/trace_values"
       autoload :UniquenessLevel, "language_server/protocol/constant/uniqueness_level"
       autoload :WatchKind, "language_server/protocol/constant/watch_kind"
 
@@ -55,6 +57,7 @@ module LanguageServer
       require_relative "constant/inlay_hint_kind"
       require_relative "constant/insert_text_format"
       require_relative "constant/insert_text_mode"
+      require_relative "constant/lsp_error_codes"
       require_relative "constant/markup_kind"
       require_relative "constant/message_type"
       require_relative "constant/moniker_kind"
@@ -70,6 +73,7 @@ module LanguageServer
       require_relative "constant/text_document_save_reason"
       require_relative "constant/text_document_sync_kind"
       require_relative "constant/token_format"
+      require_relative "constant/trace_values"
       require_relative "constant/uniqueness_level"
       require_relative "constant/watch_kind"
     end

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

@@ -4,17 +4,27 @@ module LanguageServer
       #
       # A special text edit with an additional change annotation.
       #
+      # @since 3.16.0.
+      #
       class AnnotatedTextEdit
-        def initialize(range:, new_text:, annotation_id:)
+        def initialize(annotation_id:, range:, new_text:)
           @attributes = {}
 
+          @attributes[:annotationId] = annotation_id
           @attributes[:range] = range
           @attributes[:newText] = new_text
-          @attributes[:annotationId] = annotation_id
 
           @attributes.freeze
         end
 
+        #
+        # The actual identifier of the change annotation
+        #
+        # @return [ChangeAnnotationIdentifier]
+        def annotation_id
+          attributes.fetch(:annotationId)
+        end
+
         #
         # The range of the text document to be manipulated. To insert
         # text into a document create a range where start === end.
@@ -33,14 +43,6 @@ module LanguageServer
           attributes.fetch(:newText)
         end
 
-        #
-        # The actual annotation identifier.
-        #
-        # @return [string]
-        def annotation_id
-          attributes.fetch(:annotationId)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters passed via an apply workspace edit request.
+      #
       class ApplyWorkspaceEditParams
         def initialize(label: nil, edit:)
           @attributes = {}

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The result returned from the apply workspace edit request.
+      #
+      # @since 3.17 renamed from ApplyWorkspaceEditResponse
+      #
       class ApplyWorkspaceEditResult
         def initialize(applied:, failure_reason: nil, failed_change: nil)
           @attributes = {}
@@ -31,12 +36,11 @@ module LanguageServer
         end
 
         #
-        # Depending on the client's failure handling strategy `failedChange`
-        # might contain the index of the change that failed. This property is
-        # only available if the client signals a `failureHandling` strategy
-        # in its client capabilities.
+        # Depending on the client's failure handling strategy `failedChange` might
+        # contain the index of the change that failed. This property is only available
+        # if the client signals a `failureHandlingStrategy` in its client capabilities.
         #
-        # @return [number]
+        # @return [uinteger]
         def failed_change
           attributes.fetch(:failedChange)
         end

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

@@ -0,0 +1,68 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A base for all symbol information.
+      #
+      class BaseSymbolInformation
+        def initialize(name:, kind:, tags: nil, container_name: nil)
+          @attributes = {}
+
+          @attributes[:name] = name
+          @attributes[:kind] = kind
+          @attributes[:tags] = tags if tags
+          @attributes[:containerName] = container_name if container_name
+
+          @attributes.freeze
+        end
+
+        #
+        # The name of this symbol.
+        #
+        # @return [string]
+        def name
+          attributes.fetch(:name)
+        end
+
+        #
+        # The kind of this symbol.
+        #
+        # @return [SymbolKind]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # Tags for this symbol.
+        #
+        # @since 3.16.0
+        #
+        # @return [SymbolTag[]]
+        def tags
+          attributes.fetch(:tags)
+        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]
+        def container_name
+          attributes.fetch(:containerName)
+        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/call_hierarchy_client_capabilities.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -11,10 +14,9 @@ module LanguageServer
         end
 
         #
-        # 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.
+        # 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]
         def dynamic_registration

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents an incoming call, e.g. a caller of a method or constructor.
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyIncomingCall
         def initialize(from:, from_ranges:)
           @attributes = {}
@@ -21,7 +26,7 @@ module LanguageServer
 
         #
         # The ranges at which the calls appear. This is relative to the caller
-        # denoted by [`this.from`](#CallHierarchyIncomingCall.from).
+        # denoted by {@link CallHierarchyIncomingCall.from `this.from`}.
         #
         # @return [Range[]]
         def from_ranges

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[:item] = item
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
-          @attributes[:item] = item
 
           @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,6 +1,12 @@
 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 = {}
@@ -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,6 +1,11 @@
 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 = {}

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[:item] = item
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
-          @attributes[:item] = item
 
           @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,6 +1,11 @@
 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 = {}

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

@@ -1,6 +1,11 @@
 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 = {}
@@ -13,10 +18,10 @@ 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 | 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,6 +4,8 @@ module LanguageServer
       #
       # Additional information that describes document changes.
       #
+      # @since 3.16.0
+      #
       class ChangeAnnotation
         def initialize(label:, needs_confirmation: nil, description: nil)
           @attributes = {}

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

@@ -1,6 +1,9 @@
 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 = {}
@@ -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