language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -5,7 +5,7 @@ module LanguageServer
       # Text document specific client capabilities.
       #
       class TextDocumentClientCapabilities
-        def initialize(synchronization: nil, completion: nil, hover: nil, signature_help: nil, declaration: nil, definition: nil, type_definition: nil, implementation: nil, references: nil, document_highlight: nil, document_symbol: nil, code_action: nil, code_lens: nil, document_link: nil, color_provider: nil, formatting: nil, range_formatting: nil, on_type_formatting: nil, rename: nil, folding_range: nil, selection_range: nil, publish_diagnostics: nil, call_hierarchy: nil, semantic_tokens: nil, linked_editing_range: nil, moniker: nil, type_hierarchy: nil, inline_value: nil, inlay_hint: nil, diagnostic: nil)
+        def initialize(synchronization: nil, completion: nil, hover: nil, signature_help: nil, declaration: nil, definition: nil, type_definition: nil, implementation: nil, references: nil, document_highlight: nil, document_symbol: nil, code_action: nil, code_lens: nil, document_link: nil, color_provider: nil, formatting: nil, range_formatting: nil, on_type_formatting: nil, rename: nil, publish_diagnostics: nil, folding_range: nil, selection_range: nil, linked_editing_range: nil, call_hierarchy: nil, semantic_tokens: nil, moniker: nil, type_hierarchy: nil, inline_value: nil, inlay_hint: nil, diagnostic: nil)
           @attributes = {}
 
           @attributes[:synchronization] = synchronization if synchronization
@@ -27,12 +27,12 @@ module LanguageServer
           @attributes[:rangeFormatting] = range_formatting if range_formatting
           @attributes[:onTypeFormatting] = on_type_formatting if on_type_formatting
           @attributes[:rename] = rename if rename
+          @attributes[:publishDiagnostics] = publish_diagnostics if publish_diagnostics
           @attributes[:foldingRange] = folding_range if folding_range
           @attributes[:selectionRange] = selection_range if selection_range
-          @attributes[:publishDiagnostics] = publish_diagnostics if publish_diagnostics
+          @attributes[:linkedEditingRange] = linked_editing_range if linked_editing_range
           @attributes[:callHierarchy] = call_hierarchy if call_hierarchy
           @attributes[:semanticTokens] = semantic_tokens if semantic_tokens
-          @attributes[:linkedEditingRange] = linked_editing_range if linked_editing_range
           @attributes[:moniker] = moniker if moniker
           @attributes[:typeHierarchy] = type_hierarchy if type_hierarchy
           @attributes[:inlineValue] = inline_value if inline_value
@@ -42,10 +42,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        #
-        # Defines which synchronization capabilities the client supports.
-        #
-        # @return [TextDocumentSyncClientCapabilities | nil]
+        # @return [TextDocumentSyncClientCapabilities]
         def synchronization
           attributes.fetch(:synchronization)
         end
@@ -53,7 +50,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/completion` request.
         #
-        # @return [CompletionClientCapabilities | nil]
+        # @return [CompletionClientCapabilities]
         def completion
           attributes.fetch(:completion)
         end
@@ -61,7 +58,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/hover` request.
         #
-        # @return [HoverClientCapabilities | nil]
+        # @return [HoverClientCapabilities]
         def hover
           attributes.fetch(:hover)
         end
@@ -69,7 +66,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/signatureHelp` request.
         #
-        # @return [SignatureHelpClientCapabilities | nil]
+        # @return [SignatureHelpClientCapabilities]
         def signature_help
           attributes.fetch(:signatureHelp)
         end
@@ -77,9 +74,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/declaration` request.
         #
-        # @since 3.14.0
-        #
-        # @return [DeclarationClientCapabilities | nil]
+        # @return [DeclarationClientCapabilities]
         def declaration
           attributes.fetch(:declaration)
         end
@@ -87,7 +82,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/definition` request.
         #
-        # @return [DefinitionClientCapabilities | nil]
+        # @return [DefinitionClientCapabilities]
         def definition
           attributes.fetch(:definition)
         end
@@ -95,9 +90,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/typeDefinition` request.
         #
-        # @since 3.6.0
-        #
-        # @return [TypeDefinitionClientCapabilities | nil]
+        # @return [TypeDefinitionClientCapabilities]
         def type_definition
           attributes.fetch(:typeDefinition)
         end
@@ -105,9 +98,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/implementation` request.
         #
-        # @since 3.6.0
-        #
-        # @return [ImplementationClientCapabilities | nil]
+        # @return [ImplementationClientCapabilities]
         def implementation
           attributes.fetch(:implementation)
         end
@@ -115,7 +106,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/references` request.
         #
