Interface CodeActionOptions

Provider options for a CodeActionRequest.

interface CodeActionOptions {
    codeActionKinds?: string[];
    documentation?: CodeActionKindDocumentation[];
    resolveProvider?: boolean;
    workDoneProgress?: boolean;
}

Hierarchy (View Summary)

Properties

codeActionKinds?: string[]

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.

documentation?: CodeActionKindDocumentation[]

Static documentation for a class of code actions.

Documentation from the provider should be shown in the code actions menu if either:

  • Code actions of kind are requested by the editor. In this case, the editor will show the documentation that most closely matches the requested code action kind. For example, if a provider has documentation for both Refactor and RefactorExtract, when the user requests code actions for RefactorExtract, the editor will use the documentation for RefactorExtract instead of the documentation for Refactor.

  • Any code actions of kind are returned by the provider.

At most one documentation entry should be shown per provider.

3.18.0

resolveProvider?: boolean

The server provides support to resolve additional information for a code action.

3.16.0

workDoneProgress?: boolean