The title of the code action.
Optionalkind: CodeActionKindThe kind of the code action.
OptionalcommandA 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.
OptionaldiagnosticsDiagnostics that this code action resolves.
OptionaldisabledMarks 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 reason in the editor.
Readonlyreason: stringHuman readable description of why the code action is currently disabled.
This is displayed in the code actions UI.
OptionaleditA workspace edit this code action performs.
OptionalisMarks 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.
OptionalkindKind of the code action.
Used to filter code actions.
A short, human-readable, title for this code action.
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
editand/or acommand. If both are supplied, theeditis applied first, then the command is executed.