language_server-protocol 3.17.0.0 → 3.17.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8b12f6835b7cca36a672a8afc09734c35c01d161d6114ba629df50b8769c182
-  data.tar.gz: 3518d1ed28dbb882685c35f687d96bb8a838ba8c733c1797fa1f273382a6e391
+  metadata.gz: 8d0ef69a63029bb6549f0f443e2846b9f87c73f2be7bc6f77f55c1f3819c7a91
+  data.tar.gz: 8e37d30d98a0eeebe04e64facf0f8ec0279682493a24da9a6640e465c56db30e
 SHA512:
-  metadata.gz: 474dcb382b626379424257691e35c0b739182bb201f35b843eab1d860f4f165aad509405fd050c6852d06b0ac2f72809cf7556af7cd9051867a832baa2663630
-  data.tar.gz: 86d984fd5d02006d904233422700c52a9b647fbcbe7c838fcc07dfb68d2b6571d9506930fda0cfc42eb861db12730c0832bad1f820284e8cd1d1bad4ab380611
+  metadata.gz: 6fa49ebff9f6bb27a37505a95bd1b93eb9d4bc019fc30fbe343fb4662f3fbde870cbf78a1853e4e4ca604d9bd0860508978a0ee575c0d810da8047e77573671a
+  data.tar.gz: 7b3da282738febb911ab3f2f9a8d31e4ae4e4fc9249a80c1b702cd0aff75d67a047ed0963bfdcb9f91135e7ea650b1765a231c29c328bfb937a3e307a0a4e97d

data/lib/language_server/protocol/constant/code_action_kind.rb

@@ -2,23 +2,30 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # A set of predefined code action kinds
+      # The kind of a code action.
+      #
+      # Kinds are a hierarchical list of identifiers separated by `.`,
+      # e.g. `"refactor.extract.function"`.
+      #
+      # The set of kinds is open and client needs to announce the kinds it supports
+      # to the server during initialization.
+      # A set of predefined code action kinds.
       #
       module CodeActionKind
         #
         # Empty kind.
         #
-        EMPTY = ""
+        EMPTY = ''
         #
-        # Base kind for quickfix actions: 'quickfix'
+        # Base kind for quickfix actions: 'quickfix'.
         #
-        QUICK_FIX = "quickfix"
+        QUICK_FIX = 'quickfix'
         #
-        # Base kind for refactoring actions: 'refactor'
+        # Base kind for refactoring actions: 'refactor'.
         #
-        REFACTOR = "refactor"
+        REFACTOR = 'refactor'
         #
-        # Base kind for refactoring extraction actions: 'refactor.extract'
+        # Base kind for refactoring extraction actions: 'refactor.extract'.
         #
         # Example extract actions:
         #
@@ -28,9 +35,9 @@ module LanguageServer
         # - Extract interface from class
         # - ...
         #
-        REFACTOR_EXTRACT = "refactor.extract"
+        REFACTOR_EXTRACT = 'refactor.extract'
         #
-        # Base kind for refactoring inline actions: 'refactor.inline'
+        # Base kind for refactoring inline actions: 'refactor.inline'.
         #
         # Example inline actions:
         #
@@ -39,9 +46,9 @@ module LanguageServer
         # - Inline constant
         # - ...
         #
-        REFACTOR_INLINE = "refactor.inline"
+        REFACTOR_INLINE = 'refactor.inline'
         #
-        # Base kind for refactoring rewrite actions: 'refactor.rewrite'
+        # Base kind for refactoring rewrite actions: 'refactor.rewrite'.
         #
         # Example rewrite actions:
         #
@@ -52,26 +59,26 @@ module LanguageServer
         # - Move method to base class
         # - ...
         #
-        REFACTOR_REWRITE = "refactor.rewrite"
+        REFACTOR_REWRITE = 'refactor.rewrite'
         #
-        # Base kind for source actions: `source`
+        # Base kind for source actions: `source`.
         #
         # Source code actions apply to the entire file.
         #
