CodeAction

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.

Online Documentation

Constructors

CodeAction

constructor(title: String, kind: CodeActionKind = definedExternally)

Creates a new code action.

Properties

command

var command: Command?

A Command this code action executes.

diagnostics

var diagnostics: ReadonlyArray<Diagnostic>?

Diagnostics that this code action resolves.

edit

var edit: WorkspaceEdit?

A workspace edit this code action performs.

isPreferred

var isPreferred: Boolean?

Marks this as a preferred action. Preferred actions are used by the auto fix command and can be targeted by keybindings.

kind

var kind: CodeActionKind?

Kind of the code action.

title

var title: String

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