-        # @return [ReferenceClientCapabilities | nil]
+        # @return [ReferenceClientCapabilities]
         def references
           attributes.fetch(:references)
         end
@@ -123,7 +114,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/documentHighlight` request.
         #
-        # @return [DocumentHighlightClientCapabilities | nil]
+        # @return [DocumentHighlightClientCapabilities]
         def document_highlight
           attributes.fetch(:documentHighlight)
         end
@@ -131,7 +122,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/documentSymbol` request.
         #
-        # @return [DocumentSymbolClientCapabilities | nil]
+        # @return [DocumentSymbolClientCapabilities]
         def document_symbol
           attributes.fetch(:documentSymbol)
         end
@@ -139,7 +130,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/codeAction` request.
         #
-        # @return [CodeActionClientCapabilities | nil]
+        # @return [CodeActionClientCapabilities]
         def code_action
           attributes.fetch(:codeAction)
         end
@@ -147,7 +138,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/codeLens` request.
         #
-        # @return [CodeLensClientCapabilities | nil]
+        # @return [CodeLensClientCapabilities]
         def code_lens
           attributes.fetch(:codeLens)
         end
@@ -155,7 +146,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/documentLink` request.
         #
-        # @return [DocumentLinkClientCapabilities | nil]
+        # @return [DocumentLinkClientCapabilities]
         def document_link
           attributes.fetch(:documentLink)
         end
@@ -164,9 +155,7 @@ module LanguageServer
         # Capabilities specific to the `textDocument/documentColor` and the
         # `textDocument/colorPresentation` request.
         #
-        # @since 3.6.0
-        #
-        # @return [DocumentColorClientCapabilities | nil]
+        # @return [DocumentColorClientCapabilities]
         def color_provider
           attributes.fetch(:colorProvider)
         end
@@ -174,7 +163,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/formatting` request.
         #
-        # @return [DocumentFormattingClientCapabilities | nil]
+        # @return [DocumentFormattingClientCapabilities]
         def formatting
           attributes.fetch(:formatting)
         end
@@ -182,15 +171,16 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/rangeFormatting` request.
         #
-        # @return [DocumentRangeFormattingClientCapabilities | nil]
+        # @return [DocumentRangeFormattingClientCapabilities]
         def range_formatting
           attributes.fetch(:rangeFormatting)
         end
 
         #
+        # request.
         # Capabilities specific to the `textDocument/onTypeFormatting` request.
         #
-        # @return [DocumentOnTypeFormattingClientCapabilities | nil]
+        # @return [DocumentOnTypeFormattingClientCapabilities]
         def on_type_formatting
           attributes.fetch(:onTypeFormatting)
         end
@@ -198,17 +188,24 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/rename` request.
         #
-        # @return [RenameClientCapabilities | nil]
+        # @return [RenameClientCapabilities]
         def rename
           attributes.fetch(:rename)
         end
 
         #
-        # Capabilities specific to the `textDocument/foldingRange` request.
+        # Capabilities specific to the `textDocument/publishDiagnostics`
+        # notification.
         #
-        # @since 3.10.0
+        # @return [PublishDiagnosticsClientCapabilities]
+        def publish_diagnostics
+          attributes.fetch(:publishDiagnostics)
+        end
+
         #
-        # @return [FoldingRangeClientCapabilities | nil]
+        # Capabilities specific to the `textDocument/foldingRange` request.
+        #
+        # @return [FoldingRangeClientCapabilities]
         def folding_range
           attributes.fetch(:foldingRange)
         end
