language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -1,10 +1,6 @@
 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 = {}
@@ -49,18 +45,17 @@ module LanguageServer
         #
         # Additional details for the label
         #
-        # @since 3.17.0
-        #
-        # @return [CompletionItemLabelDetails | nil]
+        # @return [CompletionItemLabelDetails]
         def label_details
           attributes.fetch(:labelDetails)
         end
 
         #
         # 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 [CompletionItemKind | nil]
+        # @return [CompletionItemKind]
         def kind
           attributes.fetch(:kind)
         end
@@ -68,9 +63,7 @@ module LanguageServer
         #
         # Tags for this completion item.
         #
-        # @since 3.15.0
-        #
-        # @return [CompletionItemTag[] | nil]
+        # @return [1[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -79,7 +72,7 @@ module LanguageServer
         # A human-readable string with additional information
         # about this item, like type or symbol information.
         #
-        # @return [string | nil]
+        # @return [string]
         def detail
           attributes.fetch(:detail)
         end
@@ -87,16 +80,15 @@ module LanguageServer
         #
         # A human-readable string that represents a doc-comment.
         #
-        # @return [string | MarkupContent | nil]
+        # @return [string | MarkupContent]
         def documentation
           attributes.fetch(:documentation)
         end
 
         #
         # Indicates if this item is deprecated.
-        # @deprecated Use `tags` instead.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def deprecated
           attributes.fetch(:deprecated)
         end
@@ -108,35 +100,35 @@ module LanguageServer
         # tool / client decides which item that is. The rule is that the *first*
         # item of those that match best is selected.
         #
-        # @return [boolean | nil]
+        # @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](#CompletionItem.label)
-        # is used.
+        # with other items. When `falsy` the label is used
+        # as the sort text for this item.
         #
-        # @return [string | nil]
+        # @return [string]
         def sort_text
           attributes.fetch(:sortText)
         end
 
         #
         # A string that should be used when filtering a set of
-        # completion items. When `falsy` the [label](#CompletionItem.label)
-        # is used.
+        # completion items. When `falsy` the label is used as the
+        # filter text for this item.
         #
-        # @return [string | nil]
+        # @return [string]
         def filter_text
           attributes.fetch(:filterText)
         end
 
         #
         # A string that should be inserted into a document when selecting
-        # this completion. When `falsy` the [label](#CompletionItem.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
@@ -146,7 +138,7 @@ module LanguageServer
         # recommended to use `textEdit` instead since it avoids additional client
         # side interpretation.
         #
-        # @return [string | nil]
+        # @return [string]
         def insert_text
           attributes.fetch(:insertText)
         end
@@ -159,35 +151,35 @@ module LanguageServer
         # Please note that the insertTextFormat doesn't apply to
         # `additionalTextEdits`.
         #
-        # @return [InsertTextFormat | nil]
+        # @return [InsertTextFormat]
         def insert_text_format
           attributes.fetch(:insertTextFormat)
         end
 
         #
         # How whitespace and indentation is handled during completion
-        # item insertion. If not provided the clients default value depends on
+        # item insertion. If not provided the client's default value depends on
         # the `textDocument.completion.insertTextMode` client capability.
         #
-        # @since 3.16.0
-        #
-        # @return [InsertTextMode | nil]
+        # @return [InsertTextMode]
         def insert_text_mode
           attributes.fetch(:insertTextMode)
         end
 
         #
-        # An [edit](#TextEdit) which is applied to a document when selecting
-        # this completion. When an edit is provided the value of
-        # [insertText](#CompletionItem.insertText) is ignored.
+        # 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.
+        # signal support for `InsertReplaceEdit`s via the
+        # `textDocument.completion.completionItem.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
@@ -196,9 +188,7 @@ 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 | nil]
+        # @return [TextEdit | InsertReplaceEdit]
         def text_edit
           attributes.fetch(:textEdit)
         end
@@ -213,52 +203,51 @@ 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 | nil]
+        # @return [string]
         def text_edit_text
           attributes.fetch(:textEditText)
         end
 
         #
-        # An optional array of additional [text edits](#TextEdit) that are applied when
-        # selecting this completion. Edits must not overlap (including the same insert position)
-        # with the main [edit](#CompletionItem.textEdit) nor with themselves.
+        # 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.
         #
-        # 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[] | nil]
+        # @return [TextEdit[]]
         def additional_text_edits
           attributes.fetch(:additionalTextEdits)
         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[] | nil]
+        # @return [string[]]
         def commit_characters
           attributes.fetch(:commitCharacters)
         end
 
         #
-        # An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
-        # additional modifications to the current document should be described with the
-        # [additionalTextEdits](#CompletionItem.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 | nil]
+        # @return [Command]
         def command
           attributes.fetch(:command)
         end
 
         #
-        # A data entry field that is preserved on a completion item between a
-        # [CompletionRequest](#CompletionRequest) and a [CompletionResolveRequest](#CompletionResolveRequest).
+        # A data entry field that is preserved on a completion item between
+        # a completion and a completion resolve request.
         #
