WP Kernel API v0.3.0

---

WP Kernel API / @wpkernel/cli / GenerateCommand

Class: GenerateCommand

Clipanion command for generating kernel artifacts.

The command powers wpk generate, running printers and emitting summary metadata back to the invoking context for inspection in tests or higher level tooling.

Extends

• Command

Constructors

Constructor

new GenerateCommand(): GenerateCommand;

Returns

GenerateCommand

Inherited from

Command.constructor

Properties

paths

static paths: string[][];

Paths under which the command should be exposed.

Overrides

Command.paths

---

usage

static usage: Usage;

Contains the usage information for the command. If undefined, the command will be hidden from the general listing.

Overrides

Command.usage

---

dryRun

dryRun: boolean;

---

verbose

verbose: boolean;

---

summary?

optional summary: GenerationSummary;

Summary of the last generation run, populated after execute completes.

Methods

execute()

execute(): Promise<WPKExitCode>;

Standard function that'll get executed by Cli#run and Cli#runExit.

Expected to return an exit code or nothing (which Clipanion will treat as if 0 had been returned).

Returns

Promise<WPKExitCode>

Overrides

Command.execute