Skip to main content
Version: Next

CompilerPlugin

CompilerPlugin​

commandkitCompilerPlugin.ts

CommandKit plugin that runs at compile time.

Signature
class CompilerPlugin<T extends PluginOptions = PluginOptions> extends PluginCommon<T, CompilerPluginRuntime> {
    public readonly type = PluginType.Compiler;
    transform(params: PluginTransformParameters) => Promise<MaybeFalsey<TransformedResult>>;
}

type​

property

The type of the plugin, which is Compiler.

transform​

method
(params: PluginTransformParameters) => Promise<MaybeFalsey<TransformedResult>>

Called when transformation is requested to this plugin