language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -6,46 +6,24 @@ module LanguageServer
       # interfaces etc.
       #
       class SymbolInformation
-        def initialize(name:, kind:, tags: nil, deprecated: nil, location:, container_name: nil)
+        def initialize(deprecated: nil, location:, name:, kind:, tags: nil, container_name: nil)
           @attributes = {}
 
+          @attributes[:deprecated] = deprecated unless deprecated.nil?
+          @attributes[:location] = location
           @attributes[:name] = name
           @attributes[:kind] = kind
-          @attributes[:tags] = tags if tags
-          @attributes[:deprecated] = deprecated if deprecated
-          @attributes[:location] = location
-          @attributes[:containerName] = container_name if container_name
+          @attributes[:tags] = tags unless tags.nil?
+          @attributes[:containerName] = container_name unless container_name.nil?
 
           @attributes.freeze
         end
 
-        #
-        # The name of this symbol.
-        #
-        # @return [string]
-        def name
-          attributes.fetch(:name)
-        end
-
-        #
-        # The kind of this symbol.
-        #
-        # @return [SymbolKind]
-        def kind
-          attributes.fetch(:kind)
-        end
-
-        #
-        # Tags for this symbol.
-        #
-        # @return [1[]]
-        def tags
-          attributes.fetch(:tags)
-        end
-
         #
         # Indicates if this symbol is deprecated.
         #
+        # @deprecated Use tags instead
+        #
         # @return [boolean]
         def deprecated
           attributes.fetch(:deprecated)
@@ -55,7 +33,7 @@ module LanguageServer
         # The location of this symbol. The location's range is used by a tool
         # to reveal the location in the editor. If the symbol is selected in the
         # tool the range's start information is used to position the cursor. So
-        # the range usually spans more then the actual symbol's name and does
+        # the range usually spans more than the actual symbol's name and does
         # normally include things like visibility modifiers.
         #
         # The range doesn't have to denote a node range in the sense of an abstract
@@ -67,6 +45,32 @@ module LanguageServer
           attributes.fetch(:location)
         end
 
+        #
+        # The name of this symbol.
+        #
+        # @return [string]
+        def name
+          attributes.fetch(:name)
+        end
+
+        #
+        # The kind of this symbol.
+        #
+        # @return [SymbolKind]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # Tags for this symbol.
+        #
+        # @since 3.16.0
+        #
+        # @return [SymbolTag[]]
+        def tags
+          attributes.fetch(:tags)
+        end
+
         #
         # The name of the symbol containing this symbol. This information is for
         # user interface purposes (e.g. to render a qualifier in the user interface

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

@@ -2,34 +2,33 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Describe options to be used when registering for text document change events.
+      # Describe options to be used when registered for text document change events.
       #
       class TextDocumentChangeRegistrationOptions
-        def initialize(document_selector:, sync_kind:)
+        def initialize(sync_kind:, document_selector:)
           @attributes = {}
 
-          @attributes[:documentSelector] = document_selector
           @attributes[:syncKind] = sync_kind
+          @attributes[:documentSelector] = document_selector
 
           @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.
+        # How documents are synced to the server.
         #
-        # @return [DocumentSelector]
-        def document_selector
-          attributes.fetch(:documentSelector)
+        # @return [TextDocumentSyncKind]
+        def sync_kind
+          attributes.fetch(:syncKind)
         end
 
         #
-        # How documents are synced to the server. See TextDocumentSyncKind.Full
-        # and TextDocumentSyncKind.Incremental.
+        # 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 [TextDocumentSyncKind]
-        def sync_kind
-          attributes.fetch(:syncKind)
+        # @return [DocumentSelector | nil]
+        def document_selector
+          attributes.fetch(:documentSelector)
         end
 
         attr_reader :attributes

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

@@ -5,48 +5,63 @@ 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, 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)
+        def initialize(synchronization: nil, filters: 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, inline_completion: nil)
           @attributes = {}
 
