language_server-protocol 3.15.0.2 → 3.16.0.3

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

@@ -1,16 +1,34 @@
 module LanguageServer
   module Protocol
     module Interface
-      class DocumentSymbolParams < PartialResultParams
-        def initialize(partial_result_token: nil, text_document:)
+      class DocumentSymbolParams
+        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.
         #

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

@@ -1,15 +1,40 @@
 module LanguageServer
   module Protocol
     module Interface
-      class DocumentSymbolRegistrationOptions < DocumentSymbolOptions
-        def initialize(work_done_progress: nil)
+      class DocumentSymbolRegistrationOptions
+        def initialize(document_selector:, work_done_progress: nil, label: nil)
           @attributes = {}
 
+          @attributes[:documentSelector] = document_selector
           @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.
+        #
+        # @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.
+        #
+        # @return [string]
+        def label
+          attributes.fetch(:label)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,7 +1,7 @@
 module LanguageServer
   module Protocol
     module Interface
-      class ExecuteCommandOptions < WorkDoneProgressOptions
+      class ExecuteCommandOptions
         def initialize(work_done_progress: nil, commands:)
           @attributes = {}
 
@@ -11,6 +11,11 @@ module LanguageServer
           @attributes.freeze
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # The commands to be executed on the server
         #

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

@@ -1,7 +1,7 @@
 module LanguageServer
   module Protocol
     module Interface
-      class ExecuteCommandParams < WorkDoneProgressParams
+      class ExecuteCommandParams
         def initialize(work_done_token: nil, command:, arguments: nil)
           @attributes = {}
 
@@ -12,6 +12,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 identifier of the actual command handler.
         #

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

@@ -4,7 +4,7 @@ module LanguageServer
       #
       # Execute command registration options.
       #
-      class ExecuteCommandRegistrationOptions < ExecuteCommandOptions
+      class ExecuteCommandRegistrationOptions
         def initialize(work_done_progress: nil, commands:)
           @attributes = {}
 
@@ -14,6 +14,19 @@ module LanguageServer
           @attributes.freeze
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        #
+        # The commands to be executed on the server
+        #
+        # @return [string[]]
+        def commands
+          attributes.fetch(:commands)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Matching options for the file operation pattern.
+      #
+      class FileOperationPatternOptions
+        def initialize(ignore_case: nil)
+          @attributes = {}
+
+          @attributes[:ignoreCase] = ignore_case if ignore_case
+
+          @attributes.freeze
+        end
+
+        #
+        # The pattern should be matched ignoring casing.
+        #
+        # @return [boolean]
+        def ignore_case
+          attributes.fetch(:ignoreCase)
+        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_registration_options.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The options to register for file operations.
+      #
+      class FileOperationRegistrationOptions
+        def initialize(filters:)
+          @attributes = {}
+
+          @attributes[:filters] = filters
+
+          @attributes.freeze
+        end
+
+        #
+        # The actual filters.
+        #
+        # @return [FileOperationFilter[]]
+        def filters
+          attributes.fetch(:filters)
+        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_rename.rb

@@ -0,0 +1,45 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents information on a file/folder rename.
+      #
+      class FileRename
+        def initialize(old_uri:, new_uri:)
+          @attributes = {}
+
+          @attributes[:oldUri] = old_uri
+          @attributes[:newUri] = new_uri
+
+          @attributes.freeze
+        end
+
+        #
+        # A file:// URI for the original location of the file/folder being renamed.
+        #
+        # @return [string]
+        def old_uri
+          attributes.fetch(:oldUri)
+        end
+
+        #
+        # A file:// URI for the new location of the file/folder being renamed.
+        #
+        # @return [string]
+        def new_uri
+          attributes.fetch(:newUri)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end