language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -1,35 +1,30 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Provider options for a [DocumentSymbolRequest](#DocumentSymbolRequest).
-      #
       class DocumentSymbolOptions
-        def initialize(label: nil, work_done_progress: nil)
+        def initialize(work_done_progress: nil, label: nil)
           @attributes = {}
 
-          @attributes[:label] = label if label
           @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.
         #
-        # @since 3.16.0
-        #
-        # @return [string | nil]
+        # @return [string]
         def label
           attributes.fetch(:label)
         end
 
-        # @return [boolean | nil]
-        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,45 +1,42 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Parameters for a [DocumentSymbolRequest](#DocumentSymbolRequest).
-      #
       class DocumentSymbolParams
-        def initialize(text_document:, work_done_token: nil, partial_result_token: nil)
+        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
           @attributes = {}
 
-          @attributes[:textDocument] = text_document
           @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
 
-        #
-        # 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.
         #
-        # @return [ProgressToken | nil]
+        # @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.
+        # An optional token that a server can use to report partial results (e.g.
+        # streaming) to the client.
         #
-        # @return [ProgressToken | nil]
+        # @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,45 +1,40 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Registration options for a [DocumentSymbolRequest](#DocumentSymbolRequest).
-      #
       class DocumentSymbolRegistrationOptions
-        def initialize(document_selector:, label: nil, work_done_progress: nil)
+        def initialize(document_selector:, work_done_progress: nil, label: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:label] = label if label
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:label] = label if label
 
           @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 | null]
+        # @return [DocumentSelector]
         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 | nil]
+        # @return [string]
         def label
           attributes.fetch(:label)
         end
 
-        # @return [boolean | nil]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The client capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
-      #
       class ExecuteCommandClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -16,7 +13,7 @@ module LanguageServer
         #
         # Execute command supports dynamic registration.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,19 +1,21 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The server capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
-      #
       class ExecuteCommandOptions
-        def initialize(commands:, work_done_progress: nil)
+        def initialize(work_done_progress: nil, commands:)
           @attributes = {}
 
-          @attributes[:commands] = commands
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:commands] = commands
 
           @attributes.freeze
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # The commands to be executed on the server
         #
@@ -22,11 +24,6 @@ module LanguageServer
           attributes.fetch(:commands)
         end
 
-        # @return [boolean | nil]
-        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,20 +1,25 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameters of a [ExecuteCommandRequest](#ExecuteCommandRequest).
-      #
       class ExecuteCommandParams
-        def initialize(command:, arguments: nil, work_done_token: nil)
+        def initialize(work_done_token: nil, command:, arguments: nil)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:command] = command
           @attributes[:arguments] = arguments if arguments
-          @attributes[:workDoneToken] = work_done_token if work_done_token
 
           @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.
         #
@@ -26,19 +31,11 @@ module LanguageServer
         #
         # Arguments that the command should be invoked with.
         #
-        # @return [LSPAny[] | nil]
+        # @return [LSPAny[]]
         def arguments
           attributes.fetch(:arguments)
         end
 
-        #
-        # An optional token that a server can use to report work done progress.
-        #
-        # @return [ProgressToken | nil]
-        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,18 +2,23 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Registration options for a [ExecuteCommandRequest](#ExecuteCommandRequest).
+      # Execute command registration options.
       #
       class ExecuteCommandRegistrationOptions
-        def initialize(commands:, work_done_progress: nil)
+        def initialize(work_done_progress: nil, commands:)
           @attributes = {}
 
-          @attributes[:commands] = commands
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:commands] = commands
 
           @attributes.freeze
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # The commands to be executed on the server
         #
@@ -22,11 +27,6 @@ module LanguageServer
           attributes.fetch(:commands)
         end
 
-        # @return [boolean | nil]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -16,7 +16,7 @@ module LanguageServer
         # indicating the execution order of a cell
         # inside a notebook.
         #
-        # @return [uinteger]
+        # @return [number]
         def execution_order
           attributes.fetch(:executionOrder)
         end
