language_server-protocol 3.16.0.2 → 3.17.0.1

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

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The params sent in a change notebook document notification.
+      #
+      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.
+        #
+        # @return [VersionedNotebookDocumentIdentifier]
+        def notebook_document
+          attributes.fetch(:notebookDocument)
+        end
+
+        #
+        # The actual changes to the notebook document.
+        #
+        # The change describes single state change to the notebook document.
+        # So it moves a notebook document, its cells and its cell text document
+        # contents from state S to 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.
+        #
+        # @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_watched_files_client_capabilities.rb

@@ -2,10 +2,11 @@ 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
@@ -20,6 +21,15 @@ module LanguageServer
           attributes.fetch(:dynamicRegistration)
         end
 
+        #
+        # Whether the client has support for relative patterns
+        # or not.
+        #
+        # @return [boolean]
+        def relative_pattern_support
+          attributes.fetch(:relativePatternSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,46 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The params sent in a close notebook document notification.
+      #
+      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_open_notebook_document_params.rb

@@ -0,0 +1,46 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The params sent in an open notebook document notification.
+      #
+      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_save_notebook_document_params.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The params sent in a save notebook document notification.
+      #
+      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/document_diagnostic_params.rb

@@ -0,0 +1,73 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Parameters of the document diagnostic request.
+      #
+      class DocumentDiagnosticParams
+        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, identifier: nil, previous_result_id: nil)
+          @attributes = {}
+
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:textDocument] = text_document
+          @attributes[:identifier] = identifier if identifier
+          @attributes[:previousResultId] = previous_result_id if previous_result_id
+
+          @attributes.freeze
+        end
+
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        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.
+        #
+        # @return [ProgressToken]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        end
+
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
+        #
+        # The additional identifier  provided during registration.
+        #
+        # @return [string]
+        def identifier
+          attributes.fetch(:identifier)
+        end
+
+        #
+        # The result id of a previous response if provided.
+        #
+        # @return [string]
+        def previous_result_id
+          attributes.fetch(:previousResultId)
+        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_diagnostic_report_partial_result.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A partial result for a document diagnostic report.
+      #
+      class DocumentDiagnosticReportPartialResult
+        def initialize(related_documents:)
+          @attributes = {}
+
+          @attributes[:relatedDocuments] = related_documents
+
+          @attributes.freeze
+        end
+
+        # @return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        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

@@ -50,7 +50,7 @@ module LanguageServer
         # A data entry field that is preserved on a document link between a
         # DocumentLinkRequest and a DocumentLinkResolveRequest.
         #
-        # @return [any]
+        # @return [LSPAny]
         def data
           attributes.fetch(:data)
         end

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

@@ -12,7 +12,7 @@ module LanguageServer
         end
 
         #
-        # A character on which formatting should be triggered, like `}`.
+        # A character on which formatting should be triggered, like `{`.
         #
         # @return [string]
         def first_trigger_character

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

@@ -14,7 +14,7 @@ module LanguageServer
         end
 
         #
-        # The text document.
+        # The document to format.
         #
         # @return [TextDocumentIdentifier]
         def text_document
@@ -22,7 +22,9 @@ module LanguageServer
         end
 
         #
-        # The position inside the text document.
+        # The position around which the on type formatting should happen.
+        # This is not necessarily the exact position where the character denoted
+        # by the property `ch` got typed.
         #
         # @return [Position]
         def position
@@ -30,7 +32,10 @@ module LanguageServer
         end
 
         #
-        # The character that has been typed.
+        # The character that has been typed that triggered the formatting
+        # on type request. That is not necessarily the last character that
+        # got inserted into the document since the client could auto insert
+        # characters as well (e.g. like automatic brace completion).
         #
         # @return [string]
         def ch
@@ -38,7 +43,7 @@ module LanguageServer
         end
 
         #
-        # The format options.
+        # The formatting options.
         #
         # @return [FormattingOptions]
         def options

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

@@ -22,7 +22,7 @@ module LanguageServer
         end
 
         #
-        # A character on which formatting should be triggered, like `}`.
+        # A character on which formatting should be triggered, like `{`.
         #
         # @return [string]
         def first_trigger_character

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

@@ -44,7 +44,7 @@ module LanguageServer
         #
         # The kind of this symbol.
         #
-        # @return [any]
+        # @return [SymbolKind]
         def kind
           attributes.fetch(:kind)
         end

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

@@ -26,7 +26,7 @@ module LanguageServer
         # Specific capabilities for the `SymbolKind` in the
         # `textDocument/documentSymbol` request.
         #
-        # @return [{ valueSet?: any[]; }]
+        # @return [{ valueSet?: SymbolKind[]; }]
         def symbol_kind
           attributes.fetch(:symbolKind)
         end

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

@@ -31,7 +31,7 @@ module LanguageServer
         #
         # Arguments that the command should be invoked with.
         #
-        # @return [any[]]
+        # @return [LSPAny[]]
         def arguments
           attributes.fetch(:arguments)
         end

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

