language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Symbol tags are extra annotations that tweak the rendering of a symbol.
       #
+      # @since 3.16
+      #
       module SymbolTag
         #
         # Render a symbol as obsolete, usually using a strike-out.

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

@@ -6,8 +6,8 @@ module LanguageServer
       #
       module TextDocumentSaveReason
         #
-        # Manually triggered, e.g. by the user pressing save, by starting
-        # debugging, or by an API call.
+        # Manually triggered, e.g. by the user pressing save, by starting debugging,
+        # or by an API call.
         #
         MANUAL = 1
         #

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

@@ -2,8 +2,8 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # Defines how the host (editor) should sync document changes to the language
-      # server.
+      # Defines how the host (editor) should sync
+      # document changes to the language server.
       #
       module TextDocumentSyncKind
         #
@@ -18,7 +18,7 @@ module LanguageServer
         #
         # Documents are synced by sending the full content on open.
         # After that only incremental updates to the document are
-        # send.
+        # sent.
         #
         INCREMENTAL = 2
       end

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Constant
       module TokenFormat
-        RELATIVE = 'relative'
+        RELATIVE = "relative"
       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/uniqueness_level.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Moniker uniqueness level to define scope of the moniker.
+      #
+      # @since 3.16.0
+      #
+      module UniquenessLevel
+        #
+        # The moniker is only unique inside a document
+        #
+        DOCUMENT = "document"
+        #
+        # The moniker is unique inside a project for which a dump got created
+        #
+        PROJECT = "project"
+        #
+        # The moniker is unique inside the group to which a project belongs
+        #
+        GROUP = "group"
+        #
+        # The moniker is unique inside the moniker scheme.
+        #
+        SCHEME = "scheme"
+        #
+        # The moniker is globally unique
+        #
+        GLOBAL = "global"
+      end
+    end
+  end
+end

data/lib/language_server/protocol/constant.rb

@@ -2,6 +2,7 @@ module LanguageServer
   module Protocol
     module Constant
       autoload :CodeActionKind, "language_server/protocol/constant/code_action_kind"
+      autoload :CodeActionTriggerKind, "language_server/protocol/constant/code_action_trigger_kind"
       autoload :CompletionItemKind, "language_server/protocol/constant/completion_item_kind"
       autoload :CompletionItemTag, "language_server/protocol/constant/completion_item_tag"
       autoload :CompletionTriggerKind, "language_server/protocol/constant/completion_trigger_kind"
@@ -12,23 +13,32 @@ module LanguageServer
       autoload :FailureHandlingKind, "language_server/protocol/constant/failure_handling_kind"
       autoload :FileChangeType, "language_server/protocol/constant/file_change_type"
       autoload :FileOperationPatternKind, "language_server/protocol/constant/file_operation_pattern_kind"
-      autoload :InitializeError, "language_server/protocol/constant/initialize_error"
+      autoload :FoldingRangeKind, "language_server/protocol/constant/folding_range_kind"
+      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"
+      autoload :NotebookCellKind, "language_server/protocol/constant/notebook_cell_kind"
+      autoload :PositionEncodingKind, "language_server/protocol/constant/position_encoding_kind"
       autoload :PrepareSupportDefaultBehavior, "language_server/protocol/constant/prepare_support_default_behavior"
       autoload :ResourceOperationKind, "language_server/protocol/constant/resource_operation_kind"
+      autoload :SemanticTokenModifiers, "language_server/protocol/constant/semantic_token_modifiers"
+      autoload :SemanticTokenTypes, "language_server/protocol/constant/semantic_token_types"
       autoload :SignatureHelpTriggerKind, "language_server/protocol/constant/signature_help_trigger_kind"
       autoload :SymbolKind, "language_server/protocol/constant/symbol_kind"
       autoload :SymbolTag, "language_server/protocol/constant/symbol_tag"
       autoload :TextDocumentSaveReason, "language_server/protocol/constant/text_document_save_reason"
       autoload :TextDocumentSyncKind, "language_server/protocol/constant/text_document_sync_kind"
-      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"
 
       require "language_server/protocol/constant/code_action_kind"
+      require "language_server/protocol/constant/code_action_trigger_kind"
       require "language_server/protocol/constant/completion_item_kind"
       require "language_server/protocol/constant/completion_item_tag"
       require "language_server/protocol/constant/completion_trigger_kind"
