language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A notebook document.
       #
+      # @since 3.17.0
+      #
       class NotebookDocument
         def initialize(uri:, notebook_type:, version:, metadata: nil, cells:)
           @attributes = {}
@@ -18,9 +20,9 @@ module LanguageServer
         end
 
         #
-        # The notebook document's URI.
+        # The notebook document's uri.
         #
-        # @return [string]
+        # @return [URI]
         def uri
           attributes.fetch(:uri)
         end
@@ -37,7 +39,7 @@ module LanguageServer
         # The version number of this document (it will increase after each
         # change, including undo/redo).
         #
-        # @return [number]
+        # @return [integer]
         def version
           attributes.fetch(:version)
         end
@@ -46,6 +48,8 @@ module LanguageServer
         # Additional metadata stored with the notebook
         # document.
         #
+        # Note: should always be an object literal (e.g. LSPObject)
+        #
         # @return [LSPObject]
         def metadata
           attributes.fetch(:metadata)

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A change event for a notebook document.
       #
+      # @since 3.17.0
+      #
       class NotebookDocumentChangeEvent
         def initialize(metadata: nil, cells: nil)
           @attributes = {}
@@ -17,6 +19,8 @@ module LanguageServer
         #
         # The changed meta data if any.
         #
+        # Note: should always be an object literal (e.g. LSPObject)
+        #
         # @return [LSPObject]
         def metadata
           attributes.fetch(:metadata)
@@ -25,7 +29,7 @@ module LanguageServer
         #
         # Changes to cells
         #
-        # @return [{ structure?: { array: NotebookCellArrayChange; didOpen?: TextDocumentItem[]; didClose?: TextDocumentIdentifier[]; }; data?: NotebookCell[]; textContent?: { ...; }[]; }]
+        # @return [{ structure?: { array: NotebookCellArrayChange; didOpen?: TextDocumentItem[]; didClose?: TextDocumentIdentifier[]; }; data?: NotebookCell[]; textContent?: { document: VersionedTextDocumentIdentifier; changes: TextDocumentContentChangeEvent[]; }[]; }]
         def cells
           attributes.fetch(:cells)
         end

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Capabilities specific to the notebook document support.
       #
+      # @since 3.17.0
+      #
       class NotebookDocumentClientCapabilities
         def initialize(synchronization:)
           @attributes = {}
@@ -16,6 +18,8 @@ module LanguageServer
         #
         # Capabilities specific to notebook document synchronization
         #
+        # @since 3.17.0
+        #
         # @return [NotebookDocumentSyncClientCapabilities]
         def synchronization
           attributes.fetch(:synchronization)

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

@@ -3,7 +3,10 @@ module LanguageServer
     module Interface
       #
       # A notebook document filter denotes a notebook document by
-      # different properties.
+      # different properties. The properties will be match
+      # against the notebook's URI (same as with documents)
+      #
+      # @since 3.17.0
       #
       class NotebookDocumentFilter
         def initialize(notebook_type: nil, scheme: nil, pattern: nil)
@@ -16,14 +19,6 @@ module LanguageServer
           @attributes.freeze
         end
 
-        #
-        # The type of the enclosing notebook.
-        #
-        # --- OR ---
-        #
-        # The type of the enclosing notebook.
-        #
-        # --- OR ---
         #
         # The type of the enclosing notebook.
         #
@@ -33,29 +28,13 @@ module LanguageServer
         end
 
         #
-        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
-        #
-        # --- OR ---
-        #
-        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
-        #
-        # --- OR ---
-        #
-        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+        # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
         #
         # @return [string]
         def scheme
           attributes.fetch(:scheme)
         end
 
-        #
-        # A glob pattern.
-        #
-        # --- OR ---
-        #
-        # A glob pattern.
-        #
-        # --- OR ---
         #
         # A glob pattern.
         #

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A literal to identify a notebook document in the client.
       #
+      # @since 3.17.0
+      #
       class NotebookDocumentIdentifier
         def initialize(uri:)
           @attributes = {}
@@ -14,9 +16,9 @@ module LanguageServer
         end
 
         #
-        # The notebook document's URI.
+        # The notebook document's uri.
         #
-        # @return [string]
+        # @return [URI]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Notebook specific client capabilities.
       #
+      # @since 3.17.0
+      #
       class NotebookDocumentSyncClientCapabilities
         def initialize(dynamic_registration: nil, execution_summary_support: nil)
           @attributes = {}

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

@@ -11,9 +11,11 @@ module LanguageServer
       #
       # If a selector provides no notebook document
       # filter but only a cell selector all notebook
-      # documents that contain at least one matching
+      # document that contain at least one matching
       # cell will be synced.
       #
+      # @since 3.17.0
+      #
       class NotebookDocumentSyncOptions
         def initialize(notebook_selector:, save: nil)
           @attributes = {}
@@ -27,7 +29,7 @@ module LanguageServer
         #
         # The notebooks to be synced
         #
-        # @return [({ notebook: string | NotebookDocumentFilter; cells?: { language: string; }[]; } | { notebook?: string | NotebookDocumentFilter; cells: { ...; }[]; })[]]
+        # @return [{ notebook: string | NotebookDocumentFilter; cells?: { language: string; }[]; } | { notebook?: string | NotebookDocumentFilter; cells: { language: string; }[]; }[]]
         def notebook_selector
           attributes.fetch(:notebookSelector)
         end

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Registration options specific to a notebook.
       #
