class

LSProtocol::CodeActionRegistrationOptions

Inherits JSON::Serializable / Reference / Object

Registration options for a CodeActionRequest.

Constructors

new(pull : JSON::PullParser)
Source
new(document_selector : DocumentSelector | Nil, code_action_kinds : Array(CodeActionKind | String) | Nil = nil, documentation : Array(CodeActionKindDocumentation) | Nil = nil, resolve_provider : Bool | Nil = nil, work_done_progress : Bool | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

code_action_kinds

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.

Source
document_selector

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.

Source
documentation

Static documentation for a class of code actions.

Documentation from the provider should be shown in the code actions menu if either:

  • Code actions of kind are requested by the editor. In this case, the editor will show the documentation that most closely matches the requested code action kind. For example, if a provider has documentation for both Refactor and RefactorExtract, when the user requests code actions for RefactorExtract, the editor will use the documentation for RefactorExtract instead of the documentation for Refactor.

  • Any code actions of kind are returned by the provider.

At most one documentation entry should be shown per provider.

@since 3.18.0 @proposed

Source
resolve_provider

The server provides support to resolve additional information for a code action.

@since 3.16.0

Source
work_done_progress
Source