struct

LSP::CodeAction

Inherits JSON::Serializable < Struct < Value < Object

Code Action options.

Constructors

new(title : String, kind : Nil | String, edit : LSP::WorkspaceEdit | Nil, diagnostics : Nil | Array(LSP::Diagnostic) = [] of Diagnostic, is_preferred : Bool | Nil = false, disabled : LSP::CodeAction::Disabled | Nil = nil, command : LSP::Command | Nil = nil, data : Nil | String = nil)
Source
new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

command

A command this code action executes. If a code action provides an edit and a command, first the edit is executed and then the command.

Source
command=(command : Command | Nil)

A command this code action executes. If a code action provides an edit and a command, first the edit is executed and then the command.

Source
data

A data entry field that is preserved on a code action between a textDocument/codeAction and a codeAction/resolve request.

@since 3.16.0

Source
data=(data : String | Nil)

A data entry field that is preserved on a code action between a textDocument/codeAction and a codeAction/resolve request.

@since 3.16.0

Source
diagnostics

The diagnostics that this code action resolves.

Source
diagnostics=(diagnostics : Array(Diagnostic) | Nil)

The diagnostics that this code action resolves.

Source
disabled

Marks that the code action cannot currently be applied.

Clients should follow the following guidelines regarding disabled code actions:

  • Disabled code actions are not shown in automatic lightbulbs code action menus.

  • 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 client should show the user an error message with reason in the editor.

@since 3.16.0

Source
disabled=(disabled : Disabled | Nil)

Marks that the code action cannot currently be applied.

Clients should follow the following guidelines regarding disabled code actions:

  • Disabled code actions are not shown in automatic lightbulbs code action menus.

  • 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 client should show the user an error message with reason in the editor.

@since 3.16.0

Source
edit

The workspace edit this code action performs.

Source
edit=(edit : WorkspaceEdit | Nil)

The workspace edit this code action performs.

Source
is_preferred

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.

@since 3.15.0

Source
is_preferred=(is_preferred : Bool | Nil)

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.

@since 3.15.0

Source
kind

The kind of the code action.

Used to filter code actions.

Source
kind=(kind : String | Nil)

The kind of the code action.

Used to filter code actions.

Source
title

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

Source
title=(title : String)

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

Source

Nested types