language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -14,8 +14,8 @@ module LanguageServer
 
         #
         # The label of this color presentation. It will be shown on the color
-        # picker header. By default this is also the text that is inserted when
-        # selecting this color presentation.
+        # picker header. By default this is also the text that is inserted when selecting
+        # this color presentation.
         #
         # @return [string]
         def label
@@ -23,9 +23,9 @@ module LanguageServer
         end
 
         #
-        # An [edit](#TextEdit) which is applied to a document when selecting
-        # this presentation for the color. When omitted the
-        # [label](#ColorPresentation.label) is used.
+        # An {@link TextEdit edit} which is applied to a document when selecting
+        # this presentation for the color.  When `falsy` the {@link ColorPresentation.label label}
+        # is used.
         #
         # @return [TextEdit]
         def text_edit
@@ -33,9 +33,8 @@ module LanguageServer
         end
 
         #
-        # An optional array of additional [text edits](#TextEdit) that are applied
-        # when selecting this color presentation. Edits must not overlap with the
-        # main [edit](#ColorPresentation.textEdit) nor with themselves.
+        # An optional array of additional {@link TextEdit text edits} that are applied when
+        # selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
         #
         # @return [TextEdit[]]
         def additional_text_edits

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

@@ -1,36 +1,22 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link ColorPresentationRequest}.
+      #
       class ColorPresentationParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, color:, range:)
+        def initialize(text_document:, color:, range:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
           @attributes[:color] = color
           @attributes[:range] = range
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_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
-
-        #
-        # 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.
         #
@@ -40,7 +26,7 @@ module LanguageServer
         end
 
         #
-        # The color information to request presentations for.
+        # The color to request presentations for.
         #
         # @return [Color]
         def color
@@ -55,6 +41,23 @@ module LanguageServer
           attributes.fetch(:range)
         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
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,12 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents a reference to a command. Provides a title which
+      # will be used to represent a command in the UI and, optionally,
+      # an array of arguments which will be passed to the command handler
+      # function when invoked.
+      #
       class Command
         def initialize(title:, command:, arguments: nil)
           @attributes = {}

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

@@ -1,15 +1,18 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Completion client capabilities
+      #
       class CompletionClientCapabilities
-        def initialize(dynamic_registration: nil, completion_item: nil, completion_item_kind: nil, context_support: nil, insert_text_mode: nil, completion_list: nil)
+        def initialize(dynamic_registration: nil, completion_item: nil, completion_item_kind: nil, insert_text_mode: nil, context_support: nil, completion_list: nil)
           @attributes = {}
 
           @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
           @attributes[:completionItem] = completion_item if completion_item
           @attributes[:completionItemKind] = completion_item_kind if completion_item_kind
-          @attributes[:contextSupport] = context_support if context_support
           @attributes[:insertTextMode] = insert_text_mode if insert_text_mode
+          @attributes[:contextSupport] = context_support if context_support
           @attributes[:completionList] = completion_list if completion_list
 
           @attributes.freeze
@@ -27,7 +30,7 @@ module LanguageServer
         # The client supports the following `CompletionItem` specific
         # capabilities.
         #
-        # @return [{ snippetSupport?: boolean; commitCharactersSupport?: boolean; documentationFormat?: MarkupKind[]; deprecatedSupport?: boolean; preselectSupport?: boolean; tagSupport?: { valueSet: 1[]; }; insertReplaceSupport?: boolean; resolveSupport?: { ...; }; insertTextModeSupport?: { ...; }; labelDetailsSupport?: boolean; }]
+        # @return [{ snippetSupport?: boolean; commitCharactersSupport?: boolean; documentationFormat?: MarkupKind[]; deprecatedSupport?: boolean; preselectSupport?: boolean; tagSupport?: { valueSet: CompletionItemTag[]; }; insertReplaceSupport?: boolean; resolveSupport?: { properties: string[]; }; insertTextModeSupport?: { valueSet: InsertTextMode[]; }; labelDetailsSupport?: boolean; }]
         def completion_item
           attributes.fetch(:completionItem)
         end
@@ -37,6 +40,18 @@ module LanguageServer
           attributes.fetch(:completionItemKind)
         end
 
+        #
+        # Defines how the client handles whitespace and indentation
+        # when accepting a completion item that uses multi line
+        # text in either `insertText` or `textEdit`.
+        #
+        # @since 3.17.0
+        #
+        # @return [InsertTextMode]
+        def insert_text_mode
+          attributes.fetch(:insertTextMode)
+        end
+
         #
         # The client supports to send additional context information for a
         # `textDocument/completion` request.
@@ -46,19 +61,12 @@ module LanguageServer
           attributes.fetch(:contextSupport)
         end
 
-        #
-        # The client's default when the completion item doesn't provide a
-        # `insertTextMode` property.
-        #
-        # @return [InsertTextMode]
-        def insert_text_mode
-          attributes.fetch(:insertTextMode)
-        end
-
         #
         # The client supports the following `CompletionList` specific
         # capabilities.
         #
+        # @since 3.17.0
+        #
         # @return [{ itemDefaults?: string[]; }]
         def completion_list
           attributes.fetch(:completionList)

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

@@ -2,8 +2,7 @@ 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)
@@ -24,9 +23,8 @@ 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

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A completion item represents a text snippet that is
+      # proposed to complete text that is being typed.
+      #
       class CompletionItem
         def initialize(label:, label_details: nil, 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, text_edit_text: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil)
           @attributes = {}
