language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -1,6 +1,9 @@
 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, server_cancel_support: nil, augments_syntax_tokens: nil)
           @attributes = {}
@@ -19,10 +22,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
@@ -39,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
@@ -61,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
@@ -87,9 +89,11 @@ module LanguageServer
         #
         # Whether the client allows the server to actively cancel a
         # semantic token request, e.g. supports returning
-        # ErrorCodes.ServerCancelled. If a server does the client
+        # LSPErrorCodes.ServerCancelled. If a server does the client
         # needs to retrigger the request.
         #
+        # @since 3.17.0
+        #
         # @return [boolean]
         def server_cancel_support
           attributes.fetch(:serverCancelSupport)
@@ -105,6 +109,8 @@ module LanguageServer
         # If the value is `undefined` then the client behavior is not
         # specified.
         #
+        # @since 3.17.0
+        #
         # @return [boolean]
         def augments_syntax_tokens
           attributes.fetch(:augmentsSyntaxTokens)

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 = {}
@@ -17,8 +20,7 @@ module LanguageServer
         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]
+        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]
+        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[]]
         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 | { ; }]
         def range
           attributes.fetch(:range)
         end
@@ -43,6 +41,11 @@ module LanguageServer
           attributes.fetch(:full)
         end
 
+        # @return [boolean]
+        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,17 +1,28 @@
 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.
         #
@@ -21,22 +32,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
 
-        #
-        # 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]
+        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
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,34 +1,32 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, legend:, range: nil, full: nil, id: nil)
+        def initialize(document_selector:, legend:, range: nil, full: nil, work_done_progress: nil, id: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @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[:id] = id if id
 
           @attributes.freeze
         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
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The legend used by the server
         #
@@ -41,7 +39,7 @@ module LanguageServer
         # Server supports providing semantic tokens for a specific range
         # of a document.
         #
-        # @return [boolean | {}]
+        # @return [boolean | { ; }]
         def range
           attributes.fetch(:range)
         end
@@ -54,6 +52,11 @@ module LanguageServer
           attributes.fetch(:full)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # The id used to register the request. The id can be used to deregister
         # the request again. See also Registration#id.

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}
@@ -16,7 +19,7 @@ module LanguageServer
         #
         # Note that this event is global and will force the client to refresh all
         # semantic tokens currently shown. It should be used with absolute care
-        # and is useful for situation where a server for example detect a project
+        # and is useful for situation where a server for example detects a project
         # wide change that requires such a calculation.
         #
         # @return [boolean]