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.
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.
(command code-action)
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.
Returns: Command | undefined
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. **Returns:** `Command | undefined`
(diagnostics code-action)
{@link Diagnostic Diagnostics} that this code action resolves.
Returns: Diagnostic[] | undefined
{@link Diagnostic Diagnostics} that this code action resolves. **Returns:** `Diagnostic[] | undefined`
(disabled code-action)
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 reason
in the editor.
Returns: { readonly reason: string; } | undefined
Marks that the code action cannot currently be applied. - Disabled code actions are not shown in automatic [lightbulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) 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](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions) 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. **Returns:** `{ readonly reason: string; } | undefined`
(edit code-action)
A {@link WorkspaceEdit workspace edit} this code action performs.
Returns: WorkspaceEdit | undefined
A {@link WorkspaceEdit workspace edit} this code action performs. **Returns:** `WorkspaceEdit | undefined`
(kind code-action)
{@link CodeActionKind Kind} of the code action.
Used to filter code actions.
Returns: CodeActionKind | undefined
{@link CodeActionKind Kind} of the code action. Used to filter code actions. **Returns:** `CodeActionKind | undefined`
(preferred? code-action)
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.
Returns: boolean | undefined
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. **Returns:** `boolean | undefined`
(set-command! code-action value)
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.
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.
(set-diagnostics! code-action value)
{@link Diagnostic Diagnostics} that this code action resolves.
{@link Diagnostic Diagnostics} that this code action resolves.
(set-disabled! code-action value)
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 reason
in the editor.
Marks that the code action cannot currently be applied. - Disabled code actions are not shown in automatic [lightbulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) 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](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions) 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.
(set-edit! code-action value)
A {@link WorkspaceEdit workspace edit} this code action performs.
A {@link WorkspaceEdit workspace edit} this code action performs.
(set-is-preferred! code-action value)
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.
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.
(set-kind! code-action value)
{@link CodeActionKind Kind} of the code action.
Used to filter code actions.
{@link CodeActionKind Kind} of the code action. Used to filter code actions.
(set-title! code-action value)
A short, human-readable, title for this code action.
A short, human-readable, title for this code action.
(title code-action)
A short, human-readable, title for this code action.
Returns: string
A short, human-readable, title for this code action. **Returns:** `string`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close