language_server-protocol 3.16.0.1 → 3.17.0.0

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, publish_diagnostics: nil, folding_range: nil, selection_range: nil, linked_editing_range: nil, call_hierarchy: nil, semantic_tokens: nil, moniker: 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, 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)
           @attributes = {}
 
           @attributes[:synchronization] = synchronization if synchronization
@@ -27,18 +27,25 @@ 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[:linkedEditingRange] = linked_editing_range if linked_editing_range
+          @attributes[:publishDiagnostics] = publish_diagnostics if publish_diagnostics
           @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
+          @attributes[:inlayHint] = inlay_hint if inlay_hint
+          @attributes[:diagnostic] = diagnostic if diagnostic
 
           @attributes.freeze
         end
 
-        # @return [TextDocumentSyncClientCapabilities]
+        #
+        # Defines which synchronization capabilities the client supports.
+        #
+        # @return [TextDocumentSyncClientCapabilities | nil]
         def synchronization
           attributes.fetch(:synchronization)
         end
@@ -46,7 +53,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/completion` request.
         #
-        # @return [CompletionClientCapabilities]
+        # @return [CompletionClientCapabilities | nil]
         def completion
           attributes.fetch(:completion)
         end
@@ -54,7 +61,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/hover` request.
         #
-        # @return [HoverClientCapabilities]
+        # @return [HoverClientCapabilities | nil]
         def hover
           attributes.fetch(:hover)
         end
@@ -62,7 +69,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/signatureHelp` request.
         #
-        # @return [SignatureHelpClientCapabilities]
+        # @return [SignatureHelpClientCapabilities | nil]
         def signature_help
           attributes.fetch(:signatureHelp)
         end
@@ -70,7 +77,9 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/declaration` request.
         #
-        # @return [DeclarationClientCapabilities]
+        # @since 3.14.0
+        #
+        # @return [DeclarationClientCapabilities | nil]
         def declaration
           attributes.fetch(:declaration)
         end
@@ -78,7 +87,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/definition` request.
         #
-        # @return [DefinitionClientCapabilities]
+        # @return [DefinitionClientCapabilities | nil]
         def definition
           attributes.fetch(:definition)
         end
@@ -86,7 +95,9 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/typeDefinition` request.
         #
-        # @return [TypeDefinitionClientCapabilities]
+        # @since 3.6.0
+        #
+        # @return [TypeDefinitionClientCapabilities | nil]
         def type_definition
           attributes.fetch(:typeDefinition)
         end
@@ -94,7 +105,9 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/implementation` request.
         #
-        # @return [ImplementationClientCapabilities]
+        # @since 3.6.0
+        #
+        # @return [ImplementationClientCapabilities | nil]
         def implementation
           attributes.fetch(:implementation)
         end
@@ -102,7 +115,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/references` request.
         #
-        # @return [ReferenceClientCapabilities]
+        # @return [ReferenceClientCapabilities | nil]
         def references
           attributes.fetch(:references)
         end
@@ -110,7 +123,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/documentHighlight` request.
         #
-        # @return [DocumentHighlightClientCapabilities]
+        # @return [DocumentHighlightClientCapabilities | nil]
         def document_highlight
           attributes.fetch(:documentHighlight)
         end
@@ -118,7 +131,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/documentSymbol` request.
         #
-        # @return [DocumentSymbolClientCapabilities]
+        # @return [DocumentSymbolClientCapabilities | nil]
         def document_symbol
           attributes.fetch(:documentSymbol)
         end
@@ -126,7 +139,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/codeAction` request.
         #
-        # @return [CodeActionClientCapabilities]
+        # @return [CodeActionClientCapabilities | nil]
         def code_action
           attributes.fetch(:codeAction)
         end
@@ -134,7 +147,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/codeLens` request.
         #
-        # @return [CodeLensClientCapabilities]
+        # @return [CodeLensClientCapabilities | nil]
         def code_lens
           attributes.fetch(:codeLens)
         end
@@ -142,7 +155,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/documentLink` request.
         #
-        # @return [DocumentLinkClientCapabilities]
+        # @return [DocumentLinkClientCapabilities | nil]
         def document_link
           attributes.fetch(:documentLink)
         end
@@ -151,7 +164,9 @@ module LanguageServer
         # Capabilities specific to the `textDocument/documentColor` and the
         # `textDocument/colorPresentation` request.
         #
-        # @return [DocumentColorClientCapabilities]
+        # @since 3.6.0
+        #
+        # @return [DocumentColorClientCapabilities | nil]
         def color_provider
           attributes.fetch(:colorProvider)
         end
@@ -159,7 +174,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/formatting` request.
         #
-        # @return [DocumentFormattingClientCapabilities]
+        # @return [DocumentFormattingClientCapabilities | nil]
         def formatting
           attributes.fetch(:formatting)
         end
@@ -167,16 +182,15 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/rangeFormatting` request.
         #
-        # @return [DocumentRangeFormattingClientCapabilities]
+        # @return [DocumentRangeFormattingClientCapabilities | nil]
         def range_formatting
           attributes.fetch(:rangeFormatting)
         end
 
         #
-        # request.
         # Capabilities specific to the `textDocument/onTypeFormatting` request.
         #
-        # @return [DocumentOnTypeFormattingClientCapabilities]
+        # @return [DocumentOnTypeFormattingClientCapabilities | nil]
         def on_type_formatting
           attributes.fetch(:onTypeFormatting)
         end
@@ -184,24 +198,17 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/rename` request.
         #
-        # @return [RenameClientCapabilities]
+        # @return [RenameClientCapabilities | nil]
         def rename
           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.
         #
-        # @return [FoldingRangeClientCapabilities]
+        # @since 3.10.0
+        #
+        # @return [FoldingRangeClientCapabilities | nil]
         def folding_range
           attributes.fetch(:foldingRange)
         end