-          @attributes[:synchronization] = synchronization if synchronization
-          @attributes[:completion] = completion if completion
-          @attributes[:hover] = hover if hover
-          @attributes[:signatureHelp] = signature_help if signature_help
-          @attributes[:declaration] = declaration if declaration
-          @attributes[:definition] = definition if definition
-          @attributes[:typeDefinition] = type_definition if type_definition
-          @attributes[:implementation] = implementation if implementation
-          @attributes[:references] = references if references
-          @attributes[:documentHighlight] = document_highlight if document_highlight
-          @attributes[:documentSymbol] = document_symbol if document_symbol
-          @attributes[:codeAction] = code_action if code_action
-          @attributes[:codeLens] = code_lens if code_lens
-          @attributes[:documentLink] = document_link if document_link
-          @attributes[:colorProvider] = color_provider if color_provider
-          @attributes[:formatting] = formatting if formatting
-          @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[:linkedEditingRange] = linked_editing_range if linked_editing_range
-          @attributes[:callHierarchy] = call_hierarchy if call_hierarchy
-          @attributes[:semanticTokens] = semantic_tokens if semantic_tokens
-          @attributes[:moniker] = moniker if moniker
-          @attributes[:typeHierarchy] = type_hierarchy if type_hierarchy
-          @attributes[:inlineValue] = inline_value if inline_value
-          @attributes[:inlayHint] = inlay_hint if inlay_hint
-          @attributes[:diagnostic] = diagnostic if diagnostic
+          @attributes[:synchronization] = synchronization unless synchronization.nil?
+          @attributes[:filters] = filters unless filters.nil?
+          @attributes[:completion] = completion unless completion.nil?
+          @attributes[:hover] = hover unless hover.nil?
+          @attributes[:signatureHelp] = signature_help unless signature_help.nil?
+          @attributes[:declaration] = declaration unless declaration.nil?
+          @attributes[:definition] = definition unless definition.nil?
+          @attributes[:typeDefinition] = type_definition unless type_definition.nil?
+          @attributes[:implementation] = implementation unless implementation.nil?
+          @attributes[:references] = references unless references.nil?
+          @attributes[:documentHighlight] = document_highlight unless document_highlight.nil?
+          @attributes[:documentSymbol] = document_symbol unless document_symbol.nil?
+          @attributes[:codeAction] = code_action unless code_action.nil?
+          @attributes[:codeLens] = code_lens unless code_lens.nil?
+          @attributes[:documentLink] = document_link unless document_link.nil?
+          @attributes[:colorProvider] = color_provider unless color_provider.nil?
+          @attributes[:formatting] = formatting unless formatting.nil?
+          @attributes[:rangeFormatting] = range_formatting unless range_formatting.nil?
+          @attributes[:onTypeFormatting] = on_type_formatting unless on_type_formatting.nil?
+          @attributes[:rename] = rename unless rename.nil?
+          @attributes[:foldingRange] = folding_range unless folding_range.nil?
+          @attributes[:selectionRange] = selection_range unless selection_range.nil?
+          @attributes[:publishDiagnostics] = publish_diagnostics unless publish_diagnostics.nil?
+          @attributes[:callHierarchy] = call_hierarchy unless call_hierarchy.nil?
+          @attributes[:semanticTokens] = semantic_tokens unless semantic_tokens.nil?
+          @attributes[:linkedEditingRange] = linked_editing_range unless linked_editing_range.nil?
+          @attributes[:moniker] = moniker unless moniker.nil?
+          @attributes[:typeHierarchy] = type_hierarchy unless type_hierarchy.nil?
+          @attributes[:inlineValue] = inline_value unless inline_value.nil?
+          @attributes[:inlayHint] = inlay_hint unless inlay_hint.nil?
+          @attributes[:diagnostic] = diagnostic unless diagnostic.nil?
+          @attributes[:inlineCompletion] = inline_completion unless inline_completion.nil?
 
           @attributes.freeze
         end
 