-        # @return [LSPAny | nil]
+        # @return [LSPAny]
         def data
           attributes.fetch(:data)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Additional details for a completion item label.
       #
-      # @since 3.17.0
-      #
       class CompletionItemLabelDetails
         def initialize(detail: nil, description: nil)
           @attributes = {}
@@ -17,19 +15,21 @@ 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 and 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 or type annotations.
         #
-        # @return [string | nil]
+        # @return [string]
         def detail
           attributes.fetch(:detail)
         end
 
         #
-        # An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
-        # for fully qualified names and file paths.
+        # An optional string which is rendered less prominently after
+        # {@link CompletionItemLabelDetails.detail}. Should be used for fully qualified
+        # names or file path.
         #
-        # @return [string | nil]
+        # @return [string]
         def description
           attributes.fetch(:description)
         end

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:, item_defaults: nil, items:)
@@ -17,7 +17,8 @@ module LanguageServer
         end
 
         #
-        # This list it not complete. Further typing results in recomputing this list.
+        # This list is not complete. Further typing should result in recomputing
+        # this list.
         #
         # Recomputed lists have all their items replaced (not appended) in the
         # incomplete completion sessions.
@@ -40,9 +41,7 @@ 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 } | nil]
+        # @return [{ commitCharacters?: string[]; editRange?: Range | { insert: Range; replace: Range; }; insertTextFormat?: InsertTextFormat; insertTextMode?: InsertTextMode; data?: LSPAny; }]
         def item_defaults
           attributes.fetch(:itemDefaults)
         end

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

@@ -5,44 +5,51 @@ module LanguageServer
       # Completion options.
       #
       class CompletionOptions
-        def initialize(trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil, work_done_progress: nil)
+        def initialize(work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: 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
+
         #
-        # 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.
+        # 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.
         #
-        # If code complete should automatically be trigger on characters not being valid inside
-        # an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
+        # 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.
         #
-        # @return [string[] | nil]
+        # @return [string[]]
         def trigger_characters
           attributes.fetch(:triggerCharacters)
         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.
         #
-        # @since 3.2.0
-        #
-        # @return [string[] | nil]
+        # @return [string[]]
         def all_commit_characters
           attributes.fetch(:allCommitCharacters)
         end
@@ -51,7 +58,7 @@ module LanguageServer
         # The server provides support to resolve additional
         # information for a completion item.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
@@ -60,18 +67,11 @@ module LanguageServer
         # The server supports the following `CompletionItem` specific
         # capabilities.
         #
-        # @since 3.17.0
-        #
-        # @return [{ labelDetailsSupport:boolean } | nil]
+        # @return [{ labelDetailsSupport?: boolean; }]
         def completion_item
           attributes.fetch(:completionItem)
         end
 
-        # @return [boolean | nil]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,31 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Completion parameters
-      #
       class CompletionParams
-        def initialize(context: nil, text_document:, position:, work_done_token: nil, partial_result_token: nil)
+        def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil, context: 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 | nil]
-        def context
-          attributes.fetch(:context)
-        end
-
         #
         # The text document.
         #
@@ -45,20 +33,30 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken | nil]
+        # @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.
+        # An optional token that a server can use to report partial results (e.g.
+        # streaming) to the client.
         #
-        # @return [ProgressToken | nil]
+        # @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

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

@@ -1,58 +1,62 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Registration options for a [CompletionRequest](#CompletionRequest).
-      #
       class CompletionRegistrationOptions
-        def initialize(document_selector:, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil, work_done_progress: nil)
+        def initialize(document_selector:, work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
+          @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
 
         #
-        # 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.
+        # 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 | null]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        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.
+        # 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.
         #
-        # If code complete should automatically be trigger on characters not being valid inside
-        # an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
+        # 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.
         #
-        # @return [string[] | nil]
+        # @return [string[]]
         def trigger_characters
           attributes.fetch(:triggerCharacters)
         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.
         #
-        # @since 3.2.0
-        #
-        # @return [string[] | nil]
+        # @return [string[]]
         def all_commit_characters
           attributes.fetch(:allCommitCharacters)
         end
@@ -61,7 +65,7 @@ module LanguageServer
         # The server provides support to resolve additional
         # information for a completion item.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
@@ -70,18 +74,11 @@ module LanguageServer
         # The server supports the following `CompletionItem` specific
         # capabilities.
         #
-        # @since 3.17.0
-        #
-        # @return [{ labelDetailsSupport:boolean } | nil]
+        # @return [{ labelDetailsSupport?: boolean; }]
         def completion_item
           attributes.fetch(:completionItem)
         end
 
-        # @return [boolean | nil]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -14,7 +14,7 @@ module LanguageServer
         #
         # The scope to get the configuration section for.
         #
-        # @return [string | nil]
+        # @return [string]
         def scope_uri
           attributes.fetch(:scopeUri)
         end
@@ -22,7 +22,7 @@ module LanguageServer
         #
         # The configuration section asked for.
         #
-        # @return [string | nil]
+        # @return [string]
         def section
           attributes.fetch(:section)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameters of a configuration request.
-      #
       class ConfigurationParams
         def initialize(items:)
           @attributes = {}