language_server-protocol 3.17.0.5 → 3.17.0.6

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[: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.
         #
@@ -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 if work_done_progress
 
           @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

@@ -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 = {}

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 = {}

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

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

@@ -0,0 +1,95 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Capabilities relating to events from file operations by the user in the client.
+      #
+      # These events do not come from the file system, they come from user operations
+      # like renaming a file in the UI.
+      #
+      # @since 3.16.0
+      #
+      class FileOperationClientCapabilities
+        def initialize(dynamic_registration: nil, did_create: nil, will_create: nil, did_rename: nil, will_rename: nil, did_delete: nil, will_delete: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:didCreate] = did_create if did_create
+          @attributes[:willCreate] = will_create if will_create
+          @attributes[:didRename] = did_rename if did_rename
+          @attributes[:willRename] = will_rename if will_rename
+          @attributes[:didDelete] = did_delete if did_delete
+          @attributes[:willDelete] = will_delete if will_delete
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether the client supports dynamic registration for file requests/notifications.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # The client has support for sending didCreateFiles notifications.
+        #
+        # @return [boolean]
+        def did_create
+          attributes.fetch(:didCreate)
+        end
+
+        #
+        # The client has support for sending willCreateFiles requests.
+        #
+        # @return [boolean]
+        def will_create
+          attributes.fetch(:willCreate)
+        end
+
+        #
+        # The client has support for sending didRenameFiles notifications.
+        #
+        # @return [boolean]
+        def did_rename
+          attributes.fetch(:didRename)
+        end
+
+        #
+        # The client has support for sending willRenameFiles requests.
+        #
+        # @return [boolean]
+        def will_rename
+          attributes.fetch(:willRename)
+        end
+
+        #
+        # The client has support for sending didDeleteFiles notifications.
+        #
+        # @return [boolean]
+        def did_delete
+          attributes.fetch(:didDelete)
+        end
+
+        #
+        # The client has support for sending willDeleteFiles requests.
+        #
+        # @return [boolean]
+        def will_delete
+          attributes.fetch(:willDelete)
+        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

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

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

@@ -0,0 +1,83 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Options for notifications/requests for user operations on files.
+      #
+      # @since 3.16.0
+      #
+      class FileOperationOptions
+        def initialize(did_create: nil, will_create: nil, did_rename: nil, will_rename: nil, did_delete: nil, will_delete: nil)
+          @attributes = {}
+
+          @attributes[:didCreate] = did_create if did_create
+          @attributes[:willCreate] = will_create if will_create
+          @attributes[:didRename] = did_rename if did_rename
+          @attributes[:willRename] = will_rename if will_rename
+          @attributes[:didDelete] = did_delete if did_delete
+          @attributes[:willDelete] = will_delete if will_delete
+
+          @attributes.freeze
+        end
+
+        #
+        # The server is interested in receiving didCreateFiles notifications.
+        #
+        # @return [FileOperationRegistrationOptions]
+        def did_create
+          attributes.fetch(:didCreate)
+        end
+
+        #
+        # The server is interested in receiving willCreateFiles requests.
+        #
+        # @return [FileOperationRegistrationOptions]
+        def will_create
+          attributes.fetch(:willCreate)
+        end
+
+        #
+        # The server is interested in receiving didRenameFiles notifications.
+        #
+        # @return [FileOperationRegistrationOptions]
+        def did_rename
+          attributes.fetch(:didRename)
+        end
+
+        #
+        # The server is interested in receiving willRenameFiles requests.
+        #
+        # @return [FileOperationRegistrationOptions]
+        def will_rename
+          attributes.fetch(:willRename)
+        end
+
+        #
+        # The server is interested in receiving didDeleteFiles file notifications.
+        #
+        # @return [FileOperationRegistrationOptions]
+        def did_delete
+          attributes.fetch(:didDelete)
+        end
+
+        #
+        # The server is interested in receiving willDeleteFiles file requests.
+        #
+        # @return [FileOperationRegistrationOptions]
+        def will_delete
+          attributes.fetch(:willDelete)
+        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

@@ -3,7 +3,9 @@ module LanguageServer
     module Interface
       #
       # A pattern to describe in which file operation requests or notifications
-      # the server is interested in.
+      # the server is interested in receiving.
+      #
+      # @since 3.16.0
       #
       class FileOperationPattern
         def initialize(glob:, matches: nil, options: nil)
@@ -21,13 +23,9 @@ 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

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Matching options for the file operation pattern.
       #
+      # @since 3.16.0
+      #
       class FileOperationPatternOptions
         def initialize(ignore_case: nil)
           @attributes = {}

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

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

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

@@ -2,9 +2,8 @@ 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)
@@ -21,50 +20,45 @@ 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 [number]
+        # @return [uinteger]
         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 [number]