@@ -39,20 +49,28 @@ module LanguageServer
       require "language_server/protocol/constant/failure_handling_kind"
       require "language_server/protocol/constant/file_change_type"
       require "language_server/protocol/constant/file_operation_pattern_kind"
-      require "language_server/protocol/constant/initialize_error"
+      require "language_server/protocol/constant/folding_range_kind"
+      require "language_server/protocol/constant/inlay_hint_kind"
       require "language_server/protocol/constant/insert_text_format"
       require "language_server/protocol/constant/insert_text_mode"
+      require "language_server/protocol/constant/lsp_error_codes"
       require "language_server/protocol/constant/markup_kind"
       require "language_server/protocol/constant/message_type"
+      require "language_server/protocol/constant/moniker_kind"
+      require "language_server/protocol/constant/notebook_cell_kind"
+      require "language_server/protocol/constant/position_encoding_kind"
       require "language_server/protocol/constant/prepare_support_default_behavior"
       require "language_server/protocol/constant/resource_operation_kind"
+      require "language_server/protocol/constant/semantic_token_modifiers"
+      require "language_server/protocol/constant/semantic_token_types"
       require "language_server/protocol/constant/signature_help_trigger_kind"
       require "language_server/protocol/constant/symbol_kind"
       require "language_server/protocol/constant/symbol_tag"
       require "language_server/protocol/constant/text_document_save_reason"
       require "language_server/protocol/constant/text_document_sync_kind"
-      require "language_server/protocol/constant/text_document_sync_kind"
       require "language_server/protocol/constant/token_format"
+      require "language_server/protocol/constant/trace_values"
+      require "language_server/protocol/constant/uniqueness_level"
       require "language_server/protocol/constant/watch_kind"
     end
   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 a apply workspace edit request.
+      #
       class ApplyWorkspaceEditParams
         def initialize(label: nil, edit:)
           @attributes = {}
@@ -16,7 +19,7 @@ module LanguageServer
         # presented in the user interface for example on an undo
         # stack to undo the workspace edit.
         #
-        # @return [string]
+        # @return [string | nil]
         def label
           attributes.fetch(:label)
         end

data/lib/language_server/protocol/interface/{apply_workspace_edit_response.rb → apply_workspace_edit_result.rb}

@@ -1,7 +1,12 @@
 module LanguageServer
   module Protocol
     module Interface
-      class ApplyWorkspaceEditResponse
+      #
+      # 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 = {}
 
@@ -25,18 +30,17 @@ module LanguageServer
         # This may be used by the server for diagnostic logging or to provide
         # a suitable error for a request that triggered the edit.
         #
-        # @return [string]
+        # @return [string | nil]
         def failure_reason
           attributes.fetch(:failureReason)
         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 `failureHandlingStrategy`
-        # 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 | nil]
         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[] | nil]
+        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 | nil]
+        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,12 +14,11 @@ 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]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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 = {}

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

@@ -1,39 +1,44 @@
 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.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def work_done_token
           attributes.fetch(:workDoneToken)
         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]
+        # @return [ProgressToken | nil]
         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 = {}
@@ -28,7 +34,7 @@ module LanguageServer
         #
         # The kind of this item.
         #
-        # @return [any]
+        # @return [SymbolKind]
         def kind
           attributes.fetch(:kind)
         end
@@ -36,7 +42,7 @@ module LanguageServer
         #
         # Tags for this item.
         #
-        # @return [1[]]
+        # @return [SymbolTag[] | nil]
         def tags
           attributes.fetch(:tags)
         end
@@ -44,7 +50,7 @@ module LanguageServer
         #
         # More detail for this item, e.g. the signature of a function.
         #
-        # @return [string]
+        # @return [string | nil]
         def detail
           attributes.fetch(:detail)
         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 [`range`](#CallHierarchyItem.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 | nil]
         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 = {}
@@ -10,7 +15,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/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 [`provideCallHierarchyOutgoingCalls`](#CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls)
+        # and not [`this.to`](#CallHierarchyOutgoingCall.to).
         #
         # @return [Range[]]
         def from_ranges

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

@@ -1,39 +1,44 @@
 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.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def work_done_token
           attributes.fetch(:workDoneToken)
         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]
+        # @return [ProgressToken | nil]
         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 = {}
@@ -31,7 +36,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