language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -0,0 +1,48 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class NotificationMessage
+        def initialize(jsonrpc:, method:, params: nil)
+          @attributes = {}
+
+          @attributes[:jsonrpc] = jsonrpc
+          @attributes[:method] = method
+          @attributes[:params] = params if params
+
+          @attributes.freeze
+        end
+
+        # @return [string]
+        def jsonrpc
+          attributes.fetch(:jsonrpc)
+        end
+
+        #
+        # The method to be invoked.
+        #
+        # @return [string]
+        def method
+          attributes.fetch(:method)
+        end
+
+        #
+        # The notification's params.
+        #
+        # @return [any]
+        def params
+          attributes.fetch(:params)
+        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/optional_versioned_text_document_identifier.rb

@@ -1,37 +1,38 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # A text document identifier to optionally denote a specific version of a text document.
-      #
       class OptionalVersionedTextDocumentIdentifier
-        def initialize(version:, uri:)
+        def initialize(uri:, version:)
           @attributes = {}
 
-          @attributes[:version] = version
           @attributes[:uri] = uri
+          @attributes[:version] = version
 
           @attributes.freeze
         end
 
         #
-        # The version number of this document. If a versioned text document identifier
-        # is sent from the server to the client and the file is not open in the editor
-        # (the server has not received an open notification before) the server can send
-        # `null` to indicate that the version is unknown and the content on disk is the
-        # truth (as specified with document content ownership).
+        # The text document's URI.
         #
-        # @return [integer | null]
-        def version
-          attributes.fetch(:version)
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
         end
 
         #
-        # The text document's uri.
+        # The version number of this document. If an optional versioned text document
+        # identifier is sent from the server to the client and the file is not
+        # open in the editor (the server has not received an open notification
+        # before) the server can send `null` to indicate that the version is
+        # known and the content on disk is the master (as specified with document
+        # content ownership).
         #
-        # @return [DocumentUri]
-        def uri
-          attributes.fetch(:uri)
+        # The version number of a document will increase after each change,
+        # including undo/redo. The number doesn't need to be consecutive.
+        #
+        # @return [number]
+        def version
+          attributes.fetch(:version)
         end
 
         attr_reader :attributes

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

@@ -18,14 +18,16 @@ module LanguageServer
         #
         # The label of this parameter information.
         #
-        # Either a string or an inclusive start and exclusive end offsets within its containing
-        # signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
-        # string representation as `Position` and `Range` does.
+        # Either a string or an inclusive start and exclusive end offsets within
+        # its containing signature label. (see SignatureInformation.label). The
+        # offsets are based on a UTF-16 string representation as `Position` and
+        # `Range` does.
         #
-        # *Note*: a label of type string should be a substring of its containing signature label.
-        # Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
+        # *Note*: a label of type string should be a substring of its containing
+        # signature label. Its intended use case is to highlight the parameter
+        # label part in the `SignatureInformation.label`.
         #
-        # @return [string | uinteger, uinteger]
+        # @return [string | [number, number]]
         def label
           attributes.fetch(:label)
         end
@@ -34,7 +36,7 @@ module LanguageServer
         # The human-readable doc-comment of this parameter. Will be shown
         # in the UI but can be omitted.
         #
-        # @return [string | MarkupContent | nil]
+        # @return [string | MarkupContent]
         def documentation
           attributes.fetch(:documentation)
         end

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

@@ -11,10 +11,10 @@ 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 | nil]
+        # @return [ProgressToken]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end

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

@@ -1,35 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Position in a text document expressed as zero-based line and character
-      # offset. Prior to 3.17 the offsets were always based on a UTF-16 string
-      # representation. So a string of the form `a𐐀b` the character offset of the
-      # character `a` is 0, the character offset of `𐐀` is 1 and the character
-      # offset of b is 3 since `𐐀` is represented using two code units in UTF-16.
-      # Since 3.17 clients and servers can agree on a different string encoding
-      # representation (e.g. UTF-8). The client announces it's supported encoding
-      # via the client capability [`general.positionEncodings`](#clientCapabilities).
-      # The value is an array of position encodings the client supports, with
-      # decreasing preference (e.g. the encoding at index `0` is the most preferred
-      # one). To stay backwards compatible the only mandatory encoding is UTF-16
-      # represented via the string `utf-16`. The server can pick one of the
-      # encodings offered by the client and signals that encoding back to the
-      # client via the initialize result's property
-      # [`capabilities.positionEncoding`](#serverCapabilities). If the string value
-      # `utf-16` is missing from the client's capability `general.positionEncodings`
-      # servers can safely assume that the client supports UTF-16. If the server
-      # omits the position encoding in its initialize result the encoding defaults
-      # to the string value `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.
-      #
-      # Positions are line end character agnostic. So you can not specify a position
-      # that denotes `\r|\n` or `\n|` where `|` represents the character offset.
-      #
-      # @since 3.17.0 - support for negotiated position encoding.
-      #
       class Position
         def initialize(line:, character:)
           @attributes = {}
