language_server-protocol 3.14.0.2 → 3.16.0.1

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

@@ -2,15 +2,18 @@ module LanguageServer
   module Protocol
     module Interface
       class Diagnostic
-        def initialize(range:, severity: nil, code: nil, source: nil, message:, related_information: nil)
+        def initialize(range:, severity: nil, code: nil, code_description: nil, source: nil, message:, tags: nil, related_information: nil, data: nil)
           @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[:message] = message
+          @attributes[:tags] = tags if tags
           @attributes[:relatedInformation] = related_information if related_information
+          @attributes[:data] = data if data
 
           @attributes.freeze
         end
@@ -27,7 +30,7 @@ module LanguageServer
         # The diagnostic's severity. Can be omitted. If omitted it is up to the
         # client to interpret diagnostics as error, warning, info or hint.
         #
-        # @return [number]
+        # @return [DiagnosticSeverity]
         def severity
           attributes.fetch(:severity)
         end
@@ -40,6 +43,14 @@ module LanguageServer
           attributes.fetch(:code)
         end
 
+        #
+        # An optional property to describe the error code.
+        #
+        # @return [CodeDescription]
+        def code_description
+          attributes.fetch(:codeDescription)
+        end
+
         #
         # A human-readable string describing the source of this
         # diagnostic, e.g. 'typescript' or 'super lint'.
@@ -57,6 +68,14 @@ module LanguageServer
           attributes.fetch(:message)
         end
 
+        #
+        # Additional metadata about the diagnostic.
+        #
+        # @return [DiagnosticTag[]]
+        def tags
+          attributes.fetch(:tags)
+        end
+
         #
         # An array of related diagnostic information, e.g. when symbol-names within
         # a scope collide all definitions can be marked via this property.
@@ -66,6 +85,16 @@ module LanguageServer
           attributes.fetch(:relatedInformation)
         end
 
+        #
+        # A data entry field that is preserved between a
+        # `textDocument/publishDiagnostics` notification and
+        # `textDocument/codeAction` request.
+        #
+        # @return [unknown]
+        def data
+          attributes.fetch(:data)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

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

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

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DidChangeConfigurationClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Did change configuration notification supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -22,9 +22,19 @@ 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 and c2 for a document
-        # in state S then c1 move the document to S' and c2 to 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:
+        # - 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.
         #
         # @return [TextDocumentContentChangeEvent[]]
         def content_changes

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

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DidChangeWatchedFilesClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Did change watched files notification supports dynamic registration.
+        # Please note that the current protocol doesn't support static
+        # configuration for file changes from the server side.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        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_registration_options.rb

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Describe options to be used when registering for text document change events.
+      # Describe options to be used when registering for file system change events.
       #
       class DidChangeWatchedFilesRegistrationOptions
         def initialize(watchers:)

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

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentColorClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether document color supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        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_color_options.rb

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

@@ -0,0 +1,52 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentColorParams
+        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
+          @attributes = {}
+
+          @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
+
+        #
+        # 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
+
+        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_color_registration_options.rb

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

@@ -35,9 +35,13 @@ module LanguageServer
         # - `*` 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 conditions (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`)
+        # - `{}` 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

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

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentFormattingClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether formatting supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        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_formatting_options.rb

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentFormattingOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end