language_server-protocol 3.17.0.6 → 3.18.0.0.pre.1

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

@@ -8,8 +8,8 @@ module LanguageServer
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:linkSupport] = link_support if link_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:linkSupport] = link_support unless link_support.nil?
 
           @attributes.freeze
         end

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

@@ -5,7 +5,7 @@ module LanguageServer
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -7,8 +7,8 @@ module LanguageServer
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end

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

@@ -5,9 +5,9 @@ module LanguageServer
         def initialize(work_done_progress: nil, document_selector:, id: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
           @attributes[:documentSelector] = document_selector
-          @attributes[:id] = id if id
+          @attributes[:id] = id unless id.nil?
 
           @attributes.freeze
         end

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

@@ -8,8 +8,8 @@ module LanguageServer
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:linkSupport] = link_support if link_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:linkSupport] = link_support unless link_support.nil?
 
           @attributes.freeze
         end

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

@@ -8,7 +8,7 @@ module LanguageServer
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -10,8 +10,8 @@ module LanguageServer
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end

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

@@ -9,7 +9,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -10,8 +10,8 @@ module LanguageServer
 
           @attributes[:kind] = kind
           @attributes[:uri] = uri
-          @attributes[:options] = options if options
-          @attributes[:annotationId] = annotation_id if annotation_id
+          @attributes[:options] = options unless options.nil?
+          @attributes[:annotationId] = annotation_id unless annotation_id.nil?
 
           @attributes.freeze
         end

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

@@ -8,8 +8,8 @@ module LanguageServer
         def initialize(recursive: nil, ignore_if_not_exists: nil)
           @attributes = {}
 
-          @attributes[:recursive] = recursive if recursive
-          @attributes[:ignoreIfNotExists] = ignore_if_not_exists if ignore_if_not_exists
+          @attributes[:recursive] = recursive unless recursive.nil?
+          @attributes[:ignoreIfNotExists] = ignore_if_not_exists unless ignore_if_not_exists.nil?
 
           @attributes.freeze
         end

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

@@ -10,14 +10,14 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:range] = range
-          @attributes[:severity] = severity if severity
-          @attributes[:code] = code if code
-          @attributes[:codeDescription] = code_description if code_description
-          @attributes[:source] = source if source
+          @attributes[:severity] = severity unless severity.nil?
+          @attributes[:code] = code unless code.nil?
+          @attributes[:codeDescription] = code_description unless code_description.nil?
+          @attributes[:source] = source unless source.nil?
           @attributes[:message] = message
-          @attributes[:tags] = tags if tags
-          @attributes[:relatedInformation] = related_information if related_information
-          @attributes[:data] = data if data
+          @attributes[:tags] = tags unless tags.nil?
+          @attributes[:relatedInformation] = related_information unless related_information.nil?
+          @attributes[:data] = data unless data.nil?
 
           @attributes.freeze
         end
@@ -31,8 +31,9 @@ module LanguageServer
         end
 
         #
-        # The diagnostic's severity. Can be omitted. If omitted it is up to the
-        # client to interpret diagnostics as error, warning, info or hint.
+        # The diagnostic's severity. To avoid interpretation mismatches when a
+        # server is used with different clients it is highly recommended that servers
+        # always provide a severity value.
         #
         # @return [DiagnosticSeverity]
         def severity
@@ -69,9 +70,12 @@ module LanguageServer
         end
 
         #
-        # The diagnostic's message. It usually appears in the user interface
+        # The diagnostic's message. It usually appears in the user interface.
         #
-        # @return [string]
+        # @since 3.18.0 - support for MarkupContent. This is guarded by the client
+        # capability `textDocument.diagnostic.markupMessageSupport`.
+        #
+        # @return [string | MarkupContent]
         def message
           attributes.fetch(:message)
         end

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

@@ -7,11 +7,16 @@ module LanguageServer
       # @since 3.17.0
       #
       class DiagnosticClientCapabilities
