Skip to main content
Version: Next

LegacyCommandsCLIPlugin

LegacyCommandsCLIPlugin​

@commandkit/legacycli.ts

LegacyCommandsCLIPlugin is a CommandKit compiler plugin that provides a CLI interface for creating legacy commands and events.

It allows users to create new command and event files with a simple command line interface, generating the appropriate boilerplate code based on whether the project is using TypeScript or JavaScript.

Example

# To create a new command:
$ commandkit create legacy command myCommand
# to create a new event:
$ commandkit create legacy event myEvent
Signature
class LegacyCommandsCLIPlugin extends CompilerPlugin<LegacyHandlerPluginOptions> {
    public readonly name = 'LegacyCommandsCLIPlugin';
    activate(ctx: CompilerPluginRuntime) => Promise<void>;
    deactivate(ctx: CompilerPluginRuntime) => Promise<void>;
}

name​

property

activate​

method
(ctx: CompilerPluginRuntime) => Promise<void>

deactivate​

method
(ctx: CompilerPluginRuntime) => Promise<void>