language_server-protocol 3.14.0.1 → 3.16.0.0

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

@@ -2,8 +2,8 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Represents a collection of [completion items](#CompletionItem) to be presented
-      # in the editor.
+      # Represents a collection of [completion items](#CompletionItem) to be
+      # presented in the editor.
       #
       class CompletionList
         def initialize(is_incomplete:, items:)

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

@@ -4,31 +4,56 @@ module LanguageServer
       #
       # Completion options.
       #
-      class CompletionOptions
-        def initialize(resolve_provider: nil, trigger_characters: nil)
+      class CompletionOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil)
           @attributes = {}
 
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:triggerCharacters] = trigger_characters if trigger_characters
+          @attributes[:allCommitCharacters] = all_commit_characters if all_commit_characters
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @attributes.freeze
         end
 
         #
-        # The server provides support to resolve additional
-        # information for a completion item.
+        # Most tools trigger completion request automatically without explicitly
+        # requesting it using a keyboard shortcut (e.g. Ctrl+Space). Typically they
+        # do so when the user starts to type an identifier. For example if the user
+        # types `c` in a JavaScript file code complete will automatically pop up
+        # present `console` besides others as a completion item. Characters that
+        # make up identifiers don't need to be listed here.
         #
-        # @return [boolean]
-        def resolve_provider
-          attributes.fetch(:resolveProvider)
+        # If code complete should automatically be trigger on characters not being
+        # valid inside an identifier (for example `.` in JavaScript) list them in
+        # `triggerCharacters`.
+        #
+        # @return [string[]]
+        def trigger_characters
+          attributes.fetch(:triggerCharacters)
         end
 
         #
-        # The characters that trigger completion automatically.
+        # The list of all possible characters that commit a completion. This field
+        # can be used if clients don't support individual commit characters per
+        # completion item. See client capability
+        # `completion.completionItem.commitCharactersSupport`.
+        #
+        # If a server provides both `allCommitCharacters` and commit characters on
+        # an individual completion item the ones on the completion item win.
         #
         # @return [string[]]
-        def trigger_characters
-          attributes.fetch(:triggerCharacters)
+        def all_commit_characters
+          attributes.fetch(:allCommitCharacters)
+        end
+
+        #
+        # The server provides support to resolve additional
+        # information for a completion item.
+        #
+        # @return [boolean]
+        def resolve_provider
+          attributes.fetch(:resolveProvider)
         end
 
         attr_reader :attributes

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

@@ -1,10 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      class CompletionParams < TextDocumentPositionParams
-        def initialize(text_document:, position:, context: nil)
+      class CompletionParams < PartialResultParams
+        def initialize(partial_result_token: nil, context: nil)
           @attributes = {}
 
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:context] = context if context
 
           @attributes.freeze
@@ -12,7 +13,8 @@ module LanguageServer
 
         #
         # The completion context. This is only available if the client specifies
-        # to send this using `ClientCapabilities.textDocument.completion.contextSupport === true`
+        # to send this using the client capability
+        # `completion.contextSupport === true`
         #
         # @return [CompletionContext]
         def context

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

@@ -1,40 +1,18 @@
 module LanguageServer
   module Protocol
     module Interface
-      class CompletionRegistrationOptions < TextDocumentRegistrationOptions
-        def initialize(document_selector:, trigger_characters: nil, resolve_provider: nil)
+      class CompletionRegistrationOptions < CompletionOptions
+        def initialize(work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil)
           @attributes = {}
 
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:triggerCharacters] = trigger_characters if trigger_characters
+          @attributes[:allCommitCharacters] = all_commit_characters if all_commit_characters
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @attributes.freeze
         end
 
-        #
-        # Most tools trigger completion request automatically without explicitly requesting
-        # it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user
-        # starts to type an identifier. For example if the user types `c` in a JavaScript file
-        # code complete will automatically pop up present `console` besides others as a
-        # completion item. Characters that make up identifiers don't need to be listed here.
-        #
-        # If code complete should automatically be trigger on characters not being valid inside
-        # an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
-        #
-        # @return [string[]]
-        def trigger_characters
-          attributes.fetch(:triggerCharacters)
-        end
-
-        #
-        # The server provides support to resolve additional
-        # information for a completion item.
-        #
-        # @return [boolean]
-        def resolve_provider
-          attributes.fetch(:resolveProvider)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -5,12 +5,13 @@ module LanguageServer
       # Create file operation
       #
       class CreateFile
-        def initialize(kind:, uri:, options: nil)
+        def initialize(kind:, uri:, options: nil, annotation_id: nil)
           @attributes = {}
 
           @attributes[:kind] = kind
           @attributes[:uri] = uri
           @attributes[:options] = options if options
+          @attributes[:annotationId] = annotation_id if annotation_id
 
           @attributes.freeze
         end
@@ -39,6 +40,14 @@ module LanguageServer
           attributes.fetch(:options)
         end
 
+        #
+        # An optional annotation identifer describing the operation.
+        #
+        # @return [string]
+        def annotation_id
+          attributes.fetch(:annotationId)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,37 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The parameters sent in notifications/requests for user-initiated creation
+      # of files.
+      #
+      class CreateFilesParams
+        def initialize(files:)
+          @attributes = {}
+
+          @attributes[:files] = files
+
+          @attributes.freeze
+        end
+
+        #
+        # An array of all files/folders created in this operation.
+        #
+        # @return [FileCreate[]]
+        def files
+          attributes.fetch(:files)
+        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/declaration_client_capabilities.rb

@@ -0,0 +1,44 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DeclarationClientCapabilities
+        def initialize(dynamic_registration: nil, link_support: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:linkSupport] = link_support if link_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether declaration supports dynamic registration. If this is set to
+        # `true` the client supports the new `DeclarationRegistrationOptions`
+        # return value for the corresponding server capability as well.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # The client supports additional metadata in the form of declaration links.
+        #
+        # @return [boolean]
+        def link_support
+          attributes.fetch(:linkSupport)
+        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/declaration_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DeclarationOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        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/declaration_params.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DeclarationParams < PartialResultParams
+        def initialize(partial_result_token: nil)
+          @attributes = {}
+
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+
+          @attributes.freeze
+        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/{folding_range_provider_options.rb → declaration_registration_options.rb}

@@ -1,13 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Folding range provider options.
-      #
-      class FoldingRangeProviderOptions
-        def initialize()
+      class DeclarationRegistrationOptions < StaticRegistrationOptions
+        def initialize(id: nil)
           @attributes = {}
 
+          @attributes[:id] = id if id
 
           @attributes.freeze
         end

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

@@ -0,0 +1,42 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DefinitionClientCapabilities
+        def initialize(dynamic_registration: nil, link_support: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:linkSupport] = link_support if link_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether definition supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # The client supports additional metadata in the form of definition links.
+        #
+        # @return [boolean]
+        def link_support
+          attributes.fetch(:linkSupport)
+        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/definition_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DefinitionOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        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/definition_params.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DefinitionParams < PartialResultParams
+        def initialize(partial_result_token: nil)
+          @attributes = {}
+
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+
+          @attributes.freeze
+        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/definition_registration_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DefinitionRegistrationOptions < DefinitionOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end