Interface CodeActionProviderMetadata

Metadata about the type of code actions that a CodeActionProvider provides.

interface CodeActionProviderMetadata {
    documentation?: readonly {
        command: Command;
        kind: string;
    }[];
    providedCodeActionKinds?: readonly string[];
}

Properties

documentation? providedCodeActionKinds?

Properties

Optional Readonly documentation

documentation?: readonly {
    command: Command;
    kind: string;
}[]

Optional Readonly providedCodeActionKinds

providedCodeActionKinds?: readonly string[]

List of code action kinds that a CodeActionProvider may return.

This list is used to determine if a given CodeActionProvider should be invoked or not. To avoid unnecessary computation, every CodeActionProvider should list use providedCodeActionKinds. The list of kinds may either be generic, such as ["quickfix", "refactor", "source"], or list out every kind provided, such as ["quickfix.removeLine", "source.fixAll" ...].

Settings

Member Visibility

Theme

On This Page

documentationprovidedCodeActionKinds