language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A selection range represents a part of a selection hierarchy. A selection range
+      # may have a parent selection range that contains it.
+      #
       class SelectionRange
         def initialize(range:, parent: nil)
           @attributes = {}
@@ -20,10 +24,9 @@ module LanguageServer
         end
 
         #
-        # The parent selection range containing this range. Therefore
-        # `parent.range` must contain `this.range`.
+        # The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.
         #
-        # @return [SelectionRange]
+        # @return [SelectionRange | nil]
         def parent
           attributes.fetch(:parent)
         end

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

@@ -11,12 +11,11 @@ module LanguageServer
         end
 
         #
-        # Whether implementation supports dynamic registration for selection range
-        # providers. If this is set to `true` the client supports the new
-        # `SelectionRangeRegistrationOptions` return value for the corresponding
-        # server capability as well.
+        # Whether implementation supports dynamic registration for selection range providers. If this is set to `true`
+        # the client supports the new `SelectionRangeRegistrationOptions` 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/selection_range_options.rb

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

@@ -1,35 +1,21 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A parameter literal used in selection range requests.
+      #
       class SelectionRangeParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, positions:)
+        def initialize(text_document:, positions:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
           @attributes[:positions] = positions
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
 
           @attributes.freeze
         end
 
-        #
-        # An optional token that a server can use to report work done progress.
-        #
-        # @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.
-        #
-        # @return [ProgressToken]
-        def partial_result_token
-          attributes.fetch(:partialResultToken)
-        end
-
         #
         # The text document.
         #
@@ -46,6 +32,23 @@ module LanguageServer
           attributes.fetch(:positions)
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @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.
+        #
+        # @return [ProgressToken | nil]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -12,16 +12,16 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         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 | null]
         def document_selector
           attributes.fetch(:documentSelector)
         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]
+        # @return [string | nil]
         def id
           attributes.fetch(:id)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokens
         def initialize(result_id: nil, data:)
           @attributes = {}
@@ -17,7 +20,7 @@ module LanguageServer
         # A server can then instead of computing all semantic tokens again simply
         # send a delta.
         #
-        # @return [string]
+        # @return [string | nil]
         def result_id
           attributes.fetch(:resultId)
         end
@@ -25,7 +28,7 @@ module LanguageServer
         #
         # The actual tokens.
         #
-        # @return [number[]]
+        # @return [uinteger[]]
         def data
           attributes.fetch(:data)
         end

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

@@ -1,8 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensClientCapabilities
-        def initialize(dynamic_registration: nil, requests:, token_types:, token_modifiers:, formats:, overlapping_token_support: nil, multiline_token_support: nil)
+        def initialize(dynamic_registration: nil, requests:, token_types:, token_modifiers:, formats:, overlapping_token_support: nil, multiline_token_support: nil, server_cancel_support: nil, augments_syntax_tokens: nil)
           @attributes = {}
 
           @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
@@ -12,17 +15,18 @@ module LanguageServer
           @attributes[:formats] = formats
           @attributes[:overlappingTokenSupport] = overlapping_token_support if overlapping_token_support
           @attributes[:multilineTokenSupport] = multiline_token_support if multiline_token_support
+          @attributes[:serverCancelSupport] = server_cancel_support if server_cancel_support
+          @attributes[:augmentsSyntaxTokens] = augments_syntax_tokens if augments_syntax_tokens
 
           @attributes.freeze
         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
@@ -37,7 +41,7 @@ module LanguageServer
         # range provider the client might not render a minimap correctly or might
         # even decide to not show any semantic tokens at all.
         #
-        # @return [{ range?: boolean | {}; full?: boolean | { delta?: boolean; }; }]
+        # @return [{ range:boolean | {  }, full:boolean | { delta:boolean } }]
         def requests
           attributes.fetch(:requests)
         end
@@ -59,9 +63,9 @@ module LanguageServer
         end
 
         #
-        # The formats the clients supports.
+        # The token formats the clients supports.
         #
-        # @return ["relative"[]]
+        # @return [TokenFormat[]]
         def formats
           attributes.fetch(:formats)
         end
@@ -69,7 +73,7 @@ module LanguageServer
         #
         # Whether the client supports tokens that can overlap each other.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def overlapping_token_support
           attributes.fetch(:overlappingTokenSupport)
         end
@@ -77,11 +81,41 @@ module LanguageServer
         #
         # Whether the client supports tokens that can span multiple lines.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def multiline_token_support
           attributes.fetch(:multilineTokenSupport)
         end
 
