language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -32,16 +32,16 @@ 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
 
         #
-        # 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

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

@@ -13,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
@@ -30,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

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # @since 3.17.0
-      #
       class TypeHierarchyItem
         def initialize(name:, kind:, tags: nil, detail: nil, uri:, range:, selection_range:, data: nil)
           @attributes = {}
@@ -39,7 +36,7 @@ module LanguageServer
         #
         # Tags for this item.
         #
-        # @return [SymbolTag[] | nil]
+        # @return [1[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -47,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
@@ -55,7 +52,7 @@ module LanguageServer
         #
         # The resource identifier of this item.
         #
-        # @return [DocumentUri]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end
@@ -85,7 +82,7 @@ module LanguageServer
         # type hierarchy in the server, helping improve the performance on
         # resolving supertypes and subtypes.
         #
-        # @return [LSPAny | nil]
+        # @return [LSPAny]
         def data
           attributes.fetch(:data)
         end

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

@@ -1,11 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Type hierarchy options used during static registration.
-      #
-      # @since 3.17.0
-      #
       class TypeHierarchyOptions
         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/type_hierarchy_prepare_params.rb

@@ -1,11 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameter of a `textDocument/prepareTypeHierarchy` request.
-      #
-      # @since 3.17.0
-      #
       class TypeHierarchyPrepareParams
         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/type_hierarchy_registration_options.rb

@@ -1,11 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Type hierarchy options used during static or dynamic registration.
-      #
-      # @since 3.17.0
-      #
       class TypeHierarchyRegistrationOptions
         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

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

@@ -1,44 +1,39 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameter of a `typeHierarchy/subtypes` request.
-      #
-      # @since 3.17.0
-      #
       class TypeHierarchySubtypesParams
-        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 [TypeHierarchyItem]
-        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 [TypeHierarchyItem]
+        def item
+          attributes.fetch(:item)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,44 +1,39 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameter of a `typeHierarchy/supertypes` request.
-      #
-      # @since 3.17.0
-      #
       class TypeHierarchySupertypesParams
-        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 [TypeHierarchyItem]
-        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 [TypeHierarchyItem]
+        def item
+          attributes.fetch(:item)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -5,8 +5,6 @@ module LanguageServer
       # A diagnostic report indicating that the last returned
       # report is still accurate.
       #
-      # @since 3.17.0
-      #
       class UnchangedDocumentDiagnosticReport
         def initialize(kind:, result_id:)
           @attributes = {}
@@ -23,7 +21,7 @@ module LanguageServer
         # only return `unchanged` if result ids are
         # provided.
         #
-        # @return ["unchanged"]
+        # @return [any]
         def kind
           attributes.fetch(:kind)
         end

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # General parameters to unregister a request or notification.
+      # General parameters to unregister a capability.
       #
       class Unregistration
         def initialize(id:, method:)
@@ -24,7 +24,7 @@ module LanguageServer
         end
 
         #
-        # The method to unregister for.
+        # The method / capability to unregister for.
         #
         # @return [string]
         def method

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # A versioned notebook document identifier.
       #
-      # @since 3.17.0
-      #
       class VersionedNotebookDocumentIdentifier
         def initialize(version:, uri:)
           @attributes = {}
@@ -19,15 +17,15 @@ module LanguageServer
         #
         # The version number of this notebook document.
         #
-        # @return [integer]
+        # @return [number]
         def version
           attributes.fetch(:version)
         end
 
         #
-        # The notebook document's uri.
+        # The notebook document's URI.
         #
-        # @return [URI]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -1,33 +1,33 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # A text document identifier to denote a specific version of a text document.
-      #
       class VersionedTextDocumentIdentifier
-        def initialize(version:, uri:)
+        def initialize(uri:, version:)
           @attributes = {}
 
-          @attributes[:version] = version
           @attributes[:uri] = uri
+          @attributes[:version] = version
 
           @attributes.freeze
         end
 
         #
-        # The version number of this document.
+        # The text document's URI.
         #
-        # @return [integer]
-        def version
-          attributes.fetch(:version)
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
         end
 
         #
-        # The text document's uri.
+        # The version number of this document.
         #
-        # @return [DocumentUri]
-        def uri
-          attributes.fetch(:uri)
+        # The version number of a document will increase after each change,
+        # including undo/redo. The number doesn't need to be consecutive.
+        #
+        # @return [number]
+        def version
+          attributes.fetch(:version)
         end
 
         attr_reader :attributes

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters sent in a will save text document notification.
+      # The parameters send in a will save text document notification.
       #
       class WillSaveTextDocumentParams
         def initialize(text_document:, reason:)

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

@@ -32,10 +32,10 @@ module LanguageServer
 
         #
         # Controls if a cancel button should show to allow the user to cancel the
