@wpkernel/cli v0.12.6-beta.3

---

@wpkernel/cli / BuildCreateCommandOptions

Interface: BuildCreateCommandOptions

Options for building the create command.

Properties

Workspace

ensureCleanDirectory()?

readonly optional ensureCleanDirectory: (options) => Promise<void>;

Optional: Custom clean directory enforcer function.

Ensures that a given directory is clean (empty) or creates it if it doesn't exist.

If the directory exists and is not empty, it will throw a WPKernelError unless force is true, in which case it will clear the directory contents.

Parameters

options

EnsureCleanDirectoryOptions

Options for ensuring the directory is clean.

Returns

Promise<void>

Throws

WPKernelError if the directory is not empty and force is false, or if it's not a directory.

Other

buildReadinessRegistry()?

readonly optional buildReadinessRegistry: (options?) => ReadinessRegistry;

Optional: Custom readiness registry builder.

Parameters

options?

BuildDefaultReadinessRegistryOptions

Returns

ReadinessRegistry

---

buildReporter()?

readonly optional buildReporter: (options) => Reporter;

Optional: Custom reporter builder function.

Parameters

options

ReporterOptions = {}

Returns

Reporter

---

buildWorkspace()?

readonly optional buildWorkspace: (root) => Workspace;

Optional: Custom workspace builder function.

Parameters

root

string = ...

Returns

Workspace

---

installComposerDependencies()?

readonly optional installComposerDependencies: (cwd, dependencies, options) => Promise<InstallerResult>;

Optional: Custom Composer dependency installer function.

Parameters

cwd

string

dependencies

InstallerDependencies = {}

options

InstallerRunOptions = {}

Returns

Promise<InstallerResult>

---

installNodeDependencies()?

readonly optional installNodeDependencies: (cwd, packageManager, dependencies, options) => Promise<InstallerResult>;

Optional: Custom Node.js dependency installer function.

Parameters

cwd

string

packageManager

PackageManager

dependencies

InstallerDependencies = {}

options

InstallerRunOptions = {}

Returns

Promise<InstallerResult>

---

loadWPKernelConfig()?

readonly optional loadWPKernelConfig: () => Promise<LoadedWPKernelConfig>;

Optional: Custom kernel config loader.

Returns

Promise<LoadedWPKernelConfig>

---

runWorkflow()?

readonly optional runWorkflow: (options) => Promise<InitWorkflowResult>;

Optional: Custom workflow runner function.

Parameters

options

InitWorkflowOptions

Returns

Promise<InitWorkflowResult>