@@ -216,57 +213,39 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/selectionRange` request.
         #
-        # @since 3.15.0
-        #
-        # @return [SelectionRangeClientCapabilities | nil]
+        # @return [SelectionRangeClientCapabilities]
         def selection_range
           attributes.fetch(:selectionRange)
         end
 
         #
-        # Capabilities specific to the `textDocument/publishDiagnostics` notification.
+        # Capabilities specific to the `textDocument/linkedEditingRange` request.
         #
-        # @return [PublishDiagnosticsClientCapabilities | nil]
-        def publish_diagnostics
-          attributes.fetch(:publishDiagnostics)
+        # @return [LinkedEditingRangeClientCapabilities]
+        def linked_editing_range
+          attributes.fetch(:linkedEditingRange)
         end
 
         #
         # Capabilities specific to the various call hierarchy requests.
         #
-        # @since 3.16.0
-        #
-        # @return [CallHierarchyClientCapabilities | nil]
+        # @return [CallHierarchyClientCapabilities]
         def call_hierarchy
           attributes.fetch(:callHierarchy)
         end
 
         #
-        # Capabilities specific to the various semantic token request.
+        # Capabilities specific to the various semantic token requests.
         #
-        # @since 3.16.0
-        #
-        # @return [SemanticTokensClientCapabilities | nil]
+        # @return [SemanticTokensClientCapabilities]
         def semantic_tokens
           attributes.fetch(:semanticTokens)
         end
 
         #
-        # Capabilities specific to the `textDocument/linkedEditingRange` request.
-        #
-        # @since 3.16.0
+        # Capabilities specific to the `textDocument/moniker` request.
         #
-        # @return [LinkedEditingRangeClientCapabilities | nil]
-        def linked_editing_range
-          attributes.fetch(:linkedEditingRange)
-        end
-
-        #
-        # Client capabilities specific to the `textDocument/moniker` request.
-        #
-        # @since 3.16.0
-        #
-        # @return [MonikerClientCapabilities | nil]
+        # @return [MonikerClientCapabilities]
         def moniker
           attributes.fetch(:moniker)
         end
@@ -274,9 +253,7 @@ module LanguageServer
         #
         # Capabilities specific to the various type hierarchy requests.
         #
-        # @since 3.17.0
-        #
-        # @return [TypeHierarchyClientCapabilities | nil]
+        # @return [TypeHierarchyClientCapabilities]
         def type_hierarchy
           attributes.fetch(:typeHierarchy)
         end
@@ -284,9 +261,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/inlineValue` request.
         #
-        # @since 3.17.0
-        #
-        # @return [InlineValueClientCapabilities | nil]
+        # @return [InlineValueClientCapabilities]
         def inline_value
           attributes.fetch(:inlineValue)
         end