@@ -43,24 +14,19 @@ module LanguageServer
         #
         # Line position in a document (zero-based).
         #
-        # If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document.
-        # If a line number is negative, it defaults to 0.
-        #
-        # @return [uinteger]
+        # @return [number]
         def line
           attributes.fetch(:line)
         end
 
         #
-        # Character offset on a line in a document (zero-based).
-        #
-        # The meaning of this offset is determined by the negotiated
-        # `PositionEncodingKind`.
+        # Character offset on a line in a document (zero-based). The meaning of this
+        # offset is determined by the negotiated `PositionEncodingKind`.
         #
-        # If the character value is greater than the line length it defaults back to the
-        # line length.
+        # If the character value is greater than the line length it defaults back
+        # to the line length.
         #
-        # @return [uinteger]
+        # @return [number]
         def character
           attributes.fetch(:character)
         end

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

@@ -31,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/previous_result_id.rb

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # A previous result id in a workspace pull request.
       #
-      # @since 3.17.0
-      #
       class PreviousResultId
         def initialize(uri:, value:)
           @attributes = {}
@@ -20,7 +18,7 @@ module LanguageServer
         # The URI for which the client knows a
         # result id.
         #
-        # @return [DocumentUri]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -22,7 +22,7 @@ module LanguageServer
         #
         # The progress data.
         #
-        # @return [LSPAny]
+        # @return [T]
         def value
           attributes.fetch(:value)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The publish diagnostic client capabilities.
-      #
       class PublishDiagnosticsClientCapabilities
         def initialize(related_information: nil, tag_support: nil, version_support: nil, code_description_support: nil, data_support: nil)
           @attributes = {}
@@ -20,7 +17,7 @@ module LanguageServer
         #
         # Whether the clients accepts diagnostics with related information.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def related_information
           attributes.fetch(:relatedInformation)
         end
@@ -29,9 +26,7 @@ module LanguageServer
         # Client supports the tag property to provide meta data about a diagnostic.
         # Clients supporting tags have to handle unknown tags gracefully.
         #
-        # @since 3.15.0
-        #
-        # @return [{ valueSet:DiagnosticTag[] } | nil]
+        # @return [{ valueSet: DiagnosticTag[]; }]
         def tag_support
           attributes.fetch(:tagSupport)
         end
@@ -40,9 +35,7 @@ module LanguageServer
         # Whether the client interprets the version property of the
         # `textDocument/publishDiagnostics` notification's parameter.
         #
-        # @since 3.15.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         def version_support
           attributes.fetch(:versionSupport)
         end
@@ -50,9 +43,7 @@ module LanguageServer
         #
         # Client supports a codeDescription property
         #
-        # @since 3.16.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         def code_description_support
           attributes.fetch(:codeDescriptionSupport)
         end
@@ -62,9 +53,7 @@ module LanguageServer
         # preserved between a `textDocument/publishDiagnostics` and
         # `textDocument/codeAction` request.
         #
-        # @since 3.16.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         def data_support
           attributes.fetch(:dataSupport)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The publish diagnostic notification's parameters.
-      #
       class PublishDiagnosticsParams
         def initialize(uri:, version: nil, diagnostics:)
           @attributes = {}
@@ -18,17 +15,16 @@ module LanguageServer
         #
         # The URI for which diagnostic information is reported.
         #
-        # @return [DocumentUri]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end
 
         #
-        # Optional the version number of the document the diagnostics are published for.
+        # Optional the version number of the document the diagnostics are published
+        # for.
         #
-        # @since 3.15.0
-        #
-        # @return [integer | nil]
+        # @return [number]
         def version
           attributes.fetch(:version)
         end

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

