@wpkernel/cli v0.12.6-beta.3

---

@wpkernel/cli / BuildGenerateCommandOptions

Interface: BuildGenerateCommandOptions

Properties

Reporter

buildReporter()?

readonly optional buildReporter: (options) => Reporter;

Create a WPKernel reporter backed by LogLayer transports.

This is the standard reporter for browser/WordPress environments. For CLI environments, use createReporterCLI() for pretty terminal output.

Parameters

options

ReporterOptions = {}

Reporter configuration

Returns

Reporter

Reporter instance with child helpers

IR

registerBuilders()?

readonly optional registerBuilders: () => readonly BuilderHelper[];

Registers the core builders with the pipeline.

These builders are responsible for taking the Intermediate Representation and generating various output artifacts (e.g., PHP, TypeScript, bundles).

Returns

readonly BuilderHelper[]

The immutable core builder programme.

---

registerFragments()?

readonly optional registerFragments: () => readonly FragmentHelper[];

Registers the core IR fragments with the pipeline.

These fragments are responsible for extracting various pieces of information from the configuration and building up the Intermediate Representation.

Returns

readonly FragmentHelper[]

The immutable core fragment programme.

Other

buildAdapterExtensionsExtension()?

readonly optional buildAdapterExtensionsExtension: () => PipelineExtension;

Returns

PipelineExtension

---

buildReadinessRegistry()?

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

Parameters

options?

BuildDefaultReadinessRegistryOptions

Returns

ReadinessRegistry

---

buildWorkspace()?

readonly optional buildWorkspace: (root) => Workspace;

Parameters

root

string = ...

Returns

Workspace

---

createPipeline()?

readonly optional createPipeline: (overrides) => Pipeline;

Parameters

overrides

Partial<CliPipelineOptions> = {}

Returns

Pipeline

---

loadWPKernelConfig()?

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

Locate and load the project's wpk configuration.

The function searches for supported config files, executes them via cosmiconfig loaders, validates the resulting structure, and returns the canonicalised configuration metadata.

Parameters

options?

cwd?

string

Returns

Promise<LoadedWPKernelConfig>

The validated wpk config and associated metadata.

Throws

WPKernelError when discovery, parsing or validation fails.

---

renderSummary()?

readonly optional renderSummary: (summary, dryRun, verbose, paths?) => string;

Parameters

summary

FileWriterSummary

dryRun

boolean

verbose

boolean

paths?

entry

string

php

string

runtime

string

blocks?

string

Returns

string

---

validateGeneratedImports()?

readonly optional validateGeneratedImports: (__namedParameters) => Promise<void>;

Parameters

__namedParameters

ValidateGeneratedImportsOptions

Returns

Promise<void>