language_server-protocol 3.14.0.1 → 3.16.0.0

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

@@ -14,7 +14,7 @@ module LanguageServer
         #
         # The text document to change.
         #
-        # @return [VersionedTextDocumentIdentifier]
+        # @return [OptionalVersionedTextDocumentIdentifier]
         def text_document
           attributes.fetch(:textDocument)
         end
@@ -22,7 +22,7 @@ module LanguageServer
         #
         # The edits to be applied.
         #
-        # @return [TextEdit[]]
+        # @return [(TextEdit | AnnotatedTextEdit)[]]
         def edits
           attributes.fetch(:edits)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # General text document registration options.
+      #
       class TextDocumentRegistrationOptions
         def initialize(document_selector:)
           @attributes = {}
@@ -11,10 +14,10 @@ module LanguageServer
         end
 
         #
-        # A document selector to identify the scope of the registration. If set to null
-        # the document selector provided on the client side will be used.
+        # A document selector to identify the scope of the registration. If set to
+        # null the document selector provided on the client side will be used.
         #
-        # @return [DocumentFilter[]]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -5,6 +5,7 @@ module LanguageServer
         def initialize(document_selector:, include_text: nil)
           @attributes = {}
 
+          @attributes[:documentSelector] = document_selector
           @attributes[:includeText] = include_text if include_text
 
           @attributes.freeze

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

@@ -0,0 +1,62 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class TextDocumentSyncClientCapabilities
+        def initialize(dynamic_registration: nil, will_save: nil, will_save_wait_until: nil, did_save: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:willSave] = will_save if will_save
+          @attributes[:willSaveWaitUntil] = will_save_wait_until if will_save_wait_until
+          @attributes[:didSave] = did_save if did_save
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether text document synchronization supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # The client supports sending will save notifications.
+        #
+        # @return [boolean]
+        def will_save
+          attributes.fetch(:willSave)
+        end
+
+        #
+        # The client supports sending a will save request and
+        # waits for a response providing text edits which will
+        # be applied to the document before it is saved.
+        #
+        # @return [boolean]
+        def will_save_wait_until
+          attributes.fetch(:willSaveWaitUntil)
+        end
+
+        #
+        # The client supports did save notifications.
+        #
+        # @return [boolean]
+        def did_save
+          attributes.fetch(:didSave)
+        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/text_document_sync_options.rb

@@ -15,7 +15,8 @@ module LanguageServer
         end
 
         #
-        # Open and close notifications are sent to the server.
+        # Open and close notifications are sent to the server. If omitted open
+        # close notification should not be sent.
         #
         # @return [boolean]
         def open_close
@@ -23,16 +24,19 @@ module LanguageServer
         end
 
         #
-        # Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
-        # and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
+        # Change notifications are sent to the server. See
+        # TextDocumentSyncKind.None, TextDocumentSyncKind.Full and
+        # TextDocumentSyncKind.Incremental. If omitted it defaults to
+        # TextDocumentSyncKind.None.
         #
-        # @return [number]
+        # @return [TextDocumentSyncKind]
         def change
           attributes.fetch(:change)
         end
 
         #
-        # Will save notifications are sent to the server.
+        # If present will save notifications are sent to the server. If omitted
+        # the notification should not be sent.
         #
         # @return [boolean]
         def will_save
@@ -40,7 +44,8 @@ module LanguageServer
         end
 
         #
-        # Will save wait until requests are sent to the server.
+        # If present will save wait until requests are sent to the server. If
+        # omitted the request should not be sent.
         #
         # @return [boolean]
         def will_save_wait_until
@@ -48,9 +53,10 @@ module LanguageServer
         end
 
         #
-        # Save notifications are sent to the server.
+        # If present save notifications are sent to the server. If omitted the
+        # notification should not be sent.
         #
-        # @return [SaveOptions]
+        # @return [boolean | SaveOptions]
         def save
           attributes.fetch(:save)
         end

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

