language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -2,11 +2,10 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A code action represents a change that can be performed in code, e.g. to fix
-      # a problem or to refactor code.
+      # A code action represents a change that can be performed in code, e.g. to fix a problem or
+      # to refactor code.
       #
-      # A CodeAction must set either `edit` and/or a `command`. If both are supplied,
-      # the `edit` is applied first, then the `command` is executed.
+      # A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
       #
       class CodeAction
         def initialize(title:, kind: nil, diagnostics: nil, is_preferred: nil, disabled: nil, edit: nil, command: nil, data: nil)
@@ -37,7 +36,7 @@ module LanguageServer
         #
         # Used to filter code actions.
         #
-        # @return [string]
+        # @return [CodeActionKind]
         def kind
           attributes.fetch(:kind)
         end
@@ -51,12 +50,13 @@ module LanguageServer
         end
 
         #
-        # Marks this as a preferred action. Preferred actions are used by the
-        # `auto fix` command and can be targeted by keybindings.
+        # Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted
+        # by keybindings.
+        #
+        # A quick fix should be marked preferred if it properly addresses the underlying error.
+        # A refactoring should be marked preferred if it is the most reasonable choice of actions to take.
         #
-        # A quick fix should be marked preferred if it properly addresses the
-        # underlying error. A refactoring should be marked preferred if it is the
-        # most reasonable choice of actions to take.
+        # @since 3.15.0
         #
         # @return [boolean]
         def is_preferred
@@ -66,19 +66,19 @@ module LanguageServer
         #
         # Marks that the code action cannot currently be applied.
         #
-        # Clients should follow the following guidelines regarding disabled code
-        # actions:
+        # Clients should follow the following guidelines regarding disabled code actions:
         #
-        # - Disabled code actions are not shown in automatic lightbulbs code
-        # action menus.
+        #   - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)
+        #     code action menus.
         #
-        # - Disabled actions are shown as faded out in the code action menu when
-        # the user request a more specific type of code action, such as
-        # refactorings.
+        #   - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type
+        #     of code action, such as refactorings.
         #
-        # - If the user has a keybinding that auto applies a code action and only
-        # a disabled code actions are returned, the client should show the user
-        # an error message with `reason` in the editor.
+        #   - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions)
+        #     that auto applies a code action and only disabled code actions are returned, the client should show the user an
+        #     error message with `reason` in the editor.
+        #
+        # @since 3.16.0
         #
         # @return [{ reason: string; }]
         def disabled
@@ -107,6 +107,8 @@ module LanguageServer
         # A data entry field that is preserved on a code action between
         # a `textDocument/codeAction` and a `codeAction/resolve` request.
         #
+        # @since 3.16.0
+        #
         # @return [LSPAny]
         def data
           attributes.fetch(:data)

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The Client Capabilities of a {@link CodeActionRequest}.
+      #
       class CodeActionClientCapabilities
         def initialize(dynamic_registration: nil, code_action_literal_support: nil, is_preferred_support: nil, disabled_support: nil, data_support: nil, resolve_support: nil, honors_change_annotations: nil)
           @attributes = {}
@@ -25,10 +28,13 @@ module LanguageServer
         end
 
         #
-        # The client supports code action literals as a valid
-        # response of the `textDocument/codeAction` request.
+        # The client support code action literals of type `CodeAction` as a valid
+        # response of the `textDocument/codeAction` request. If the property is not
+        # set the request can only return `Command` literals.
         #
-        # @return [{ codeActionKind: { valueSet: string[]; }; }]
+        # @since 3.8.0
+        #
+        # @return [{ codeActionKind: { valueSet: CodeActionKind[]; }; }]
         def code_action_literal_support
           attributes.fetch(:codeActionLiteralSupport)
         end
@@ -36,6 +42,8 @@ module LanguageServer
         #
         # Whether code action supports the `isPreferred` property.
         #
+        # @since 3.15.0
+        #
         # @return [boolean]
         def is_preferred_support
           attributes.fetch(:isPreferredSupport)
@@ -44,6 +52,8 @@ module LanguageServer
         #
         # Whether code action supports the `disabled` property.
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def disabled_support
           attributes.fetch(:disabledSupport)
@@ -54,6 +64,8 @@ module LanguageServer
         # preserved between a `textDocument/codeAction` and a
         # `codeAction/resolve` request.
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def data_support
           attributes.fetch(:dataSupport)
@@ -63,6 +75,8 @@ module LanguageServer
         # Whether the client supports resolving additional code action
         # properties via a separate `codeAction/resolve` request.
         #
+        # @since 3.16.0
+        #
         # @return [{ properties: string[]; }]
         def resolve_support
           attributes.fetch(:resolveSupport)
@@ -75,6 +89,8 @@ module LanguageServer
         # the workspace edit in the user interface and asking
         # for confirmation.
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def honors_change_annotations
           attributes.fetch(:honorsChangeAnnotations)

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

@@ -3,7 +3,7 @@ module LanguageServer
     module Interface
       #
       # Contains additional diagnostic information about the context in which
-      # a code action is run.
+      # a {@link CodeActionProvider.provideCodeActions code action} is run.
       #
       class CodeActionContext
         def initialize(diagnostics:, only: nil, trigger_kind: nil)
@@ -17,11 +17,10 @@ module LanguageServer
         end
 
         #
