language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -1,42 +1,45 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a [FoldingRangeRequest](#FoldingRangeRequest).
+      #
       class FoldingRangeParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
+        def initialize(text_document:, work_done_token: nil, partial_result_token: nil)
           @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]
+        # @return [ProgressToken | nil]
         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]
+        # @return [ProgressToken | nil]
         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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         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]
+        # @return [string | nil]
         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 [number]
+        # @return [uinteger]
         def tab_size
           attributes.fetch(:tabSize)
         end
@@ -36,7 +36,9 @@ module LanguageServer
         #
         # Trim trailing whitespace on a line.
         #
-        # @return [boolean]
+        # @since 3.15.0
+        #
+        # @return [boolean | nil]
         def trim_trailing_whitespace
           attributes.fetch(:trimTrailingWhitespace)
         end
@@ -44,7 +46,9 @@ module LanguageServer
         #
         # Insert a newline character at the end of the file if one does not exist.
         #
-        # @return [boolean]
+        # @since 3.15.0
+        #
+        # @return [boolean | nil]
         def insert_final_newline
           attributes.fetch(:insertFinalNewline)
         end
@@ -52,7 +56,9 @@ module LanguageServer
         #
         # Trim all newlines after the final newline at the end of the file.
         #
-        # @return [boolean]
+        # @since 3.15.0
+        #
+        # @return [boolean | nil]
         def trim_final_newlines
           attributes.fetch(:trimFinalNewlines)
         end

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

@@ -0,0 +1,58 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # 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[:items] = items
+
+          @attributes.freeze
+        end
+
+        #
+        # A full document diagnostic report.
+        #
+        # @return ["full"]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # An optional result id. If provided it will
+        # be sent on the next diagnostic request for the
+        # same document.
+        #
+        # @return [string | nil]
+        def result_id
+          attributes.fetch(:resultId)
+        end
+
+        #
+        # The actual items.
+        #
+        # @return [Diagnostic[]]
+        def items
+          attributes.fetch(:items)
+        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/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[] } | nil]
+        def stale_request_support
+          attributes.fetch(:staleRequestSupport)
+        end
+
+        #
+        # Client capabilities specific to regular expressions.
+        #
+        # @since 3.16.0
+        #
+        # @return [RegularExpressionsClientCapabilities | nil]
+        def regular_expressions
+          attributes.fetch(:regularExpressions)
+        end
+
+        #
+        # Client capabilities specific to the client's markdown parser.
+        #
+        # @since 3.16.0
+        #
+        # @return [MarkdownClientCapabilities | nil]
+        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[] | nil]
+        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/glob_pattern.rb

@@ -0,0 +1,48 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The glob pattern. Either a string pattern or a relative pattern.
+      #
+      # @since 3.17.0
+      #
+      class GlobPattern
+        def initialize(base_uri:, pattern:)
+          @attributes = {}
+
+          @attributes[:baseUri] = base_uri
+          @attributes[:pattern] = pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # A workspace folder or a base URI to which this pattern will be matched
+        # against relatively.
+        #
+        # @return [WorkspaceFolder | URI]
+        def base_uri
+          attributes.fetch(:baseUri)
+        end
+
+        #
+        # The actual glob pattern;
+        #
+        # @return [Pattern]
+        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/hover.rb

@@ -23,10 +23,10 @@ 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]
+        # @return [Range | nil]
         def range
           attributes.fetch(:range)
         end

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

@@ -14,17 +14,16 @@ module LanguageServer
         #
         # Whether hover supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
 
         #
-        # Client supports the following 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[]]
+        # @return [MarkupKind[] | nil]
         def content_format
           attributes.fetch(:contentFormat)
         end

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 = {}
@@ -10,7 +13,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

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

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [HoverRequest](#HoverRequest).
+      #
       class HoverRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -12,15 +15,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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         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,11 +15,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]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -24,7 +27,9 @@ module LanguageServer
         #
         # The client supports additional metadata in the form of definition links.
         #
-        # @return [boolean]
+        # @since 3.14.0
+        #
+        # @return [boolean | nil]
         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]
+        # @return [boolean | nil]
         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]
+        # @return [ProgressToken | nil]
         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]
+        # @return [ProgressToken | nil]
         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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         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]
+        # @return [string | nil]
         def id
           attributes.fetch(:id)
         end

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

@@ -2,7 +2,8 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Known error codes for an `InitializeError`;
+      # The data type of the ResponseError if the
+      # initialize request fails.
       #
       class InitializeError
         def initialize(retry:)