@@ -25,7 +25,7 @@ module LanguageServer
         # Whether the execution was successful or
         # not if known by the client.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def success
           attributes.fetch(:success)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Represents information on a file/folder create.
       #
-      # @since 3.16.0
-      #
       class FileCreate
         def initialize(uri:)
           @attributes = {}

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Represents information on a file/folder delete.
       #
-      # @since 3.16.0
-      #
       class FileDelete
         def initialize(uri:)
           @attributes = {}

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 [DocumentUri]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end
@@ -25,7 +25,7 @@ module LanguageServer
         #
         # The change type.
         #
-        # @return [FileChangeType]
+        # @return [number]
         def type
           attributes.fetch(:type)
         end

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

@@ -3,9 +3,7 @@ module LanguageServer
     module Interface
       #
       # A filter to describe in which file operation requests or notifications
-      # the server is interested in receiving.
-      #
-      # @since 3.16.0
+      # the server is interested in.
       #
       class FileOperationFilter
         def initialize(scheme: nil, pattern:)
@@ -18,9 +16,9 @@ module LanguageServer
         end
 
         #
-        # A Uri scheme like `file` or `untitled`.
+        # A Uri like `file` or `untitled`.
         #
-        # @return [string | nil]
+        # @return [string]
         def scheme
           attributes.fetch(:scheme)
         end

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

@@ -3,9 +3,7 @@ module LanguageServer
     module Interface
       #
       # A pattern to describe in which file operation requests or notifications
-      # the server is interested in receiving.
-      #
-      # @since 3.16.0
+      # the server is interested in.
       #
       class FileOperationPattern
         def initialize(glob:, matches: nil, options: nil)
@@ -23,9 +21,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 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`)
+        # - `{}` 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
@@ -37,7 +39,7 @@ module LanguageServer
         #
         # Matches both if undefined.
         #
-        # @return [FileOperationPatternKind | nil]
+        # @return [FileOperationPatternKind]
         def matches
           attributes.fetch(:matches)
         end
@@ -45,7 +47,7 @@ module LanguageServer
         #
         # Additional options used during matching.
         #
-        # @return [FileOperationPatternOptions | nil]
+        # @return [FileOperationPatternOptions]
         def options
           attributes.fetch(:options)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Matching options for the file operation pattern.
       #
-      # @since 3.16.0
-      #
       class FileOperationPatternOptions
         def initialize(ignore_case: nil)
           @attributes = {}
@@ -18,7 +16,7 @@ module LanguageServer
         #
         # The pattern should be matched ignoring casing.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def ignore_case
           attributes.fetch(:ignoreCase)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # The options to register for file operations.
       #
-      # @since 3.16.0
-      #
       class FileOperationRegistrationOptions
         def initialize(filters:)
           @attributes = {}

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Represents information on a file/folder rename.
       #
-      # @since 3.16.0
-      #
       class FileRename
         def initialize(old_uri:, new_uri:)
           @attributes = {}

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

@@ -12,9 +12,8 @@ module LanguageServer
         end
 
         #
-        # The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
-        #
-        # @since 3.17.0 support for relative patterns.
+        # The glob pattern to watch. See {@link GlobPattern glob pattern}
+        # for more detail.
         #
         # @return [GlobPattern]
         def glob_pattern
@@ -26,7 +25,7 @@ module LanguageServer
         # to WatchKind.Create | WatchKind.Change | WatchKind.Delete
         # which is 7.
         #
-        # @return [WatchKind | nil]
+        # @return [number]
         def kind
           attributes.fetch(:kind)
         end

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

@@ -2,8 +2,9 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Represents a folding range. To be valid, start and end line must be bigger than zero and smaller
-      # than the number of lines in the document. Clients are free to ignore invalid ranges.
+      # Represents a folding range. To be valid, start and end line must be bigger
+      # than zero and smaller than the number of lines in the document. Clients
+      # are free to ignore invalid ranges.
       #
       class FoldingRange
         def initialize(start_line:, start_character: nil, end_line:, end_character: nil, kind: nil, collapsed_text: nil)
@@ -20,45 +21,50 @@ module LanguageServer
         end
 
         #
-        # The zero-based start line of the range to fold. The folded area starts after the line's last character.
-        # To be valid, the end must be zero or larger and smaller than the number of lines in the document.
+        # The zero-based start line of the range to fold. The folded area starts
+        # after the line's last character. To be valid, the end must be zero or
+        # larger and smaller than the number of lines in the document.
         #
-        # @return [uinteger]
+        # @return [number]
         def start_line
           attributes.fetch(:startLine)
         end
 
         #
-        # The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
+        # The zero-based character offset from where the folded range starts. If
+        # not defined, defaults to the length of the start line.
         #
-        # @return [uinteger | nil]
+        # @return [number]
         def start_character
           attributes.fetch(:startCharacter)
         end
 
         #
-        # The zero-based end line of the range to fold. The folded area ends with the line's last character.
-        # To be valid, the end must be zero or larger and smaller than the number of lines in the document.
+        # The zero-based end line of the range to fold. The folded area ends with
+        # the line's last character. To be valid, the end must be zero or larger
+        # and smaller than the number of lines in the document.
         #
-        # @return [uinteger]
+        # @return [number]
         def end_line
           attributes.fetch(:endLine)
         end
 
         #
-        # The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
+        # The zero-based character offset before the folded range ends. If not
+        # defined, defaults to the length of the end line.
         #
-        # @return [uinteger | nil]
+        # @return [number]
         def end_character
           attributes.fetch(:endCharacter)
         end
 
         #
-        # Describes the kind of the folding range such as `comment' or 'region'. The kind
-        # is used to categorize folding ranges and used by commands like 'Fold all comments'.
-        # See [FoldingRangeKind](#FoldingRangeKind) for an enumeration of standardized kinds.
+        # Describes the kind of the folding range such as `comment` or `region`.
+        # The kind is used to categorize folding ranges and used by commands like
+        # 'Fold all comments'. See [FoldingRangeKind](#FoldingRangeKind) for an
+        # enumeration of standardized kinds.
         #