-        SOURCE = "source"
-        #
-        # Base kind for an organize imports source action: `source.organizeImports`
+        SOURCE = 'source'
         #
-        SOURCE_ORGANIZE_IMPORTS = "source.organizeImports"
+        # Base kind for an organize imports source action:
+        # `source.organizeImports`.
         #
-        # Base kind for auto-fix source actions: `source.fixAll`.
+        SOURCE_ORGANIZE_IMPORTS = 'source.organizeImports'
         #
-        # Fix all actions automatically fix errors that have a clear fix that do not require user input.
-        # They should not suppress errors or perform unsafe fixes such as generating new types or classes.
+        # Base kind for a 'fix all' source action: `source.fixAll`.
         #
-        # @since 3.15.0
+        # 'Fix all' actions automatically fix errors that have a clear fix that
+        # do not require user input. They should not suppress errors or perform
+        # unsafe fixes such as generating new types or classes.
         #
-        SOURCE_FIX_ALL = "source.fixAll"
+        SOURCE_FIX_ALL = 'source.fixAll'
       end
     end
   end

data/lib/language_server/protocol/constant/code_action_trigger_kind.rb

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # The reason why code actions were requested.
       #
-      # @since 3.17.0
-      #
       module CodeActionTriggerKind
         #
         # Code actions were explicitly requested by the user or by an extension.

data/lib/language_server/protocol/constant/completion_item_tag.rb

@@ -2,10 +2,8 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # Completion item tags are extra annotations that tweak the rendering of a completion
-      # item.
-      #
-      # @since 3.15.0
+      # Completion item tags are extra annotations that tweak the rendering of a
+      # completion item.
       #
       module CompletionItemTag
         #

data/lib/language_server/protocol/constant/completion_trigger_kind.rb

@@ -12,11 +12,12 @@ module LanguageServer
         INVOKED = 1
         #
         # Completion was triggered by a trigger character specified by
-        # the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
+        # the `triggerCharacters` properties of the
+        # `CompletionRegistrationOptions`.
         #
         TRIGGER_CHARACTER = 2
         #
-        # Completion was re-triggered as current completion list is incomplete
+        # Completion was re-triggered as the current completion list is incomplete.
         #
         TRIGGER_FOR_INCOMPLETE_COMPLETIONS = 3
       end

data/lib/language_server/protocol/constant/diagnostic_severity.rb

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Constant
-      #
-      # The diagnostic's severity.
-      #
       module DiagnosticSeverity
         #
         # Reports an error.

data/lib/language_server/protocol/constant/diagnostic_tag.rb

@@ -4,14 +4,12 @@ module LanguageServer
       #
       # The diagnostic tags.
       #
-      # @since 3.15.0
-      #
       module DiagnosticTag
         #
         # Unused or unnecessary code.
         #
-        # Clients are allowed to render diagnostics with this tag faded out instead of having
-        # an error squiggle.
+        # Clients are allowed to render diagnostics with this tag faded out
+        # instead of having an error squiggle.
         #
         UNNECESSARY = 1
         #

data/lib/language_server/protocol/constant/document_diagnostic_report_kind.rb

@@ -0,0 +1,21 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # The document diagnostic report kinds.
+      #
+      module DocumentDiagnosticReportKind
+        #
+        # A diagnostic report with a full
+        # set of problems.
+        #
+        FULL = 'full'
+        #
+        # A report indicating that the last
+        # returned report is still accurate.
+        #
+        UNCHANGED = 'unchanged'
+      end
+    end
+  end
+end

data/lib/language_server/protocol/constant/error_codes.rb

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Constant
-      #
-      # Predefined error codes.
-      #
       module ErrorCodes
         PARSE_ERROR = -32700
         INVALID_REQUEST = -32600
@@ -11,19 +8,14 @@ module LanguageServer
         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 application error codes should
+        # 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.
         #
-        # @since 3.16.0
-        #
         JSONRPC_RESERVED_ERROR_RANGE_START = -32099
