language_server-protocol 3.15.0.2 → 3.16.0.0

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

@@ -25,7 +25,7 @@ module LanguageServer
         # The client supports the following `CompletionItem` specific
         # capabilities.
         #
-        # @return [{ snippetSupport?: boolean; commitCharactersSupport?: boolean; documentationFormat?: MarkupKind[]...]
+        # @return [{ snippetSupport?: boolean; commitCharactersSupport?: boolean; documentationFormat?: MarkupKind[]; deprecatedSupport?: boolean; preselectSupport?: boolean; tagSupport?: { valueSet: 1[]; }; insertReplaceSupport?: boolean; resolveSupport?: { ...; }; insertTextModeSupport?: { ...; }; }]
         def completion_item
           attributes.fetch(:completionItem)
         end

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

@@ -2,7 +2,8 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Contains additional information about the context in which a completion request is triggered.
+      # Contains additional information about the context in which a completion
+      # request is triggered.
       #
       class CompletionContext
         def initialize(trigger_kind:, trigger_character: nil)
@@ -23,8 +24,9 @@ module LanguageServer
         end
 
         #
-        # The trigger character (a single character) that has trigger code complete.
-        # Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
+        # The trigger character (a single character) that has trigger code
+        # complete. Is undefined if
+        # `triggerKind !== CompletionTriggerKind.TriggerCharacter`
         #
         # @return [string]
         def trigger_character

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       class CompletionItem
-        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)
+        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, insert_text_mode: nil, text_edit: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil)
           @attributes = {}
 
           @attributes[:label] = label
@@ -16,6 +16,7 @@ module LanguageServer
           @attributes[:filterText] = filter_text if filter_text
           @attributes[:insertText] = insert_text if insert_text
           @attributes[:insertTextFormat] = insert_text_format if insert_text_format
+          @attributes[:insertTextMode] = insert_text_mode if insert_text_mode
           @attributes[:textEdit] = text_edit if text_edit
           @attributes[:additionalTextEdits] = additional_text_edits if additional_text_edits
           @attributes[:commitCharacters] = commit_characters if commit_characters
@@ -40,7 +41,7 @@ module LanguageServer
         # an icon is chosen by the editor. The standardized set
         # of available values is defined in `CompletionItemKind`.
         #
-        # @return [number]
+        # @return [any]
         def kind
           attributes.fetch(:kind)
         end
@@ -92,7 +93,8 @@ module LanguageServer
 
         #
         # A string that should be used when comparing this item
-        # with other items. When `falsy` the label is used.
+        # with other items. When `falsy` the label is used
+        # as the sort text for this item.
         #
         # @return [string]
         def sort_text
@@ -101,7 +103,8 @@ module LanguageServer
 
         #
         # A string that should be used when filtering a set of
-        # completion items. When `falsy` the label is used.
+        # completion items. When `falsy` the label is used as the
+        # filter text for this item.
         #
         # @return [string]
         def filter_text
@@ -110,14 +113,16 @@ module LanguageServer
 
         #
         # A string that should be inserted into a document when selecting
-        # this completion. When `falsy` the label is used.
+        # this completion. When `falsy` the label is used as the insert text
+        # for this item.
         #
         # The `insertText` is subject to interpretation by the client side.
         # Some tools might not take the string literally. For example
-        # VS Code when code complete is requested in this example `con<cursor position>`
-        # and a completion item with an `insertText` of `console` is provided it
-        # will only insert `sole`. Therefore it is recommended to use `textEdit` instead
-        # since it avoids additional client side interpretation.
+        # VS Code when code complete is requested in this example
+        # `con<cursor position>` and a completion item with an `insertText` of
+        # `console` is provided it will only insert `sole`. Therefore it is
+        # recommended to use `textEdit` instead since it avoids additional client
+        # side interpretation.
         #
         # @return [string]
         def insert_text
@@ -125,35 +130,60 @@ module LanguageServer
         end
 
         #
-        # The format of the insert text. The format applies to both the `insertText` property
-        # and the `newText` property of a provided `textEdit`. If omitted defaults to
-        # `InsertTextFormat.PlainText`.
+        # The format of the insert text. The format applies to both the
+        # `insertText` property and the `newText` property of a provided
+        # `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
         #
-        # @return [DiagnosticTag]
+        # @return [InsertTextFormat]
         def insert_text_format
           attributes.fetch(:insertTextFormat)
         end
 
         #
-        # An edit which is applied to a document when selecting this completion. When an edit is provided the value of
-        # `insertText` is ignored.
+        # How whitespace and indentation is handled during completion
+        # item insertion. If not provided the client's default value depends on
+        # the `textDocument.completion.insertTextMode` client capability.
+        #
+        # @return [InsertTextMode]
+        def insert_text_mode
+          attributes.fetch(:insertTextMode)
+        end
+
+        #
+        # An edit which is applied to a document when selecting this completion.
+        # When an edit is provided the value of `insertText` is ignored.
+        #
+        # *Note:* The range of the edit must be a single line range and it must
+        # contain the position at which completion has been requested.
+        #
+        # Most editors support two different operations when accepting a completion
+        # item. One is to insert a completion text and the other is to replace an
+        # existing text with a completion text. Since this can usually not be
+        # predetermined by a server it can report both ranges. Clients need to
+        # signal support for `InsertReplaceEdits` via the
+        # `textDocument.completion.insertReplaceSupport` client capability
+        # property.
         #
