Skip to content

Interface: GitCowWorktreeBuilder ​

Defined in: git/src/builders/git-cow-worktree-builder.ts:19

Fluent builder for a Tier-3 branchable Copy-on-Write Git worktree scope (git.cowWorktree).

Compiles into a passive GitCowWorktreeNode (type: 'git:cow-worktree', capabilityTier: 'branchable') with zero filesystem or subprocess I/O at builder declaration time.

Extends ​

Methods ​

checkpointPolicy() ​

ts
checkpointPolicy(policy): GitCowWorktreeBuilder;

Defined in: git/src/builders/git-cow-worktree-builder.ts:64

Configures dirty-index checkpointing exclusions, partition mapping, and untracked blob size limits.

Controls how serializeCheckpoint, diffEffects, and restoreCheckpoint stage tracked and untracked files.

Parameters ​

ParameterTypeDescription
policyGitCowWorktreeCheckpointPolicyCheckpoint policy configuration.

Returns ​

GitCowWorktreeBuilder

Updated immutable worktree builder instance.


excludeFromCloneGlobs() ​

ts
excludeFromCloneGlobs(globs): GitCowWorktreeBuilder;

Defined in: git/src/builders/git-cow-worktree-builder.ts:30

Configures glob patterns excluded when cloning dirty working-tree files or caches into a worktree.

Returns a new immutable GitCowWorktreeBuilder instance with excludeFromCloneGlobs set to a frozen copy of globs.

Parameters ​

ParameterTypeDescription
globsreadonly string[]Repository-relative glob patterns to omit during worktree cloning.

Returns ​

GitCowWorktreeBuilder

Updated immutable worktree builder instance.


lockfileGate() ​

ts
lockfileGate(lockfilePath): GitCowWorktreeBuilder;

Defined in: git/src/builders/git-cow-worktree-builder.ts:53

Configures a lockfile path whose SHA-256 digest gates whether .setup() commands can be skipped.

On a lockfile hash hit against the host repository, node_modules is CoW-cloned/hardlinked; on a miss, any hardlinked node_modules tree is unlinked and replaced before executing .setup() commands.

Parameters ​

ParameterTypeDescription
lockfilePathstringRepository-relative path to the dependency lockfile (such as 'pnpm-lock.yaml').

Returns ​

GitCowWorktreeBuilder

Updated immutable worktree builder instance.


reconcileStrategy() ​

ts
reconcileStrategy(modeOrOptions, options?): GitCowWorktreeBuilder;

Defined in: git/src/builders/git-cow-worktree-builder.ts:76

Configures the branch landing reconciliation strategy ('rebase-onto-base' or 'batch-merge-train').

Accepts either (mode, options?) positional arguments or a single GitReconcileStrategyOptions object.

Parameters ​

ParameterTypeDescription
modeOrOptions| GitReconcileStrategyOptions | "rebase-onto-base" | "batch-merge-train"Reconciliation mode or options object.
options?GitReconcileStrategyOptionsOptional verification check and batch size settings.

Returns ​

GitCowWorktreeBuilder

Updated immutable worktree builder instance.


setup() ​

ts
setup(...commands): GitCowWorktreeBuilder;

Defined in: git/src/builders/git-cow-worktree-builder.ts:41

Appends one or more setup command steps executed when provisioning a root worktree on a lockfile gate miss.

Accepts either raw ASTNode descriptors or fluent AstBuilder<ASTNode> instances (such as local.command(...)).

Parameters ​

ParameterTypeDescription
...commandsreadonly MaybeBuilder<ASTNode>[]Setup command steps to execute in declaration order.

Returns ​

GitCowWorktreeBuilder

Updated immutable worktree builder instance.


toAST() ​

ts
toAST(): GitCowWorktreeNode;

Defined in: core/dist/ast/ast-builder.d.ts:19

Compiles the current builder configuration into a deeply frozen passive AST node.

Validates required builder invariants at compilation time and returns an immutable plain-object AST representation containing zero execution methods.

Returns ​

GitCowWorktreeNode

Deeply frozen passive AST node.

Inherited from ​

AstBuilder.toAST

Released under the MIT License.