language_server-protocol 3.15.0.2 → 3.16.0.0

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 are 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_text_document_params.rb

@@ -22,17 +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 (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 recevie 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

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

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_highlight.rb

@@ -27,7 +27,7 @@ module LanguageServer
         #
         # The highlight kind, default is DocumentHighlightKind.Text.
         #
-        # @return [number]
+        # @return [DocumentHighlightKind]
         def kind
           attributes.fetch(:kind)
         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)
@@ -36,9 +36,10 @@ 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]
         def tooltip

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

@@ -2,17 +2,19 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be
-      # hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range,
-      # e.g. the range of an identifier.
+      # Represents programming constructs like variables, classes, interfaces etc.
+      # that appear in a document. Document symbols can be hierarchical and they
+      # have two ranges: one that encloses its definition and one that points to its
+      # most interesting range, e.g. the range of an identifier.
       #
       class DocumentSymbol
-        def initialize(name:, detail: nil, kind:, deprecated: nil, range:, selection_range:, children: nil)
+        def initialize(name:, detail: nil, kind:, tags: nil, deprecated: nil, range:, selection_range:, children: nil)
           @attributes = {}
 
           @attributes[:name] = name
           @attributes[:detail] = detail if detail
           @attributes[:kind] = kind
+          @attributes[:tags] = tags if tags
           @attributes[:deprecated] = deprecated if deprecated
           @attributes[:range] = range
           @attributes[:selectionRange] = selection_range
@@ -22,8 +24,9 @@ module LanguageServer
         end
 
         #
-        # The name of this symbol. Will be displayed in the user interface and therefore must not be
-        # an empty string or a string only consisting of white spaces.
+        # The name of this symbol. Will be displayed in the user interface and
+        # therefore must not be an empty string or a string only consisting of
+        # white spaces.
         #
         # @return [string]
         def name
@@ -46,6 +49,14 @@ module LanguageServer
           attributes.fetch(:kind)
         end
 
+        #
+        # Tags for this document symbol.
+        #
+        # @return [1[]]
+        def tags
+          attributes.fetch(:tags)
+        end
+
         #
         # Indicates if this symbol is deprecated.
         #
@@ -55,9 +66,10 @@ module LanguageServer
         end
 
         #
-        # The range enclosing this symbol not including leading/trailing whitespace but everything else
-        # like comments. This information is typically used to determine if the clients cursor is
-        # inside the symbol to reveal in the symbol in the UI.
+        # The range enclosing this symbol not including leading/trailing whitespace
+        # but everything else like comments. This information is typically used to
+        # determine if the clients cursor is inside the symbol to reveal in the
+        # symbol in the UI.
         #
         # @return [Range]
         def range
@@ -65,8 +77,8 @@ module LanguageServer
         end
 
         #
-        # The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
-        # Must be contained by the `range`.
+        # The range that should be selected and revealed when this symbol is being
+        # picked, e.g. the name of a function. Must be contained by the `range`.
         #
         # @return [Range]
         def selection_range

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

@@ -2,12 +2,14 @@ module LanguageServer
   module Protocol
     module Interface
       class DocumentSymbolClientCapabilities
-        def initialize(dynamic_registration: nil, symbol_kind: nil, hierarchical_document_symbol_support: nil)
+        def initialize(dynamic_registration: nil, symbol_kind: nil, hierarchical_document_symbol_support: nil, tag_support: nil, label_support: nil)
           @attributes = {}
 
           @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
           @attributes[:symbolKind] = symbol_kind if symbol_kind
           @attributes[:hierarchicalDocumentSymbolSupport] = hierarchical_document_symbol_support if hierarchical_document_symbol_support
+          @attributes[:tagSupport] = tag_support if tag_support
+          @attributes[:labelSupport] = label_support if label_support
 
           @attributes.freeze
         end
@@ -21,7 +23,8 @@ module LanguageServer
         end
 
         #
-        # Specific capabilities for the `SymbolKind` in the `textDocument/documentSymbol` request.
+        # Specific capabilities for the `SymbolKind` in the
+        # `textDocument/documentSymbol` request.
         #
         # @return [{ valueSet?: any[]; }]
         def symbol_kind
@@ -36,6 +39,25 @@ module LanguageServer
           attributes.fetch(:hierarchicalDocumentSymbolSupport)
         end
 
+        #
+        # The client supports tags on `SymbolInformation`. Tags are supported on
+        # `DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true.
+        # Clients supporting tags have to handle unknown tags gracefully.
+        #
+        # @return [{ valueSet: 1[]; }]
+        def tag_support
+          attributes.fetch(:tagSupport)
+        end
+
+        #
+        # The client supports an additional label presented in the UI when
+        # registering a document symbol provider.
+        #
+        # @return [boolean]
+        def label_support
+          attributes.fetch(:labelSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,14 +2,24 @@ module LanguageServer
   module Protocol
     module Interface
       class DocumentSymbolOptions < WorkDoneProgressOptions
-        def initialize(work_done_progress: nil)
+        def initialize(work_done_progress: nil, label: nil)
           @attributes = {}
 
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:label] = label if label
 
           @attributes.freeze
         end
 
+        #
+        # A human-readable string that is shown when multiple outlines trees
+        # are shown for the same document.
+        #
+        # @return [string]
+        def label
+          attributes.fetch(:label)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,10 +2,11 @@ module LanguageServer
   module Protocol
     module Interface
       class DocumentSymbolRegistrationOptions < DocumentSymbolOptions
-        def initialize(work_done_progress: nil)
+        def initialize(work_done_progress: nil, label: nil)
           @attributes = {}
 
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:label] = label if label
 
           @attributes.freeze
         end

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents information on a file/folder create.
+      #
+      class FileCreate
+        def initialize(uri:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+
+          @attributes.freeze
+        end
+
+        #
+        # A file:// URI for the location of the file/folder being created.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        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_delete.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents information on a file/folder delete.
+      #
+      class FileDelete
+        def initialize(uri:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+
+          @attributes.freeze
+        end
+
+        #
+        # A file:// URI for the location of the file/folder being deleted.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        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_operation_filter.rb

@@ -0,0 +1,46 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A filter to describe in which file operation requests or notifications
+      # the server is interested in.
+      #
+      class FileOperationFilter
+        def initialize(scheme: nil, pattern:)
+          @attributes = {}
+
+          @attributes[:scheme] = scheme if scheme
+          @attributes[:pattern] = pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # A Uri like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # The actual file operation pattern.
+        #
+        # @return [FileOperationPattern]
+        def pattern
+          attributes.fetch(:pattern)
+        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_operation_pattern.rb

@@ -0,0 +1,67 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A pattern to describe in which file operation requests or notifications
+      # the server is interested in.
+      #
+      class FileOperationPattern
+        def initialize(glob:, matches: nil, options: nil)
+          @attributes = {}
+
+          @attributes[:glob] = glob
+          @attributes[:matches] = matches if matches
+          @attributes[:options] = options if options
+
+          @attributes.freeze
+        end
+
+        #
+        # The glob pattern to match. 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 glob
+          attributes.fetch(:glob)
+        end
+
+        #
+        # Whether to match files or folders with this pattern.
+        #
+        # Matches both if undefined.
+        #
+        # @return [FileOperationPatternKind]
+        def matches
+          attributes.fetch(:matches)
+        end
+
+        #
+        # Additional options used during matching.
+        #
+        # @return [FileOperationPatternOptions]
+        def options
+          attributes.fetch(:options)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end