language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -1,39 +1,42 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [DocumentLinkRequest](#DocumentLinkRequest).
+      #
       class DocumentLinkRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, resolve_provider: nil)
+        def initialize(document_selector:, resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @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 | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # Document links have a resolve provider as well.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities of a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
+      #
       class DocumentOnTypeFormattingClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -13,7 +16,7 @@ module LanguageServer
         #
         # Whether on type formatting supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
+      #
       class DocumentOnTypeFormattingOptions
         def initialize(first_trigger_character:, more_trigger_character: nil)
           @attributes = {}
@@ -12,7 +15,7 @@ module LanguageServer
         end
 
         #
-        # A character on which formatting should be triggered, like `}`.
+        # A character on which formatting should be triggered, like `{`.
         #
         # @return [string]
         def first_trigger_character
@@ -22,7 +25,7 @@ module LanguageServer
         #
         # More trigger characters.
         #
-        # @return [string[]]
+        # @return [string[] | nil]
         def more_trigger_character
           attributes.fetch(:moreTriggerCharacter)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
+      #
       class DocumentOnTypeFormattingParams
         def initialize(text_document:, position:, ch:, options:)
           @attributes = {}
@@ -14,7 +17,7 @@ module LanguageServer
         end
 
         #
-        # The text document.
+        # The document to format.
         #
         # @return [TextDocumentIdentifier]
         def text_document
@@ -22,7 +25,9 @@ module LanguageServer
         end
 
         #
-        # The position inside the text document.
+        # The position around which the on type formatting should happen.
+        # This is not necessarily the exact position where the character denoted
+        # by the property `ch` got typed.
         #
         # @return [Position]
         def position
@@ -30,7 +35,10 @@ module LanguageServer
         end
 
         #
-        # The character that has been typed.
+        # The character that has been typed that triggered the formatting
+        # on type request. That is not necessarily the last character that
+        # got inserted into the document since the client could auto insert
+        # characters as well (e.g. like automatic brace completion).
         #
         # @return [string]
         def ch
@@ -38,7 +46,7 @@ module LanguageServer
         end
 
         #
-        # The format options.
+        # The formatting options.
         #
         # @return [FormattingOptions]
         def options

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
+      #
       class DocumentOnTypeFormattingRegistrationOptions
         def initialize(document_selector:, first_trigger_character:, more_trigger_character: nil)
           @attributes = {}
@@ -13,16 +16,16 @@ 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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
         #
-        # A character on which formatting should be triggered, like `}`.
+        # A character on which formatting should be triggered, like `{`.
         #
         # @return [string]
         def first_trigger_character
@@ -32,7 +35,7 @@ module LanguageServer
         #
         # More trigger characters.
         #
-        # @return [string[]]
+        # @return [string[] | nil]
         def more_trigger_character
           attributes.fetch(:moreTriggerCharacter)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities of a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
+      #
       class DocumentRangeFormattingClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -11,9 +14,9 @@ module LanguageServer
         end
 
         #
-        # Whether formatting supports dynamic registration.
+        # Whether range formatting supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
+      #
       class DocumentRangeFormattingOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
@@ -10,7 +13,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/document_range_formatting_params.rb

@@ -1,26 +1,21 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
+      #
       class DocumentRangeFormattingParams
-        def initialize(work_done_token: nil, text_document:, range:, options:)
+        def initialize(text_document:, range:, options:, work_done_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
           @attributes[:options] = options
+          @attributes[:workDoneToken] = work_done_token if work_done_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
-
         #
         # The document to format.
         #
@@ -45,6 +40,14 @@ module LanguageServer
           attributes.fetch(:options)
         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
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
+      #
       class DocumentRangeFormattingRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -12,15 +15,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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -4,8 +4,8 @@ module LanguageServer
       #
       # Represents programming constructs like variables, classes, interfaces etc.
       # that appear in a document. Document symbols can be hierarchical and they
-      # have two ranges: one that encloses its definition and one that points to its
-      # most interesting range, e.g. the range of an identifier.
+      # have two ranges: one that encloses its definition and one that points to
+      # its most interesting range, e.g. the range of an identifier.
       #
       class DocumentSymbol
         def initialize(name:, detail: nil, kind:, tags: nil, deprecated: nil, range:, selection_range:, children: nil)
@@ -24,9 +24,8 @@ module LanguageServer
         end
 
         #
-        # The name of this symbol. Will be displayed in the user interface and
-        # therefore must not be an empty string or a string only consisting of
-        # white spaces.
+        # The name of this symbol. Will be displayed in the user interface and therefore must not be
+        # an empty string or a string only consisting of white spaces.
         #
         # @return [string]
         def name
@@ -36,7 +35,7 @@ module LanguageServer
         #
         # More detail for this symbol, e.g the signature of a function.
         #
-        # @return [string]
+        # @return [string | nil]
         def detail
           attributes.fetch(:detail)
         end
@@ -44,7 +43,7 @@ module LanguageServer
         #
         # The kind of this symbol.
         #
-        # @return [any]
+        # @return [SymbolKind]
         def kind
           attributes.fetch(:kind)
         end
@@ -52,7 +51,9 @@ module LanguageServer
         #
         # Tags for this document symbol.
         #
-        # @return [1[]]
+        # @since 3.16.0
+        #
+        # @return [SymbolTag[] | nil]
         def tags
           attributes.fetch(:tags)
         end
@@ -60,16 +61,17 @@ module LanguageServer
         #
         # Indicates if this symbol is deprecated.
         #
-        # @return [boolean]
+        # @deprecated Use tags instead
+        #
+        # @return [boolean | nil]
         def deprecated
           attributes.fetch(:deprecated)
         end
 
         #
-        # The range enclosing this symbol not including leading/trailing whitespace
-        # but everything else like comments. This information is typically used to
-        # determine if the clients cursor is inside the symbol to reveal in the
-        # symbol in the UI.
+        # The range enclosing this symbol not including leading/trailing whitespace but everything else
+        # like comments. This information is typically used to determine if the clients cursor is
+        # inside the symbol to reveal in the symbol in the UI.
         #
         # @return [Range]
         def range
@@ -77,8 +79,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`.
+        # 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`.
         #
         # @return [Range]
         def selection_range
@@ -88,7 +90,7 @@ module LanguageServer
         #
         # Children of this symbol, e.g. properties of a class.
         #
-        # @return [DocumentSymbol[]]
+        # @return [DocumentSymbol[] | nil]
         def children
           attributes.fetch(:children)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client Capabilities for a [DocumentSymbolRequest](#DocumentSymbolRequest).
+      #
       class DocumentSymbolClientCapabilities
         def initialize(dynamic_registration: nil, symbol_kind: nil, hierarchical_document_symbol_support: nil, tag_support: nil, label_support: nil)
           @attributes = {}
@@ -17,7 +20,7 @@ module LanguageServer
         #
         # Whether document symbol supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -26,7 +29,7 @@ module LanguageServer
         # Specific capabilities for the `SymbolKind` in the
         # `textDocument/documentSymbol` request.
         #
-        # @return [{ valueSet?: any[]; }]
+        # @return [{ valueSet:SymbolKind[] } | nil]
         def symbol_kind
           attributes.fetch(:symbolKind)
         end
@@ -34,7 +37,7 @@ module LanguageServer
         #
         # The client supports hierarchical document symbols.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def hierarchical_document_symbol_support
           attributes.fetch(:hierarchicalDocumentSymbolSupport)
         end
@@ -44,7 +47,9 @@ module LanguageServer
         # `DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true.
         # Clients supporting tags have to handle unknown tags gracefully.
         #
-        # @return [{ valueSet: 1[]; }]
+        # @since 3.16.0
+        #
+        # @return [{ valueSet:SymbolTag[] } | nil]
         def tag_support
           attributes.fetch(:tagSupport)
         end
@@ -53,7 +58,9 @@ module LanguageServer
         # The client supports an additional label presented in the UI when
         # registering a document symbol provider.
         #
-        # @return [boolean]
+        # @since 3.16.0
+        #
+        # @return [boolean | nil]
         def label_support
           attributes.fetch(:labelSupport)
         end

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

@@ -1,30 +1,35 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a [DocumentSymbolRequest](#DocumentSymbolRequest).
+      #
       class DocumentSymbolOptions
-        def initialize(work_done_progress: nil, label: nil)
+        def initialize(label: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:label] = label if label
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # A human-readable string that is shown when multiple outlines trees
         # are shown for the same document.
         #
-        # @return [string]
+        # @since 3.16.0
+        #
+        # @return [string | nil]
         def label
           attributes.fetch(:label)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,42 +1,45 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a [DocumentSymbolRequest](#DocumentSymbolRequest).
+      #
       class DocumentSymbolParams
-        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/document_symbol_registration_options.rb

@@ -1,40 +1,45 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [DocumentSymbolRequest](#DocumentSymbolRequest).
+      #
       class DocumentSymbolRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, label: nil)
+        def initialize(document_selector:, label: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:label] = label if label
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @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 | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # A human-readable string that is shown when multiple outlines trees
         # are shown for the same document.
         #
-        # @return [string]
+        # @since 3.16.0
+        #
+        # @return [string | nil]
         def label
           attributes.fetch(:label)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The client capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
+      #
       class ExecuteCommandClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -13,7 +16,7 @@ module LanguageServer
         #
         # Execute command supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,21 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The server capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
+      #
       class ExecuteCommandOptions
-        def initialize(work_done_progress: nil, commands:)
+        def initialize(commands:, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:commands] = commands
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The commands to be executed on the server
         #
@@ -24,6 +22,11 @@ module LanguageServer
           attributes.fetch(:commands)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash