language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -2,9 +2,9 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Represents a related message and source code location for a diagnostic.
-      # This should be used to point to code locations that cause or are related to
-      # a diagnostics, e.g when duplicating a symbol in a scope.
+      # Represents a related message and source code location for a diagnostic. This should be
+      # used to point to code locations that cause or related to a diagnostics, e.g when duplicating
+      # a symbol in a scope.
       #
       class DiagnosticRelatedInformation
         def initialize(location:, message:)

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

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Cancellation data returned from a diagnostic request.
+      #
+      # @since 3.17.0
+      #
+      class DiagnosticServerCancellationData
+        def initialize(retrigger_request:)
+          @attributes = {}
+
+          @attributes[:retriggerRequest] = retrigger_request
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def retrigger_request
+          attributes.fetch(:retriggerRequest)
+        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/diagnostic_workspace_client_capabilities.rb

@@ -0,0 +1,44 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Workspace client capabilities specific to diagnostic pull requests.
+      #
+      # @since 3.17.0
+      #
+      class DiagnosticWorkspaceClientCapabilities
+        def initialize(refresh_support: nil)
+          @attributes = {}
+
+          @attributes[:refreshSupport] = refresh_support if refresh_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether the client implementation supports a refresh request sent from
+        # the server to the client.
+        #
+        # Note that this event is global and will force the client to refresh all
+        # pulled diagnostics currently shown. It should be used with absolute care and
+        # is useful for situation where a server for example detects a project wide
+        # change that requires such a calculation.
+        #
+        # @return [boolean | nil]
+        def refresh_support
+          attributes.fetch(:refreshSupport)
+        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_configuration_client_capabilities.rb

@@ -13,7 +13,7 @@ module LanguageServer
         #
         # Did change configuration notification supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a change configuration notification.
+      #
       class DidChangeConfigurationParams
         def initialize(settings:)
           @attributes = {}
@@ -13,7 +16,7 @@ module LanguageServer
         #
         # The actual changed settings
         #
-        # @return [any]
+        # @return [LSPAny]
         def settings
           attributes.fetch(:settings)
         end

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

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DidChangeConfigurationRegistrationOptions
+        def initialize(section: nil)
+          @attributes = {}
+
+          @attributes[:section] = section if section
+
+          @attributes.freeze
+        end
+
+        # @return [string | string[] | nil]
+        def section
+          attributes.fetch(:section)
+        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_notebook_document_params.rb

@@ -0,0 +1,62 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The params sent in a change notebook document notification.
+      #
+      # @since 3.17.0
+      #
+      class DidChangeNotebookDocumentParams
+        def initialize(notebook_document:, change:)
+          @attributes = {}
+
+          @attributes[:notebookDocument] = notebook_document
+          @attributes[:change] = change
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebook document that did change. The version number points
+        # to the version after all provided changes have been applied. If
+        # only the text document content of a cell changes the notebook version
+        # doesn't necessarily have to change.
+        #
+        # @return [VersionedNotebookDocumentIdentifier]
+        def notebook_document
+          attributes.fetch(:notebookDocument)
+        end
+
+        #
+        # The actual changes to the notebook document.
+        #
+        # The changes describe single state changes to the notebook document.
+        # So if there are two changes c1 (at array index 0) and c2 (at array
+        # index 1) for a notebook in state S then c1 moves the notebook 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 notebook using change events use the following approach:
+        # - start with the same initial content
+        # - apply the 'notebookDocument/didChange' notifications in the order you receive them.
+        # - apply the `NotebookChangeEvent`s in a single notification in the order
+        #   you receive them.
+        #
+        # @return [NotebookDocumentChangeEvent]
+        def change
+          attributes.fetch(:change)
+        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_text_document_params.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The change text document notification's parameters.
+      #
       class DidChangeTextDocumentParams
         def initialize(text_document:, content_changes:)
           @attributes = {}
@@ -22,19 +25,17 @@ module LanguageServer
         end
 
         #
-        # The actual content changes. The content changes describe single state
-        # changes 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'.
+        # The actual content changes. The content changes describe single state changes
+        # 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:
+        # 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
-        # receive them.
-        # - apply the `TextDocumentContentChangeEvent`s in a single notification
-        # in the order you receive them.
+        # - apply the 'textDocument/didChange' notifications in the order you receive 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

@@ -2,24 +2,36 @@ module LanguageServer
   module Protocol
     module Interface
       class DidChangeWatchedFilesClientCapabilities
-        def initialize(dynamic_registration: nil)
+        def initialize(dynamic_registration: nil, relative_pattern_support: nil)
           @attributes = {}
 
           @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:relativePatternSupport] = relative_pattern_support if relative_pattern_support
 
           @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.
+        # 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]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
 
