language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -1,45 +1,42 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Parameters for a [FoldingRangeRequest](#FoldingRangeRequest).
-      #
       class FoldingRangeParams
-        def initialize(text_document:, work_done_token: nil, partial_result_token: nil)
+        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
           @attributes = {}
 
-          @attributes[:textDocument] = text_document
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:textDocument] = text_document
 
           @attributes.freeze
         end
 
-        #
-        # The text document.
-        #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
-        end
-
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken | nil]
+        # @return [ProgressToken]
         def work_done_token
           attributes.fetch(:workDoneToken)
         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 | nil]
+        # @return [ProgressToken]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end
 
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -13,15 +13,15 @@ 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 | null]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end
@@ -30,7 +30,7 @@ module LanguageServer
         # The id used to register the request. The id can be used to deregister
         # the request again. See also Registration#id.
         #
-        # @return [string | nil]
+        # @return [string]
         def id
           attributes.fetch(:id)
         end

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

@@ -20,7 +20,7 @@ module LanguageServer
         #
         # Size of a tab in spaces.
         #
-        # @return [uinteger]
+        # @return [number]
         def tab_size
           attributes.fetch(:tabSize)
         end
@@ -36,9 +36,7 @@ module LanguageServer
         #
         # Trim trailing whitespace on a line.
         #
-        # @since 3.15.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         def trim_trailing_whitespace
           attributes.fetch(:trimTrailingWhitespace)
         end
@@ -46,9 +44,7 @@ module LanguageServer
         #
         # Insert a newline character at the end of the file if one does not exist.
         #
-        # @since 3.15.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         def insert_final_newline
           attributes.fetch(:insertFinalNewline)
         end
@@ -56,9 +52,7 @@ module LanguageServer
         #
         # Trim all newlines after the final newline at the end of the file.
         #
-        # @since 3.15.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         def trim_final_newlines
           attributes.fetch(:trimFinalNewlines)
         end

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

@@ -4,8 +4,6 @@ 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 = {}
@@ -20,7 +18,7 @@ module LanguageServer
         #
         # A full document diagnostic report.
         #
-        # @return ["full"]
+        # @return [any]
         def kind
           attributes.fetch(:kind)
         end
@@ -30,7 +28,7 @@ module LanguageServer
         # be sent on the next diagnostic request for the
         # same document.
         #
-        # @return [string | nil]
+        # @return [string]
         def result_id
           attributes.fetch(:resultId)
         end

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

@@ -23,10 +23,10 @@ module LanguageServer
         end
 
         #
-        # An optional range inside the text document that is used to
-        # visualize the hover, e.g. by changing the background color.
+        # An optional range is a range inside a text document
+        # that is used to visualize a hover, e.g. by changing the background color.
         #
-        # @return [Range | nil]
+        # @return [Range]
         def range
           attributes.fetch(:range)
         end

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

@@ -14,16 +14,17 @@ module LanguageServer
         #
         # Whether hover supports dynamic registration.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
 
         #
-        # Client supports the following content formats for the content
-        # property. The order describes the preferred format of the client.
+        # 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.
         #
-        # @return [MarkupKind[] | nil]
+        # @return [MarkupKind[]]
         def content_format
           attributes.fetch(:contentFormat)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Hover options.
-      #
       class HoverOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
@@ -13,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Parameters for a [HoverRequest](#HoverRequest).
-      #
       class HoverParams
         def initialize(text_document:, position:, work_done_token: nil)
           @attributes = {}
@@ -34,7 +31,7 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken | nil]
+        # @return [ProgressToken]
         def work_done_token
           attributes.fetch(:workDoneToken)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Registration options for a [HoverRequest](#HoverRequest).
-      #
       class HoverRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -15,15 +12,15 @@ 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 | null]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

data/lib/language_server/protocol/interface/{t.rb → hover_result.rb}

@@ -1,14 +1,20 @@
 module LanguageServer
   module Protocol
     module Interface
-      class T
-        def initialize()
+      class HoverResult
+        def initialize(value:)
           @attributes = {}
 
+          @attributes[:value] = value
 
           @attributes.freeze
         end
 
+        # @return [string]
+        def value
+          attributes.fetch(:value)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

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

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

@@ -10,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -32,16 +32,16 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken | nil]
+        # @return [ProgressToken]
         def work_done_token
           attributes.fetch(:workDoneToken)
         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 | nil]
+        # @return [ProgressToken]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end

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

@@ -13,15 +13,15 @@ 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 | null]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end
@@ -30,7 +30,7 @@ module LanguageServer
         # The id used to register the request. The id can be used to deregister
         # the request again. See also Registration#id.
         #
-        # @return [string | nil]
+        # @return [string]
         def id
           attributes.fetch(:id)
         end

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

@@ -1,10 +1,6 @@
 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,31 +2,38 @@ module LanguageServer
   module Protocol
     module Interface
       class InitializeParams
