language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -1,25 +1,39 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link DocumentRangeFormattingRequest}.
+      #
       class DocumentRangeFormattingRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil)
+        def initialize(document_selector:, ranges_support: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:rangesSupport] = ranges_support unless ranges_support.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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.
+        # 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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
+        #
+        # Whether the server supports formatting multiple ranges at once.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def ranges_support
+          attributes.fetch(:rangesSupport)
+        end
+
         # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)

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

@@ -0,0 +1,65 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The parameters of a {@link DocumentRangesFormattingRequest}.
+      #
+      # @since 3.18.0
+      #
+      class DocumentRangesFormattingParams
+        def initialize(text_document:, ranges:, options:, work_done_token: nil)
+          @attributes = {}
+
+          @attributes[:textDocument] = text_document
+          @attributes[:ranges] = ranges
+          @attributes[:options] = options
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The document to format.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
+        #
+        # The ranges to format
+        #
+        # @return [Range[]]
+        def ranges
+          attributes.fetch(:ranges)
+        end
+
+        #
+        # The format options
+        #
+        # @return [FormattingOptions]
+        def options
+          attributes.fetch(:options)
+        end
+
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        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

@@ -4,29 +4,28 @@ module LanguageServer
       #
       # 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.
+      # 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[:detail] = detail unless detail.nil?
           @attributes[:kind] = kind
-          @attributes[:tags] = tags if tags
-          @attributes[:deprecated] = deprecated if deprecated
+          @attributes[:tags] = tags unless tags.nil?
+          @attributes[:deprecated] = deprecated unless deprecated.nil?
           @attributes[:range] = range
           @attributes[:selectionRange] = selection_range
-          @attributes[:children] = children if children
+          @attributes[:children] = children unless children.nil?
 
           @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.
+        # 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
@@ -52,7 +51,9 @@ module LanguageServer
         #
         # Tags for this document symbol.
         #
-        # @return [1[]]
+        # @since 3.16.0
+        #
+        # @return [SymbolTag[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -60,16 +61,17 @@ module LanguageServer
         #
         # Indicates if this symbol is deprecated.
         #
+        # @deprecated Use tags instead
+        #
         # @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.
+        # 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
@@ -77,8 +79,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

@@ -1,15 +1,18 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client Capabilities for a {@link DocumentSymbolRequest}.
+      #
       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[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:symbolKind] = symbol_kind unless symbol_kind.nil?
+          @attributes[:hierarchicalDocumentSymbolSupport] = hierarchical_document_symbol_support unless hierarchical_document_symbol_support.nil?
+          @attributes[:tagSupport] = tag_support unless tag_support.nil?
+          @attributes[:labelSupport] = label_support unless label_support.nil?
 
           @attributes.freeze
         end
@@ -26,7 +29,7 @@ module LanguageServer
         # Specific capabilities for the `SymbolKind` in the
         # `textDocument/documentSymbol` request.
         #
-        # @return [{ valueSet?: SymbolKind[]; }]
+        # @return [ClientSymbolKindOptions]
         def symbol_kind
           attributes.fetch(:symbolKind)
         end
@@ -44,7 +47,9 @@ module LanguageServer
         # `DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true.
         # Clients supporting tags have to handle unknown tags gracefully.
         #
-        # @return [{ valueSet: 1[]; }]
+        # @since 3.16.0
+        #
+        # @return [ClientSymbolTagOptions]
         def tag_support
           attributes.fetch(:tagSupport)
         end
@@ -53,6 +58,8 @@ module LanguageServer
         # The client supports an additional label presented in the UI when
         # registering a document symbol provider.
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def label_support
           attributes.fetch(:labelSupport)

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

@@ -1,30 +1,35 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a {@link DocumentSymbolRequest}.
+      #
       class DocumentSymbolOptions
-        def initialize(work_done_progress: nil, label: nil)
+        def initialize(label: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:label] = label if label
+          @attributes[:label] = label unless label.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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.
         #
+        # @since 3.16.0
+        #
         # @return [string]
         def label
           attributes.fetch(:label)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,17 +1,28 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link DocumentSymbolRequest}.