-        # An array of diagnostics known on the client side overlapping the range
-        # provided to the `textDocument/codeAction` request. They are provided so
-        # that the server knows which errors are currently presented to the user
-        # for the given range. There is no guarantee that these accurately reflect
-        # the error state of the resource. The primary parameter
+        # An array of diagnostics known on the client side overlapping the range provided to the
+        # `textDocument/codeAction` request. They are provided so that the server knows which
+        # errors are currently presented to the user for the given range. There is no guarantee
+        # that these accurately reflect the error state of the resource. The primary parameter
         # to compute code actions is the provided range.
         #
         # @return [Diagnostic[]]
@@ -32,10 +31,10 @@ module LanguageServer
         #
         # Requested kind of actions to return.
         #
-        # Actions not of this kind are filtered out by the client before being
-        # shown. So servers can omit computing them.
+        # Actions not of this kind are filtered out by the client before being shown. So servers
+        # can omit computing them.
         #
-        # @return [string[]]
+        # @return [CodeActionKind[]]
         def only
           attributes.fetch(:only)
         end
@@ -43,6 +42,8 @@ module LanguageServer
         #
         # The reason why code actions were requested.
         #
+        # @since 3.17.0
+        #
         # @return [CodeActionTriggerKind]
         def trigger_kind
           attributes.fetch(:triggerKind)

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

@@ -1,29 +1,27 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a {@link CodeActionRequest}.
+      #
       class CodeActionOptions
-        def initialize(work_done_progress: nil, code_action_kinds: nil, resolve_provider: nil)
+        def initialize(code_action_kinds: nil, resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:codeActionKinds] = code_action_kinds if code_action_kinds
           @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
-
         #
         # CodeActionKinds that this server may return.
         #
-        # The list of kinds may be generic, such as `CodeActionKind.Refactor`,
-        # or the server may list out every specific kind they provide.
+        # The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server
+        # may list out every specific kind they provide.
         #
-        # @return [string[]]
+        # @return [CodeActionKind[]]
         def code_action_kinds
           attributes.fetch(:codeActionKinds)
         end
@@ -32,11 +30,18 @@ module LanguageServer
         # The server provides support to resolve additional
         # information for a code action.
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,38 +2,21 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Params for the CodeActionRequest
+      # The parameters of a {@link CodeActionRequest}.
       #
       class CodeActionParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, range:, context:)
+        def initialize(text_document:, range:, context:, 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[:range] = range
           @attributes[:context] = context
+          @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 document in which the command was invoked.
         #
@@ -58,6 +41,23 @@ module LanguageServer
           attributes.fetch(:context)
         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/code_action_registration_options.rb

@@ -1,39 +1,37 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link CodeActionRequest}.
+      #
       class CodeActionRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, code_action_kinds: nil, resolve_provider: nil)
+        def initialize(document_selector:, code_action_kinds: nil, resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:codeActionKinds] = code_action_kinds if code_action_kinds
           @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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # CodeActionKinds that this server may return.
         #
-        # The list of kinds may be generic, such as `CodeActionKind.Refactor`,
-        # or the server may list out every specific kind they provide.
+        # The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server
+        # may list out every specific kind they provide.
         #
-        # @return [string[]]
+        # @return [CodeActionKind[]]
         def code_action_kinds
           attributes.fetch(:codeActionKinds)
         end
@@ -42,11 +40,18 @@ module LanguageServer
         # The server provides support to resolve additional
         # information for a code action.
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Structure to capture a description for an error code.
       #
+      # @since 3.16.0
+      #
       class CodeDescription
         def initialize(href:)
           @attributes = {}
@@ -16,7 +18,7 @@ module LanguageServer
         #
         # An URI to open with more information about the diagnostic error.
         #
-        # @return [string]
+        # @return [URI]
         def href
           attributes.fetch(:href)
         end

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

@@ -2,12 +2,11 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A code lens represents a command that should be shown along with
+      # A code lens represents a {@link Command command} that should be shown along with
       # source text, like the number of references, a way to run tests, etc.
       #
-      # A code lens is _unresolved_ when no command is associated to it. For
-      # performance reasons the creation of a code lens and resolving should be done
-      # in two stages.
+      # A code lens is _unresolved_ when no command is associated to it. For performance
+      # reasons the creation of a code lens and resolving should be done in two stages.
       #
       class CodeLens
         def initialize(range:, command: nil, data: nil)
@@ -21,8 +20,7 @@ module LanguageServer
         end
 
         #
-        # The range in which this code lens is valid. Should only span a single
-        # line.
+        # The range in which this code lens is valid. Should only span a single line.
         #
         # @return [Range]
         def range
@@ -39,7 +37,8 @@ module LanguageServer
 
         #
         # A data entry field that is preserved on a code lens item between
-        # a code lens and a code lens resolve request.
+        # a {@link CodeLensRequest} and a [CodeLensResolveRequest]
+        # (#CodeLensResolveRequest)
         #
         # @return [LSPAny]
         def data

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 {@link CodeLensRequest}.
+      #
       class CodeLensClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}

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

@@ -1,21 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Code Lens provider options of a {@link 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.
         #
@@ -24,6 +22,11 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        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,17 +1,28 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a {@link 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.
         #
@@ -21,22 +32,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 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,31 +1,29 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link 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 | nil]
         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.
         #
@@ -34,6 +32,11 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        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 = {}

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 = {}