-        #
-        # @deprecated use  jsonrpcReservedErrorRangeStart */
-        #
-        SERVER_ERROR_START = -32099
+        SERVER_ERROR_START = JSONRPC_RESERVED_ERROR_RANGE_START
         #
         # Error code indicating that a server received a notification or
         # request before the server has received the `initialize` request.
@@ -31,16 +23,50 @@ module LanguageServer
         SERVER_NOT_INITIALIZED = -32002
         UNKNOWN_ERROR_CODE = -32001
         #
-        # This is the end range of JSON RPC reserved error codes.
+        # This is the end range of JSON-RPC reserved error codes.
         # It doesn't denote a real error code.
         #
-        # @since 3.16.0
-        #
         JSONRPC_RESERVED_ERROR_RANGE_END = -32000
+        SERVER_ERROR_END = JSONRPC_RESERVED_ERROR_RANGE_END
+        #
+        # 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
         #
-        # @deprecated use  jsonrpcReservedErrorRangeEnd */
+        # 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.
         #
-        SERVER_ERROR_END = -32000
+        LSP_RESERVED_ERROR_RANGE_END = -32800
       end
     end
   end

data/lib/language_server/protocol/constant/failure_handling_kind.rb

@@ -3,26 +3,27 @@ module LanguageServer
     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.
+        # 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"
+        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"
+        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.
+        # 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"
+        TEXT_ONLY_TRANSACTIONAL = 'textOnlyTransactional'
         #
         # The client tries to undo the operations already executed. But there is no
         # guarantee that this is succeeding.
         #
-        UNDO = "undo"
+        UNDO = 'undo'
       end
     end
   end

data/lib/language_server/protocol/constant/file_change_type.rb

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # The file event type
+      # The file event type.
       #
       module FileChangeType
         #

data/lib/language_server/protocol/constant/file_operation_pattern_kind.rb

@@ -5,17 +5,15 @@ module LanguageServer
       # A pattern kind describing if a glob pattern matches a file a folder or
       # both.
       #
-      # @since 3.16.0
-      #
       module FileOperationPatternKind
         #
         # The pattern matches a file only.
         #
-        FILE = "file"
+        FILE = 'file'
         #
         # The pattern matches a folder only.
         #
-        FOLDER = "folder"
+        FOLDER = 'folder'
       end
     end
   end

data/lib/language_server/protocol/constant/folding_range_kind.rb

@@ -3,20 +3,21 @@ module LanguageServer
     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"
+        COMMENT = 'comment'
         #
-        # Folding range for an import or include
+        # Folding range for a imports or includes
         #
-        IMPORTS = "imports"
+        IMPORTS = 'imports'
         #
         # Folding range for a region (e.g. `#region`)
         #
-        REGION = "region"
+        REGION = 'region'
       end
     end
   end

data/lib/language_server/protocol/constant/initialize_error_codes.rb

@@ -0,0 +1,16 @@
+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.
+        #
+        UNKNOWN_PROTOCOL_VERSION = 1
+      end
+    end
+  end
+end

data/lib/language_server/protocol/constant/inlay_hint_kind.rb

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Inlay hint kinds.
       #
-      # @since 3.17.0
-      #
       module InlayHintKind
         #
         # An inlay hint that for a type annotation.

data/lib/language_server/protocol/constant/insert_text_format.rb

@@ -18,8 +18,6 @@ module LanguageServer
         # the end of the snippet. Placeholders with equal identifiers are linked,
         # that is typing in one will update others too.
         #
-        # See also: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#snippet_syntax
-        #
         SNIPPET = 2
       end
     end

data/lib/language_server/protocol/constant/insert_text_mode.rb

@@ -5,8 +5,6 @@ module LanguageServer
       # How whitespace and indentation is handled during completion
       # item insertion.
       #
-      # @since 3.16.0
-      #
       module InsertTextMode
         #
         # The insertion or replace strings is taken as it is. If the

data/lib/language_server/protocol/constant/markup_kind.rb

@@ -12,11 +12,11 @@ module LanguageServer
         #
         # Plain text is supported as a content format
         #