+        #
+        # Whether the client has support for {@link  RelativePattern relative pattern}
+        # or not.
+        #
+        # @since 3.17.0
+        #
+        # @return [boolean | nil]
+        def relative_pattern_support
+          attributes.fetch(:relativePatternSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The watched files change notification's parameters.
+      #
       class DidChangeWatchedFilesParams
         def initialize(changes:)
           @attributes = {}

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 file system change events.
+      # Describe options to be used when registered for text document change events.
       #
       class DidChangeWatchedFilesRegistrationOptions
         def initialize(watchers:)

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a `workspace/didChangeWorkspaceFolders` notification.
+      #
       class DidChangeWorkspaceFoldersParams
         def initialize(event:)
           @attributes = {}

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

@@ -0,0 +1,48 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The params sent in a close notebook document notification.
+      #
+      # @since 3.17.0
+      #
+      class DidCloseNotebookDocumentParams
+        def initialize(notebook_document:, cell_text_documents:)
+          @attributes = {}
+
+          @attributes[:notebookDocument] = notebook_document
+          @attributes[:cellTextDocuments] = cell_text_documents
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebook document that got closed.
+        #
+        # @return [NotebookDocumentIdentifier]
+        def notebook_document
+          attributes.fetch(:notebookDocument)
+        end
+
+        #
+        # The text documents that represent the content
+        # of a notebook cell that got closed.
+        #
+        # @return [TextDocumentIdentifier[]]
+        def cell_text_documents
+          attributes.fetch(:cellTextDocuments)
+        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_close_text_document_params.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters sent in a close text document notification
+      #
       class DidCloseTextDocumentParams
         def initialize(text_document:)
           @attributes = {}

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

@@ -0,0 +1,48 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The params sent in an open notebook document notification.
+      #
+      # @since 3.17.0
+      #
+      class DidOpenNotebookDocumentParams
+        def initialize(notebook_document:, cell_text_documents:)
+          @attributes = {}
+
+          @attributes[:notebookDocument] = notebook_document
+          @attributes[:cellTextDocuments] = cell_text_documents
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebook document that got opened.
+        #
+        # @return [NotebookDocument]
+        def notebook_document
+          attributes.fetch(:notebookDocument)
+        end
+
+        #
+        # The text documents that represent the content
+        # of a notebook cell.
+        #
+        # @return [TextDocumentItem[]]
+        def cell_text_documents
+          attributes.fetch(:cellTextDocuments)
+        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_open_text_document_params.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters sent in an open text document notification
+      #
       class DidOpenTextDocumentParams
         def initialize(text_document:)
           @attributes = {}

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The params sent in a save notebook document notification.
+      #
+      # @since 3.17.0
+      #
+      class DidSaveNotebookDocumentParams
+        def initialize(notebook_document:)
+          @attributes = {}
+
+          @attributes[:notebookDocument] = notebook_document
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebook document that got saved.
+        #
+        # @return [NotebookDocumentIdentifier]
+        def notebook_document
+          attributes.fetch(:notebookDocument)
+        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_save_text_document_params.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters sent in a save text document notification
+      #
       class DidSaveTextDocumentParams
         def initialize(text_document:, text: nil)
           @attributes = {}
@@ -23,7 +26,7 @@ module LanguageServer
         # Optional the content when saved. Depends on the includeText value
         # when the save notification was requested.
         #
-        # @return [string]
+        # @return [string | nil]
         def text
           attributes.fetch(:text)
         end

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

@@ -11,9 +11,11 @@ module LanguageServer
         end
 
         #
-        # Whether document color supports dynamic registration.
+        # Whether implementation supports dynamic registration. If this is set to `true`
+        # the client supports the new `DocumentColorRegistrationOptions` return value
+        # for the corresponding server capability as well.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -10,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -1,42 +1,45 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a [DocumentColorRequest](#DocumentColorRequest).
+      #
       class DocumentColorParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
+        def initialize(text_document:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
+          @attributes[:textDocument] = text_document
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @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
+
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def work_done_token
           attributes.fetch(:workDoneToken)
         end
 
         #
-        # An optional token that a server can use to report partial results (e.g.
-        # streaming) to the client.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end
 
-        #
-        # The text document.
-        #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -2,39 +2,39 @@ module LanguageServer
   module Protocol
     module Interface
       class DocumentColorRegistrationOptions
-        def initialize(document_selector:, id: nil, work_done_progress: nil)
+        def initialize(document_selector:, work_done_progress: nil, id: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:id] = id if id
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:id] = id if id
 
           @attributes.freeze
         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 [DocumentSelector]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # The id used to register the request. The id can be used to deregister
         # the request again. See also Registration#id.
         #
-        # @return [string]
+        # @return [string | nil]
         def id
           attributes.fetch(:id)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         attr_reader :attributes
 
         def to_hash