+        #
+        # Whether the client allows the server to actively cancel a
+        # semantic token request, e.g. supports returning
+        # LSPErrorCodes.ServerCancelled. If a server does the client
+        # needs to retrigger the request.
+        #
+        # @since 3.17.0
+        #
+        # @return [boolean | nil]
+        def server_cancel_support
+          attributes.fetch(:serverCancelSupport)
+        end
+
+        #
+        # Whether the client uses semantic tokens to augment existing
+        # syntax tokens. If set to `true` client side created syntax
+        # tokens and semantic tokens are both used for colorization. If
+        # set to `false` the client only uses the returned semantic tokens
+        # for colorization.
+        #
+        # If the value is `undefined` then the client behavior is not
+        # specified.
+        #
+        # @since 3.17.0
+        #
+        # @return [boolean | nil]
+        def augments_syntax_tokens
+          attributes.fetch(:augmentsSyntaxTokens)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensDelta
         def initialize(result_id: nil, edits:)
           @attributes = {}
@@ -11,14 +14,13 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [string]
+        # @return [string | nil]
         def result_id
           attributes.fetch(:resultId)
         end
 
         #
-        # The semantic token edits to transform a previous result into a new
-        # result.
+        # The semantic token edits to transform a previous result into a new result.
         #
         # @return [SemanticTokensEdit[]]
         def edits

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

@@ -1,50 +1,53 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensDeltaParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, previous_result_id:)
+        def initialize(text_document:, previous_result_id:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
           @attributes[:previousResultId] = previous_result_id
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
 
           @attributes.freeze
         end
 
         #
-        # An optional token that a server can use to report work done progress.
+        # The text document.
         #
-        # @return [ProgressToken]
-        def work_done_token
-          attributes.fetch(:workDoneToken)
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
         end
 
         #
-        # An optional token that a server can use to report partial results (e.g.
-        # streaming) to the client.
+        # The result id of a previous response. The result Id can either point to a full response
+        # or a delta response depending on what was received last.
         #
-        # @return [ProgressToken]
-        def partial_result_token
-          attributes.fetch(:partialResultToken)
+        # @return [string]
+        def previous_result_id
+          attributes.fetch(:previousResultId)
         end
 
         #
-        # The text document.
+        # An optional token that a server can use to report work done progress.
         #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
+        # @return [ProgressToken | nil]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
         end
 
         #
-        # The result id of a previous response. The result Id can either point to
-        # a full response or a delta response depending on what was received last.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
-        # @return [string]
-        def previous_result_id
-          attributes.fetch(:previousResultId)
+        # @return [ProgressToken | nil]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
         end
 
         attr_reader :attributes

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensDeltaPartialResult
         def initialize(edits:)
           @attributes = {}

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensEdit
         def initialize(start:, delete_count:, data: nil)
           @attributes = {}
@@ -15,7 +18,7 @@ module LanguageServer
         #
         # The start offset of the edit.
         #
-        # @return [number]
+        # @return [uinteger]
         def start
           attributes.fetch(:start)
         end
@@ -23,7 +26,7 @@ module LanguageServer
         #
         # The count of elements to remove.
         #
-        # @return [number]
+        # @return [uinteger]
         def delete_count
           attributes.fetch(:deleteCount)
         end
@@ -31,7 +34,7 @@ module LanguageServer
         #
         # The elements to insert.
         #
-        # @return [number[]]
+        # @return [uinteger[] | nil]
         def data
           attributes.fetch(:data)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensLegend
         def initialize(token_types:, token_modifiers:)
           @attributes = {}

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

@@ -1,23 +1,21 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensOptions
-        def initialize(work_done_progress: nil, legend:, range: nil, full: nil)
+        def initialize(legend:, range: nil, full: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:legend] = legend
           @attributes[:range] = range if range
           @attributes[:full] = full if full
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The legend used by the server
         #
@@ -30,7 +28,7 @@ module LanguageServer
         # Server supports providing semantic tokens for a specific range
         # of a document.
         #
-        # @return [boolean | {}]
+        # @return [boolean | {  } | nil]
         def range
           attributes.fetch(:range)
         end
@@ -38,11 +36,16 @@ module LanguageServer
         #
         # Server supports providing semantic tokens for a full document.
         #
-        # @return [boolean | { delta?: boolean; }]
+        # @return [boolean | { delta:boolean } | nil]
         def full
           attributes.fetch(:full)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,42 +1,45 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
+        def initialize(text_document:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
+          @attributes[:textDocument] = text_document
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
-          @attributes[:textDocument] = text_document
 
           @attributes.freeze
         end
 
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        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
 
-        #
-        # The text document.
-        #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensPartialResult
         def initialize(data:)
           @attributes = {}
@@ -10,7 +13,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [number[]]
+        # @return [uinteger[]]
         def data
           attributes.fetch(:data)
         end

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

@@ -1,35 +1,21 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensRangeParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, range:)
+        def initialize(text_document:, range:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
 
           @attributes.freeze
         end
 
-        #
-        # An optional token that a server can use to report work done progress.
-        #
-        # @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.
-        #
-        # @return [ProgressToken]
-        def partial_result_token
-          attributes.fetch(:partialResultToken)
-        end
-
         #
         # The text document.
         #
@@ -46,6 +32,23 @@ module LanguageServer
           attributes.fetch(:range)
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @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.
+        #
+        # @return [ProgressToken | nil]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        end
+
         attr_reader :attributes
 
         def to_hash