package codeactions
- Alphabetic
- Public
- All
Type Members
-
case class
CodeAction(title: String, kind: Option[CodeActionKind], diagnostics: Option[Seq[Diagnostic]], isPreferred: Option[Boolean], edit: Option[WorkspaceEdit], command: Option[Command]) extends Product with Serializable
- title
A short, human-readable, title for this code action.
- kind
The kind of the code action. Used to filter code actions.
- diagnostics
The diagnostics that this code action resolves.
- isPreferred
Marks this as a preferred action. Preferred actions are used by the
auto fixcommand 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.- edit
The workspace edit this code action performs.
- 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.
-
case class
CodeActionCapabilities(dynamicRegistration: Option[Boolean], codeActionLiteralSupport: Option[CodeActionLiteralSupportCapabilities], isPreferredSupport: Option[Boolean]) extends Product with Serializable
Capabilities specific to the
textDocument/codeActionCapabilities specific to the
textDocument/codeAction- dynamicRegistration
Whether code action supports dynamic registration.
- codeActionLiteralSupport
The client supports code action literals as a valid response of the
textDocument/codeActionrequest.- isPreferredSupport
Whether code action supports the
isPreferredproperty.
-
case class
CodeActionContext(diagnostics: Seq[Diagnostic], only: Option[Seq[CodeActionKind]]) extends Product with Serializable
- diagnostics
An array of diagnostics known on the client side overlapping the range provided to the
textDocument/codeActionrequest. They are provided so that the server knows which errors are currently presented to the user for the given range. There is no guarantee that these accurately reflect the error state of the resource. The primary parameter to compute code actions is the provided range.
- case class CodeActionKindCapabilities(valueSet: List[CodeActionKind]) extends Product with Serializable
-
case class
CodeActionLiteralSupportCapabilities(codeActionKind: CodeActionKindCapabilities) extends Product with Serializable
- codeActionKind
: The code action kind is supported with the following value set
-
trait
CodeActionOptions extends AnyRef
CodeActionKinds that this server may return.
CodeActionKinds that this server may return.
The list of kinds may be generic, such as
CodeActionKind.Refactor, or the server may list out every specific kind they provide. - case class CodeActionParams(textDocument: TextDocumentIdentifier, range: Range, context: CodeActionContext) extends Product with Serializable
-
case class
CodeActionRegistrationOptions(codeActionKinds: Option[Seq[CodeActionKind]] = None) extends CodeActionOptions with TextDocumentRegistrationOptions with Product with Serializable
CodeActions options.
CodeActions options.
- codeActionKinds
CodeActionKinds that this server may return. The list of kinds may be generic, such as
CodeActionKind.Refactor, or the server may list out every specific kind they provide.
Value Members
- object CodeActionConfigType extends ConfigType[CodeActionCapabilities, CodeActionOptions] with Product with Serializable
-
object
CodeActionKind extends Enumeration with Product with Serializable
A set of predefined code action kinds.
- object CodeActionRequestType extends RequestType[CodeActionParams, Seq[CodeAction]] with Product with Serializable