language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -0,0 +1,91 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # General client capabilities.
+      #
+      # @since 3.16.0
+      #
+      class GeneralClientCapabilities
+        def initialize(stale_request_support: nil, regular_expressions: nil, markdown: nil, position_encodings: nil)
+          @attributes = {}
+
+          @attributes[:staleRequestSupport] = stale_request_support if stale_request_support
+          @attributes[:regularExpressions] = regular_expressions if regular_expressions
+          @attributes[:markdown] = markdown if markdown
+          @attributes[:positionEncodings] = position_encodings if position_encodings
+
+          @attributes.freeze
+        end
+
+        #
+        # Client capability that signals how the client
+        # handles stale requests (e.g. a request
+        # for which the client will not process the response
+        # anymore since the information is outdated).
+        #
+        # @since 3.17.0
+        #
+        # @return [{ cancel: boolean; retryOnContentModified: string[]; }]
+        def stale_request_support
+          attributes.fetch(:staleRequestSupport)
+        end
+
+        #
+        # Client capabilities specific to regular expressions.
+        #
+        # @since 3.16.0
+        #
+        # @return [RegularExpressionsClientCapabilities]
+        def regular_expressions
+          attributes.fetch(:regularExpressions)
+        end
+
+        #
+        # Client capabilities specific to the client's markdown parser.
+        #
+        # @since 3.16.0
+        #
+        # @return [MarkdownClientCapabilities]
+        def markdown
+          attributes.fetch(:markdown)
+        end
+
+        #
+        # The position encodings supported by the client. Client and server
+        # have to agree on the same position encoding to ensure that offsets
+        # (e.g. character position in a line) are interpreted the same on both
+        # sides.
+        #
+        # To keep the protocol backwards compatible the following applies: if
+        # the value 'utf-16' is missing from the array of position encodings
+        # servers can assume that the client supports UTF-16. UTF-16 is
+        # therefore a mandatory encoding.
+        #
+        # If omitted it defaults to ['utf-16'].
+        #
+        # Implementation considerations: since the conversion from one encoding
+        # into another requires the content of the file / line the conversion
+        # is best done where the file is read which is usually on the server
+        # side.
+        #
+        # @since 3.17.0
+        #
+        # @return [PositionEncodingKind[]]
+        def position_encodings
+          attributes.fetch(:positionEncodings)
+        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/hover.rb

@@ -23,8 +23,8 @@ module LanguageServer
         end
 
         #
-        # An optional range is a range inside a text document
-        # that is used to visualize a hover, e.g. by changing the background color.
+        # An optional range inside the text document that is used to
+        # visualize the hover, e.g. by changing the background color.
         #
         # @return [Range]
         def range

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

@@ -20,9 +20,8 @@ module LanguageServer
         end
 
         #
-        # Client supports the follow content formats if the content
-        # property refers to a `literal of type MarkupContent`.
-        # The order describes the preferred format of the client.
+        # Client supports the following content formats for the content
+        # property. The order describes the preferred format of the client.
         #
         # @return [MarkupKind[]]
         def content_format

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Hover options.
+      #
       class HoverOptions
         def initialize(work_done_progress: nil)
           @attributes = {}

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link HoverRequest}.
+      #
       class HoverParams
         def initialize(text_document:, position:, work_done_token: nil)
           @attributes = {}

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link HoverRequest}.
+      #
       class HoverRegistrationOptions
         def initialize(document_selector:, work_done_progress: 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/implementation_client_capabilities.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.6.0
+      #
       class ImplementationClientCapabilities
         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 `ImplementationRegistrationOptions`
-        # 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 `ImplementationRegistrationOptions` 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/implementation_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/implementation_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

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

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The data type of the ResponseError if the
+      # initialize request fails.
+      #
       class InitializeError
         def initialize(retry:)
           @attributes = {}

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

@@ -2,38 +2,31 @@ module LanguageServer
   module Protocol
     module Interface
       class InitializeParams
-        def initialize(work_done_token: nil, process_id:, client_info: nil, locale: nil, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil)
+        def initialize(process_id:, client_info: nil, locale: nil, root_path: nil, root_uri:, capabilities:, initialization_options: nil, trace: nil, work_done_token: nil, workspace_folders: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:processId] = process_id
           @attributes[:clientInfo] = client_info if client_info
           @attributes[:locale] = locale if locale
           @attributes[:rootPath] = root_path if root_path
           @attributes[:rootUri] = root_uri
-          @attributes[:initializationOptions] = initialization_options if initialization_options
           @attributes[:capabilities] = capabilities
+          @attributes[:initializationOptions] = initialization_options if initialization_options
           @attributes[:trace] = trace if trace
+          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:workspaceFolders] = workspace_folders if workspace_folders
 
           @attributes.freeze
         end
 
         #
