language_server-protocol 3.17.0.5 → 3.17.0.6

data/sig/language_server/protocol/constant/error_codes.rbs

@@ -0,0 +1,73 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module ErrorCodes
+        PARSE_ERROR: -32700
+        INVALID_REQUEST: -32600
+        METHOD_NOT_FOUND: -32601
+        INVALID_PARAMS: -32602
+        INTERNAL_ERROR: -32603
+        #
+        # This is the start range of JSON-RPC reserved error codes.
+        # It doesn't denote a real error code. No LSP error codes should
+        # be defined between the start and end range. For backwards
+        # compatibility the `ServerNotInitialized` and the `UnknownErrorCode`
+        # are left in the range.
+        #
+        JSONRPC_RESERVED_ERROR_RANGE_START: -32099
+        SERVER_ERROR_START: Integer
+        #
+        # Error code indicating that a server received a notification or
+        # request before the server has received the `initialize` request.
+        #
+        SERVER_NOT_INITIALIZED: -32002
+        UNKNOWN_ERROR_CODE: -32001
+        #
+        # This is the end range of JSON-RPC reserved error codes.
+        # It doesn't denote a real error code.
+        #
+        JSONRPC_RESERVED_ERROR_RANGE_END: -32000
+        SERVER_ERROR_END: Integer
+        #
+        # This is the start range of LSP reserved error codes.
+        # It doesn't denote a real error code.
+        #
+        LSP_RESERVED_ERROR_RANGE_START: -32899
+        #
+        # A request failed but it was syntactically correct, e.g the
+        # method name was known and the parameters were valid. The error
+        # message should contain human readable information about why
+        # the request failed.
+        #
+        REQUEST_FAILED: -32803
+        #
+        # The server cancelled the request. This error code should
+        # only be used for requests that explicitly support being
+        # server cancellable.
+        #
+        SERVER_CANCELLED: -32802
+        #
+        # The server detected that the content of a document got
+        # modified outside normal conditions. A server should
+        # NOT send this error code if it detects a content change
+        # in it unprocessed messages. The result even computed
+        # on an older state might still be useful for the client.
+        #
+        # If a client decides that a result is not of any use anymore
+        # the client should cancel the request.
+        #
+        CONTENT_MODIFIED: -32801
+        #
+        # The client has canceled a request and a server as detected
+        # the cancel.
+        #
+        REQUEST_CANCELLED: -32800
+        #
+        # This is the end range of LSP reserved error codes.
+        # It doesn't denote a real error code.
+        #
+        LSP_RESERVED_ERROR_RANGE_END: -32800
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/failure_handling_kind.rbs

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module FailureHandlingKind
+        #
+        # Applying the workspace change is simply aborted if one of the changes
+        # provided fails. All operations executed before the failing operation
+        # stay executed.
+        #
+        ABORT: 'abort'
+        #
+        # All operations are executed transactional. That means they either all
+        # succeed or no changes at all are applied to the workspace.
+        #
+        TRANSACTIONAL: 'transactional'
+        #
+        # If the workspace edit contains only textual file changes they are
+        # executed transactional. If resource changes (create, rename or delete
+        # file) are part of the change the failure handling strategy is abort.
+        #
+        TEXT_ONLY_TRANSACTIONAL: 'textOnlyTransactional'
+        #
+        # The client tries to undo the operations already executed. But there is no
+        # guarantee that this is succeeding.
+        #
+        UNDO: 'undo'
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/file_change_type.rbs

@@ -0,0 +1,23 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # The file event type.
+      #
+      module FileChangeType
+        #
+        # The file got created.
+        #
+        CREATED: 1
+        #
+        # The file got changed.
+        #
+        CHANGED: 2
+        #
+        # The file got deleted.
+        #
+        DELETED: 3
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/file_operation_pattern_kind.rbs

@@ -0,0 +1,20 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # A pattern kind describing if a glob pattern matches a file a folder or
+      # both.
+      #
+      module FileOperationPatternKind
+        #
+        # The pattern matches a file only.
+        #
+        FILE: 'file'
+        #
+        # The pattern matches a folder only.
+        #
+        FOLDER: 'folder'
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/folding_range_kind.rbs

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # A set of predefined range kinds.
+      # The type is a string since the value set is extensible
+      #
+      module FoldingRangeKind
+        #
+        # Folding range for a comment
+        #
+        COMMENT: 'comment'
+        #
+        # Folding range for imports or includes
+        #
+        IMPORTS: 'imports'
+        #
+        # Folding range for a region (e.g. `#region`)
+        #
+        REGION: 'region'
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/initialize_error_codes.rbs

@@ -0,0 +1,18 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Known error codes for an `InitializeErrorCodes`;
+      #
+      module InitializeErrorCodes
+        #
+        # If the protocol version provided by the client can't be handled by
+        # the server.
+        #
+        # There is no version handshake in version 3.0x
+        #
+        UNKNOWN_PROTOCOL_VERSION: 1
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/inlay_hint_kind.rbs