+      #
       class DocumentSymbolParams
-        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[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end
 
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
         #
         # An optional token that a server can use to report work done progress.
         #
@@ -21,22 +32,14 @@ module LanguageServer
         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]
         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

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

@@ -1,40 +1,45 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link DocumentSymbolRequest}.
+      #
       class DocumentSymbolRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, label: nil)
+        def initialize(document_selector:, label: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:label] = label if label
+          @attributes[:label] = label unless label.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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.
+        # 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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         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.
         #
+        # @since 3.16.0
+        #
         # @return [string]
         def label
           attributes.fetch(:label)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,41 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Edit range variant that includes ranges for insert and replace operations.
+      #
+      # @since 3.18.0
+      #
+      class EditRangeWithInsertReplace
+        def initialize(insert:, replace:)
+          @attributes = {}
+
+          @attributes[:insert] = insert
+          @attributes[:replace] = replace
+
+          @attributes.freeze
+        end
+
+        # @return [Range]
+        def insert
+          attributes.fetch(:insert)
+        end
+
+        # @return [Range]
+        def replace
+          attributes.fetch(:replace)
+        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/execute_command_client_capabilities.rb

@@ -1,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The client capabilities of a {@link ExecuteCommandRequest}.
+      #
       class ExecuteCommandClientCapabilities
         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/execute_command_options.rb

@@ -1,21 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The server capabilities of a {@link ExecuteCommandRequest}.
+      #
       class ExecuteCommandOptions
-        def initialize(work_done_progress: nil, commands:)
+        def initialize(commands:, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:commands] = commands
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The commands to be executed on the server
         #
@@ -24,6 +22,11 @@ module LanguageServer
           attributes.fetch(:commands)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,25 +1,20 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a {@link ExecuteCommandRequest}.
+      #
       class ExecuteCommandParams
-        def initialize(work_done_token: nil, command:, arguments: nil)
+        def initialize(command:, arguments: nil, work_done_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:command] = command
-          @attributes[:arguments] = arguments if arguments
+          @attributes[:arguments] = arguments unless arguments.nil?
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @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 identifier of the actual command handler.
         #
@@ -36,6 +31,14 @@ module LanguageServer
           attributes.fetch(:arguments)
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,23 +2,18 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Execute command registration options.
+      # Registration options for a {@link ExecuteCommandRequest}.
       #
       class ExecuteCommandRegistrationOptions
-        def initialize(work_done_progress: nil, commands:)
+        def initialize(commands:, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:commands] = commands
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The commands to be executed on the server
         #
@@ -27,6 +22,11 @@ module LanguageServer
           attributes.fetch(:commands)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -6,7 +6,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:executionOrder] = execution_order
-          @attributes[:success] = success if success
+          @attributes[:success] = success unless success.nil?
 
           @attributes.freeze
         end
@@ -16,7 +16,7 @@ module LanguageServer
         # indicating the execution order of a cell
         # inside a notebook.
         #
-        # @return [number]
+        # @return [uinteger]
         def execution_order
           attributes.fetch(:executionOrder)
         end

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Represents information on a file/folder create.
       #
+      # @since 3.16.0
+      #
       class FileCreate
         def initialize(uri:)
           @attributes = {}
@@ -14,9 +16,9 @@ module LanguageServer
         end
 
         #
-        # A file:// URI for the location of the file/folder being created.
+        # A URI for the location of the file/folder being created.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Represents information on a file/folder delete.
       #
+      # @since 3.16.0
+      #
       class FileDelete
         def initialize(uri:)
           @attributes = {}
@@ -14,9 +16,9 @@ module LanguageServer
         end
 
         #
-        # A file:// URI for the location of the file/folder being deleted.
+        # A URI for the location of the file/folder being deleted.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -15,9 +15,9 @@ module LanguageServer
         end
 
         #
-        # The file's URI.
+        # The file's uri.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end
@@ -25,7 +25,7 @@ module LanguageServer
         #
         # The change type.
         #
-        # @return [number]
+        # @return [FileChangeType]
         def type
           attributes.fetch(:type)
         end