class LSProtocol::CodeActionOptions
- LSProtocol::CodeActionOptions
- Reference
- Object
Overview
Provider options for a CodeActionRequest.
Included Modules
- JSON::Serializable
Defined in:
lsprotocol/types.crConstructors
- .new(pull : JSON::PullParser)
- .new(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
CodeActionKinds that this server may return.
-
#documentation : Array(CodeActionKindDocumentation) | Nil
Static documentation for a class of code actions.
-
#resolve_provider : Bool | Nil
The server provides support to resolve additional information for a code action.
- #work_done_progress : Bool | Nil
Constructor Detail
Instance Method Detail
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.
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
kindare 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 bothRefactorandRefactorExtract, when the user requests code actions forRefactorExtract, the editor will use the documentation forRefactorExtractinstead of the documentation forRefactor. -
Any code actions of
kindare returned by the provider.
At most one documentation entry should be shown per provider.
@since 3.18.0 @proposed
The server provides support to resolve additional information for a code action.
@since 3.16.0