@@ -1,19 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # A range in a text document expressed as (zero-based) start and end positions.
-      #
-      # If you want to specify a range that contains a line including the line ending
-      # character(s) then use an end position denoting the start of the next line.
-      # For example:
-      # ```ts
-      # {
-      #     start: { line: 5, character: 23 }
-      #     end : { line 6, character : 0 }
-      # }
-      # ```
-      #
       class Range
         def initialize(start:, end:)
           @attributes = {}

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Client Capabilities for a [ReferencesRequest](#ReferencesRequest).
-      #
       class ReferenceClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -16,7 +13,7 @@ module LanguageServer
         #
         # Whether references supports dynamic registration.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,10 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Value-object that contains additional information when
-      # requesting references.
-      #
       class ReferenceContext
         def initialize(include_declaration:)
           @attributes = {}

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Reference options.
-      #
       class ReferenceOptions
         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/reference_params.rb

@@ -1,27 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Parameters for a [ReferencesRequest](#ReferencesRequest).
-      #
       class ReferenceParams
-        def initialize(context:, text_document:, position:, work_done_token: nil, partial_result_token: nil)
+        def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil, context:)
           @attributes = {}
 
-          @attributes[:context] = context
           @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[:context] = context
 
           @attributes.freeze
         end
 
-        # @return [ReferenceContext]
-        def context
-          attributes.fetch(:context)
-        end
-
         #
         # The text document.
         #
@@ -41,20 +33,25 @@ 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
 
+        # @return [ReferenceContext]
+        def context
+          attributes.fetch(:context)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Registration options for a [ReferencesRequest](#ReferencesRequest).
-      #
       class ReferenceRegistrationOptions
         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/registration.rb

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # General parameters to to register for an notification or to register a provider.
+      # General parameters to register for a capability.
       #
       class Registration
         def initialize(id:, method:, register_options: nil)
@@ -35,7 +35,7 @@ module LanguageServer
         #
         # Options necessary for the registration.
         #
-        # @return [LSPAny | nil]
+        # @return [LSPAny]
         def register_options
           attributes.fetch(:registerOptions)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Client capabilities specific to regular expressions.
       #
-      # @since 3.16.0
-      #
       class RegularExpressionsClientCapabilities
         def initialize(engine:, version: nil)
           @attributes = {}
@@ -27,7 +25,7 @@ module LanguageServer
         #
         # The engine's version.
         #
-        # @return [string | nil]
+        # @return [string]
         def version
           attributes.fetch(:version)
         end

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

@@ -4,38 +4,22 @@ module LanguageServer
       #
       # A full diagnostic report with a set of related documents.
       #
-      # @since 3.17.0
-      #
       class RelatedFullDocumentDiagnosticReport
-        def initialize(related_documents: nil, kind:, result_id: nil, items:)
+        def initialize(kind:, result_id: nil, items:, related_documents: nil)
           @attributes = {}
 
-          @attributes[:relatedDocuments] = related_documents if related_documents
           @attributes[:kind] = kind
           @attributes[:resultId] = result_id if result_id
           @attributes[:items] = items
+          @attributes[:relatedDocuments] = related_documents if related_documents
 
           @attributes.freeze
         end
 
-        #
-        # Diagnostics of related documents. This information is useful
-        # in programming languages where code in a file A can generate
-        # diagnostics in a file B which A depends on. An example of
-        # such a language is C/C++ where marco definitions in a file
-        # a.cpp and result in errors in a header file b.hpp.
-        #
-        # @since 3.17.0
-        #
-        # @return [DocumentUri => FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport | nil]
-        def related_documents
-          attributes.fetch(:relatedDocuments)
-        end
-
         #
         # A full document diagnostic report.
         #
-        # @return ["full"]
+        # @return [any]
         def kind
           attributes.fetch(:kind)
         end
@@ -45,7 +29,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
@@ -58,6 +42,18 @@ module LanguageServer
           attributes.fetch(:items)
         end
 
+        #
+        # Diagnostics of related documents. This information is useful
+        # in programming languages where code in a file A can generate
+        # diagnostics in a file B which A depends on. An example of
+        # such a language is C/C++ where marco definitions in a file
+        # a.cpp and result in errors in a header file b.hpp.
+        #
+        # @return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        end
+
         attr_reader :attributes
 
         def to_hash