language_server-protocol 3.16.0.1 → 3.17.0.0

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

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

@@ -0,0 +1,77 @@
+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:)
+          @attributes = {}
+
+          @attributes[:relatedDocuments] = related_documents if related_documents
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id if result_id
+          @attributes[:items] = 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 | nil]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        end
+
+        #
+        # A full document diagnostic report.
+        #
+        # @return ["full"]
+        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 | nil]
+        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

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A partial result for a document diagnostic report.
+      #
+      # @since 3.17.0
+      #
+      class DocumentDiagnosticReportPartialResult
+        def initialize(related_documents:)
+          @attributes = {}
+
+          @attributes[:relatedDocuments] = related_documents
+
+          @attributes.freeze
+        end
+
+        # @return [DocumentUri => 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_filter.rb

@@ -1,19 +1,26 @@
 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:, scheme: nil, pattern: nil, notebook:)
           @attributes = {}
 
-          @attributes[:language] = language if language
+          @attributes[:language] = language
           @attributes[:scheme] = scheme if scheme
           @attributes[:pattern] = pattern if pattern
+          @attributes[:notebook] = notebook
 
           @attributes.freeze
         end
 
         #
-        # A language id, like `typescript`.
+        # A language id, like `typescript`. */
         #
         # @return [string]
         def language
@@ -21,33 +28,32 @@ module LanguageServer
         end
 
         #
-        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
         #
-        # @return [string]
+        # @return [string | nil]
         def scheme
           attributes.fetch(:scheme)
         end
 
         #
-        # 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`)
+        # A glob pattern, like `*.{ts,js}`. */
         #
-        # @return [string]
+        # @return [string | nil]
         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 [DocumentFormattingRequest](#DocumentFormattingRequest).
+      #
       class DocumentFormattingClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -13,7 +16,7 @@ module LanguageServer
         #
         # Whether formatting supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a [DocumentFormattingRequest](#DocumentFormattingRequest).
+      #
       class DocumentFormattingOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
@@ -10,7 +13,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_formatting_params.rb

@@ -1,25 +1,20 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a [DocumentFormattingRequest](#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 | nil]
+        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 [DocumentFormattingRequest](#DocumentFormattingRequest).
+      #
       class DocumentFormattingRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -12,15 +15,15 @@ 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 | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -25,9 +25,9 @@ module LanguageServer
         end
 
         #
-        # The highlight kind, default is DocumentHighlightKind.Text.
+        # The highlight kind, default is [text](#DocumentHighlightKind.Text).
         #
-        # @return [DocumentHighlightKind]
+        # @return [DocumentHighlightKind | nil]
         def kind
           attributes.fetch(:kind)
         end

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 [DocumentHighlightRequest](#DocumentHighlightRequest).
+      #
       class DocumentHighlightClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -13,7 +16,7 @@ module LanguageServer
         #
         # Whether document highlight supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a [DocumentHighlightRequest](#DocumentHighlightRequest).
+      #
       class DocumentHighlightOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
@@ -10,7 +13,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_highlight_params.rb

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

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

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

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

@@ -2,8 +2,8 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A document link is a range in a text document that links to an internal or
-      # external resource, like another text document or a web site.
+      # A document link is a range in a text document that links to an internal or external resource, like another
+      # text document or a web site.
       #
       class DocumentLink
         def initialize(range:, target: nil, tooltip: nil, data: nil)
@@ -28,7 +28,7 @@ module LanguageServer
         #
         # The uri this link points to. If missing a resolve request is sent later.
         #
-        # @return [string]
+        # @return [string | nil]
         def target
           attributes.fetch(:target)
         end
@@ -36,12 +36,13 @@ module LanguageServer
         #
         # 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.
+        # 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]
+        # @since 3.15.0
+        #
+        # @return [string | nil]
         def tooltip
           attributes.fetch(:tooltip)
         end
@@ -50,7 +51,7 @@ module LanguageServer
         # A data entry field that is preserved on a document link between a
         # DocumentLinkRequest and a DocumentLinkResolveRequest.
         #
-        # @return [any]
+        # @return [LSPAny | nil]
         def data
           attributes.fetch(:data)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The client capabilities of a [DocumentLinkRequest](#DocumentLinkRequest).
+      #
       class DocumentLinkClientCapabilities
         def initialize(dynamic_registration: nil, tooltip_support: nil)
           @attributes = {}
@@ -14,7 +17,7 @@ module LanguageServer
         #
         # Whether document link supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -22,7 +25,9 @@ module LanguageServer
         #
         # Whether the client supports the `tooltip` property on `DocumentLink`.
         #
-        # @return [boolean]
+        # @since 3.15.0
+        #
+        # @return [boolean | nil]
         def tooltip_support
           attributes.fetch(:tooltipSupport)
         end

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

@@ -1,29 +1,32 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a [DocumentLinkRequest](#DocumentLinkRequest).
+      #
       class DocumentLinkOptions
-        def initialize(work_done_progress: nil, resolve_provider: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # Document links have a resolve provider as well.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,42 +1,45 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a [DocumentLinkRequest](#DocumentLinkRequest).
+      #
       class DocumentLinkParams
-        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 document to provide document links for.
+        #
+        # @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 document to provide document links for.
-        #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
-        end
-
         attr_reader :attributes
 
         def to_hash