@@ -45,6 +49,8 @@ module LanguageServer
         #
         # Additional details for the label
         #
+        # @since 3.17.0
+        #
         # @return [CompletionItemLabelDetails]
         def label_details
           attributes.fetch(:labelDetails)
@@ -52,8 +58,7 @@ module LanguageServer
 
         #
         # The kind of this completion item. Based of the kind
-        # an icon is chosen by the editor. The standardized set
-        # of available values is defined in `CompletionItemKind`.
+        # an icon is chosen by the editor.
         #
         # @return [CompletionItemKind]
         def kind
@@ -63,7 +68,9 @@ module LanguageServer
         #
         # Tags for this completion item.
         #
-        # @return [1[]]
+        # @since 3.15.0
+        #
+        # @return [CompletionItemTag[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -87,6 +94,7 @@ module LanguageServer
 
         #
         # Indicates if this item is deprecated.
+        # @deprecated Use `tags` instead.
         #
         # @return [boolean]
         def deprecated
@@ -107,8 +115,8 @@ module LanguageServer
 
         #
         # A string that should be used when comparing this item
-        # with other items. When omitted the label is used
-        # as the sort text for this item.
+        # with other items. When `falsy` the {@link CompletionItem.label label}
+        # is used.
         #
         # @return [string]
         def sort_text
@@ -117,8 +125,8 @@ module LanguageServer
 
         #
         # A string that should be used when filtering a set of
-        # completion items. When omitted the label is used as the
-        # filter text for this item.
+        # completion items. When `falsy` the {@link CompletionItem.label label}
+        # is used.
         #
         # @return [string]
         def filter_text
@@ -127,8 +135,8 @@ module LanguageServer
 
         #
         # A string that should be inserted into a document when selecting
-        # this completion. When omitted the label is used as the insert text
-        # for this item.
+        # this completion. When `falsy` the {@link CompletionItem.label label}
+        # is used.
         #
         # The `insertText` is subject to interpretation by the client side.
         # Some tools might not take the string literally. For example
@@ -158,28 +166,28 @@ module LanguageServer
 
         #
         # How whitespace and indentation is handled during completion
-        # item insertion. If not provided the client's default value depends on
+        # item insertion. If not provided the clients default value depends on
         # the `textDocument.completion.insertTextMode` client capability.
         #
+        # @since 3.16.0
+        #
         # @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.
+        # An {@link TextEdit edit} which is applied to a document when selecting
+        # this completion. When an edit is provided the value of
+        # {@link CompletionItem.insertText insertText} is ignored.
         #
         # 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 `InsertReplaceEdit`s via the
-        # `textDocument.completion.completionItem.insertReplaceSupport` client
-        # capability property.
+        # signal support for `InsertReplaceEdits` via the
+        # `textDocument.completion.insertReplaceSupport` client capability
+        # property.
         #
         # *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
@@ -188,6 +196,8 @@ module LanguageServer
         # must be a prefix of the edit's replace range, that means it must be
         # contained and starting at the same position.
         #
+        # @since 3.16.0 additional type `InsertReplaceEdit`
+        #
         # @return [TextEdit | InsertReplaceEdit]
         def text_edit
           attributes.fetch(:textEdit)
@@ -203,19 +213,21 @@ module LanguageServer
         # If not provided and a list's default range is provided the label
         # property is used as a text.
         #
+        # @since 3.17.0
+        #
         # @return [string]
         def text_edit_text
           attributes.fetch(:textEditText)
         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.
