language_server-protocol 3.15.0.1 → 3.16.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9569616333bfa8cac560d8eb19e79c0078325e0c9805ad93b71e188f86df01ed
-  data.tar.gz: a610b33875a9ec242d72a19cdead030ab3125bc73c674f68c505217960dcb343
+  metadata.gz: cb38ed978207a09954b5a1a62b25b5d5ebaec981d82b9486dbf429c2593a9b5d
+  data.tar.gz: 274301eb1c493d7d408da8b1b723630566a51c803bcc1affe22122ed85e18bba
 SHA512:
-  metadata.gz: b514fafbc7e16989109d19e13d5a744e3e1560ef5214661642e963b4eb68a37694decba47cd61bbfd58d7a54056aa35778a0368a22710617d9ebc4ce3a206770
-  data.tar.gz: a975ab715b6bcc6474e2dac4f755117a77c465153e0abdc30d89a5d9053f5d6314871a0332a693a536767e31f22d1284f49d70ed8202071c95005c715978284c
+  metadata.gz: 57b0e114a97a7313c59c2f34650967dedde4a93faf0ca9cd5ef33deedfa30c7a6609fb0d8decb33fd3e4ebed94a3948b5c20d0b10e2eb41b4812552f67ae0713
+  data.tar.gz: 2faf8f34ce05e565828acc2cc06131e0a7112e2574da38e86e44432a17b536c8312c6ea40f7618617c145e9c17358d8ec926f482d89f73a6ce28fc961bad017b

data/README.md

@@ -2,6 +2,8 @@
 
 A Language Server Protocol SDK for Ruby.
 
