language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -1,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities of a {@link DocumentFormattingRequest}.
+      #
       class DocumentFormattingClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

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

@@ -1,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a {@link DocumentFormattingRequest}.
+      #
       class DocumentFormattingOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -1,25 +1,20 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a {@link DocumentFormattingRequest}.
+      #
       class DocumentFormattingParams
-        def initialize(work_done_token: nil, text_document:, options:)
+        def initialize(text_document:, options:, work_done_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:options] = options
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @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.
         #
@@ -36,6 +31,14 @@ module LanguageServer
           attributes.fetch(:options)
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,21 +1,24 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link DocumentFormattingRequest}.
+      #
       class DocumentFormattingRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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

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

@@ -11,7 +11,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:range] = range
-          @attributes[:kind] = kind if kind
+          @attributes[:kind] = kind unless kind.nil?
 
           @attributes.freeze
         end
@@ -25,7 +25,7 @@ module LanguageServer
         end
 
         #
-        # The highlight kind, default is DocumentHighlightKind.Text.
+        # The highlight kind, default is {@link DocumentHighlightKind.Text text}.
         #
         # @return [DocumentHighlightKind]
         def kind

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

@@ -1,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client Capabilities for a {@link DocumentHighlightRequest}.
+      #
       class DocumentHighlightClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

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

@@ -1,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a {@link DocumentHighlightRequest}.
+      #
       class DocumentHighlightOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -1,14 +1,17 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link DocumentHighlightRequest}.
+      #
       class DocumentHighlightParams
         def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end
@@ -38,8 +41,8 @@ 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

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

@@ -1,21 +1,24 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link DocumentHighlightRequest}.
+      #
       class DocumentHighlightRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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

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

@@ -2,17 +2,17 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A document link is a range in a text document that links to an internal or
-      # external resource, like another text document or a web site.
+      # A document link is a range in a text document that links to an internal or external resource, like another
+      # text document or a web site.
       #
       class DocumentLink
         def initialize(range:, target: nil, tooltip: nil, data: nil)
           @attributes = {}
 
           @attributes[:range] = range
-          @attributes[:target] = target if target
-          @attributes[:tooltip] = tooltip if tooltip
-          @attributes[:data] = data if data
+          @attributes[:target] = target unless target.nil?
+          @attributes[:tooltip] = tooltip unless tooltip.nil?
+          @attributes[:data] = data unless data.nil?
 
           @attributes.freeze
         end
@@ -28,7 +28,7 @@ module LanguageServer
         #
         # The uri this link points to. If missing a resolve request is sent later.
         #
-        # @return [string]
+        # @return [URI]
         def target
           attributes.fetch(:target)
         end
@@ -36,10 +36,11 @@ module LanguageServer
         #
         # The tooltip text when you hover over this link.
         #
-        # If a tooltip is provided, is will be displayed in a string that includes
-        # instructions on how to trigger the link, such as `{0} (ctrl + click)`.
-        # The specific instructions vary depending on OS, user settings, and
-        # localization.
+        # If a tooltip is provided, is will be displayed in a string that includes instructions on how to
+        # trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
+        # user settings, and localization.
+        #
+        # @since 3.15.0
         #
         # @return [string]
         def tooltip

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

@@ -1,12 +1,15 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The client capabilities of a {@link DocumentLinkRequest}.
+      #
       class DocumentLinkClientCapabilities
         def initialize(dynamic_registration: nil, tooltip_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:tooltipSupport] = tooltip_support if tooltip_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:tooltipSupport] = tooltip_support unless tooltip_support.nil?
 
           @attributes.freeze
         end
@@ -22,6 +25,8 @@ module LanguageServer
         #
         # Whether the client supports the `tooltip` property on `DocumentLink`.
         #
+        # @since 3.15.0
+        #
         # @return [boolean]
         def tooltip_support
           attributes.fetch(:tooltipSupport)

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

@@ -1,21 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a {@link DocumentLinkRequest}.
+      #
       class DocumentLinkOptions
-        def initialize(work_done_progress: nil, resolve_provider: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:resolveProvider] = resolve_provider unless resolve_provider.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # Document links have a resolve provider as well.
         #
@@ -24,6 +22,11 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,17 +1,28 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a {@link DocumentLinkRequest}.
+      #
       class DocumentLinkParams
-        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[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end
 
+        #
+        # The document to provide document links for.
+        #
+        # @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 document to provide document links for.
-        #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,31 +1,29 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link 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[:resolveProvider] = resolve_provider unless resolve_provider.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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
-
         #
         # Document links have a resolve provider as well.
         #
@@ -34,6 +32,11 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        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,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
+      #
       class DocumentOnTypeFormattingClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

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

@@ -1,12 +1,15 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a {@link DocumentOnTypeFormattingRequest}.
+      #
       class DocumentOnTypeFormattingOptions
         def initialize(first_trigger_character:, more_trigger_character: nil)
           @attributes = {}
 
           @attributes[:firstTriggerCharacter] = first_trigger_character
-          @attributes[:moreTriggerCharacter] = more_trigger_character if more_trigger_character
+          @attributes[:moreTriggerCharacter] = more_trigger_character unless more_trigger_character.nil?
 
           @attributes.freeze
         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 {@link DocumentOnTypeFormattingRequest}.
+      #
       class DocumentOnTypeFormattingParams
         def initialize(text_document:, position:, ch:, options:)
           @attributes = {}

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

@@ -1,22 +1,25 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link DocumentOnTypeFormattingRequest}.
+      #
       class DocumentOnTypeFormattingRegistrationOptions
         def initialize(document_selector:, first_trigger_character:, more_trigger_character: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
           @attributes[:firstTriggerCharacter] = first_trigger_character
-          @attributes[:moreTriggerCharacter] = more_trigger_character if more_trigger_character
+          @attributes[:moreTriggerCharacter] = more_trigger_character unless more_trigger_character.nil?
 
           @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

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

@@ -1,23 +1,37 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities of a {@link DocumentRangeFormattingRequest}.
+      #
       class DocumentRangeFormattingClientCapabilities
-        def initialize(dynamic_registration: nil)
+        def initialize(dynamic_registration: nil, ranges_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:rangesSupport] = ranges_support unless ranges_support.nil?
 
           @attributes.freeze
         end
 
         #
-        # Whether formatting supports dynamic registration.
+        # Whether range formatting supports dynamic registration.
         #
         # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
 
+        #
+        # Whether the client supports formatting multiple ranges at once.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def ranges_support
+          attributes.fetch(:rangesSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,15 +1,29 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a {@link DocumentRangeFormattingRequest}.
+      #
       class DocumentRangeFormattingOptions
-        def initialize(work_done_progress: nil)
+        def initialize(ranges_support: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:rangesSupport] = ranges_support unless ranges_support.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
 
+        #
+        # Whether the server supports formatting multiple ranges at once.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def ranges_support
+          attributes.fetch(:rangesSupport)
+        end
+
         # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)

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 {@link 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 unless work_done_token.nil?
 
           @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]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
         attr_reader :attributes
 
         def to_hash