-        # long running operation. Clients that don't support cancellation are allowed
-        # to ignore the setting.
+        # long running operation. Clients that don't support cancellation are
+        # allowed to ignore the setting.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def cancellable
           attributes.fetch(:cancellable)
         end
@@ -47,7 +47,7 @@ module LanguageServer
         # Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
         # If unset, the previous progress message (if any) is still valid.
         #
-        # @return [string | nil]
+        # @return [string]
         def message
           attributes.fetch(:message)
         end
@@ -58,9 +58,9 @@ module LanguageServer
         # to ignore the `percentage` value in subsequent in report notifications.
         #
         # The value should be steadily rising. Clients are free to ignore values
-        # that are not following this rule. The value range is [0, 100].
+        # that are not following this rule. The value range is [0, 100]
         #
-        # @return [uinteger | nil]
+        # @return [number]
         def percentage
           attributes.fetch(:percentage)
         end

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

@@ -20,7 +20,7 @@ module LanguageServer
         # Optional, a final message indicating to for example indicate the outcome
         # of the operation.
         #
-        # @return [string | nil]
+        # @return [string]
         def message
           attributes.fetch(:message)
         end

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

@@ -10,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/work_done_progress_params.rb

@@ -13,7 +13,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/work_done_progress_report.rb

@@ -19,12 +19,13 @@ module LanguageServer
         end
 
         #
-        # Controls enablement state of a cancel button.
+        # Controls enablement state of a cancel button. This property is only valid
+        # if a cancel button got requested in the `WorkDoneProgressBegin` payload.
         #
-        # Clients that don't support cancellation or don't support controlling the button's
-        # enablement state are allowed to ignore the property.
+        # Clients that don't support cancellation or don't support control the
+        # button's enablement state are allowed to ignore the setting.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def cancellable
           attributes.fetch(:cancellable)
         end
@@ -36,7 +37,7 @@ module LanguageServer
         # Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
         # If unset, the previous progress message (if any) is still valid.
         #
-        # @return [string | nil]
+        # @return [string]
         def message
           attributes.fetch(:message)
         end
@@ -49,7 +50,7 @@ module LanguageServer
         # The value should be steadily rising. Clients are free to ignore values
         # that are not following this rule. The value range is [0, 100]
         #
-        # @return [uinteger | nil]
+        # @return [number]
         def percentage
           attributes.fetch(:percentage)
         end

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

@@ -4,52 +4,50 @@ module LanguageServer
       #
       # Parameters of the workspace diagnostic request.
       #
-      # @since 3.17.0
-      #
       class WorkspaceDiagnosticParams
-        def initialize(identifier: nil, previous_result_ids:, work_done_token: nil, partial_result_token: nil)
+        def initialize(work_done_token: nil, partial_result_token: nil, identifier: nil, previous_result_ids:)
           @attributes = {}
 
-          @attributes[:identifier] = identifier if identifier
-          @attributes[:previousResultIds] = previous_result_ids
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:identifier] = identifier if identifier
+          @attributes[:previousResultIds] = previous_result_ids
 
           @attributes.freeze
         end
 
         #
-        # The additional identifier provided during registration.
+        # An optional token that a server can use to report work done progress.
         #
-        # @return [string | nil]
-        def identifier
-          attributes.fetch(:identifier)
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
         end
 
         #
-        # The currently known diagnostic reports with their
-        # previous result ids.
+        # An optional token that a server can use to report partial results (e.g.
+        # streaming) to the client.
         #
-        # @return [PreviousResultId[]]
-        def previous_result_ids
-          attributes.fetch(:previousResultIds)
+        # @return [ProgressToken]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
         end
 
         #
-        # An optional token that a server can use to report work done progress.
+        # The additional identifier provided during registration.
         #
-        # @return [ProgressToken | nil]
-        def work_done_token
-          attributes.fetch(:workDoneToken)
+        # @return [string]
+        def identifier
+          attributes.fetch(:identifier)
         end
 
         #
-        # An optional token that a server can use to report partial results (e.g. streaming) to
-        # the client.
+        # The currently known diagnostic reports with their
+        # previous result ids.
         #
-        # @return [ProgressToken | nil]
-        def partial_result_token
-          attributes.fetch(:partialResultToken)
+        # @return [PreviousResultId[]]
+        def previous_result_ids
+          attributes.fetch(:previousResultIds)
         end
 
         attr_reader :attributes

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # A workspace diagnostic report.
       #
-      # @since 3.17.0
-      #
       class WorkspaceDiagnosticReport
         def initialize(items:)
           @attributes = {}

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # A partial result for a workspace diagnostic report.
       #
-      # @since 3.17.0
-      #
       class WorkspaceDiagnosticReportPartialResult
         def initialize(items:)
           @attributes = {}