@@ -0,0 +1,44 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class TypeDefinitionClientCapabilities
+        def initialize(dynamic_registration: nil, link_support: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:linkSupport] = link_support if link_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether implementation supports dynamic registration. If this is set to
+        # `true` the client supports the new `TypeDefinitionRegistrationOptions`
+        # return value for the corresponding server capability as well.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # The client supports additional metadata in the form of definition links.
+        #
+        # @return [boolean]
+        def link_support
+          attributes.fetch(:linkSupport)
+        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/type_definition_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class TypeDefinitionOptions < 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/type_definition_params.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class TypeDefinitionParams < 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/type_definition_registration_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class TypeDefinitionRegistrationOptions < StaticRegistrationOptions
+        def initialize(id: nil)
+          @attributes = {}
+
+          @attributes[:id] = id if id
+
+          @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/versioned_text_document_identifier.rb

@@ -5,20 +5,17 @@ module LanguageServer
         def initialize(uri:, version:)
           @attributes = {}
 
+          @attributes[:uri] = uri
           @attributes[:version] = version
 
           @attributes.freeze
         end
 
         #
-        # The version number of this document. If a versioned text document identifier
-        # is sent from the server to the client and the file is not open in the editor
-        # (the server has not received an open notification before) the server can send
-        # `null` to indicate that the version is known and the content on disk is the
-        # truth (as speced with document content ownership).
+        # The version number of this document.
         #
-        # The version number of a document will increase after each change, including
-        # undo/redo. The number doesn't need to be consecutive.
+        # The version number of a document will increase after each change,
+        # including undo/redo. The number doesn't need to be consecutive.
         #
         # @return [number]
         def version

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

@@ -25,7 +25,7 @@ module LanguageServer
         #
         # The 'TextDocumentSaveReason'.
         #
-        # @return [number]
+        # @return [TextDocumentSaveReason]
         def reason
           attributes.fetch(:reason)
         end

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

@@ -0,0 +1,80 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkDoneProgressBegin
+        def initialize(kind:, title:, cancellable: nil, message: nil, percentage: nil)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:title] = title
+          @attributes[:cancellable] = cancellable if cancellable
+          @attributes[:message] = message if message
+          @attributes[:percentage] = percentage if percentage
+
+          @attributes.freeze
+        end
+
+        # @return ["begin"]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # Mandatory title of the progress operation. Used to briefly inform about
+        # the kind of operation being performed.
+        #
+        # Examples: "Indexing" or "Linking dependencies".
+        #
+        # @return [string]
+        def title
+          attributes.fetch(:title)
+        end
+
+        #
+        # Controls if a cancel button should show to allow the user to cancel the
+        # long running operation. Clients that don't support cancellation are
+        # allowed to ignore the setting.
+        #
+        # @return [boolean]
+        def cancellable
+          attributes.fetch(:cancellable)
+        end
+
+        #
+        # Optional, more detailed associated progress message. Contains
+        # complementary information to the `title`.
+        #
+        # Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
+        # If unset, the previous progress message (if any) is still valid.
+        #
+        # @return [string]
+        def message
+          attributes.fetch(:message)
+        end
+
+        #
+        # Optional progress percentage to display (value 100 is considered 100%).
+        # If not provided infinite progress is assumed and clients are allowed
+        # to ignore the `percentage` value in subsequent in report notifications.
+        #
+        # The value should be steadily rising. Clients are free to ignore values
+        # that are not following this rule. The value range is [0, 100]
+        #
+        # @return [number]
+        def percentage
+          attributes.fetch(:percentage)
+        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/work_done_progress_cancel_params.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkDoneProgressCancelParams
+        def initialize(token:)
+          @attributes = {}
+
+          @attributes[:token] = token
+
+          @attributes.freeze
+        end
+
+        #
+        # The token to be used to report progress.
+        #
+        # @return [ProgressToken]
+        def token
+          attributes.fetch(:token)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end