-        def initialize(dynamic_registration: nil, related_document_support: nil)
+        def initialize(dynamic_registration: nil, related_document_support: nil, markup_message_support: nil, related_information: nil, tag_support: nil, code_description_support: nil, data_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:relatedDocumentSupport] = related_document_support if related_document_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:relatedDocumentSupport] = related_document_support unless related_document_support.nil?
+          @attributes[:markupMessageSupport] = markup_message_support unless markup_message_support.nil?
+          @attributes[:relatedInformation] = related_information unless related_information.nil?
+          @attributes[:tagSupport] = tag_support unless tag_support.nil?
+          @attributes[:codeDescriptionSupport] = code_description_support unless code_description_support.nil?
+          @attributes[:dataSupport] = data_support unless data_support.nil?
 
           @attributes.freeze
         end
@@ -34,6 +39,57 @@ module LanguageServer
           attributes.fetch(:relatedDocumentSupport)
         end
 
+        #
+        # Whether the client supports `MarkupContent` in diagnostic messages.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def markup_message_support
+          attributes.fetch(:markupMessageSupport)
+        end
+
+        #
+        # Whether the clients accepts diagnostics with related information.
+        #
+        # @return [boolean]
+        def related_information
+          attributes.fetch(:relatedInformation)
+        end
+
+        #
+        # Client supports the tag property to provide meta data about a diagnostic.
+        # Clients supporting tags have to handle unknown tags gracefully.
+        #
+        # @since 3.15.0
+        #
+        # @return [ClientDiagnosticsTagOptions]
+        def tag_support
+          attributes.fetch(:tagSupport)
+        end
+
+        #
+        # Client supports a codeDescription property
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean]
+        def code_description_support
+          attributes.fetch(:codeDescriptionSupport)
+        end
+
+        #
+        # Whether code action supports the `data` property which is
+        # preserved between a `textDocument/publishDiagnostics` and
+        # `textDocument/codeAction` request.
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean]
+        def data_support
+          attributes.fetch(:dataSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -10,10 +10,10 @@ module LanguageServer
         def initialize(identifier: nil, inter_file_dependencies:, workspace_diagnostics:, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:identifier] = identifier if identifier
+          @attributes[:identifier] = identifier unless identifier.nil?
           @attributes[:interFileDependencies] = inter_file_dependencies
           @attributes[:workspaceDiagnostics] = workspace_diagnostics
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -11,11 +11,11 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:identifier] = identifier if identifier
+          @attributes[:identifier] = identifier unless identifier.nil?
           @attributes[:interFileDependencies] = inter_file_dependencies
           @attributes[:workspaceDiagnostics] = workspace_diagnostics
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:id] = id if id
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+          @attributes[:id] = id unless id.nil?
 
           @attributes.freeze
         end

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

@@ -10,7 +10,7 @@ module LanguageServer
         def initialize(refresh_support: nil)
           @attributes = {}
 
-          @attributes[:refreshSupport] = refresh_support if refresh_support
+          @attributes[:refreshSupport] = refresh_support unless refresh_support.nil?
 
           @attributes.freeze
         end

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

@@ -0,0 +1,72 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # General diagnostics capabilities for pull and push model.
+      #
+      class DiagnosticsCapabilities
+        def initialize(related_information: nil, tag_support: nil, code_description_support: nil, data_support: nil)
+          @attributes = {}
+
+          @attributes[:relatedInformation] = related_information unless related_information.nil?
+          @attributes[:tagSupport] = tag_support unless tag_support.nil?
+          @attributes[:codeDescriptionSupport] = code_description_support unless code_description_support.nil?
+          @attributes[:dataSupport] = data_support unless data_support.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether the clients accepts diagnostics with related information.
+        #
+        # @return [boolean]
+        def related_information
+          attributes.fetch(:relatedInformation)
+        end
+
+        #
+        # Client supports the tag property to provide meta data about a diagnostic.
+        # Clients supporting tags have to handle unknown tags gracefully.
+        #
+        # @since 3.15.0
+        #
+        # @return [ClientDiagnosticsTagOptions]
+        def tag_support
+          attributes.fetch(:tagSupport)
+        end
+
+        #
+        # Client supports a codeDescription property
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean]
+        def code_description_support
+          attributes.fetch(:codeDescriptionSupport)
+        end
+
+        #
+        # Whether code action supports the `data` property which is
+        # preserved between a `textDocument/publishDiagnostics` and
+        # `textDocument/codeAction` request.
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean]
+        def data_support
+          attributes.fetch(:dataSupport)
+        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

