language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -12,9 +12,9 @@ module LanguageServer
         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]
         def dynamic_registration
@@ -22,9 +22,11 @@ module LanguageServer
         end
 
         #
-        # Whether the client has support for relative patterns
+        # Whether the client has support for {@link  RelativePattern relative pattern}
         # or not.
         #
+        # @since 3.17.0
+        #
         # @return [boolean]
         def relative_pattern_support
           attributes.fetch(:relativePatternSupport)

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # The params sent in a close notebook document notification.
       #
+      # @since 3.17.0
+      #
       class DidCloseNotebookDocumentParams
         def initialize(notebook_document:, cell_text_documents:)
           @attributes = {}

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # The params sent in an open notebook document notification.
       #
+      # @since 3.17.0
+      #
       class DidOpenNotebookDocumentParams
         def initialize(notebook_document:, cell_text_documents:)
           @attributes = {}

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # The params sent in a save notebook document notification.
       #
+      # @since 3.17.0
+      #
       class DidSaveNotebookDocumentParams
         def initialize(notebook_document:)
           @attributes = {}

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 = {}

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

@@ -11,7 +11,9 @@ 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]
         def dynamic_registration

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

@@ -1,17 +1,28 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link 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.
         #
@@ -21,22 +32,14 @@ module LanguageServer
         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]
         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,25 +2,30 @@ 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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
+        # @return [boolean]
+        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.
@@ -30,11 +35,6 @@ module LanguageServer
           attributes.fetch(:id)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -4,36 +4,21 @@ module LanguageServer
       #
       # Parameters of the document diagnostic request.
       #
+      # @since 3.17.0
+      #
       class DocumentDiagnosticParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, identifier: nil, previous_result_id: nil)
+        def initialize(text_document:, identifier: nil, previous_result_id: nil, work_done_token: nil, partial_result_token: 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[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
 
           @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.
         #
@@ -58,6 +43,23 @@ module LanguageServer
           attributes.fetch(:previousResultId)
         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
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,89 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The result of a document diagnostic pull request. A report can
+      # either be a full report containing all diagnostics for the
+      # requested document or an unchanged report indicating that nothing
+      # has changed in terms of diagnostics in comparison to the last
+      # pull request.
+      #
+      # @since 3.17.0
+      #
+      class DocumentDiagnosticReport
+        def initialize(related_documents: nil, kind:, result_id: nil, items: nil)
+          @attributes = {}
+
+          @attributes[:relatedDocuments] = related_documents if related_documents
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id if result_id
+          @attributes[:items] = items if items
+
+          @attributes.freeze
+        end
+
+        #
+        # Diagnostics of related documents. This information is useful
+        # in programming languages where code in a file A can generate
+        # diagnostics in a file B which A depends on. An example of
+        # such a language is C/C++ where marco definitions in a file
+        # a.cpp and result in errors in a header file b.hpp.
+        #
+        # @since 3.17.0
+        #
+        # @return [DocumentUri => FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        end
+
+        #
+        # A full document diagnostic report.
+        #
+        # --- OR ---
+        #
+        # A document diagnostic report indicating
+        # no changes to the last result. A server can
+        # only return `unchanged` if result ids are
+        # provided.
+        #
+        # @return ["full" | "unchanged"]
+        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.
+        #
+        # --- OR ---
+        #
+        # A result id which 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/document_diagnostic_report_partial_result.rb

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A partial result for a document diagnostic report.
       #
+      # @since 3.17.0
+      #
       class DocumentDiagnosticReportPartialResult
         def initialize(related_documents:)
           @attributes = {}
@@ -13,7 +15,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]
+        # @return [DocumentUri => FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport]
         def related_documents
           attributes.fetch(:relatedDocuments)
         end

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

@@ -1,13 +1,20 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A document filter describes a top level text document or
+      # a notebook cell document.
+      #
+      # @since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
+      #
       class DocumentFilter
-        def initialize(language: nil, scheme: nil, pattern: nil)
+        def initialize(language: nil, scheme: nil, pattern: nil, notebook: nil)
           @attributes = {}
 
           @attributes[:language] = language if language
           @attributes[:scheme] = scheme if scheme
           @attributes[:pattern] = pattern if pattern
+          @attributes[:notebook] = notebook if notebook
 
           @attributes.freeze
         end
@@ -15,13 +22,20 @@ module LanguageServer
         #
         # A language id, like `typescript`.
         #
+        # --- OR ---
+        #
+        # A language id like `python`.
+        #
+        # Will be matched against the language id of the
+        # notebook cell document. '*' matches every language.
+        #
         # @return [string]
         def language
           attributes.fetch(:language)
         end
 
         #
-        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+        # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
         #
         # @return [string]
         def scheme
@@ -31,23 +45,22 @@ module LanguageServer
         #
         # A glob pattern, like `*.{ts,js}`.
         #
-        # 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]
         def pattern
           attributes.fetch(:pattern)
         end
 
+        #
+        # A filter that matches against the notebook
+        # containing the notebook cell. If a string
+        # value is provided it matches against the
+        # notebook type. '*' matches every notebook.
+        #
+        # @return [string | NotebookDocumentFilter]
+        def notebook
+          attributes.fetch(:notebook)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities of a {@link DocumentFormattingRequest}.
+      #
       class DocumentFormattingClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a {@link DocumentFormattingRequest}.
+      #
       class DocumentFormattingOptions
         def initialize(work_done_progress: nil)
           @attributes = {}

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

@@ -1,25 +1,20 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a {@link DocumentFormattingRequest}.
+      #
       class DocumentFormattingParams
-        def initialize(work_done_token: nil, text_document:, options:)
+        def initialize(text_document:, options:, work_done_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:options] = options
+          @attributes[:workDoneToken] = work_done_token if work_done_token
 
           @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
-
         #
         # The document to format.
         #
@@ -36,6 +31,14 @@ module LanguageServer
           attributes.fetch(:options)
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link DocumentFormattingRequest}.
+      #
       class DocumentFormattingRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -12,10 +15,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 [DocumentSelector]
+        # @return [DocumentSelector | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -25,7 +25,7 @@ module LanguageServer
         end
 
         #
-        # The highlight kind, default is DocumentHighlightKind.Text.
+        # The highlight kind, default is {@link DocumentHighlightKind.Text text}.
         #
         # @return [DocumentHighlightKind]
         def kind

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client Capabilities for a {@link DocumentHighlightRequest}.
+      #
       class DocumentHighlightClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a {@link DocumentHighlightRequest}.
+      #
       class DocumentHighlightOptions
         def initialize(work_done_progress: nil)
           @attributes = {}

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link DocumentHighlightRequest}.
+      #
       class DocumentHighlightParams
         def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
@@ -38,8 +41,8 @@ module LanguageServer
         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]
         def partial_result_token