language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -0,0 +1,40 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline value information can be provided by different means:
+      # - directly as a text value (class InlineValueText).
+      # - as a name to use for a variable lookup (class InlineValueVariableLookup)
+      # - as an evaluatable expression (class InlineValueEvaluatableExpression)
+      # The InlineValue types combines all inline value types into one type.
+      #
+      # @since 3.17.0
+      #
+      class InlineValue
+        def initialize: (range: untyped, ?text: String, ?variable_name: String, ?case_sensitive_lookup: bool, ?expression: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def range: () -> untyped
+
+        %a{pure}
+        def text: () -> String
+
+        %a{pure}
+        def variable_name: () -> String
+
+        %a{pure}
+        def case_sensitive_lookup: () -> bool
+
+        %a{pure}
+        def expression: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities specific to inline values.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueClientCapabilities
+        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/inline_value_context.rbs

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.17.0
+      #
+      class InlineValueContext
+        def initialize: (frame_id: Integer, stopped_location: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def frame_id: () -> Integer
+
+        %a{pure}
+        def stopped_location: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Provide an inline value through an expression evaluation.
+      # If only a range is specified, the expression will be extracted from the underlying document.
+      # An optional expression can be used to override the extracted expression.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueEvaluatableExpression
+        def initialize: (range: untyped, ?expression: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def range: () -> untyped
+
+        %a{pure}
+        def expression: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline value options used during static registration.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueOptions
+        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/inline_value_params.rbs

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A parameter literal used in inline value requests.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueParams
+        def initialize: (text_document: untyped, range: untyped, context: 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 range: () -> untyped
+
+        %a{pure}
+        def context: () -> 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/inline_value_registration_options.rbs

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline value options used during static or dynamic registration.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueRegistrationOptions
+        def initialize: (?work_done_progress: bool, document_selector: untyped, ?id: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def work_done_progress: () -> bool
+
+        %a{pure}
+        def document_selector: () -> untyped
+
+        %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/inline_value_text.rbs

@@ -0,0 +1,27 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Provide inline value as text.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueText
+        def initialize: (range: untyped, text: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def range: () -> untyped
+
+        %a{pure}
+        def text: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Provide inline value through a variable lookup.
+      # If only a range is specified, the variable name will be extracted from the underlying document.
+      # An optional variable name can be used to override the extracted name.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueVariableLookup
+        def initialize: (range: untyped, ?variable_name: String, case_sensitive_lookup: bool) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def range: () -> untyped
+
+        %a{pure}
+        def variable_name: () -> String
+
+        %a{pure}
+        def case_sensitive_lookup: () -> bool
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client workspace capabilities specific to inline values.
+      #
+      # @since 3.17.0
+      #
+      class InlineValueWorkspaceClientCapabilities
+        def initialize: (?refresh_support: bool) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def refresh_support: () -> bool
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A special text edit to provide an insert and a replace operation.
+      #
+      # @since 3.16.0
+      #
+      class InsertReplaceEdit
+        def initialize: (new_text: String, insert: untyped, replace: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def new_text: () -> String
+
+        %a{pure}
+        def insert: () -> untyped
+
+        %a{pure}
+        def replace: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities for the linked editing range request.
+      #
+      # @since 3.16.0
+      #
+      class LinkedEditingRangeClientCapabilities
+        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/linked_editing_range_options.rbs

@@ -0,0 +1,19 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRangeOptions
+        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/linked_editing_range_params.rbs

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRangeParams
+        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/linked_editing_range_registration_options.rbs

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRangeRegistrationOptions
+        def initialize: (document_selector: untyped, ?work_done_progress: bool, ?id: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def document_selector: () -> untyped
+
+        %a{pure}
+        def work_done_progress: () -> 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/linked_editing_ranges.rbs

@@ -0,0 +1,27 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The result of a linked editing range request.
+      #
+      # @since 3.16.0
+      #
+      class LinkedEditingRanges
+        def initialize: (ranges: Array[untyped], ?word_pattern: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def ranges: () -> Array[untyped]
+
+        %a{pure}
+        def word_pattern: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents a location inside a resource, such as a line
+      # inside a text file.
+      #
+      class Location
+        def initialize: (uri: String, range: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def uri: () -> String
+
+        %a{pure}
+        def range: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},
+      # including an origin range.
+      #
+      class LocationLink
+        def initialize: (?origin_selection_range: untyped, target_uri: String, target_range: untyped, target_selection_range: untyped) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def origin_selection_range: () -> untyped
+
+        %a{pure}
+        def target_uri: () -> String
+
+        %a{pure}
+        def target_range: () -> untyped
+
+        %a{pure}
+        def target_selection_range: () -> untyped
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The log message parameters.
+      #
+      class LogMessageParams
+        def initialize: (type: untyped, message: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def type: () -> untyped
+
+        %a{pure}
+        def message: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities specific to the used markdown parser.
+      #
+      # @since 3.16.0
+      #
+      class MarkdownClientCapabilities
+        def initialize: (parser: String, ?version: String, ?allowed_tags: Array[String]) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def parser: () -> String
+
+        %a{pure}
+        def version: () -> String
+
+        %a{pure}
+        def allowed_tags: () -> Array[String]
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A `MarkupContent` literal represents a string value which content is interpreted base on its
+      # kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
+      #
+      # If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
+      # See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
+      #
+      # Here is an example how such a string can be constructed using JavaScript / TypeScript:
+      # ```ts
+      # let markdown: MarkdownContent = {
+      #  kind: MarkupKind.Markdown,
+      #  value: [
+      #    '# Header',
+      #    'Some text',
+      #    '```typescript',
+      #    'someCode();',
+      #    '```'
+      #  ].join('\n')
+      # };
+      # ```
+      #
+      # *Please Note* that clients might sanitize the return markdown. A client could decide to
+      # remove HTML from the markdown to avoid script execution.
+      #
+      class MarkupContent
+        def initialize: (kind: untyped, value: String) -> void
+
+        @attributes: Hash[Symbol, untyped]
+        attr_reader attributes: Hash[Symbol, untyped]
+
+        %a{pure}
+        def kind: () -> untyped
+
+        %a{pure}
+        def value: () -> String
+
+        def to_hash: () -> Hash[Symbol, untyped]
+
+        def to_json: (*untyped) -> String
+      end
+    end
+  end
+end

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

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

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

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