-        PLAIN_TEXT = "plaintext"
+        PLAIN_TEXT = 'plaintext'
         #
         # Markdown is supported as a content format
         #
-        MARKDOWN = "markdown"
+        MARKDOWN = 'markdown'
       end
     end
   end

data/lib/language_server/protocol/constant/message_type.rb

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Constant
-      #
-      # The message type
-      #
       module MessageType
         #
         # An error message.

data/lib/language_server/protocol/constant/moniker_kind.rb

@@ -4,22 +4,20 @@ module LanguageServer
       #
       # The moniker kind.
       #
-      # @since 3.16.0
-      #
       module MonikerKind
         #
         # The moniker represent a symbol that is imported into a project
         #
-        IMPORT = "import"
+        IMPORT = 'import'
         #
         # The moniker represents a symbol that is exported from a project
         #
-        EXPORT = "export"
+        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"
+        LOCAL = 'local'
       end
     end
   end

data/lib/language_server/protocol/constant/notebook_cell_kind.rb

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # A notebook cell kind.
       #
-      # @since 3.17.0
-      #
       module NotebookCellKind
         #
         # A markup-cell is formatted source that is used for display.

data/lib/language_server/protocol/constant/position_encoding_kind.rb

@@ -2,22 +2,22 @@ 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.
       #
-      # @since 3.17.0
-      #
       module PositionEncodingKind
         #
         # Character offsets count UTF-8 code units.
         #
-        UTF8 = "utf-8"
+        UTF8 = 'utf-8'
         #
         # Character offsets count UTF-16 code units.
         #
         # This is the default and must always be supported
         # by servers
         #
-        UTF16 = "utf-16"
+        UTF16 = 'utf-16'
         #
         # Character offsets count UTF-32 code units.
         #
@@ -25,7 +25,7 @@ module LanguageServer
         # so this `PositionEncodingKind` may also be used for an
         # encoding-agnostic representation of character offsets.
         #
-        UTF32 = "utf-32"
+        UTF32 = 'utf-32'
       end
     end
   end

data/lib/language_server/protocol/constant/prepare_support_default_behavior.rb

@@ -4,7 +4,7 @@ module LanguageServer
       module PrepareSupportDefaultBehavior
         #
         # The client's default behavior is to select the identifier
-        # according the to language's syntax rule.
+        # according to the language's syntax rule.
         #
         IDENTIFIER = 1
       end

data/lib/language_server/protocol/constant/resource_operation_kind.rb

@@ -1,19 +1,22 @@
 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"
+        CREATE = 'create'
         #
         # Supports renaming existing files and folders.
         #
-        RENAME = "rename"
+        RENAME = 'rename'
         #
         # Supports deleting existing files and folders.
         #
-        DELETE = "delete"
+        DELETE = 'delete'
       end
     end
   end

data/lib/language_server/protocol/constant/semantic_token_modifiers.rb

@@ -1,24 +1,17 @@
 module LanguageServer
   module Protocol
     module Constant
-      #
-      # A set of predefined token modifiers. This set is not fixed
-      # an clients can specify additional token types via the
-      # corresponding client capabilities.
-      #
-      # @since 3.16.0
-      #
       module SemanticTokenModifiers
-        DECLARATION = "declaration"
-        DEFINITION = "definition"
-        READONLY = "readonly"
-        STATIC = "static"
-        DEPRECATED = "deprecated"
-        ABSTRACT = "abstract"
-        ASYNC = "async"
-        MODIFICATION = "modification"
-        DOCUMENTATION = "documentation"
-        DEFAULT_LIBRARY = "defaultLibrary"
+        DECLARATION = 'declaration'
+        DEFINITION = 'definition'
+        READONLY = 'readonly'
+        STATIC = 'static'
+        DEPRECATED = 'deprecated'
+        ABSTRACT = 'abstract'
+        ASYNC = 'async'
+        MODIFICATION = 'modification'
+        DOCUMENTATION = 'documentation'
+        DEFAULT_LIBRARY = 'defaultLibrary'
       end
     end
   end