dots.vscode.code-action — io.github.dots-cljs/dots-vscode 1.89.0-5

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 cljs

(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.

diagnostics cljs

(diagnostics code-action)

{@link Diagnostic Diagnostics} that this code action resolves.

disabled cljs

(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.

edit cljs

(edit code-action)

A {@link WorkspaceEdit workspace edit} this code action performs.

kind cljs

(kind code-action)

{@link CodeActionKind Kind} of the code action.

Used to filter code actions.

preferred? cljs

(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.

set-command! cljs

(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.

set-diagnostics! cljs

(set-diagnostics! code-action value)

{@link Diagnostic Diagnostics} that this code action resolves.

set-disabled! cljs

(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.

set-edit! cljs

(set-edit! code-action value)

A {@link WorkspaceEdit workspace edit} this code action performs.

set-is-preferred! cljs

(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.

set-kind! cljs

(set-kind! code-action value)

{@link CodeActionKind Kind} of the code action.

Used to filter code actions.

set-title! cljs

(set-title! code-action value)

A short, human-readable, title for this code action.

title cljs

(title code-action)

A short, human-readable, title for this code action.