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 {@linkcode CodeAction.edit edit} and/or a {@linkcode CodeAction.command command}. If both are supplied, the edit is applied first, then the command is executed.
Constructor
new(title:String, ?kind:CodeActionKind)
Creates a new code action.
A code action must have at least a {@link CodeAction.title title} and {@link CodeAction.edit edits} and/or a {@link CodeAction.command command}.
Parameters:
title | The title of the code action. |
|---|---|
kind | The kind of the code action. |
Variables
command:Null<Command>
A {@link Command} this code action executes.
If this command throws an exception, the editor displays the exception message to users in the editor at the current cursor position.
disabled:Null<{reason:String}>
Marks that the code action cannot currently be applied.
-
Disabled code actions are not shown in automatic lightbulb code action menu.
-
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.
-
If the user has a keybinding that auto applies a code action and only a disabled code actions are returned, the editor will show the user an error message with
reasonin the editor.
isPreferred:Null<Bool>
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.
kind:Null<CodeActionKind>
{@link CodeActionKind Kind} of the code action.
Used to filter code actions.