@@ -0,0 +1,45 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ExecutionSummary
+        def initialize(execution_order:, success: nil)
+          @attributes = {}
+
+          @attributes[:executionOrder] = execution_order
+          @attributes[:success] = success if success
+
+          @attributes.freeze
+        end
+
+        #
+        # A strict monotonically increasing value
+        # indicating the execution order of a cell
+        # inside a notebook.
+        #
+        # @return [number]
+        def execution_order
+          attributes.fetch(:executionOrder)
+        end
+
+        #
+        # Whether the execution was successful or
+        # not if known by the client.
+        #
+        # @return [boolean]
+        def success
+          attributes.fetch(:success)
+        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/file_system_watcher.rb

@@ -12,21 +12,10 @@ module LanguageServer
         end
 
         #
-        # The  glob pattern to watch.
+        # The glob pattern to watch. See {@link GlobPattern glob pattern}
+        # for more detail.
         #
-        # Glob patterns can have the following syntax:
-        # - `*` to match one or more characters in a path segment
-        # - `?` to match on one character in a path segment
-        # - `**` to match any number of path segments, including none
-        # - `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}`
-        # matches all TypeScript and JavaScript files)
-        # - `[]` to declare a range of characters to match in a path segment
-        # (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
-        # - `[!...]` to negate a range of characters to match in a path segment
-        # (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not
-        # `example.0`)
-        #
-        # @return [string]
+        # @return [GlobPattern]
         def glob_pattern
           attributes.fetch(:globPattern)
         end

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

@@ -7,7 +7,7 @@ module LanguageServer
       # are free to ignore invalid ranges.
       #
       class FoldingRange
-        def initialize(start_line:, start_character: nil, end_line:, end_character: nil, kind: nil)
+        def initialize(start_line:, start_character: nil, end_line:, end_character: nil, kind: nil, collapsed_text: nil)
           @attributes = {}
 
           @attributes[:startLine] = start_line
@@ -15,6 +15,7 @@ module LanguageServer
           @attributes[:endLine] = end_line
           @attributes[:endCharacter] = end_character if end_character
           @attributes[:kind] = kind if kind
+          @attributes[:collapsedText] = collapsed_text if collapsed_text
 
           @attributes.freeze
         end
@@ -68,6 +69,16 @@ module LanguageServer
           attributes.fetch(:kind)
         end
 
+        #
+        # The text that the client should show when the specified range is
+        # collapsed. If not defined or not supported by the client, a default
+        # will be chosen by the client.
+        #
+        # @return [string]
+        def collapsed_text
+          attributes.fetch(:collapsedText)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,12 +2,14 @@ module LanguageServer
   module Protocol
     module Interface
       class FoldingRangeClientCapabilities
-        def initialize(dynamic_registration: nil, range_limit: nil, line_folding_only: nil)
+        def initialize(dynamic_registration: nil, range_limit: nil, line_folding_only: nil, folding_range_kind: nil, folding_range: nil)
           @attributes = {}
 
           @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
           @attributes[:rangeLimit] = range_limit if range_limit
           @attributes[:lineFoldingOnly] = line_folding_only if line_folding_only
+          @attributes[:foldingRangeKind] = folding_range_kind if folding_range_kind
+          @attributes[:foldingRange] = folding_range if folding_range
 
           @attributes.freeze
         end
@@ -43,6 +45,22 @@ module LanguageServer
           attributes.fetch(:lineFoldingOnly)
         end
 
+        #
+        # Specific options for the folding range kind.
+        #
+        # @return [{ valueSet?: string[]; }]
+        def folding_range_kind
+          attributes.fetch(:foldingRangeKind)
+        end
+
+        #
+        # Specific options for the folding range.
+        #
+        # @return [{ collapsedText?: boolean; }]
+        def folding_range
+          attributes.fetch(:foldingRange)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A diagnostic report with a full set of problems.
+      #
+      class FullDocumentDiagnosticReport
+        def initialize(kind:, result_id: nil, items:)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id if result_id
+          @attributes[:items] = items
+
+          @attributes.freeze
+        end
+
+        #
+        # A full document diagnostic report.
+        #
+        # @return [any]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # An optional result id. If provided it will
+        # be sent on the next diagnostic request for the
+        # same document.
+        #
+        # @return [string]
+        def result_id
+          attributes.fetch(:resultId)
+        end
+
+        #
+        # The actual items.
+        #
+        # @return [Diagnostic[]]
+        def items
+          attributes.fetch(:items)
+        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/hover_client_capabilities.rb

@@ -20,7 +20,7 @@ module LanguageServer
         end
 
         #
-        # Client supports the following content formats if the content
+        # Client supports the follow content formats if the content
         # property refers to a `literal of type MarkupContent`.
         # The order describes the preferred format of the client.
         #

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

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Known error codes for an `InitializeError`;
-      #
       class InitializeError
         def initialize(retry:)
           @attributes = {}

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

@@ -81,7 +81,7 @@ module LanguageServer
         #
         # User provided initialization options.
         #
-        # @return [any]
+        # @return [LSPAny]
         def initialization_options
           attributes.fetch(:initializationOptions)
         end