@wpkernel/cli v0.12.6-beta.3

---

@wpkernel/cli / Workspace

Interface: Workspace

Kernel-aware workspace contract used by CLI generators.

Extends

• WorkspaceLike

Properties

begin()

begin: (label?) => void;

Parameters

label?

string

Returns

void

---

commit()

commit: (label?) => Promise<FileManifest>;

Parameters

label?

string

Returns

Promise<FileManifest>

---

cwd()

cwd: () => string;

Returns

string

---

dryRun()

dryRun: <T>(fn) => Promise<{
  manifest: FileManifest;
  result: T;
}>;

Type Parameters

T

T

Parameters

fn

() => Promise<T>

Returns

Promise<{ manifest: FileManifest; result: T; }>

---

exists()

exists: (target) => Promise<boolean>;

Parameters

target

string

Returns

Promise<boolean>

Inherited from

WorkspaceLike.exists

---

glob()

glob: (pattern) => Promise<string[]>;

Parameters

pattern

string | readonly string[]

Returns

Promise<string[]>

---

read()

read: (file) => Promise<Buffer<ArrayBufferLike> | null>;

Parameters

file

string

Returns

Promise<Buffer<ArrayBufferLike> | null>

---

readText()

readText: (file) => Promise<string | null>;

Parameters

file

string

Returns

Promise<string | null>

---

resolve()

resolve: (...segments) => string;

Parameters

segments

...string[]

Returns

string

Overrides

WorkspaceLike.resolve

---

rm()

rm: (target, options?) => Promise<void>;

Parameters

target

string

options?

RemoveOptions

Returns

Promise<void>

---

rollback()

rollback: (label?) => Promise<FileManifest>;

Parameters

label?

string

Returns

Promise<FileManifest>

---

root

root: string;

Overrides

WorkspaceLike.root

---

threeWayMerge()

threeWayMerge: (file, base, current, incoming, options?) => Promise<"conflict" | "clean">;

Parameters

file

string

base

string

current

string

incoming

string

options?

MergeOptions

Returns

Promise<"conflict" | "clean">

---

tmpDir()

tmpDir: (prefix?) => Promise<string>;

Parameters

prefix?

string

Returns

Promise<string>

---

write()

write: (file, data, options?) => Promise<void>;

Parameters

file

string

data

string | Buffer<ArrayBufferLike>

options?

WorkspaceWriteOptions

Returns

Promise<void>

---

writeJson()

writeJson: <T>(file, value, options?) => Promise<void>;

Type Parameters

T

T

Parameters

file

string

value

T

options?

WriteJsonOptions

Returns

Promise<void>