language_server-protocol 3.17.0.5 → 3.17.0.6

data/sig/language_server/protocol/interface/moniker.rbs

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Moniker definition to match LSIF 0.5 moniker definition.
+      #
+      # @since 3.16.0
+      #
+      class Moniker
+        def initialize: (scheme: String, identifier: String, unique: untyped, ?kind: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def scheme: () -> String
+
+        %a{pure}
+        def identifier: () -> String
+
+        %a{pure}
+        def unique: () -> untyped
+
+        %a{pure}
+        def kind: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/moniker_client_capabilities.rbs

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities specific to the moniker request.
+      #
+      # @since 3.16.0
+      #
+      class MonikerClientCapabilities
+        def initialize: (?dynamic_registration: bool) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def dynamic_registration: () -> bool
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/moniker_options.rbs

@@ -0,0 +1,19 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class MonikerOptions
+        def initialize: (?work_done_progress: bool) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def work_done_progress: () -> bool
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/moniker_params.rbs

@@ -0,0 +1,28 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class MonikerParams
+        def initialize: (text_document: untyped, position: untyped, ?work_done_token: untyped, ?partial_result_token: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def text_document: () -> untyped
+
+        %a{pure}
+        def position: () -> untyped
+
+        %a{pure}
+        def work_done_token: () -> untyped
+
+        %a{pure}
+        def partial_result_token: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/moniker_registration_options.rbs

@@ -0,0 +1,22 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class MonikerRegistrationOptions
+        def initialize: (document_selector: untyped, ?work_done_progress: bool) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def document_selector: () -> untyped
+
+        %a{pure}
+        def work_done_progress: () -> bool
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_cell.rbs

@@ -0,0 +1,37 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook cell.
+      #
+      # A cell's document URI must be unique across ALL notebook
+      # cells and can therefore be used to uniquely identify a
+      # notebook cell or the cell's text document.
+      #
+      # @since 3.17.0
+      #
+      class NotebookCell
+        def initialize: (kind: untyped, document: String, ?metadata: untyped, ?execution_summary: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def kind: () -> untyped
+
+        %a{pure}
+        def document: () -> String
+
+        %a{pure}
+        def metadata: () -> untyped
+
+        %a{pure}
+        def execution_summary: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_cell_array_change.rbs

@@ -0,0 +1,31 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A change describing how to move a `NotebookCell`
+      # array from state S to S'.
+      #
+      # @since 3.17.0
+      #
+      class NotebookCellArrayChange
+        def initialize: (start: Integer, delete_count: Integer, ?cells: Array[untyped]) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def start: () -> Integer
+
+        %a{pure}
+        def delete_count: () -> Integer
+
+        %a{pure}
+        def cells: () -> Array[untyped]
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_cell_text_document_filter.rbs

@@ -0,0 +1,28 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook cell text document filter denotes a cell text
+      # document by different properties.
+      #
+      # @since 3.17.0
+      #
+      class NotebookCellTextDocumentFilter
+        def initialize: (notebook: untyped, ?language: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def notebook: () -> untyped
+
+        %a{pure}
+        def language: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_document.rbs

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook document.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocument
+        def initialize: (uri: String, notebook_type: String, version: Integer, ?metadata: untyped, cells: Array[untyped]) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def uri: () -> String
+
+        %a{pure}
+        def notebook_type: () -> String
+
+        %a{pure}
+        def version: () -> Integer
+
+        %a{pure}
+        def metadata: () -> untyped
+
+        %a{pure}
+        def cells: () -> Array[untyped]
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_document_change_event.rbs

@@ -0,0 +1,27 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A change event for a notebook document.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocumentChangeEvent
+        def initialize: (?metadata: untyped, ?cells: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def metadata: () -> untyped
+
+        %a{pure}
+        def cells: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_document_client_capabilities.rbs

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Capabilities specific to the notebook document support.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocumentClientCapabilities
+        def initialize: (synchronization: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def synchronization: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_document_filter.rbs

@@ -0,0 +1,32 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook document filter denotes a notebook document by
+      # 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: String, ?scheme: String, ?pattern: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def notebook_type: () -> String
+
+        %a{pure}
+        def scheme: () -> String
+
+        %a{pure}
+        def pattern: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_document_identifier.rbs

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A literal to identify a notebook document in the client.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocumentIdentifier
+        def initialize: (uri: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def uri: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_document_sync_client_capabilities.rbs

@@ -0,0 +1,27 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Notebook specific client capabilities.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocumentSyncClientCapabilities
+        def initialize: (?dynamic_registration: bool, ?execution_summary_support: bool) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def dynamic_registration: () -> bool
+
+        %a{pure}
+        def execution_summary_support: () -> bool
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_document_sync_options.rbs

@@ -0,0 +1,37 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Options specific to a notebook plus its cells
+      # to be synced to the server.
+      #
+      # If a selector provides a notebook document
+      # filter but no cell selector all cells of a
+      # matching notebook document will be synced.
+      #
+      # If a selector provides no notebook document
+      # filter but only a cell selector all notebook
+      # document that contain at least one matching
+      # cell will be synced.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocumentSyncOptions
+        def initialize: (notebook_selector: Array[untyped], ?save: bool) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def notebook_selector: () -> Array[untyped]
+
+        %a{pure}
+        def save: () -> bool
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notebook_document_sync_registration_options.rbs

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Registration options specific to a notebook.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocumentSyncRegistrationOptions
+        def initialize: (notebook_selector: Array[untyped], ?save: bool, ?id: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def notebook_selector: () -> Array[untyped]
+
+        %a{pure}
+        def save: () -> bool
+
+        %a{pure}
+        def id: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/notification_message.rbs

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class NotificationMessage
+        def initialize: (jsonrpc: String, method: String, ?params: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def jsonrpc: () -> String
+
+        %a{pure}
+        def method: () -> String
+
+        %a{pure}
+        def params: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/optional_versioned_text_document_identifier.rbs

@@ -0,0 +1,25 @@
+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: Integer?, uri: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def version: () -> Integer?
+
+        %a{pure}
+        def uri: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/parameter_information.rbs

@@ -0,0 +1,26 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents a parameter of a callable-signature. A parameter can
+      # have a label and a doc-comment.
+      #
+      class ParameterInformation
+        def initialize: (label: untyped, ?documentation: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def label: () -> untyped
+
+        %a{pure}
+        def documentation: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/partial_result_params.rbs

@@ -0,0 +1,19 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class PartialResultParams
+        def initialize: (?partial_result_token: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def partial_result_token: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/position.rbs

@@ -0,0 +1,51 @@
+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: Integer, character: Integer) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def line: () -> Integer
+
+        %a{pure}
+        def character: () -> Integer
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/prepare_rename_params.rbs

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class PrepareRenameParams
+        def initialize: (text_document: untyped, position: untyped, ?work_done_token: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def text_document: () -> untyped
+
+        %a{pure}
+        def position: () -> untyped
+
+        %a{pure}
+        def work_done_token: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

data/sig/language_server/protocol/interface/prepare_rename_result.rbs

@@ -0,0 +1,31 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class PrepareRenameResult
+        def initialize: (?start: untyped, ?end: untyped, ?range: untyped, ?placeholder: String, ?default_behavior: bool) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def start: () -> untyped
+
+        %a{pure}
+        def end: () -> untyped
+
+        %a{pure}
+        def range: () -> untyped
+
+        %a{pure}
+        def placeholder: () -> String
+
+        %a{pure}
+        def default_behavior: () -> bool
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end