language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -1,44 +1,34 @@
 module LanguageServer
   module Protocol
     module Constant
-      #
-      # A set of predefined token types. This set is not fixed
-      # an clients can specify additional token types via the
-      # corresponding client capabilities.
-      #
-      # @since 3.16.0
-      #
       module SemanticTokenTypes
-        NAMESPACE = "namespace"
+        NAMESPACE = 'namespace'
         #
-        # Represents a generic type. Acts as a fallback for types which can't be mapped to
-        # a specific type like class or enum.
+        # Represents a generic type. Acts as a fallback for types which
+        # can't be mapped to a specific type like class or enum.
         #
-        TYPE = "type"
-        CLASS = "class"
-        ENUM = "enum"
-        INTERFACE = "interface"
-        STRUCT = "struct"
-        TYPE_PARAMETER = "typeParameter"
-        PARAMETER = "parameter"
-        VARIABLE = "variable"
-        PROPERTY = "property"
-        ENUM_MEMBER = "enumMember"
-        EVENT = "event"
-        FUNCTION = "function"
-        METHOD = "method"
-        MACRO = "macro"
-        KEYWORD = "keyword"
-        MODIFIER = "modifier"
-        COMMENT = "comment"
-        STRING = "string"
-        NUMBER = "number"
-        REGEXP = "regexp"
-        OPERATOR = "operator"
-        #
-        # @since 3.17.0
-        #
-        DECORATOR = "decorator"
+        TYPE = 'type'
+        CLASS = 'class'
+        ENUM = 'enum'
+        INTERFACE = 'interface'
+        STRUCT = 'struct'
+        TYPE_PARAMETER = 'typeParameter'
+        PARAMETER = 'parameter'
+        VARIABLE = 'variable'
+        PROPERTY = 'property'
+        ENUM_MEMBER = 'enumMember'
+        EVENT = 'event'
+        FUNCTION = 'function'
+        METHOD = 'method'
+        MACRO = 'macro'
+        KEYWORD = 'keyword'
+        MODIFIER = 'modifier'
+        COMMENT = 'comment'
+        STRING = 'string'
+        NUMBER = 'number'
+        REGEXP = 'regexp'
+        OPERATOR = 'operator'
+        DECORATOR = 'decorator'
       end
     end
   end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # How a signature help was triggered.
       #
-      # @since 3.15.0
-      #
       module SignatureHelpTriggerKind
         #
         # Signature help was invoked manually by the user or by a command.
@@ -16,7 +14,8 @@ module LanguageServer
         #
         TRIGGER_CHARACTER = 2
         #
-        # Signature help was triggered by the cursor moving or by the document content changing.
+        # Signature help was triggered by the cursor moving or by the document
+        # content changing.
         #
         CONTENT_CHANGE = 3
       end

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

@@ -4,8 +4,6 @@ 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
-        # sent.
+        # send.
         #
         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/uniqueness_level.rb

@@ -4,29 +4,27 @@ module LanguageServer
       #
       # 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"
+        DOCUMENT = 'document'
         #
         # The moniker is unique inside a project for which a dump got created
         #
-        PROJECT = "project"
+        PROJECT = 'project'
         #
         # The moniker is unique inside the group to which a project belongs
         #
-        GROUP = "group"
+        GROUP = 'group'
         #
         # The moniker is unique inside the moniker scheme.
         #
-        SCHEME = "scheme"
+        SCHEME = 'scheme'
         #
         # The moniker is globally unique
         #
-        GLOBAL = "global"
+        GLOBAL = 'global'
       end
     end
   end

data/lib/language_server/protocol/constant.rb

@@ -8,16 +8,17 @@ module LanguageServer
       autoload :CompletionTriggerKind, "language_server/protocol/constant/completion_trigger_kind"
       autoload :DiagnosticSeverity, "language_server/protocol/constant/diagnostic_severity"
       autoload :DiagnosticTag, "language_server/protocol/constant/diagnostic_tag"
+      autoload :DocumentDiagnosticReportKind, "language_server/protocol/constant/document_diagnostic_report_kind"
       autoload :DocumentHighlightKind, "language_server/protocol/constant/document_highlight_kind"
       autoload :ErrorCodes, "language_server/protocol/constant/error_codes"
       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 :FoldingRangeKind, "language_server/protocol/constant/folding_range_kind"
