language_server-protocol 3.14.0.1 → 3.16.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 421a684037f06cc7621698f2e85f9032a5d8f67a469a4d36266bbdef355af192
-  data.tar.gz: 46566651baf77dc574777806f6b2d0fb8d7a43015380b9f688dc772d0cdf8ac9
+  metadata.gz: 00220a60292ca5389c9c868b6a353365ac849beb73f5c4ae31b2fe232b97cf12
+  data.tar.gz: 6dcfe25b611fb4bc0c2d84b92330d92009d928259cf4ef1c2efb5b64476beede
 SHA512:
-  metadata.gz: bd257d1aab4eb25a25765826ffbe7924d8dc5e76a7645289da8d3863ef7d873156e2ca30bed215768bc873fdf5c9fb29043604d56d4322fcc2a47cdfed00af0d
-  data.tar.gz: 23005ed19a166de779eecd57643d5eebec4c7aad3172a8af50f840080f102248aba6d98df6274a1157c117d85885341b893e871831a1f0629b16783f3e63171a
+  metadata.gz: bca0506fe727899f789680333657d9ff2ec5f7e99124343dc1580cfcfa74e3ff7972da1f35cbd00617df25d0b5dbff8a05a055cdc72fb3cc5f7fff0227df39d8
+  data.tar.gz: 3ae1247e1ecdb1b5e1cf2a357a6b5057ce271707f6975181a1ef7fb51e160f379af7192c34cd72e2fe00bcbcd3061c1f5f87b4b6aaf144da7c524b1f00ebea08

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-:memo: Currently, this gem supports only stdio as transport layer.
+Currently, this gem supports only stdio as transport layer out of box.
 
 ```ruby
 require "language_server-protocol"
@@ -53,6 +53,14 @@ reader.read do |request|
 end
 ```
 
+You can use any IO object as transport layer:
+
+```ruby
+io = StringIO.new
+writer = LSP::Transport::Io::Writer.new(io)
+reader = LSP::Transport::Io::Reader.new(io)
+```
+
 ## Versioning
 
 language_server-protocol gem does NOT use semantic versioning.
@@ -75,4 +83,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.rb

@@ -3,38 +3,56 @@ module LanguageServer
     module Constant
       autoload :CodeActionKind, "language_server/protocol/constant/code_action_kind"
       autoload :CompletionItemKind, "language_server/protocol/constant/completion_item_kind"
+      autoload :CompletionItemTag, "language_server/protocol/constant/completion_item_tag"
       autoload :CompletionTriggerKind, "language_server/protocol/constant/completion_trigger_kind"
       autoload :DiagnosticSeverity, "language_server/protocol/constant/diagnostic_severity"
+      autoload :DiagnosticTag, "language_server/protocol/constant/diagnostic_tag"
       autoload :DocumentHighlightKind, "language_server/protocol/constant/document_highlight_kind"
       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"
       require "language_server/protocol/constant/completion_item_kind"
+      require "language_server/protocol/constant/completion_item_tag"
       require "language_server/protocol/constant/completion_trigger_kind"
       require "language_server/protocol/constant/diagnostic_severity"
+      require "language_server/protocol/constant/diagnostic_tag"
       require "language_server/protocol/constant/document_highlight_kind"
       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/constant/code_action_kind.rb

@@ -4,23 +4,28 @@ 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.
-      # A set of predefined code action kinds
+      # 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
         #
-        # Base kind for quickfix actions: 'quickfix'
+        # Empty kind.
+        #
+        EMPTY = ''
+        #
+        # Base kind for quickfix actions: 'quickfix'.
         #
         QUICK_FIX = 'quickfix'
         #
-        # Base kind for refactoring actions: 'refactor'
+        # Base kind for refactoring actions: 'refactor'.
         #
         REFACTOR = 'refactor'
         #
-        # Base kind for refactoring extraction actions: 'refactor.extract'
+        # Base kind for refactoring extraction actions: 'refactor.extract'.
         #
         # Example extract actions:
         #
@@ -32,7 +37,7 @@ module LanguageServer
         #
         REFACTOR_EXTRACT = 'refactor.extract'
         #
-        # Base kind for refactoring inline actions: 'refactor.inline'
+        # Base kind for refactoring inline actions: 'refactor.inline'.
         #
         # Example inline actions:
         #
@@ -43,7 +48,7 @@ module LanguageServer
         #
         REFACTOR_INLINE = 'refactor.inline'
         #
-        # Base kind for refactoring rewrite actions: 'refactor.rewrite'
+        # Base kind for refactoring rewrite actions: 'refactor.rewrite'.
         #
         # Example rewrite actions:
         #
@@ -56,13 +61,14 @@ module LanguageServer
         #
         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`
+        # 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

@@ -0,0 +1,16 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Completion item tags are extra annotations that tweak the rendering of a
+      # completion item.
+      #
+      module CompletionItemTag
+        #
+        # Render a completion as obsolete, usually using a strike-out.
+        #
+        DEPRECATED = 1
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # The diagnostic tags.
+      #
+      module DiagnosticTag
+        #
+        # Unused or unnecessary code.
+        #
+        # Clients are allowed to render diagnostics with this tag faded out
+        # instead of having an error squiggle.
+        #
+        UNNECESSARY = 1
+        #
+        # Deprecated or obsolete code.
+        #
+        # Clients are allowed to rendered diagnostics with this tag strike through.
+        #
+        DEPRECATED = 2
+      end
+    end
+  end
+end

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

@@ -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/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,7 +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.
       #
       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