@@ -0,0 +1,19 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Inlay hint kinds.
+      #
+      module InlayHintKind
+        #
+        # An inlay hint that for a type annotation.
+        #
+        TYPE: 1
+        #
+        # An inlay hint that is for a parameter.
+        #
+        PARAMETER: 2
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/insert_text_format.rbs

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Defines whether the insert text in a completion item should be interpreted as
+      # plain text or a snippet.
+      #
+      module InsertTextFormat
+        #
+        # The primary text to be inserted is treated as a plain string.
+        #
+        PLAIN_TEXT: 1
+        #
+        # The primary text to be inserted is treated as a snippet.
+        #
+        # A snippet can define tab stops and placeholders with `$1`, `$2`
+        # and `${3:foo}`. `$0` defines the final tab stop, it defaults to
+        # the end of the snippet. Placeholders with equal identifiers are linked,
+        # that is typing in one will update others too.
+        #
+        SNIPPET: 2
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/insert_text_mode.rbs

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # How whitespace and indentation is handled during completion
+      # item insertion.
+      #
+      module InsertTextMode
+        #
+        # The insertion or replace strings is taken as it is. If the
+        # value is multi line the lines below the cursor will be
+        # inserted using the indentation defined in the string value.
+        # The client will not apply any kind of adjustments to the
+        # string.
+        #
+        AS_IS: 1
+        #
+        # The editor adjusts leading whitespace of new lines so that
+        # they match the indentation up to the cursor of the line for
+        # which the item is accepted.
+        #
+        # Consider a line like this: <2tabs><cursor><3tabs>foo. Accepting a
+        # multi line completion item is indented using 2 tabs and all
+        # following lines inserted will be indented using 2 tabs as well.
+        #
+        ADJUST_INDENTATION: 2
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/lsp_error_codes.rbs

@@ -0,0 +1,41 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module LSPErrorCodes
+        #
+        # A request failed but it was syntactically correct, e.g the
+        # method name was known and the parameters were valid. The error
+        # message should contain human readable information about why
+        # the request failed.
+        #
+        # @since 3.17.0
+        #
+        REQUEST_FAILED: -32803
+        #
+        # The server cancelled the request. This error code should
+        # only be used for requests that explicitly support being
+        # server cancellable.
+        #
+        # @since 3.17.0
+        #
+        SERVER_CANCELLED: -32802
+        #
+        # The server detected that the content of a document got
+        # modified outside normal conditions. A server should
+        # NOT send this error code if it detects a content change
+        # in it unprocessed messages. The result even computed
+        # on an older state might still be useful for the client.
+        #
+        # If a client decides that a result is not of any use anymore
+        # the client should cancel the request.
+        #
+        CONTENT_MODIFIED: -32801
+        #
+        # The client has canceled a request and a server as detected
+        # the cancel.
+        #
+        REQUEST_CANCELLED: -32800
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/markup_kind.rbs

@@ -0,0 +1,23 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Describes the content type that a client supports in various
+      # result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
+      #
+      # Please note that `MarkupKinds` must not start with a `$`. This kinds
+      # are reserved for internal usage.
+      #
+      module MarkupKind
+        #
+        # Plain text is supported as a content format
+        #
+        PLAIN_TEXT: 'plaintext'
+        #
+        # Markdown is supported as a content format
+        #
+        MARKDOWN: 'markdown'
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/message_type.rbs

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module MessageType
+        #
+        # An error message.
+        #
+        ERROR: 1
+        #
+        # A warning message.
+        #
+        WARNING: 2
+        #
+        # An information message.
+        #
+        INFO: 3
+        #
+        # A log message.
+        #
+        LOG: 4
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/moniker_kind.rbs

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # The moniker kind.
+      #
+      module MonikerKind
+        #
+        # The moniker represent a symbol that is imported into a project
+        #
+        IMPORT: 'import'
+        #
+        # The moniker represents a symbol that is exported from a project
+        #
+        EXPORT: 'export'
+        #
+        # The moniker represents a symbol that is local to a project (e.g. a local
+        # variable of a function, a class not visible outside the project, ...)
+        #
+        LOCAL: 'local'
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/notebook_cell_kind.rbs

@@ -0,0 +1,19 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # A notebook cell kind.
+      #
+      module NotebookCellKind
+        #
+        # A markup-cell is formatted source that is used for display.
+        #
+        MARKUP: 1
+        #
+        # A code-cell is source code.
+        #
+        CODE: 2
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/position_encoding_kind.rbs

@@ -0,0 +1,32 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # A type indicating how positions are encoded,
+      # specifically what column offsets mean.
+      # A set of predefined position encoding kinds.
+      #
+      module PositionEncodingKind
+        #
+        # Character offsets count UTF-8 code units (e.g bytes).
+        #
+        UTF8: 'utf-8'
+        #
+        # Character offsets count UTF-16 code units.
+        #
+        # This is the default and must always be supported
+        # by servers
+        #
+        UTF16: 'utf-16'
+        #
+        # Character offsets count UTF-32 code units.
+        #
+        # Implementation note: these are the same as Unicode code points,
+        # so this `PositionEncodingKind` may also be used for an
+        # encoding-agnostic representation of character offsets.
+        #
+        UTF32: 'utf-32'
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/prepare_support_default_behavior.rbs

