@wpkernel/cli / BuildApplyCommandOptions
Interface: BuildApplyCommandOptions
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
AST Builders
createPatcher()?
readonly optional createPatcher: () => BuilderHelper;Creates a builder helper for applying patches to the workspace.
This helper reads a patch plan, applies file modifications (writes, merges, deletions) based on the plan, and records the outcome in a patch manifest. It uses git merge-file for intelligent three-way merges to handle conflicts.
Returns
A BuilderHelper instance for applying patches.
Other
appendApplyLog()?
readonly optional appendApplyLog: (workspace, entry) => Promise<void>;Parameters
workspace
entry
Returns
Promise<void>
buildBuilderOutput()?
readonly optional buildBuilderOutput: () => BuilderOutput;Returns
BuilderOutput
buildReadinessRegistry()?
readonly optional buildReadinessRegistry: (options?) => ReadinessRegistry;Parameters
options?
BuildDefaultReadinessRegistryOptions
Returns
buildWorkspace()?
readonly optional buildWorkspace: (root) => Workspace;Parameters
root
string
Returns
createBackups()?
readonly optional createBackups: (options) => Promise<void>;Parameters
options
Returns
Promise<void>
ensureGitRepository()?
readonly optional ensureGitRepository: (workspace) => Promise<void>;Parameters
workspace
Returns
Promise<void>
loadWPKernelConfig()?
readonly optional loadWPKernelConfig: () => Promise<LoadedWPKernelConfig>;Returns
Promise<LoadedWPKernelConfig>
promptConfirm()?
readonly optional promptConfirm: (options) => Promise<boolean>;Parameters
options
defaultValue
boolean
input
ReadableStream
message
string
output
WritableStream
Returns
Promise<boolean>
readManifest()?
readonly optional readManifest: (workspace) => Promise<PatchManifest | null>;Parameters
workspace
Returns
Promise<PatchManifest | null>
resolveWorkspaceRoot()?
readonly optional resolveWorkspaceRoot: (loaded) => string;Parameters
loaded
Returns
string