-        # *Note:* The range of the edit must be a single line range and it must contain the position at which completion
-        # has been requested.
+        # *Note 1:* The text edit's range as well as both ranges from an insert
+        # replace edit must be a [single line] and they must contain the position
+        # at which completion has been requested.
+        # *Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range
+        # must be a prefix of the edit's replace range, that means it must be
+        # contained and starting at the same position.
         #
-        # @return [TextEdit]
+        # @return [TextEdit | InsertReplaceEdit]
         def text_edit
           attributes.fetch(:textEdit)
         end
 
         #
         # An optional array of additional text edits that are applied when
-        # selecting this completion. Edits must not overlap (including the same insert position)
-        # with the main edit nor with themselves.
+        # selecting this completion. Edits must not overlap (including the same
+        # insert position) with the main edit nor with themselves.
         #
-        # Additional text edits should be used to change text unrelated to the current cursor position
-        # (for example adding an import statement at the top of the file if the completion item will
-        # insert an unqualified type).
+        # Additional text edits should be used to change text unrelated to the
+        # current cursor position (for example adding an import statement at the
+        # top of the file if the completion item will insert an unqualified type).
         #
         # @return [TextEdit[]]
         def additional_text_edits
@@ -161,9 +191,10 @@ module LanguageServer
         end
 
         #
-        # An optional set of characters that when pressed while this completion is active will accept it first and
-        # then type that character. *Note* that all commit characters should have `length=1` and that superfluous
-        # characters will be ignored.
+        # An optional set of characters that when pressed while this completion is
+        # active will accept it first and then type that character. *Note* that all
+        # commit characters should have `length=1` and that superfluous characters
+        # will be ignored.
         #
         # @return [string[]]
         def commit_characters
@@ -171,9 +202,9 @@ module LanguageServer
         end
 
         #
-        # An optional command that is executed *after* inserting this completion. *Note* that
-        # additional modifications to the current document should be described with the
-        # additionalTextEdits-property.
+        # An optional command that is executed *after* inserting this completion.
+        # *Note* that additional modifications to the current document should be
+        # described with the additionalTextEdits-property.
         #
         # @return [Command]
         def command

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

@@ -17,14 +17,16 @@ module LanguageServer
         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.
+        # 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`.
+        # 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
@@ -32,12 +34,13 @@ module LanguageServer
         end
 
         #
-        # 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`.
+        # 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.
+        # If a server provides both `allCommitCharacters` and commit characters on
+        # an individual completion item the ones on the completion item win.
         #
         # @return [string[]]
         def all_commit_characters

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

@@ -13,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/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

@@ -12,9 +12,9 @@ module LanguageServer
         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.
+        # 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

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

@@ -5,12 +5,13 @@ module LanguageServer
       # Delete file operation
       #
       class DeleteFile
-        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/delete_files_params.rb

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

@@ -2,16 +2,18 @@ module LanguageServer
   module Protocol
     module Interface
       class Diagnostic
-        def initialize(range:, severity: nil, code: nil, source: nil, message:, tags: nil, related_information: nil)
+        def initialize(range:, severity: nil, code: nil, code_description: nil, source: nil, message:, tags: nil, related_information: nil, data: nil)
           @attributes = {}
 
           @attributes[:range] = range
           @attributes[:severity] = severity if severity
           @attributes[:code] = code if code
+          @attributes[:codeDescription] = code_description if code_description
           @attributes[:source] = source if source
           @attributes[:message] = message
           @attributes[:tags] = tags if tags
           @attributes[:relatedInformation] = related_information if related_information
+          @attributes[:data] = data if data
 
           @attributes.freeze
         end
@@ -41,6 +43,14 @@ module LanguageServer
           attributes.fetch(:code)
         end
 
+        #
+        # An optional property to describe the error code.
+        #
+        # @return [CodeDescription]
+        def code_description
+          attributes.fetch(:codeDescription)
+        end
+
         #
         # A human-readable string describing the source of this
         # diagnostic, e.g. 'typescript' or 'super lint'.
@@ -75,6 +85,16 @@ module LanguageServer
           attributes.fetch(:relatedInformation)
         end
 
+        #
+        # A data entry field that is preserved between a
+        # `textDocument/publishDiagnostics` notification and
+        # `textDocument/codeAction` request.
+        #
+        # @return [unknown]
+        def data
+          attributes.fetch(:data)
+        end
+
         attr_reader :attributes
 
         def to_hash