language_server-protocol 3.14.0.2 → 3.16.0.1

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Format document on type options.
-      #
       class DocumentOnTypeFormattingOptions
         def initialize(first_trigger_character:, more_trigger_character: nil)
           @attributes = {}

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

@@ -14,7 +14,7 @@ module LanguageServer
         end
 
         #
-        # The document to format.
+        # The text document.
         #
         # @return [TextDocumentIdentifier]
         def text_document
@@ -22,7 +22,7 @@ module LanguageServer
         end
 
         #
-        # The position at which this request was sent.
+        # The position inside the text document.
         #
         # @return [Position]
         def position

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

@@ -1,7 +1,7 @@
 module LanguageServer
   module Protocol
     module Interface
-      class DocumentOnTypeFormattingRegistrationOptions < TextDocumentRegistrationOptions
+      class DocumentOnTypeFormattingRegistrationOptions
         def initialize(document_selector:, first_trigger_character:, more_trigger_character: nil)
           @attributes = {}
 
@@ -12,6 +12,15 @@ module LanguageServer
           @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
+
         #
         # A character on which formatting should be triggered, like `}`.
         #

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

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentRangeFormattingClientCapabilities
+        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_range_formatting_options.rb

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentRangeFormattingOptions
+        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_range_formatting_params.rb

@@ -2,9 +2,10 @@ module LanguageServer
   module Protocol
     module Interface
       class DocumentRangeFormattingParams
-        def initialize(text_document:, range:, options:)
+        def initialize(work_done_token: nil, text_document:, range:, options:)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
           @attributes[:options] = options
@@ -12,6 +13,14 @@ module LanguageServer
           @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.
         #

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

@@ -0,0 +1,40 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentRangeFormattingRegistrationOptions
+        def initialize(document_selector:, work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:documentSelector] = document_selector
+          @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
+
+        # @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_symbol.rb

@@ -0,0 +1,108 @@
+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.
+      #
+      class DocumentSymbol
+        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
+          @attributes[:children] = children if children
+
+          @attributes.freeze
+        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.
+        #
+        # @return [string]
+        def name
+          attributes.fetch(:name)
+        end
+
+        #
+        # More detail for this symbol, e.g the signature of a function.
+        #
+        # @return [string]
+        def detail
+          attributes.fetch(:detail)
+        end
+
+        #
+        # The kind of this symbol.
+        #
+        # @return [any]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # Tags for this document symbol.
+        #
+        # @return [1[]]
+        def tags
+          attributes.fetch(:tags)
+        end
+
+        #
+        # Indicates if this symbol is deprecated.
+        #
+        # @return [boolean]
+        def deprecated
+          attributes.fetch(:deprecated)
+        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.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        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`.
+        #
+        # @return [Range]
+        def selection_range
+          attributes.fetch(:selectionRange)
+        end
+
+        #
+        # Children of this symbol, e.g. properties of a class.
+        #
+        # @return [DocumentSymbol[]]
+        def children
+          attributes.fetch(:children)
+        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_symbol_client_capabilities.rb

@@ -0,0 +1,73 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentSymbolClientCapabilities
+        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
+
+        #
+        # Whether document symbol supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # Specific capabilities for the `SymbolKind` in the
+        # `textDocument/documentSymbol` request.
+        #
+        # @return [{ valueSet?: any[]; }]
+        def symbol_kind
+          attributes.fetch(:symbolKind)
+        end
+
+        #
+        # The client supports hierarchical document symbols.
+        #
+        # @return [boolean]
+        def hierarchical_document_symbol_support
+          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
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DocumentSymbolOptions
+        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
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        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
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -2,14 +2,33 @@ module LanguageServer
   module Protocol
     module Interface
       class DocumentSymbolParams
-        def initialize(text_document:)
+        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.
         #