-        # @return [FoldingRangeKind | nil]
+        # @return [string]
         def kind
           attributes.fetch(:kind)
         end
@@ -68,9 +74,7 @@ module LanguageServer
         # collapsed. If not defined or not supported by the client, a default
         # will be chosen by the client.
         #
-        # @since 3.17.0
-        #
-        # @return [string | nil]
+        # @return [string]
         def collapsed_text
           attributes.fetch(:collapsedText)
         end

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

@@ -20,7 +20,7 @@ module LanguageServer
         # `FoldingRangeRegistrationOptions` return value for the corresponding
         # server capability as well.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -30,7 +30,7 @@ module LanguageServer
         # per document. The value serves as a hint, servers are free to follow the
         # limit.
         #
-        # @return [uinteger | nil]
+        # @return [number]
         def range_limit
           attributes.fetch(:rangeLimit)
         end
@@ -40,7 +40,7 @@ module LanguageServer
         # If set, client will ignore specified `startCharacter` and `endCharacter`
         # properties in a FoldingRange.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def line_folding_only
           attributes.fetch(:lineFoldingOnly)
         end
@@ -48,9 +48,7 @@ module LanguageServer
         #
         # Specific options for the folding range kind.
         #
-        # @since 3.17.0
-        #
-        # @return [{ valueSet:FoldingRangeKind[] } | nil]
+        # @return [{ valueSet?: string[]; }]
         def folding_range_kind
           attributes.fetch(:foldingRangeKind)
         end
@@ -58,9 +56,7 @@ module LanguageServer
         #
         # Specific options for the folding range.
         #
-        # @since 3.17.0
-        #
-        # @return [{ collapsedText:boolean } | nil]
+        # @return [{ collapsedText?: boolean; }]
         def folding_range
           attributes.fetch(:foldingRange)
         end

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

@@ -10,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end