@@ -294,9 +269,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/inlayHint` request.
         #
-        # @since 3.17.0
-        #
-        # @return [InlayHintClientCapabilities | nil]
+        # @return [InlayHintClientCapabilities]
         def inlay_hint
           attributes.fetch(:inlayHint)
         end
@@ -304,9 +277,7 @@ module LanguageServer
         #
         # Capabilities specific to the diagnostic pull model.
         #
-        # @since 3.17.0
-        #
-        # @return [DiagnosticClientCapabilities | nil]
+        # @return [DiagnosticClientCapabilities]
         def diagnostic
           attributes.fetch(:diagnostic)
         end

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

@@ -6,10 +6,10 @@ module LanguageServer
       # it is considered to be the full content of the document.
       #
       class TextDocumentContentChangeEvent
-        def initialize(range:, range_length: nil, text:)
+        def initialize(range: nil, range_length: nil, text:)
           @attributes = {}
 
-          @attributes[:range] = range
+          @attributes[:range] = range if range
           @attributes[:rangeLength] = range_length if range_length
           @attributes[:text] = text
 
@@ -19,7 +19,7 @@ module LanguageServer
         #
         # The range of the document that changed.
         #
-        # @return [Range]
+        # @return [Range, nil]
         def range
           attributes.fetch(:range)
         end
@@ -27,9 +27,7 @@ module LanguageServer
         #
         # The optional length of the range that got replaced.
         #
-        # @deprecated use range instead.
-        #
-        # @return [uinteger | nil]
+        # @return [number, nil]
         def range_length
           attributes.fetch(:rangeLength)
         end
@@ -37,6 +35,10 @@ module LanguageServer
         #
         # The new text for the provided range.
         #
+        # --- OR ---
+        #
+        # The new text of the whole document.
+        #
         # @return [string]
         def text
           attributes.fetch(:text)

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

@@ -1,12 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Describes textual changes on a text document. A TextDocumentEdit describes all changes
-      # on a document version Si and after they are applied move the document to version Si+1.
-      # So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any
-      # kind of ordering. However the edits must be non overlapping.
-      #
       class TextDocumentEdit
         def initialize(text_document:, edits:)
           @attributes = {}
@@ -28,10 +22,7 @@ module LanguageServer
         #
         # The edits to be applied.
         #
-        # @since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a
-        # client capability.
-        #
-        # @return [TextEdit | AnnotatedTextEdit[]]
+        # @return [(TextEdit | AnnotatedTextEdit)[]]
         def edits
           attributes.fetch(:edits)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # A literal to identify a text document in the client.
-      #
       class TextDocumentIdentifier
         def initialize(uri:)
           @attributes = {}
@@ -14,9 +11,9 @@ module LanguageServer
         end
 
         #
-        # The text document's uri.
+        # The text document's URI.
         #
-        # @return [DocumentUri]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -1,10 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # An item to transfer a text document from the client to the
-      # server.
-      #
       class TextDocumentItem
         def initialize(uri:, language_id:, version:, text:)
           @attributes = {}
@@ -18,9 +14,9 @@ module LanguageServer
         end
 
         #
-        # The text document's uri.
+        # The text document's URI.
         #
-        # @return [DocumentUri]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end
@@ -37,7 +33,7 @@ module LanguageServer
         # The version number of this document (it will increase after each
         # change, including undo/redo).
         #
-        # @return [integer]
+        # @return [number]
         def version
           attributes.fetch(:version)
         end

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

@@ -1,10 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # A parameter literal used in requests to pass a text document and a position inside that
-      # document.
-      #
       class TextDocumentPositionParams
         def initialize(text_document:, position:)
           @attributes = {}

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

@@ -14,10 +14,10 @@ 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

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Save registration options.
-      #
       class TextDocumentSaveRegistrationOptions
         def initialize(document_selector:, include_text: nil)
           @attributes = {}
@@ -15,10 +12,10 @@ 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
@@ -26,7 +23,7 @@ module LanguageServer
         #
         # The client is supposed to include the content on save.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def include_text
           attributes.fetch(:includeText)
         end

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

@@ -16,7 +16,7 @@ module LanguageServer
         #
         # Whether text document synchronization supports dynamic registration.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -24,7 +24,7 @@ module LanguageServer
         #
         # The client supports sending will save notifications.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def will_save
           attributes.fetch(:willSave)
         end
@@ -34,7 +34,7 @@ module LanguageServer
         # waits for a response providing text edits which will
         # be applied to the document before it is saved.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def will_save_wait_until
           attributes.fetch(:willSaveWaitUntil)
         end
@@ -42,7 +42,7 @@ module LanguageServer
         #
         # The client supports did save notifications.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def did_save
           attributes.fetch(:didSave)
         end

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

@@ -15,46 +15,50 @@ module LanguageServer
         end
 
         #
-        # Open and close notifications are sent to the server. If omitted open close notifications should not
-        # be sent.
+        # Open and close notifications are sent to the server. If omitted open
+        # close notifications should not be sent.
+        # Open and close notifications are sent to the server. If omitted open
+        # close notification should not be sent.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def open_close
           attributes.fetch(:openClose)
         end
 
         #
-        # Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
-        # and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
+        # Change notifications are sent to the server. See
+        # TextDocumentSyncKind.None, TextDocumentSyncKind.Full and
+        # TextDocumentSyncKind.Incremental. If omitted it defaults to
+        # TextDocumentSyncKind.None.
         #
-        # @return [TextDocumentSyncKind | nil]
+        # @return [TextDocumentSyncKind]
         def change
           attributes.fetch(:change)
         end
 
         #
-        # If present will save notifications are sent to the server. If omitted the notification should not be
-        # sent.
+        # If present will save notifications are sent to the server. If omitted
+        # the notification should not be sent.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def will_save
           attributes.fetch(:willSave)
         end
 
         #
-        # If present will save wait until requests are sent to the server. If omitted the request should not be
-        # sent.
+        # If present will save wait until requests are sent to the server. If
+        # omitted the request should not be sent.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def will_save_wait_until
           attributes.fetch(:willSaveWaitUntil)
         end
 
         #
-        # If present save notifications are sent to the server. If omitted the notification should not be
-        # sent.
+        # If present save notifications are sent to the server. If omitted the
+        # notification should not be sent.
         #
-        # @return [boolean | SaveOptions | nil]
+        # @return [boolean | SaveOptions]
         def save
           attributes.fetch(:save)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # A text edit applicable to a text document.
-      #
       class TextEdit
         def initialize(range:, new_text:)
           @attributes = {}

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Since 3.6.0
-      #
       class TypeDefinitionClientCapabilities
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
@@ -15,11 +12,11 @@ module LanguageServer
         end
 
         #
-        # Whether implementation supports dynamic registration. If this is set to `true`
-        # the client supports the new `TypeDefinitionRegistrationOptions` 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 `TypeDefinitionRegistrationOptions`
+        # return value for the corresponding server capability as well.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -27,9 +24,7 @@ module LanguageServer
         #
         # The client supports additional metadata in the form of definition links.
         #
-        # Since 3.14.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         def link_support
           attributes.fetch(:linkSupport)
         end

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

@@ -10,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end