@@ -5,7 +5,7 @@ module LanguageServer
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

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

@@ -5,7 +5,7 @@ module LanguageServer
         def initialize(section: nil)
           @attributes = {}
 
-          @attributes[:section] = section if section
+          @attributes[:section] = section unless section.nil?
 
           @attributes.freeze
         end

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

@@ -5,8 +5,8 @@ module LanguageServer
         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[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:relativePatternSupport] = relative_pattern_support unless relative_pattern_support.nil?
 
           @attributes.freeze
         end

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

@@ -9,7 +9,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:textDocument] = text_document
-          @attributes[:text] = text if text
+          @attributes[:text] = text unless text.nil?
 
           @attributes.freeze
         end

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

@@ -5,7 +5,7 @@ module LanguageServer
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

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

@@ -5,7 +5,7 @@ module LanguageServer
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -9,8 +9,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:textDocument] = text_document
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end

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

@@ -6,8 +6,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:id] = id if id
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+          @attributes[:id] = id unless id.nil?
 
           @attributes.freeze
         end

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

@@ -11,10 +11,10 @@ module LanguageServer
           @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[:identifier] = identifier unless identifier.nil?
+          @attributes[:previousResultId] = previous_result_id unless previous_result_id.nil?
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end

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

@@ -14,10 +14,10 @@ module LanguageServer
         def initialize(related_documents: nil, kind:, result_id: nil, items: nil)
           @attributes = {}
 
-          @attributes[:relatedDocuments] = related_documents if related_documents
+          @attributes[:relatedDocuments] = related_documents unless related_documents.nil?
           @attributes[:kind] = kind
-          @attributes[:resultId] = result_id if result_id
-          @attributes[:items] = items if items
+          @attributes[:resultId] = result_id unless result_id.nil?
+          @attributes[:items] = items unless items.nil?
 
           @attributes.freeze
         end

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

@@ -0,0 +1,97 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The document diagnostic report used when reporting partial result.
+      #
+      # When using partial results, the first literal sent needs to be a
+      # DocumentDiagnosticReport providing the diagnostics on the document
+      # followed by n DocumentDiagnosticReportPartialResult literals providing
+      # the diagnostics for related documents.
+      #
+      # ```
+      # DocumentDiagnosticReport
+      # DocumentDiagnosticReportPartialResult
+      # DocumentDiagnosticReportPartialResult
+      # ...
+      # ```
+      #
+      # @since 3.18.1
+      #
+      class DocumentDiagnosticReportProgress
+        def initialize(related_documents: nil, kind: nil, result_id: nil, items: nil)
+          @attributes = {}
+
+          @attributes[:relatedDocuments] = related_documents unless related_documents.nil?
+          @attributes[:kind] = kind unless kind.nil?
+          @attributes[:resultId] = result_id unless result_id.nil?
+          @attributes[:items] = items unless items.nil?
+
+          @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_filter.rb

@@ -5,16 +5,16 @@ module LanguageServer
       # A document filter describes a top level text document or
       # a notebook cell document.
       #
-      # @since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
+      # @since 3.17.0 - support for NotebookCellTextDocumentFilter.
       #
       class DocumentFilter
         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[:language] = language unless language.nil?
+          @attributes[:scheme] = scheme unless scheme.nil?
+          @attributes[:pattern] = pattern unless pattern.nil?
+          @attributes[:notebook] = notebook unless notebook.nil?
 
           @attributes.freeze
         end
@@ -43,9 +43,13 @@ module LanguageServer
         end
 
         #
-        # A glob pattern, like `*.{ts,js}`.
+        # A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
         #
-        # @return [string]
+        # @since 3.18.0 - support for relative patterns. Whether clients support
+        # relative patterns depends on the client capability
+        # `textDocuments.filters.relativePatternSupport`.
+        #
+        # @return [GlobPattern]
         def pattern
           attributes.fetch(:pattern)
         end

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

@@ -8,7 +8,7 @@ module LanguageServer
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

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

@@ -8,7 +8,7 @@ module LanguageServer
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -10,7 +10,7 @@ module LanguageServer
 
           @attributes[:textDocument] = text_document
           @attributes[:options] = options
-          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @attributes.freeze
         end

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

@@ -9,7 +9,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end