language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -4,12 +4,14 @@ module LanguageServer
       #
       # A diagnostic report with a full set of problems.
       #
+      # @since 3.17.0
+      #
       class FullDocumentDiagnosticReport
         def initialize(kind:, result_id: nil, items:)
           @attributes = {}
 
           @attributes[:kind] = kind
-          @attributes[:resultId] = result_id if result_id
+          @attributes[:resultId] = result_id unless result_id.nil?
           @attributes[:items] = items
 
           @attributes.freeze
@@ -18,7 +20,7 @@ module LanguageServer
         #
         # A full document diagnostic report.
         #
-        # @return [any]
+        # @return ["full"]
         def kind
           attributes.fetch(:kind)
         end

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 unless stale_request_support.nil?
+          @attributes[:regularExpressions] = regular_expressions unless regular_expressions.nil?
+          @attributes[:markdown] = markdown unless markdown.nil?
+          @attributes[:positionEncodings] = position_encodings unless position_encodings.nil?
+
+          @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 [StaleRequestSupportOptions]
+        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

@@ -9,7 +9,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:contents] = contents
-          @attributes[:range] = range if range
+          @attributes[:range] = range unless range.nil?
 
           @attributes.freeze
         end
@@ -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

@@ -5,8 +5,8 @@ module LanguageServer
         def initialize(dynamic_registration: nil, content_format: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:contentFormat] = content_format if content_format
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:contentFormat] = content_format unless content_format.nil?
 
           @attributes.freeze
         end
@@ -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,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Hover options.
+      #
       class HoverOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -1,13 +1,16 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link HoverRequest}.
+      #
       class HoverParams
         def initialize(text_document:, position:, work_done_token: nil)
           @attributes = {}
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @attributes.freeze
         end

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

@@ -1,21 +1,24 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link HoverRequest}.
+      #
       class HoverRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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.
+        # 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,20 +1,23 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.6.0
+      #
       class ImplementationClientCapabilities
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:linkSupport] = link_support if link_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:linkSupport] = link_support unless link_support.nil?
 
           @attributes.freeze
         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_options.rb

@@ -5,7 +5,7 @@ module LanguageServer
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -7,8 +7,8 @@ module LanguageServer
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end
@@ -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

@@ -6,17 +6,17 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:id] = id if id
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+          @attributes[:id] = id unless id.nil?
 
           @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.
+        # 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[:clientInfo] = client_info unless client_info.nil?
+          @attributes[:locale] = locale unless locale.nil?
+          @attributes[:rootPath] = root_path unless root_path.nil?
           @attributes[:rootUri] = root_uri
-          @attributes[:initializationOptions] = initialization_options if initialization_options
           @attributes[:capabilities] = capabilities
-          @attributes[:trace] = trace if trace
-          @attributes[:workspaceFolders] = workspace_folders if workspace_folders
+          @attributes[:initializationOptions] = initialization_options unless initialization_options.nil?
+          @attributes[:trace] = trace unless trace.nil?
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:workspaceFolders] = workspace_folders unless workspace_folders.nil?
 
           @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,7 +34,9 @@ module LanguageServer
         #
         # Information about the client
         #
-        # @return [{ name: string; version?: string; }]
+        # @since 3.15.0
+        #
+        # @return [ClientInfo]
         def client_info
           attributes.fetch(:clientInfo)
         end
@@ -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,19 +72,13 @@ 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
 
-        #
-        # User provided initialization options.
-        #
-        # @return [LSPAny]
-        def initialization_options
-          attributes.fetch(:initializationOptions)
-        end
-
         #
         # The capabilities provided by the client (editor or tool)
         #
@@ -94,6 +87,14 @@ module LanguageServer
           attributes.fetch(:capabilities)
         end
 
+        #
+        # User provided initialization options.
+        #
+        # @return [LSPAny]
+        def initialization_options
+          attributes.fetch(:initializationOptions)
+        end
+
         #
         # The initial trace setting. If omitted trace is disabled ('off').
         #
@@ -102,12 +103,23 @@ module LanguageServer
           attributes.fetch(:trace)
         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 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,12 +1,15 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The result returned from an initialize request.
+      #
       class InitializeResult
         def initialize(capabilities:, server_info: nil)
           @attributes = {}
 
           @attributes[:capabilities] = capabilities
-          @attributes[:serverInfo] = server_info if server_info
+          @attributes[:serverInfo] = server_info unless server_info.nil?
 
           @attributes.freeze
         end
@@ -22,7 +25,9 @@ module LanguageServer
         #
         # Information about the server.
         #
-        # @return [{ name: string; version?: string; }]
+        # @since 3.15.0
+        #
+        # @return [ServerInfo]
         def server_info
           attributes.fetch(:serverInfo)
         end

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

@@ -4,18 +4,20 @@ 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 = {}
 
           @attributes[:position] = position
           @attributes[:label] = label
-          @attributes[:kind] = kind if kind
-          @attributes[:textEdits] = text_edits if text_edits
-          @attributes[:tooltip] = tooltip if tooltip
-          @attributes[:paddingLeft] = padding_left if padding_left
-          @attributes[:paddingRight] = padding_right if padding_right
-          @attributes[:data] = data if data
+          @attributes[:kind] = kind unless kind.nil?
+          @attributes[:textEdits] = text_edits unless text_edits.nil?
+          @attributes[:tooltip] = tooltip unless tooltip.nil?
+          @attributes[:paddingLeft] = padding_left unless padding_left.nil?
+          @attributes[:paddingRight] = padding_right unless padding_right.nil?
+          @attributes[:data] = data unless data.nil?
 
           @attributes.freeze
         end
@@ -23,6 +25,9 @@ module LanguageServer
         #
         # The position of this hint.
         #
+        # If multiple hints have the same position, they will be shown in the order
+        # they appear in the response.
+        #
         # @return [Position]
         def position
           attributes.fetch(:position)
@@ -55,9 +60,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 +68,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,12 +4,14 @@ module LanguageServer
       #
       # Inlay hint client capabilities.
       #
+      # @since 3.17.0
+      #
       class InlayHintClientCapabilities
         def initialize(dynamic_registration: nil, resolve_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:resolveSupport] = resolve_support if resolve_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:resolveSupport] = resolve_support unless resolve_support.nil?
 
           @attributes.freeze
         end
@@ -26,7 +28,7 @@ module LanguageServer
         # Indicates which properties a client can resolve lazily on an inlay
         # hint.
         #
-        # @return [{ properties: string[]; }]
+        # @return [ClientInlayHintResolveOptions]
         def resolve_support
           attributes.fetch(:resolveSupport)
         end

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

@@ -5,14 +5,16 @@ 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 = {}
 
           @attributes[:value] = value
-          @attributes[:tooltip] = tooltip if tooltip
-          @attributes[:location] = location if location
-          @attributes[:command] = command if command
+          @attributes[:tooltip] = tooltip unless tooltip.nil?
+          @attributes[:location] = location unless location.nil?
+          @attributes[:command] = command unless command.nil?
 
           @attributes.freeze
         end

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[:resolveProvider] = resolve_provider unless resolve_provider.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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