+        # @return [uinteger]
         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 [number]
+        # @return [uinteger]
         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 [number]
+        # @return [uinteger]
         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 {@link FoldingRangeKind} for an enumeration of standardized kinds.
         #
-        # @return [string]
+        # @return [FoldingRangeKind]
         def kind
           attributes.fetch(:kind)
         end
@@ -74,6 +68,8 @@ 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]
         def collapsed_text
           attributes.fetch(:collapsedText)

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

@@ -30,7 +30,7 @@ module LanguageServer
         # per document. The value serves as a hint, servers are free to follow the
         # limit.
         #
-        # @return [number]
+        # @return [uinteger]
         def range_limit
           attributes.fetch(:rangeLimit)
         end
@@ -48,7 +48,9 @@ module LanguageServer
         #
         # Specific options for the folding range kind.
         #
-        # @return [{ valueSet?: string[]; }]
+        # @since 3.17.0
+        #
+        # @return [{ valueSet?: FoldingRangeKind[]; }]
         def folding_range_kind
           attributes.fetch(:foldingRangeKind)
         end
@@ -56,6 +58,8 @@ module LanguageServer
         #
         # Specific options for the folding range.
         #
+        # @since 3.17.0
+        #
         # @return [{ collapsedText?: boolean; }]
         def folding_range
           attributes.fetch(:foldingRange)

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

@@ -1,17 +1,28 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link FoldingRangeRequest}.
+      #
       class FoldingRangeParams
-        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[: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.
         #
@@ -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/folding_range_registration_options.rb

@@ -13,10 +13,10 @@ module LanguageServer
         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

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

@@ -20,7 +20,7 @@ module LanguageServer
         #
         # Size of a tab in spaces.
         #
-        # @return [number]
+        # @return [uinteger]
         def tab_size
           attributes.fetch(:tabSize)
         end
@@ -36,6 +36,8 @@ module LanguageServer
         #
         # Trim trailing whitespace on a line.
         #
+        # @since 3.15.0
+        #
         # @return [boolean]
         def trim_trailing_whitespace
           attributes.fetch(:trimTrailingWhitespace)
@@ -44,6 +46,8 @@ module LanguageServer
         #
         # Insert a newline character at the end of the file if one does not exist.
         #
+        # @since 3.15.0
+        #
         # @return [boolean]
         def insert_final_newline
           attributes.fetch(:insertFinalNewline)
@@ -52,6 +56,8 @@ module LanguageServer
         #
         # Trim all newlines after the final newline at the end of the file.
         #
+        # @since 3.15.0
+        #
         # @return [boolean]
         def trim_final_newlines
           attributes.fetch(:trimFinalNewlines)

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A diagnostic report with a full set of problems.
       #
+      # @since 3.17.0
+      #
       class FullDocumentDiagnosticReport
         def initialize(kind:, result_id: nil, items:)
           @attributes = {}
@@ -18,7 +20,7 @@ module LanguageServer
         #
         # A full document diagnostic report.
         #
-        # @return [any]
+        # @return ["full"]
         def kind
           attributes.fetch(:kind)
         end