@lumpcode/cli-utils 0.2.0 → 0.3.1

package/dist/index.d.ts

@@ -61,6 +61,34 @@ type LumpJsConfigStep<V extends LumpVariables = LumpVariables, SV extends StepVa
     command?: CommandTag | FilePath | Step<V, SV>['commandFn'];
 }>;
 
+/**
+ * How Lumpcode prepares the per-lump git workspace inside the preflight repo root.
+ *
+ * - `checkout`: switch the main worktree to a fresh lump branch (default).
+ * - `worktree`: add a linked worktree under `.lumpcode/worktrees/<branch>/`.
+ */
+type WorkspaceStrategy = 'checkout' | 'worktree';
+
+type PostSetupWorkspaceFnInput<V extends LumpVariables = LumpVariables> = {
+    baseBranch: string;
+    branchName: string;
+    contextList: ContextList;
+    /** Branch workspace. Already prepared on a real run. Read-only. */
+    workspacePath: string;
+    executionWorkspacePath: string;
+    workspaceStrategy: WorkspaceStrategy;
+    projectRoot: string;
+    lumpVariables: V;
+};
+
+type PostSetupWorkspaceFn<V extends LumpVariables = LumpVariables> = (input: PostSetupWorkspaceFnInput<V>) => MaybePromise<{
+    command?: string;
+} | void>;
+
+type PostTeardownWorkspaceFn<V extends LumpVariables = LumpVariables> = (input: PostSetupWorkspaceFnInput<V>) => MaybePromise<{
+    command?: string;
+} | void>;
+
 type LumpJsConfigSoloStep<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = LumpJsConfigStep<V, SV> | LumpJsConfigStep<V, SV>['promptTemplate'] | LumpJsConfigStep<V, SV>['promptFn'];
 type LumpJsConfig<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = MergeObjs<Omit<{
     [K in keyof RunLumpInput<V, SV>]?: NonNullable<RunLumpInput<V, SV>[K]> extends Function ? (RunLumpInput<V, SV>[K] | FilePath) : RunLumpInput<V, SV>[K];
@@ -86,9 +114,28 @@ type LumpJsConfig<V extends LumpVariables = LumpVariables, SV extends StepVariab
     maximumNumberOfConcurrentBranches?: number;
     prompt?: LumpJsConfigSoloStep<V, SV>;
     steps?: LumpJsConfigSteps<V, SV> | LumpJsConfigStepsItem<V, SV>;
+    /**
+     * Extra command tags to pre-load before composed setup/teardown.
+     * A tag top-level `command` is pre-registered automatically; list other
+     * tags that appear only in dynamic/recursive returns.
+     */
     registerCommands?: string[];
     keepHistory?: boolean;
     verbose?: boolean;
+    /**
+     * After generated checkout/worktree setup. Mutually exclusive with
+     * `postSetupWorkspaceCommand`.
+     */
+    postSetupWorkspaceFn?: FilePath | PostSetupWorkspaceFn<V>;
+    /** Shell fragment in the branch workspace. Mutually exclusive with `postSetupWorkspaceFn`. */
+    postSetupWorkspaceCommand?: string;
+    /**
+     * Before generated workspace teardown. Mutually exclusive with
+     * `postTeardownWorkspaceCommand`.
+     */
+    postTeardownWorkspaceFn?: FilePath | PostTeardownWorkspaceFn<V>;
+    /** Shell fragment in the branch workspace. Mutually exclusive with `postTeardownWorkspaceFn`. */
+    postTeardownWorkspaceCommand?: string;
 }>;
 
 declare function getContextStatuses(input: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumpcode/cli-utils",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Types, defineX helpers, and runtime utilities for Lumpcode lump configs and recipes",
   "keywords": [
     "lumpcode",
@@ -43,8 +43,8 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@lumpcode/cli-types": "^0.2.0",
-    "@lumpcode/core": "^0.2.0",
+    "@lumpcode/cli-types": "^0.3.1",
+    "@lumpcode/core": "^0.3.1",
     "js-yaml": "^5.0.0"
   },
   "devDependencies": {