-        # An optional token that a server can use to report work done progress.
-        #
-        # @return [ProgressToken]
-        def work_done_token
-          attributes.fetch(:workDoneToken)
-        end
-
+        # The process Id of the parent process that started
+        # the server.
         #
-        # The process Id of the parent process that started the server. Is null if
-        # the process has not been started by another process. If the parent
-        # process is not alive then the server should exit (see exit notification)
-        # its process.
+        # Is `null` if the process has not been started by another process.
+        # If the parent process is not alive then the server should exit.
         #
-        # @return [number]
+        # @return [integer | nil]
         def process_id
           attributes.fetch(:processId)
         end
@@ -41,6 +34,8 @@ module LanguageServer
         #
         # Information about the client
         #
+        # @since 3.15.0
+        #
         # @return [{ name: string; version?: string; }]
         def client_info
           attributes.fetch(:clientInfo)
@@ -54,6 +49,8 @@ module LanguageServer
         # Uses IETF language tags as the value's syntax
         # (See https://en.wikipedia.org/wiki/IETF_language_tag)
         #
+        # @since 3.16.0
+        #
         # @return [string]
         def locale
           attributes.fetch(:locale)
@@ -63,6 +60,8 @@ module LanguageServer
         # The rootPath of the workspace. Is null
         # if no folder is open.
         #
+        # @deprecated in favour of rootUri.
+        #
         # @return [string]
         def root_path
           attributes.fetch(:rootPath)
@@ -73,11 +72,21 @@ module LanguageServer
         # folder is open. If both `rootPath` and `rootUri` are set
         # `rootUri` wins.
         #
-        # @return [string]
+        # @deprecated in favour of workspaceFolders.
+        #
+        # @return [DocumentUri | nil]
         def root_uri
           attributes.fetch(:rootUri)
         end
 
+        #
+        # The capabilities provided by the client (editor or tool)
+        #
+        # @return [ClientCapabilities]
+        def capabilities
+          attributes.fetch(:capabilities)
+        end
+
         #
         # User provided initialization options.
         #
@@ -87,27 +96,30 @@ module LanguageServer
         end
 
         #
-        # The capabilities provided by the client (editor or tool)
+        # The initial trace setting. If omitted trace is disabled ('off').
         #
-        # @return [ClientCapabilities]
-        def capabilities
-          attributes.fetch(:capabilities)
+        # @return [TraceValues]
+        def trace
+          attributes.fetch(:trace)
         end
 
         #
-        # The initial trace setting. If omitted trace is disabled ('off').
+        # An optional token that a server can use to report work done progress.
         #
-        # @return [TraceValue]
-        def trace
-          attributes.fetch(:trace)
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
         end
 
         #
         # The workspace folders configured in the client when the server starts.
+        #
         # This property is only available if the client supports workspace folders.
         # It can be `null` if the client supports workspace folders but none are
         # configured.
         #
+        # @since 3.6.0
+        #
         # @return [WorkspaceFolder[]]
         def workspace_folders
           attributes.fetch(:workspaceFolders)

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The result returned from an initialize request.
+      #
       class InitializeResult
         def initialize(capabilities:, server_info: nil)
           @attributes = {}
@@ -22,6 +25,8 @@ module LanguageServer
         #
         # Information about the server.
         #
+        # @since 3.15.0
+        #
         # @return [{ name: string; version?: string; }]
         def server_info
           attributes.fetch(:serverInfo)

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Inlay hint information.
       #
+      # @since 3.17.0
+      #
       class InlayHint
         def initialize(position:, label:, kind: nil, text_edits: nil, tooltip: nil, padding_left: nil, padding_right: nil, data: nil)
           @attributes = {}
@@ -55,9 +57,6 @@ module LanguageServer
         # hint (or its nearest variant) is now part of the document and the inlay
         # hint itself is now obsolete.
         #
-        # Depending on the client capability `inlayHint.resolveSupport` clients
-        # might resolve this property late using the resolve request.
-        #
         # @return [TextEdit[]]
         def text_edits
           attributes.fetch(:textEdits)
@@ -66,9 +65,6 @@ module LanguageServer
         #
         # The tooltip text when you hover over this item.
         #