+[![Gem Version](https://badge.fury.io/rb/language_server-protocol.svg)](https://badge.fury.io/rb/language_server-protocol)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -83,4 +85,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the LanguageServer::Protocol project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/language_server-protocol/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the LanguageServer::Protocol project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mtsmfm/language_server-protocol/blob/master/CODE_OF_CONDUCT.md).

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

@@ -4,10 +4,11 @@ module LanguageServer
       #
       # The kind of a code action.
       #
-      # Kinds are a hierarchical list of identifiers separated by `.`, e.g. `"refactor.extract.function"`.
+      # 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.
+      # 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
@@ -66,7 +67,8 @@ module LanguageServer
         #
         SOURCE = 'source'
         #
-        # Base kind for an organize imports source action: `source.organizeImports`.
+        # Base kind for an organize imports source action:
+        # `source.organizeImports`.
         #
         SOURCE_ORGANIZE_IMPORTS = 'source.organizeImports'
       end

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

@@ -2,8 +2,8 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # Completion item tags are extra annotations that tweak the rendering of a completion
-      # item.
+      # 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,7 +12,8 @@ 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
         #

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

@@ -8,8 +8,8 @@ module LanguageServer
         #
         # 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/error_codes.rb

@@ -7,12 +7,35 @@ module LanguageServer
         METHOD_NOT_FOUND = -32601
         INVALID_PARAMS = -32602
         INTERNAL_ERROR = -32603
-        SERVER_ERROR_START = -32099
-        SERVER_ERROR_END = -32000
+        #
+        # 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 = JSONRPC_RESERVED_ERROR_RANGE_START
         SERVER_NOT_INITIALIZED = -32002
         UNKNOWN_ERROR_CODE = -32001
-        REQUEST_CANCELLED = -32800
+        #
+        # This is the start range of JSON RPC reserved error codes.
+        # It doesn't denote a real error code.
+        #
+        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
         CONTENT_MODIFIED = -32801
+        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

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

@@ -3,8 +3,9 @@ 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'
         #
@@ -13,9 +14,9 @@ module LanguageServer
         #
         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'
         #

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

@@ -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/lib/language_server/protocol/constant/initialize_error.rb

@@ -6,7 +6,8 @@ module LanguageServer
       #
       module InitializeError
         #
-        # If the protocol version provided by the client can't be handled by the server.
+        # If the protocol version provided by the client can't be handled by the
+        # server.
         #
         UNKNOWN_PROTOCOL_VERSION = 1
       end

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

@@ -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/lib/language_server/protocol/constant/prepare_support_default_behavior.rb

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

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

@@ -14,7 +14,8 @@ module LanguageServer
         #
         TRIGGER_CHARACTER = 2
         #
-        # Signature help was triggered by the cursor moving or by the document content changing.
+        # Signature help was triggered by the cursor moving or by the document
+        # content changing.
         #
         CONTENT_CHANGE = 3
       end

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

@@ -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/lib/language_server/protocol/constant/text_document_save_reason.rb

@@ -6,8 +6,8 @@ module LanguageServer
       #
       module TextDocumentSaveReason
         #
-        # Manually triggered, e.g. by the user pressing save, by starting debugging,
-        # or by an API call.
+        # Manually triggered, e.g. by the user pressing save, by starting
+        # debugging, or by an API call.
         #
         MANUAL = 1
         #

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

@@ -2,8 +2,8 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # Defines how the host (editor) should sync document changes to the language server.
-      # Defines how the host (editor) should sync document changes to the language server.
+      # Defines how the host (editor) should sync document changes to the language
+      # server.
       #
       module TextDocumentSyncKind
         #

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

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

data/lib/language_server/protocol/constant.rb

@@ -11,16 +11,21 @@ module LanguageServer
       autoload :ErrorCodes, "language_server/protocol/constant/error_codes"
       autoload :FailureHandlingKind, "language_server/protocol/constant/failure_handling_kind"
       autoload :FileChangeType, "language_server/protocol/constant/file_change_type"
+      autoload :FileOperationPatternKind, "language_server/protocol/constant/file_operation_pattern_kind"
       autoload :InitializeError, "language_server/protocol/constant/initialize_error"
       autoload :InsertTextFormat, "language_server/protocol/constant/insert_text_format"
+      autoload :InsertTextMode, "language_server/protocol/constant/insert_text_mode"
       autoload :MarkupKind, "language_server/protocol/constant/markup_kind"
       autoload :MessageType, "language_server/protocol/constant/message_type"
+      autoload :PrepareSupportDefaultBehavior, "language_server/protocol/constant/prepare_support_default_behavior"
       autoload :ResourceOperationKind, "language_server/protocol/constant/resource_operation_kind"
       autoload :SignatureHelpTriggerKind, "language_server/protocol/constant/signature_help_trigger_kind"
       autoload :SymbolKind, "language_server/protocol/constant/symbol_kind"
+      autoload :SymbolTag, "language_server/protocol/constant/symbol_tag"
       autoload :TextDocumentSaveReason, "language_server/protocol/constant/text_document_save_reason"
       autoload :TextDocumentSyncKind, "language_server/protocol/constant/text_document_sync_kind"
       autoload :TextDocumentSyncKind, "language_server/protocol/constant/text_document_sync_kind"
+      autoload :TokenFormat, "language_server/protocol/constant/token_format"
       autoload :WatchKind, "language_server/protocol/constant/watch_kind"
 
       require "language_server/protocol/constant/code_action_kind"
@@ -33,16 +38,21 @@ module LanguageServer
       require "language_server/protocol/constant/error_codes"
       require "language_server/protocol/constant/failure_handling_kind"
       require "language_server/protocol/constant/file_change_type"
+      require "language_server/protocol/constant/file_operation_pattern_kind"
       require "language_server/protocol/constant/initialize_error"
       require "language_server/protocol/constant/insert_text_format"
+      require "language_server/protocol/constant/insert_text_mode"
       require "language_server/protocol/constant/markup_kind"
       require "language_server/protocol/constant/message_type"
+      require "language_server/protocol/constant/prepare_support_default_behavior"
       require "language_server/protocol/constant/resource_operation_kind"
       require "language_server/protocol/constant/signature_help_trigger_kind"
       require "language_server/protocol/constant/symbol_kind"
+      require "language_server/protocol/constant/symbol_tag"
       require "language_server/protocol/constant/text_document_save_reason"
       require "language_server/protocol/constant/text_document_sync_kind"
       require "language_server/protocol/constant/text_document_sync_kind"
+      require "language_server/protocol/constant/token_format"
       require "language_server/protocol/constant/watch_kind"
     end
   end

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

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A special text edit with an additional change annotation.
+      #
+      class AnnotatedTextEdit
+        def initialize(range:, new_text:, annotation_id:)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:newText] = new_text
+          @attributes[:annotationId] = annotation_id
+
+          @attributes.freeze
+        end
+
+        #
+        # The range of the text document to be manipulated. To insert
+        # text into a document create a range where start === end.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The string to be inserted. For delete operations use an
+        # empty string.
+        #
+        # @return [string]
+        def new_text
+          attributes.fetch(:newText)
+        end
+
+        #
+        # The actual annotation identifier.
+        #
+        # @return [string]
+        def annotation_id
+          attributes.fetch(:annotationId)
+        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/apply_workspace_edit_response.rb

@@ -2,11 +2,12 @@ module LanguageServer
   module Protocol
     module Interface
       class ApplyWorkspaceEditResponse
-        def initialize(applied:, failure_reason: nil)
+        def initialize(applied:, failure_reason: nil, failed_change: nil)
           @attributes = {}
 
           @attributes[:applied] = applied
           @attributes[:failureReason] = failure_reason if failure_reason
+          @attributes[:failedChange] = failed_change if failed_change
 
           @attributes.freeze
         end
@@ -21,15 +22,25 @@ module LanguageServer
 
         #
         # An optional textual description for why the edit was not applied.
-        # This may be used may be used by the server for diagnostic
-        # logging or to provide a suitable error for a request that
-        # triggered the edit.
+        # This may be used by the server for diagnostic logging or to provide
+        # a suitable error for a request that triggered the edit.
         #
         # @return [string]
         def failure_reason
           attributes.fetch(:failureReason)
         end
 
+        #
+        # Depending on the client's failure handling strategy `failedChange`
+        # might contain the index of the change that failed. This property is
+        # only available if the client signals a `failureHandlingStrategy`
+        # in its client capabilities.
+        #
+        # @return [number]
+        def failed_change
+          attributes.fetch(:failedChange)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class CallHierarchyClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether implementation supports dynamic registration. If this is set to
+        # `true` the client supports the new `(TextDocumentRegistrationOptions &
+        # StaticRegistrationOptions)` return value for the corresponding server
+        # capability as well.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end