@@ -209,43 +216,101 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/selectionRange` request.
         #
-        # @return [SelectionRangeClientCapabilities]
+        # @since 3.15.0
+        #
+        # @return [SelectionRangeClientCapabilities | nil]
         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 | nil]
+        def publish_diagnostics
+          attributes.fetch(:publishDiagnostics)
         end
 
         #
         # Capabilities specific to the various call hierarchy requests.
         #
-        # @return [CallHierarchyClientCapabilities]
+        # @since 3.16.0
+        #
+        # @return [CallHierarchyClientCapabilities | nil]
         def call_hierarchy
           attributes.fetch(:callHierarchy)
         end
 
         #
-        # Capabilities specific to the various semantic token requests.
+        # Capabilities specific to the various semantic token request.
         #
-        # @return [SemanticTokensClientCapabilities]
+        # @since 3.16.0
+        #
+        # @return [SemanticTokensClientCapabilities | nil]
         def semantic_tokens
           attributes.fetch(:semanticTokens)
         end
 
         #
-        # Capabilities specific to the `textDocument/moniker` request.
+        # Capabilities specific to the `textDocument/linkedEditingRange` request.
+        #
+        # @since 3.16.0
+        #
+        # @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]
+        # @return [MonikerClientCapabilities | nil]
         def moniker
           attributes.fetch(:moniker)
         end
 
+        #
+        # Capabilities specific to the various type hierarchy requests.
+        #
+        # @since 3.17.0
+        #
+        # @return [TypeHierarchyClientCapabilities | nil]
+        def type_hierarchy
+          attributes.fetch(:typeHierarchy)
+        end
+
+        #
+        # Capabilities specific to the `textDocument/inlineValue` request.
+        #
+        # @since 3.17.0
+        #
+        # @return [InlineValueClientCapabilities | nil]
+        def inline_value
+          attributes.fetch(:inlineValue)
+        end
+
+        #
+        # Capabilities specific to the `textDocument/inlayHint` request.
+        #
+        # @since 3.17.0
+        #
+        # @return [InlayHintClientCapabilities | nil]
+        def inlay_hint
+          attributes.fetch(:inlayHint)
+        end
+
+        #
+        # Capabilities specific to the diagnostic pull model.
+        #
+        # @since 3.17.0
+        #
+        # @return [DiagnosticClientCapabilities | nil]
+        def diagnostic
+          attributes.fetch(:diagnostic)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,14 +2,14 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # An event describing a change to a text document. If range and rangeLength are
-      # omitted the new text is considered to be the full content of the document.
+      # An event describing a change to a text document. If only a text is provided
+      # it is considered to be the full content of the document.
       #
       class TextDocumentContentChangeEvent
-        def initialize(range: nil, range_length: nil, text:)
+        def initialize(range:, range_length: nil, text:)
           @attributes = {}
 
-          @attributes[:range] = range if range
+          @attributes[:range] = 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, 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 | nil]
         def range_length
           attributes.fetch(:rangeLength)
         end
@@ -35,10 +37,6 @@ 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,6 +1,12 @@
 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 = {}
@@ -22,7 +28,10 @@ module LanguageServer
         #
         # The edits to be applied.
         #
-        # @return [(TextEdit | AnnotatedTextEdit)[]]
+        # @since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a
+        # client capability.
+        #
+        # @return [TextEdit | AnnotatedTextEdit[]]
         def edits
           attributes.fetch(:edits)
         end

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

@@ -0,0 +1,69 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A document filter denotes a document by different properties like
+      # the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
+      # its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
+      #
+      # Glob patterns can have the following syntax:
+      # - `*` to match one or more characters in a path segment
+      # - `?` to match on one character in a path segment
+      # - `**` to match any number of path segments, including none
+      # - `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+      # - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+      # - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+      #
+      # @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
+      # @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
+      #
+      # @since 3.17.0
+      #
+      class TextDocumentFilter
+        def initialize(language:, scheme: nil, pattern: nil)
+          @attributes = {}
+
+          @attributes[:language] = language
+          @attributes[:scheme] = scheme if scheme
+          @attributes[:pattern] = pattern if pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # A language id, like `typescript`. */
+        #
+        # @return [string]
+        def language
+          attributes.fetch(:language)
+        end
+
+        #
+        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
+        #
+        # @return [string | nil]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern, like `*.{ts,js}`. */
+        #
+        # @return [string | nil]
+        def pattern
+          attributes.fetch(:pattern)
+        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_identifier.rb

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

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

@@ -1,6 +1,10 @@
 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 = {}
@@ -14,9 +18,9 @@ module LanguageServer
         end
 
         #
-        # The text document's URI.
+        # The text document's uri.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end
@@ -33,7 +37,7 @@ module LanguageServer
         # The version number of this document (it will increase after each
         # change, including undo/redo).
         #
-        # @return [number]
+        # @return [integer]
         def version
           attributes.fetch(:version)
         end

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

@@ -1,6 +1,10 @@
 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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Save registration options.
+      #
       class TextDocumentSaveRegistrationOptions
         def initialize(document_selector:, include_text: nil)
           @attributes = {}
@@ -12,10 +15,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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
@@ -23,7 +26,7 @@ module LanguageServer
         #
         # The client is supposed to include the content on save.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         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]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -24,7 +24,7 @@ module LanguageServer
         #
         # The client supports sending will save notifications.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         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]
+        # @return [boolean | nil]
         def will_save_wait_until
           attributes.fetch(:willSaveWaitUntil)
         end
@@ -42,7 +42,7 @@ module LanguageServer
         #
         # The client supports did save notifications.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def did_save
           attributes.fetch(:didSave)
         end