+        #
+        # Defines which synchronization capabilities the client supports.
+        #
         # @return [TextDocumentSyncClientCapabilities]
         def synchronization
           attributes.fetch(:synchronization)
         end
 
+        #
+        # Defines which filters the client supports.
+        #
+        # @since 3.18.0
+        #
+        # @return [TextDocumentFilterClientCapabilities]
+        def filters
+          attributes.fetch(:filters)
+        end
+
         #
         # Capabilities specific to the `textDocument/completion` request.
         #
@@ -74,6 +89,8 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/declaration` request.
         #
+        # @since 3.14.0
+        #
         # @return [DeclarationClientCapabilities]
         def declaration
           attributes.fetch(:declaration)
@@ -90,6 +107,8 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/typeDefinition` request.
         #
+        # @since 3.6.0
+        #
         # @return [TypeDefinitionClientCapabilities]
         def type_definition
           attributes.fetch(:typeDefinition)
@@ -98,6 +117,8 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/implementation` request.
         #
+        # @since 3.6.0
+        #
         # @return [ImplementationClientCapabilities]
         def implementation
           attributes.fetch(:implementation)
@@ -155,6 +176,8 @@ module LanguageServer
         # Capabilities specific to the `textDocument/documentColor` and the
         # `textDocument/colorPresentation` request.
         #
+        # @since 3.6.0
+        #
         # @return [DocumentColorClientCapabilities]
         def color_provider
           attributes.fetch(:colorProvider)
@@ -177,7 +200,6 @@ module LanguageServer
         end
 
         #
-        # request.
         # Capabilities specific to the `textDocument/onTypeFormatting` request.
         #
         # @return [DocumentOnTypeFormattingClientCapabilities]
@@ -193,18 +215,11 @@ module LanguageServer
           attributes.fetch(:rename)
         end
 
-        #
-        # Capabilities specific to the `textDocument/publishDiagnostics`
-        # notification.
-        #
-        # @return [PublishDiagnosticsClientCapabilities]
-        def publish_diagnostics
-          attributes.fetch(:publishDiagnostics)
-        end
-
         #
         # Capabilities specific to the `textDocument/foldingRange` request.
         #
+        # @since 3.10.0
+        #
         # @return [FoldingRangeClientCapabilities]
         def folding_range
           attributes.fetch(:foldingRange)
@@ -213,29 +228,35 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/selectionRange` request.
         #
+        # @since 3.15.0
+        #
         # @return [SelectionRangeClientCapabilities]
         def selection_range
           attributes.fetch(:selectionRange)
         end
 
         #
-        # Capabilities specific to the `textDocument/linkedEditingRange` request.
+        # Capabilities specific to the `textDocument/publishDiagnostics` notification.
         #
-        # @return [LinkedEditingRangeClientCapabilities]
-        def linked_editing_range
-          attributes.fetch(:linkedEditingRange)
+        # @return [PublishDiagnosticsClientCapabilities]
+        def publish_diagnostics
+          attributes.fetch(:publishDiagnostics)
         end
 
         #
         # Capabilities specific to the various call hierarchy requests.
         #
+        # @since 3.16.0
+        #
         # @return [CallHierarchyClientCapabilities]
         def call_hierarchy
           attributes.fetch(:callHierarchy)
         end
 
         #
-        # Capabilities specific to the various semantic token requests.
+        # Capabilities specific to the various semantic token request.
+        #
+        # @since 3.16.0
         #
         # @return [SemanticTokensClientCapabilities]
         def semantic_tokens
@@ -243,7 +264,19 @@ module LanguageServer
         end
 
         #
-        # Capabilities specific to the `textDocument/moniker` request.
+        # Capabilities specific to the `textDocument/linkedEditingRange` request.
+        #
+        # @since 3.16.0
+        #
+        # @return [LinkedEditingRangeClientCapabilities]
+        def linked_editing_range
+          attributes.fetch(:linkedEditingRange)
+        end
+
+        #
+        # Client capabilities specific to the `textDocument/moniker` request.
+        #
+        # @since 3.16.0
         #
         # @return [MonikerClientCapabilities]
         def moniker
