language_server-protocol 3.14.0.0 → 3.15.0.2

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

@@ -23,8 +23,16 @@ module LanguageServer
 
         #
         # The actual content changes. The content changes describe single state changes
-        # to the document. So if there are two content changes c1 and c2 for a document
-        # in state S then c1 move the document to S' and c2 to S''.
+        # to the document. So if there are two content changes c1 (at array index 0) and
+        # c2 (at array index 1) for a document in state S then c1 moves the document from
+        # S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed
+        # on the state S'.
+        #
+        # To mirror the content of a document using change events use the following approach:
+        # - start with the same initial content
+        # - apply the 'textDocument/didChange' notifications in the order you recevie them.
+        # - apply the `TextDocumentContentChangeEvent`s in a single notification in the order
+        # you receive them.
         #
         # @return [TextDocumentContentChangeEvent[]]
         def content_changes

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

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DidChangeWatchedFilesClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Did change watched files notification supports dynamic registration. Please note
+        # that the current protocol doesn't support static configuration for file changes
+        # from the server side.
+        #
+        # @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

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Describe options to be used when registering for text document change events.
+      # Describe options to be used when registering for file system change events.
       #
       class DidChangeWatchedFilesRegistrationOptions
         def initialize(watchers:)

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

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentColorClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether document color supports dynamic registration.
+        #
+        # @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

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

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentColorOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        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/document_color_params.rb

@@ -0,0 +1,34 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentColorParams < PartialResultParams
+        def initialize(partial_result_token: nil, text_document:)
+          @attributes = {}
+
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:textDocument] = text_document
+
+          @attributes.freeze
+        end
+
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        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/document_color_registration_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentColorRegistrationOptions < DocumentColorOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        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/document_formatting_client_capabilities.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentFormattingClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether formatting supports dynamic registration.
+        #
+        # @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

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

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentFormattingOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        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/document_formatting_params.rb

@@ -1,10 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      class DocumentFormattingParams
-        def initialize(text_document:, options:)
+      class DocumentFormattingParams < WorkDoneProgressParams
+        def initialize(work_done_token: nil, text_document:, options:)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:options] = options
 

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

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentFormattingRegistrationOptions < DocumentFormattingOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        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/document_highlight_client_capabilities.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentHighlightClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether document highlight supports dynamic registration.
+        #
+        # @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

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

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentHighlightOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        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/document_highlight_params.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentHighlightParams < PartialResultParams
+        def initialize(partial_result_token: nil)
+          @attributes = {}
+
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+
+          @attributes.freeze
+        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/document_highlight_registration_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentHighlightRegistrationOptions < DocumentHighlightOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        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/document_link.rb

@@ -6,11 +6,12 @@ module LanguageServer
       # text document or a web site.
       #
       class DocumentLink
-        def initialize(range:, target: nil, data: nil)
+        def initialize(range:, target: nil, tooltip: nil, data: nil)
           @attributes = {}
 
           @attributes[:range] = range
           @attributes[:target] = target if target
+          @attributes[:tooltip] = tooltip if tooltip
           @attributes[:data] = data if data
 
           @attributes.freeze
@@ -32,6 +33,18 @@ module LanguageServer
           attributes.fetch(:target)
         end
 
+        #
+        # The tooltip text when you hover over this link.
+        #
+        # If a tooltip is provided, is will be displayed in a string that includes instructions on how to
+        # trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
+        # user settings, and localization.
+        #
+        # @return [string]
+        def tooltip
+          attributes.fetch(:tooltip)
+        end
+
         #
         # A data entry field that is preserved on a document link between a
         # DocumentLinkRequest and a DocumentLinkResolveRequest.

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

@@ -0,0 +1,42 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentLinkClientCapabilities
+        def initialize(dynamic_registration: nil, tooltip_support: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:tooltipSupport] = tooltip_support if tooltip_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether document link supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # Whether the client supports the `tooltip` property on `DocumentLink`.
+        #
+        # @return [boolean]
+        def tooltip_support
+          attributes.fetch(:tooltipSupport)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end