+        # An optional array of additional {@link TextEdit text edits} that are applied when
+        # selecting this completion. Edits must not overlap (including the same insert position)
+        # with the main {@link CompletionItem.textEdit 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
@@ -223,10 +235,9 @@ 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
@@ -234,9 +245,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 {@link Command command} that is executed *after* inserting this completion. *Note* that
+        # additional modifications to the current document should be described with the
+        # {@link CompletionItem.additionalTextEdits additionalTextEdits}-property.
         #
         # @return [Command]
         def command
@@ -244,8 +255,8 @@ module LanguageServer
         end
 
         #
-        # A data entry field that is preserved on a completion item between
-        # a completion and a completion resolve request.
+        # A data entry field that is preserved on a completion item between a
+        # {@link CompletionRequest} and a {@link CompletionResolveRequest}.
         #
         # @return [LSPAny]
         def data

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Additional details for a completion item label.
       #
+      # @since 3.17.0
+      #
       class CompletionItemLabelDetails
         def initialize(detail: nil, description: nil)
           @attributes = {}
@@ -15,9 +17,8 @@ module LanguageServer
         end
 
         #
-        # An optional string which is rendered less prominently directly after
-        # {@link CompletionItem.label label}, without any spacing. Should be
-        # used for function signatures or type annotations.
+        # An optional string which is rendered less prominently directly after {@link CompletionItem.label label},
+        # without any spacing. Should be used for function signatures and type annotations.
         #
         # @return [string]
         def detail
@@ -25,9 +26,8 @@ module LanguageServer
         end
 
         #
-        # An optional string which is rendered less prominently after
-        # {@link CompletionItemLabelDetails.detail}. Should be used for fully qualified
-        # names or file path.
+        # An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
+        # for fully qualified names and file paths.
         #
         # @return [string]
         def description

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 {@link CompletionItem completion items} to be presented
+      # in the editor.
       #
       class CompletionList
         def initialize(is_incomplete:, item_defaults: nil, items:)
@@ -17,8 +17,7 @@ module LanguageServer
         end
 
         #
-        # This list is not complete. Further typing should result in recomputing
-        # this list.
+        # This list it not complete. Further typing results in recomputing this list.
         #
         # Recomputed lists have all their items replaced (not appended) in the
         # incomplete completion sessions.
@@ -41,6 +40,8 @@ module LanguageServer
         # signals support for this via the `completionList.itemDefaults`
         # capability.
         #
+        # @since 3.17.0
+        #
         # @return [{ commitCharacters?: string[]; editRange?: Range | { insert: Range; replace: Range; }; insertTextFormat?: InsertTextFormat; insertTextMode?: InsertTextMode; data?: LSPAny; }]
         def item_defaults
           attributes.fetch(:itemDefaults)

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

@@ -5,35 +5,27 @@ module LanguageServer
       # Completion options.
       #
       class CompletionOptions
-        def initialize(work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil)
+        def initialize(trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil, work_done_progress: 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[:completionItem] = completion_item if completion_item
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
-        # The additional characters, beyond the defaults provided by the client (typically
-        # [a-zA-Z]), that should automatically trigger a completion request. For example
-        # `.` in JavaScript represents the beginning of an object property or method and is
-        # thus a good candidate for triggering a completion request.
+        # 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 a 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
@@ -41,13 +33,14 @@ 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 client capability
-        # `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
+        # `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.
+        # If a server provides both `allCommitCharacters` and commit characters on an individual
+        # completion item the ones on the completion item win.
+        #
+        # @since 3.2.0
         #
         # @return [string[]]
         def all_commit_characters
@@ -67,11 +60,18 @@ module LanguageServer
         # The server supports the following `CompletionItem` specific
         # capabilities.
         #
+        # @since 3.17.0
+        #
         # @return [{ labelDetailsSupport?: boolean; }]
         def completion_item
           attributes.fetch(:completionItem)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,19 +1,31 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Completion parameters
+      #
       class CompletionParams
-        def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil, context: nil)
+        def initialize(context: nil, text_document:, position:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
+          @attributes[:context] = context if context
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @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
+        # to send this using the client capability `textDocument.completion.contextSupport === true`
+        #
+        # @return [CompletionContext]
+        def context
+          attributes.fetch(:context)
+        end
+
         #
         # The text document.
         #
@@ -39,24 +51,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 completion context. This is only available if the client specifies
-        # to send this using the client capability
-        # `completion.contextSupport === true`
-        #
-        # @return [CompletionContext]
-        def context
-          attributes.fetch(:context)
-        end
-
         attr_reader :attributes
 
         def to_hash