+      autoload :InitializeErrorCodes, "language_server/protocol/constant/initialize_error_codes"
       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"
@@ -32,8 +33,8 @@ module LanguageServer
       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"
 
@@ -44,16 +45,17 @@ module LanguageServer
       require "language_server/protocol/constant/completion_trigger_kind"
       require "language_server/protocol/constant/diagnostic_severity"
       require "language_server/protocol/constant/diagnostic_tag"
+      require "language_server/protocol/constant/document_diagnostic_report_kind"
       require "language_server/protocol/constant/document_highlight_kind"
       require "language_server/protocol/constant/error_codes"
       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/folding_range_kind"
+      require "language_server/protocol/constant/initialize_error_codes"
       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"
@@ -68,8 +70,8 @@ module LanguageServer
       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

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

@@ -4,27 +4,17 @@ module LanguageServer
       #
       # A special text edit with an additional change annotation.
       #
-      # @since 3.16.0.
-      #
       class AnnotatedTextEdit
-        def initialize(annotation_id:, range:, new_text:)
+        def initialize(range:, new_text:, annotation_id:)
           @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.
@@ -43,6 +33,14 @@ 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,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameters passed via a apply workspace edit request.
-      #
       class ApplyWorkspaceEditParams
         def initialize(label: nil, edit:)
           @attributes = {}
@@ -19,7 +16,7 @@ module LanguageServer
         # presented in the user interface for example on an undo
         # stack to undo the workspace edit.
         #
-        # @return [string | nil]
+        # @return [string]
         def label
           attributes.fetch(:label)
         end

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

@@ -1,11 +1,6 @@
 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 = {}
@@ -30,17 +25,18 @@ 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 | nil]
+        # @return [string]
         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 `failureHandling` strategy
+        # in its client capabilities.
         #
-        # @return [uinteger | nil]
+        # @return [number]
         def failed_change
           attributes.fetch(:failedChange)
         end

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

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

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

@@ -1,11 +1,6 @@
 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,44 +1,39 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameter of a `callHierarchy/incomingCalls` request.
-      #
-      # @since 3.16.0
-      #
       class CallHierarchyIncomingCallsParams
-        def initialize(item:, work_done_token: nil, partial_result_token: nil)
+        def initialize(work_done_token: nil, partial_result_token: nil, item:)
           @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 | nil]
+        # @return [ProgressToken]
         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 | nil]
+        # @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,12 +1,6 @@
 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 = {}
@@ -42,7 +36,7 @@ module LanguageServer
         #
         # Tags for this item.
         #
-        # @return [SymbolTag[] | nil]
+        # @return [1[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -50,7 +44,7 @@ module LanguageServer
         #
         # More detail for this item, e.g. the signature of a function.
         #
-        # @return [string | nil]
+        # @return [string]
         def detail
           attributes.fetch(:detail)
         end
@@ -58,13 +52,14 @@ module LanguageServer
         #
         # The resource identifier of this item.
         #
-        # @return [DocumentUri]
+        # @return [string]
         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
@@ -72,8 +67,9 @@ 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
@@ -84,7 +80,7 @@ module LanguageServer
         # A data entry field that is preserved between a call hierarchy prepare and
         # incoming calls or outgoing calls requests.
         #
-        # @return [LSPAny | nil]
+        # @return [unknown]
         def data
           attributes.fetch(:data)
         end

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

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

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

@@ -1,11 +1,6 @@
 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 = {}
@@ -25,9 +20,8 @@ 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 [`provideCallHierarchyOutgoingCalls`](#CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls)
-        # and not [`this.to`](#CallHierarchyOutgoingCall.to).
+        # 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.
         #
         # @return [Range[]]
         def from_ranges

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

@@ -1,44 +1,39 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameter of a `callHierarchy/outgoingCalls` request.
-      #
-      # @since 3.16.0
-      #
       class CallHierarchyOutgoingCallsParams
-        def initialize(item:, work_done_token: nil, partial_result_token: nil)
+        def initialize(work_done_token: nil, partial_result_token: nil, item:)
           @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 | nil]
+        # @return [ProgressToken]
         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 | nil]
+        # @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,11 +1,6 @@
 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 = {}
@@ -36,7 +31,7 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken | nil]
+        # @return [ProgressToken]
         def work_done_token
           attributes.fetch(:workDoneToken)
         end

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

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