@@ -0,0 +1,13 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module PrepareSupportDefaultBehavior
+        #
+        # The client's default behavior is to select the identifier
+        # according to the language's syntax rule.
+        #
+        IDENTIFIER: 1
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/resource_operation_kind.rbs

@@ -0,0 +1,23 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # The kind of resource operations supported by the client.
+      #
+      module ResourceOperationKind
+        #
+        # Supports creating new files and folders.
+        #
+        CREATE: 'create'
+        #
+        # Supports renaming existing files and folders.
+        #
+        RENAME: 'rename'
+        #
+        # Supports deleting existing files and folders.
+        #
+        DELETE: 'delete'
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/semantic_token_modifiers.rbs

@@ -0,0 +1,18 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module SemanticTokenModifiers
+        DECLARATION: 'declaration'
+        DEFINITION: 'definition'
+        READONLY: 'readonly'
+        STATIC: 'static'
+        DEPRECATED: 'deprecated'
+        ABSTRACT: 'abstract'
+        ASYNC: 'async'
+        MODIFICATION: 'modification'
+        DOCUMENTATION: 'documentation'
+        DEFAULT_LIBRARY: 'defaultLibrary'
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/semantic_token_types.rbs

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module SemanticTokenTypes
+        NAMESPACE: 'namespace'
+        #
+        # Represents a generic type. Acts as a fallback for types which
+        # can't be mapped to a specific type like class or enum.
+        #
+        TYPE: 'type'
+        CLASS: 'class'
+        ENUM: 'enum'
+        INTERFACE: 'interface'
+        STRUCT: 'struct'
+        TYPE_PARAMETER: 'typeParameter'
+        PARAMETER: 'parameter'
+        VARIABLE: 'variable'
+        PROPERTY: 'property'
+        ENUM_MEMBER: 'enumMember'
+        EVENT: 'event'
+        FUNCTION: 'function'
+        METHOD: 'method'
+        MACRO: 'macro'
+        KEYWORD: 'keyword'
+        MODIFIER: 'modifier'
+        COMMENT: 'comment'
+        STRING: 'string'
+        NUMBER: 'number'
+        REGEXP: 'regexp'
+        OPERATOR: 'operator'
+        DECORATOR: 'decorator'
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/signature_help_trigger_kind.rbs

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # How a signature help was triggered.
+      #
+      module SignatureHelpTriggerKind
+        #
+        # Signature help was invoked manually by the user or by a command.
+        #
+        INVOKED: 1
+        #
+        # Signature help was triggered by a trigger character.
+        #
+        TRIGGER_CHARACTER: 2
+        #
+        # Signature help was triggered by the cursor moving or by the document
+        # content changing.
+        #
+        CONTENT_CHANGE: 3
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/symbol_kind.rbs

@@ -0,0 +1,37 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # A symbol kind.
+      #
+      module SymbolKind
+        FILE: 1
+        MODULE: 2
+        NAMESPACE: 3
+        PACKAGE: 4
+        CLASS: 5
+        METHOD: 6
+        PROPERTY: 7
+        FIELD: 8
+        CONSTRUCTOR: 9
+        ENUM: 10
+        INTERFACE: 11
+        FUNCTION: 12
+        VARIABLE: 13
+        CONSTANT: 14
+        STRING: 15
+        NUMBER: 16
+        BOOLEAN: 17
+        ARRAY: 18
+        OBJECT: 19
+        KEY: 20
+        NULL: 21
+        ENUM_MEMBER: 22
+        STRUCT: 23
+        EVENT: 24
+        OPERATOR: 25
+        TYPE_PARAMETER: 26
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/symbol_tag.rbs

@@ -0,0 +1,15 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Symbol tags are extra annotations that tweak the rendering of a symbol.
+      #
+      module SymbolTag
+        #
+        # Render a symbol as obsolete, usually using a strike-out.
+        #
+        DEPRECATED: 1
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/text_document_save_reason.rbs

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Represents reasons why a text document is saved.
+      #
+      module TextDocumentSaveReason
+        #
+        # Manually triggered, e.g. by the user pressing save, by starting
+        # debugging, or by an API call.
+        #
+        MANUAL: 1
+        #
+        # Automatic after a delay.
+        #
+        AFTER_DELAY: 2
+        #
+        # When the editor lost focus.
+        #
+        FOCUS_OUT: 3
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/text_document_sync_kind.rbs

@@ -0,0 +1,27 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Defines how the host (editor) should sync document changes to the language
+      # server.
+      #
+      module TextDocumentSyncKind
+        #
+        # Documents should not be synced at all.
+        #
+        NONE: 0
+        #
+        # Documents are synced by always sending the full content
+        # of the document.
+        #
+        FULL: 1
+        #
+        # Documents are synced by sending the full content on open.
+        # After that only incremental updates to the document are
+        # sent.
+        #
+        INCREMENTAL: 2
+      end
+    end
+  end
+end

data/sig/language_server/protocol/constant/token_format.rbs

@@ -0,0 +1,9 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module TokenFormat
+        RELATIVE: 'relative'
+      end
+    end
+  end
+end