class LSProtocol::CodeActionRegistrationOptions
- LSProtocol::CodeActionRegistrationOptions
- Reference
- Object
Overview
Registration options for a CodeActionRequest
.
Included Modules
- JSON::Serializable
Defined in:
lsprotocol/types.crConstructors
- .new(pull : JSON::PullParser)
- .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)
Instance Method Summary
- #code_action_kinds : Array(CodeActionKind | String) | Nil
- #document_selector : DocumentSelector | Nil
-
#documentation : Array(CodeActionKindDocumentation) | Nil
Static documentation for a class of code actions.
- #resolve_provider : Bool | Nil
- #work_done_progress : Bool | Nil
Constructor Detail
Instance Method Detail
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 bothRefactor
andRefactorExtract
, when the user requests code actions forRefactorExtract
, the editor will use the documentation forRefactorExtract
instead of the documentation forRefactor
. -
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