-        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)
+        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)
           @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[:capabilities] = capabilities
           @attributes[:initializationOptions] = initialization_options if initialization_options
+          @attributes[:capabilities] = capabilities
           @attributes[:trace] = trace if trace
-          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:workspaceFolders] = workspace_folders if workspace_folders
 
           @attributes.freeze
         end
 
         #
-        # The process Id of the parent process that started
-        # the server.
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
         #
-        # Is `null` if the process has not been started by another process.
-        # If the parent process is not alive then the server should exit.
+        # 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.
         #
-        # @return [integer | null]
+        # @return [number]
         def process_id
           attributes.fetch(:processId)
         end
@@ -34,9 +41,7 @@ module LanguageServer
         #
         # Information about the client
         #
-        # @since 3.15.0
-        #
-        # @return [{ name:string, version:string } | nil]
+        # @return [{ name: string; version?: string; }]
         def client_info
           attributes.fetch(:clientInfo)
         end
@@ -49,9 +54,7 @@ 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 | nil]
+        # @return [string]
         def locale
           attributes.fetch(:locale)
         end
@@ -60,9 +63,7 @@ module LanguageServer
         # The rootPath of the workspace. Is null
         # if no folder is open.
         #
-        # @deprecated in favour of rootUri.
-        #
-        # @return [string | null]
+        # @return [string]
         def root_path
           attributes.fetch(:rootPath)
         end
@@ -72,55 +73,42 @@ module LanguageServer
         # folder is open. If both `rootPath` and `rootUri` are set
         # `rootUri` wins.
         #
-        # @deprecated in favour of workspaceFolders.
-        #
-        # @return [DocumentUri | null]
+        # @return [string]
         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.
         #
-        # @return [LSPAny | nil]
+        # @return [LSPAny]
         def initialization_options
           attributes.fetch(:initializationOptions)
         end
 
         #
-        # The initial trace setting. If omitted trace is disabled ('off').
+        # The capabilities provided by the client (editor or tool)
         #
-        # @return ["off" | "messages" | "compact" | "verbose" | nil]
-        def trace
-          attributes.fetch(:trace)
+        # @return [ClientCapabilities]
+        def capabilities
+          attributes.fetch(:capabilities)
         end
 
         #
-        # An optional token that a server can use to report work done progress.
+        # The initial trace setting. If omitted trace is disabled ('off').
         #
-        # @return [ProgressToken | nil]
-        def work_done_token
-          attributes.fetch(:workDoneToken)
+        # @return [TraceValue]
+        def trace
+          attributes.fetch(:trace)
         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[] | null]
+        # @return [WorkspaceFolder[]]
         def workspace_folders
           attributes.fetch(:workspaceFolders)
         end

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

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

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

@@ -4,8 +4,6 @@ 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 = {}
@@ -45,7 +43,7 @@ module LanguageServer
         # The kind of this hint. Can be omitted in which case the client
         # should fall back to a reasonable default.
         #
-        # @return [InlayHintKind | nil]
+        # @return [InlayHintKind]
         def kind
           attributes.fetch(:kind)
         end
@@ -57,7 +55,10 @@ module LanguageServer
         # hint (or its nearest variant) is now part of the document and the inlay
         # hint itself is now obsolete.
         #
-        # @return [TextEdit[] | nil]
+        # 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)
         end
@@ -65,7 +66,10 @@ module LanguageServer
         #
         # The tooltip text when you hover over this item.
         #
-        # @return [string | MarkupContent | nil]
+        # 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)
         end
@@ -77,7 +81,7 @@ module LanguageServer
         # background color of the hint itself. That means padding can be used
         # to visually align/separate an inlay hint.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def padding_left
           attributes.fetch(:paddingLeft)
         end
@@ -89,16 +93,16 @@ module LanguageServer
         # background color of the hint itself. That means padding can be used
         # to visually align/separate an inlay hint.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def padding_right
           attributes.fetch(:paddingRight)
         end
 
         #
-        # A data entry field that is preserved on an inlay hint between
+        # A data entry field that is preserved on a inlay hint between
         # a `textDocument/inlayHint` and a `inlayHint/resolve` request.
         #
-        # @return [LSPAny | nil]
+        # @return [LSPAny]
         def data
           attributes.fetch(:data)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Inlay hint client capabilities.
       #
-      # @since 3.17.0
-      #
       class InlayHintClientCapabilities
         def initialize(dynamic_registration: nil, resolve_support: nil)
           @attributes = {}
@@ -19,16 +17,16 @@ module LanguageServer
         #
         # Whether inlay hints support dynamic registration.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
 
         #
-        # Indicates which properties a client can resolve lazily on an inlay
+        # Indicates which properties a client can resolve lazily on a inlay
         # hint.
         #
-        # @return [{ properties:string[] } | nil]
+        # @return [{ properties: string[]; }]
         def resolve_support
           attributes.fetch(:resolveSupport)
         end