+      # @since 3.17.0
+      #
       class NotebookDocumentSyncRegistrationOptions
         def initialize(notebook_selector:, save: nil, id: nil)
           @attributes = {}
@@ -18,7 +20,7 @@ module LanguageServer
         #
         # The notebooks to be synced
         #
-        # @return [({ notebook: string | NotebookDocumentFilter; cells?: { language: string; }[]; } | { notebook?: string | NotebookDocumentFilter; cells: { ...; }[]; })[]]
+        # @return [{ notebook: string | NotebookDocumentFilter; cells?: { language: string; }[]; } | { notebook?: string | NotebookDocumentFilter; cells: { language: string; }[]; }[]]
         def notebook_selector
           attributes.fetch(:notebookSelector)
         end

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

@@ -1,38 +1,37 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A text document identifier to optionally denote a specific version of a text document.
+      #
       class OptionalVersionedTextDocumentIdentifier
-        def initialize(uri:, version:)
+        def initialize(version:, uri:)
           @attributes = {}
 
-          @attributes[:uri] = uri
           @attributes[:version] = version
+          @attributes[:uri] = uri
 
           @attributes.freeze
         end
 
         #
-        # The text document's URI.
+        # 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).
         #
-        # @return [string]
-        def uri
-          attributes.fetch(:uri)
+        # @return [integer | nil]
+        def version
+          attributes.fetch(:version)
         end
 
         #
-        # 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).
+        # The text document's 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)
+        # @return [DocumentUri]
+        def uri
+          attributes.fetch(:uri)
         end
 
         attr_reader :attributes

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

@@ -18,16 +18,14 @@ 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 | [number, number]]
+        # @return [string | [uinteger, uinteger]]
         def label
           attributes.fetch(:label)
         end

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

@@ -11,8 +11,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/position.rb

@@ -1,6 +1,35 @@
 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 = {}
@@ -14,19 +43,24 @@ module LanguageServer
         #
         # Line position in a document (zero-based).
         #
-        # @return [number]
+        # 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]
         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 [number]
+        # @return [uinteger]
         def character
           attributes.fetch(:character)
         end

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

@@ -0,0 +1,69 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class PrepareRenameResult
+        def initialize(start: nil, end: nil, range: nil, placeholder: nil, default_behavior: nil)
+          @attributes = {}
+
+          @attributes[:start] = start if start
+          @attributes[:end] = binding.local_variable_get(:end) if binding.local_variable_get(:end)
+          @attributes[:range] = range if range
+          @attributes[:placeholder] = placeholder if placeholder
+          @attributes[:defaultBehavior] = default_behavior if default_behavior
+
+          @attributes.freeze
+        end
+
+        #
+        # The range's start position.
+        #
+        # @return [Position]
+        def start
+          attributes.fetch(:start)
+        end
+
+        #
+        # The range's end position.
+        #
+        # @return [Position]
+        def end
+          attributes.fetch(:end)
+        end
+
+        #
+
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+
+        #
+        # @return [string]
+        def placeholder
+          attributes.fetch(:placeholder)
+        end
+
+        #
+
+        #
+        # @return [boolean]
+        def default_behavior
+          attributes.fetch(:defaultBehavior)
+        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/previous_result_id.rb

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A previous result id in a workspace pull request.
       #
+      # @since 3.17.0
+      #
       class PreviousResultId
         def initialize(uri:, value:)
           @attributes = {}
@@ -15,10 +17,10 @@ module LanguageServer
         end
 
         #
-        # The URI for which the client knows a
+        # The URI for which the client knowns a
         # result id.
         #
-        # @return [string]
+        # @return [DocumentUri]
         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 [T]
+        # @return [LSPAny]
         def value
           attributes.fetch(:value)
         end

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

@@ -1,6 +1,9 @@
 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 = {}
@@ -26,6 +29,8 @@ 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[]; }]
         def tag_support
           attributes.fetch(:tagSupport)
@@ -35,6 +40,8 @@ module LanguageServer
         # Whether the client interprets the version property of the
         # `textDocument/publishDiagnostics` notification's parameter.
         #
+        # @since 3.15.0
+        #
         # @return [boolean]
         def version_support
           attributes.fetch(:versionSupport)
@@ -43,6 +50,8 @@ module LanguageServer
         #
         # Client supports a codeDescription property
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def code_description_support
           attributes.fetch(:codeDescriptionSupport)
@@ -53,6 +62,8 @@ module LanguageServer
         # preserved between a `textDocument/publishDiagnostics` and
         # `textDocument/codeAction` request.
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def data_support
           attributes.fetch(:dataSupport)

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

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

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

@@ -1,6 +1,19 @@
 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,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client Capabilities for a {@link ReferencesRequest}.
+      #
       class ReferenceClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}

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

@@ -1,6 +1,10 @@
 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,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Reference options.
+      #
       class ReferenceOptions
         def initialize(work_done_progress: nil)
           @attributes = {}

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

@@ -1,19 +1,27 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link ReferencesRequest}.
+      #
       class ReferenceParams
-        def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil, context:)
+        def initialize(context:, text_document:, position:, work_done_token: nil, partial_result_token: nil)
           @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.
         #
@@ -39,19 +47,14 @@ 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
           attributes.fetch(:partialResultToken)
         end
 
-        # @return [ReferenceContext]
-        def context
-          attributes.fetch(:context)
-        end
-
         attr_reader :attributes
 
         def to_hash