@@ -253,6 +286,8 @@ module LanguageServer
         #
         # Capabilities specific to the various type hierarchy requests.
         #
+        # @since 3.17.0
+        #
         # @return [TypeHierarchyClientCapabilities]
         def type_hierarchy
           attributes.fetch(:typeHierarchy)
@@ -261,6 +296,8 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/inlineValue` request.
         #
+        # @since 3.17.0
+        #
         # @return [InlineValueClientCapabilities]
         def inline_value
           attributes.fetch(:inlineValue)
@@ -269,6 +306,8 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/inlayHint` request.
         #
+        # @since 3.17.0
+        #
         # @return [InlayHintClientCapabilities]
         def inlay_hint
           attributes.fetch(:inlayHint)
@@ -277,11 +316,23 @@ module LanguageServer
         #
         # Capabilities specific to the diagnostic pull model.
         #
+        # @since 3.17.0
+        #
         # @return [DiagnosticClientCapabilities]
         def diagnostic
           attributes.fetch(:diagnostic)
         end
 
+        #
+        # Client capabilities specific to inline completions.
+        #
+        # @since 3.18.0
+        #
+        # @return [InlineCompletionClientCapabilities]
+        def inline_completion
+          attributes.fetch(:inlineCompletion)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -9,8 +9,8 @@ module LanguageServer
         def initialize(range: nil, range_length: nil, text:)
           @attributes = {}
 
-          @attributes[:range] = range if range
-          @attributes[:rangeLength] = range_length if range_length
+          @attributes[:range] = range unless range.nil?
+          @attributes[:rangeLength] = range_length unless range_length.nil?
           @attributes[:text] = text
 
           @attributes.freeze
@@ -19,7 +19,7 @@ module LanguageServer
         #
         # The range of the document that changed.
         #
-        # @return [Range, nil]
+        # @return [Range]
         def range
           attributes.fetch(:range)
         end
@@ -27,7 +27,9 @@ module LanguageServer
         #
         # The optional length of the range that got replaced.
         #
-        # @return [number, nil]
+        # @deprecated use range instead.
+        #
+        # @return [uinteger]
         def range_length
           attributes.fetch(:rangeLength)
         end

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

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentContentChangePartial
+        def initialize(range:, range_length: nil, text:)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:rangeLength] = range_length unless range_length.nil?
+          @attributes[:text] = text
+
+          @attributes.freeze
+        end
+
+        #
+        # The range of the document that changed.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The optional length of the range that got replaced.
+        #
+        # @deprecated use range instead.
+        #
+        # @return [uinteger]
+        def range_length
+          attributes.fetch(:rangeLength)
+        end
+
+        #
+        # The new text for the provided range.
+        #
+        # @return [string]
+        def text
+          attributes.fetch(:text)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentContentChangeWholeDocument
+        def initialize(text:)
+          @attributes = {}
+
+          @attributes[:text] = text
+
+          @attributes.freeze
+        end
+
+        #
+        # The new text of the whole document.
+        #
+        # @return [string]
+        def text
+          attributes.fetch(:text)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities for a text document content provider.
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentContentClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Text document content provider supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Text document content provider options.
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentContentOptions
+        def initialize(schemes:)
+          @attributes = {}
+
+          @attributes[:schemes] = schemes
+
+          @attributes.freeze
+        end
+
+        #
+        # The schemes for which the server provides content.
+        #
+        # @return [string[]]
+        def schemes
+          attributes.fetch(:schemes)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Parameters for the `workspace/textDocumentContent` request.
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentContentParams
+        def initialize(uri:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+
+          @attributes.freeze
+        end
+
+        #
+        # The uri of the text document.
+        #
+        # @return [DocumentUri]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end