language_server-protocol 3.17.0.5 → 3.17.0.6

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 if deprecated
+          @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.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,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, 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, 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,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[: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
@@ -42,6 +42,9 @@ module LanguageServer
           @attributes.freeze
         end
 
+        #
+        # Defines which synchronization capabilities the client supports.
+        #
         # @return [TextDocumentSyncClientCapabilities]
         def synchronization
           attributes.fetch(:synchronization)
@@ -74,6 +77,8 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/declaration` request.
         #
+        # @since 3.14.0
+        #
         # @return [DeclarationClientCapabilities]
         def declaration
           attributes.fetch(:declaration)
@@ -90,6 +95,8 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/typeDefinition` request.
         #
+        # @since 3.6.0
+        #
         # @return [TypeDefinitionClientCapabilities]
         def type_definition
           attributes.fetch(:typeDefinition)
@@ -98,6 +105,8 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/implementation` request.
         #
+        # @since 3.6.0
+        #
         # @return [ImplementationClientCapabilities]
         def implementation
           attributes.fetch(:implementation)
@@ -155,6 +164,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 +188,6 @@ module LanguageServer
         end
 
         #
-        # request.
         # Capabilities specific to the `textDocument/onTypeFormatting` request.
         #
         # @return [DocumentOnTypeFormattingClientCapabilities]
@@ -193,18 +203,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 +216,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 +252,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 +274,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 +284,8 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/inlineValue` request.
         #
+        # @since 3.17.0
+        #
         # @return [InlineValueClientCapabilities]
         def inline_value
           attributes.fetch(:inlineValue)
@@ -269,6 +294,8 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/inlayHint` request.
         #
+        # @since 3.17.0
+        #
         # @return [InlayHintClientCapabilities]
         def inlay_hint
           attributes.fetch(:inlayHint)
@@ -277,6 +304,8 @@ module LanguageServer
         #
         # Capabilities specific to the diagnostic pull model.
         #
+        # @since 3.17.0
+        #
         # @return [DiagnosticClientCapabilities]
         def diagnostic
           attributes.fetch(:diagnostic)

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

@@ -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_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 {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of
+      # its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
+      #
+      # 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: nil, scheme: nil, pattern: nil)
+          @attributes = {}
+
+          @attributes[:language] = language if 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 {@link Uri.scheme scheme}, like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern, like `*.{ts,js}`.
+        #
+        # @return [string]
+        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 | nil]
         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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -15,10 +15,8 @@ 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 notification should not be sent.
+        # Open and close notifications are sent to the server. If omitted open close notification should not
+        # be sent.
         #
         # @return [boolean]
         def open_close
@@ -26,10 +24,8 @@ module LanguageServer
         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]
         def change
@@ -37,8 +33,8 @@ module LanguageServer
         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]
         def will_save
@@ -46,8 +42,8 @@ module LanguageServer
         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]
         def will_save_wait_until
@@ -55,8 +51,8 @@ module LanguageServer
         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]
         def save

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

@@ -1,6 +1,9 @@
 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,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Since 3.6.0
+      #
       class TypeDefinitionClientCapabilities
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
@@ -12,9 +15,9 @@ 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]
         def dynamic_registration
@@ -24,6 +27,8 @@ module LanguageServer
         #
         # The client supports additional metadata in the form of definition links.
         #
+        # Since 3.14.0
+        #
         # @return [boolean]
         def link_support
           attributes.fetch(:linkSupport)

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

@@ -38,8 +38,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/type_definition_registration_options.rb

@@ -13,10 +13,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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end