language_server-protocol 3.7.0.0 → 3.15.0.0

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

@@ -2,14 +2,16 @@ module LanguageServer
   module Protocol
     module Interface
       class CompletionItem
-        def initialize(label:, kind: nil, detail: nil, documentation: nil, deprecated: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, text_edit: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil)
+        def initialize(label:, kind: nil, tags: nil, detail: nil, documentation: nil, deprecated: nil, preselect: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, text_edit: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil)
           @attributes = {}
 
           @attributes[:label] = label
           @attributes[:kind] = kind if kind
+          @attributes[:tags] = tags if tags
           @attributes[:detail] = detail if detail
           @attributes[:documentation] = documentation if documentation
           @attributes[:deprecated] = deprecated if deprecated
+          @attributes[:preselect] = preselect if preselect
           @attributes[:sortText] = sort_text if sort_text
           @attributes[:filterText] = filter_text if filter_text
           @attributes[:insertText] = insert_text if insert_text
@@ -35,13 +37,22 @@ module LanguageServer
 
         #
         # The kind of this completion item. Based of the kind
-        # an icon is chosen by the editor.
+        # an icon is chosen by the editor. The standardized set
+        # of available values is defined in `CompletionItemKind`.
         #
         # @return [number]
         def kind
           attributes.fetch(:kind)
         end
 
+        #
+        # Tags for this completion item.
+        #
+        # @return [1[]]
+        def tags
+          attributes.fetch(:tags)
+        end
+
         #
         # A human-readable string with additional information
         # about this item, like type or symbol information.
@@ -67,6 +78,18 @@ module LanguageServer
           attributes.fetch(:deprecated)
         end
 
+        #
+        # Select this item when showing.
+        #
+        # *Note* that only one completion item can be selected and that the
+        # tool / client decides which item that is. The rule is that the *first*
+        # item of those that match best is selected.
+        #
+        # @return [boolean]
+        def preselect
+          attributes.fetch(:preselect)
+        end
+
         #
         # A string that should be used when comparing this item
         # with other items. When `falsy` the label is used.
@@ -103,9 +126,10 @@ module LanguageServer
 
         #
         # The format of the insert text. The format applies to both the `insertText` property
-        # and the `newText` property of a provided `textEdit`.
+        # and the `newText` property of a provided `textEdit`. If omitted defaults to
+        # `InsertTextFormat.PlainText`.
         #
-        # @return [InsertTextFormat]
+        # @return [DiagnosticTag]
         def insert_text_format
           attributes.fetch(:insertTextFormat)
         end
@@ -157,7 +181,7 @@ module LanguageServer
         end
 
         #
-        # An data entry field that is preserved on a completion item between
+        # A data entry field that is preserved on a completion item between
         # a completion and a completion resolve request.
         #
         # @return [any]

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

@@ -4,31 +4,53 @@ 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
+        # `ClientCapabilities.textDocument.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,17 +1,18 @@
 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
         end
 
         #
-        # The completion context. This is only available it the client specifies
+        # The completion context. This is only available if the client specifies
         # to send this using `ClientCapabilities.textDocument.completion.contextSupport === true`
         #
         # @return [CompletionContext]

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

@@ -0,0 +1,54 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Create file operation
+      #
+      class CreateFile
+        def initialize(kind:, uri:, options: nil)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:uri] = uri
+          @attributes[:options] = options if options
+
+          @attributes.freeze
+        end
+
+        #
+        # A create
+        #
+        # @return ["create"]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # The resource to create.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # Additional options
+        #
+        # @return [CreateFileOptions]
+        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/create_file_options.rb

@@ -0,0 +1,45 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Options to create a file.
+      #
+      class CreateFileOptions
+        def initialize(overwrite: nil, ignore_if_exists: nil)
+          @attributes = {}
+
+          @attributes[:overwrite] = overwrite if overwrite
+          @attributes[:ignoreIfExists] = ignore_if_exists if ignore_if_exists
+
+          @attributes.freeze
+        end
+
+        #
+        # Overwrite existing file. Overwrite wins over `ignoreIfExists`
+        #
+        # @return [boolean]
+        def overwrite
+          attributes.fetch(:overwrite)
+        end
+
+        #
+        # Ignore if exists.
+        #
+        # @return [boolean]
+        def ignore_if_exists
+          attributes.fetch(:ignoreIfExists)
+        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/{color_provider_options.rb → declaration_registration_options.rb}

@@ -1,13 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Color provider Options
-      #
-      class ColorProviderOptions
-        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