language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The client capabilities  of a [CodeLensRequest](#CodeLensRequest).
+      #
       class CodeLensClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -13,7 +16,7 @@ module LanguageServer
         #
         # Whether code lens supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,29 +1,32 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Code Lens provider options of a [CodeLensRequest](#CodeLensRequest).
+      #
       class CodeLensOptions
-        def initialize(work_done_progress: nil, resolve_provider: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # Code lens has a resolve provider as well.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,42 +1,45 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a [CodeLensRequest](#CodeLensRequest).
+      #
       class CodeLensParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
+        def initialize(text_document:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
+          @attributes[:textDocument] = text_document
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
-          @attributes[:textDocument] = text_document
 
           @attributes.freeze
         end
 
+        #
+        # The document to request code lens for.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         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]
+        # @return [ProgressToken | nil]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end
 
-        #
-        # The document to request code lens for.
-        #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,39 +1,42 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [CodeLensRequest](#CodeLensRequest).
+      #
       class CodeLensRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, resolve_provider: nil)
+        def initialize(document_selector:, resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # Code lens has a resolve provider as well.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class CodeLensWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}
@@ -19,7 +22,7 @@ module LanguageServer
         # useful for situation where a server for example detect a project wide
         # change that requires such a calculation.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def refresh_support
           attributes.fetch(:refreshSupport)
         end

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

@@ -19,7 +19,7 @@ module LanguageServer
         #
         # The red component of this color in the range [0-1].
         #
-        # @return [number]
+        # @return [decimal]
         def red
           attributes.fetch(:red)
         end
@@ -27,7 +27,7 @@ module LanguageServer
         #
         # The green component of this color in the range [0-1].
         #
-        # @return [number]
+        # @return [decimal]
         def green
           attributes.fetch(:green)
         end
@@ -35,7 +35,7 @@ module LanguageServer
         #
         # The blue component of this color in the range [0-1].
         #
-        # @return [number]
+        # @return [decimal]
         def blue
           attributes.fetch(:blue)
         end
@@ -43,7 +43,7 @@ module LanguageServer
         #
         # The alpha component of this color in the range [0-1].
         #
-        # @return [number]
+        # @return [decimal]
         def alpha
           attributes.fetch(:alpha)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents a color range from a document.
+      #
       class ColorInformation
         def initialize(range:, color:)
           @attributes = {}

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
@@ -24,20 +24,19 @@ module LanguageServer
 
         #
         # An [edit](#TextEdit) which is applied to a document when selecting
-        # this presentation for the color.  When `falsy` the
-        # [label](#ColorPresentation.label) is used.
+        # this presentation for the color.  When `falsy` the [label](#ColorPresentation.label)
+        # is used.
         #
-        # @return [TextEdit]
+        # @return [TextEdit | nil]
         def text_edit
           attributes.fetch(:textEdit)
         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 [text edits](#TextEdit) that are applied when
+        # selecting this color presentation. Edits must not overlap with the main [edit](#ColorPresentation.textEdit) nor with themselves.
         #
-        # @return [TextEdit[]]
+        # @return [TextEdit[] | nil]
         def additional_text_edits
           attributes.fetch(:additionalTextEdits)
         end

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

@@ -1,36 +1,22 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a [ColorPresentationRequest](#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 | nil]
+        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 | nil]
+        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 = {}
@@ -32,7 +38,7 @@ module LanguageServer
         # Arguments that the command handler should be
         # invoked with.
         #
-        # @return [any[]]
+        # @return [LSPAny[] | nil]
         def arguments
           attributes.fetch(:arguments)
         end

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

@@ -1,14 +1,19 @@
 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)
+        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[:insertTextMode] = insert_text_mode if insert_text_mode
           @attributes[:contextSupport] = context_support if context_support
+          @attributes[:completionList] = completion_list if completion_list
 
           @attributes.freeze
         end
@@ -16,7 +21,7 @@ module LanguageServer
         #
         # Whether completion supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -25,25 +30,48 @@ 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?: { ...; }; }]
+        # @return [{ snippetSupport:boolean, commitCharactersSupport:boolean, documentationFormat:MarkupKind[], deprecatedSupport:boolean, preselectSupport:boolean, tagSupport:{ valueSet:CompletionItemTag[] }, insertReplaceSupport:boolean, resolveSupport:{ properties:string[] }, insertTextModeSupport:{ valueSet:InsertTextMode[] }, labelDetailsSupport:boolean } | nil]
         def completion_item
           attributes.fetch(:completionItem)
         end
 
-        # @return [{ valueSet?: any[]; }]
+        # @return [{ valueSet:CompletionItemKind[] } | nil]
         def completion_item_kind
           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 | nil]
+        def insert_text_mode
+          attributes.fetch(:insertTextMode)
+        end
+
         #
         # The client supports to send additional context information for a
         # `textDocument/completion` request.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def context_support
           attributes.fetch(:contextSupport)
         end
 
+        #
+        # The client supports the following `CompletionList` specific
+        # capabilities.
+        #
+        # @since 3.17.0
+        #
+        # @return [{ itemDefaults:string[] } | nil]
+        def completion_list
+          attributes.fetch(:completionList)
+        end
+
         attr_reader :attributes
 
         def to_hash

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,11 +23,10 @@ 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]
+        # @return [string | nil]
         def trigger_character
           attributes.fetch(:triggerCharacter)
         end