-        # Depending on the client capability `inlayHint.resolveSupport` clients
-        # might resolve this property late using the resolve request.
-        #
         # @return [string | MarkupContent]
         def tooltip
           attributes.fetch(:tooltip)

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Inlay hint client capabilities.
       #
+      # @since 3.17.0
+      #
       class InlayHintClientCapabilities
         def initialize(dynamic_registration: nil, resolve_support: nil)
           @attributes = {}

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

@@ -5,6 +5,8 @@ module LanguageServer
       # An inlay hint label part allows for interactive and composite labels
       # of inlay hints.
       #
+      # @since 3.17.0
+      #
       class InlayHintLabelPart
         def initialize(value:, tooltip: nil, location: nil, command: nil)
           @attributes = {}

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

@@ -4,21 +4,18 @@ module LanguageServer
       #
       # Inlay hint options used during static registration.
       #
+      # @since 3.17.0
+      #
       class InlayHintOptions
-        def initialize(work_done_progress: nil, resolve_provider: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The server provides support to resolve additional
         # information for an inlay hint item.
@@ -28,6 +25,11 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -4,25 +4,19 @@ module LanguageServer
       #
       # A parameter literal used in inlay hint requests.
       #
+      # @since 3.17.0
+      #
       class InlayHintParams
-        def initialize(work_done_token: nil, text_document:, range:)
+        def initialize(text_document:, range:, work_done_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
+          @attributes[:workDoneToken] = work_done_token if work_done_token
 
           @attributes.freeze
         end
 
-        #
-        # An optional token that a server can use to report work done progress.
-        #
-        # @return [ProgressToken]
-        def work_done_token
-          attributes.fetch(:workDoneToken)
-        end
-
         #
         # The text document.
         #
@@ -32,13 +26,21 @@ module LanguageServer
         end
 
         #
-        # The visible document range for which inlay hints should be computed.
+        # The document range for which inlay hints should be computed.
         #
         # @return [Range]
         def range
           attributes.fetch(:range)
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -4,23 +4,20 @@ module LanguageServer
       #
       # Inlay hint options used during static or dynamic registration.
       #
+      # @since 3.17.0
+      #
       class InlayHintRegistrationOptions
-        def initialize(work_done_progress: nil, resolve_provider: nil, document_selector:, id: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil, document_selector:, id: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:documentSelector] = document_selector
           @attributes[:id] = id if id
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The server provides support to resolve additional
         # information for an inlay hint item.
@@ -30,11 +27,16 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        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/inlay_hint_workspace_client_capabilities.rb

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Client workspace capabilities specific to inlay hints.
       #
+      # @since 3.17.0
+      #
       class InlayHintWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}

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

@@ -0,0 +1,88 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline value information can be provided by different means:
+      # - directly as a text value (class InlineValueText).
+      # - as a name to use for a variable lookup (class InlineValueVariableLookup)
+      # - as an evaluatable expression (class InlineValueEvaluatableExpression)
+      # The InlineValue types combines all inline value types into one type.
+      #
+      # @since 3.17.0
+      #
+      class InlineValue
+        def initialize(range:, text: nil, variable_name: nil, case_sensitive_lookup: nil, expression: nil)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:text] = text if text
+          @attributes[:variableName] = variable_name if variable_name
+          @attributes[:caseSensitiveLookup] = case_sensitive_lookup if case_sensitive_lookup
+          @attributes[:expression] = expression if expression
+
+          @attributes.freeze
+        end
+
+        #
+        # The document range for which the inline value applies.
+        #
+        # --- OR ---
+        #
+        # The document range for which the inline value applies.
+        # The range is used to extract the variable name from the underlying document.
+        #
+        # --- OR ---
+        #
+        # The document range for which the inline value applies.
+        # The range is used to extract the evaluatable expression from the underlying document.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The text of the inline value.
+        #
+        # @return [string]
+        def text
+          attributes.fetch(:text)
+        end
+
+        #
+        # If specified the name of the variable to look up.
+        #
+        # @return [string]
+        def variable_name
+          attributes.fetch(:variableName)
+        end
+
+        #
+        # How to perform the lookup.
+        #
+        # @return [boolean]
+        def case_sensitive_lookup
+          attributes.fetch(:caseSensitiveLookup)
+        end
+
+        #
+        # If specified the expression overrides the extracted expression.
+        #
+        # @return [string]
+        def expression
+          attributes.fetch(:expression)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end