@lumpcode/cli-types 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -72,6 +72,34 @@ type GetContextListFnInput<V extends LumpVariables = LumpVariables> = {
 };
 type GetContextListFn<V extends LumpVariables = LumpVariables> = (params: GetContextListFnInput<V>) => GetContextListFnOutput;
 
+/**
+ * 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];
@@ -100,6 +128,20 @@ type LumpJsConfig<V extends LumpVariables = LumpVariables, SV extends StepVariab
     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 defineConfig<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables>(config: NoInfer<LumpJsConfig<V, SV>>): LumpJsConfig<V, SV>;
@@ -142,6 +184,7 @@ type LumpJsonConfig<V extends LumpVariables = LumpVariables, SV extends StepVari
 
 declare const resolvedProjectLocalConfigSchema: z.ZodObject<{
     verbose: z.ZodOptional<z.ZodBoolean>;
+    refreshCommand: z.ZodOptional<z.ZodString>;
     command: z.ZodOptional<z.ZodString>;
     maximumNumberOfConcurrentBranches: z.ZodOptional<z.ZodNumber>;
     keepHistory: z.ZodOptional<z.ZodBoolean>;
@@ -166,7 +209,7 @@ type ResolvedProjectLocalConfig = z.infer<typeof resolvedProjectLocalConfigSchem
  * Shape of `.lumpcode/local.json` — Pick from resolved config.
  * `mode` is required on the file schema; other keys optional.
  */
-type LocalJsonConfig = Pick<ResolvedProjectLocalConfig, 'mode' | 'workspaceStrategy' | 'disabled' | 'maxParallelRun' | 'primaryBranch' | 'primaryBranches' | 'projectBaseBranch' | 'command' | 'maximumNumberOfConcurrentBranches' | 'keepHistory' | 'verbose'>;
+type LocalJsonConfig = Pick<ResolvedProjectLocalConfig, 'mode' | 'workspaceStrategy' | 'disabled' | 'maxParallelRun' | 'primaryBranch' | 'primaryBranches' | 'projectBaseBranch' | 'command' | 'maximumNumberOfConcurrentBranches' | 'keepHistory' | 'verbose' | 'refreshCommand'>;
 
 /**
  * Shape of `.lumpcode/local.json` — alias of {@link LocalJsonConfig}.
@@ -188,7 +231,7 @@ type Mode = 'shared' | 'dedicated';
  * Shape of `.lumpcode/project.json` — Pick from resolved config.
  * `projectName` is required on the file schema; other keys optional.
  */
-type ProjectJsonConfig = Pick<ResolvedProjectLocalConfig, 'projectName' | 'primaryBranch' | 'primaryBranches' | 'projectBaseBranch' | 'command' | 'maximumNumberOfConcurrentBranches' | 'keepHistory'>;
+type ProjectJsonConfig = Pick<ResolvedProjectLocalConfig, 'projectName' | 'primaryBranch' | 'primaryBranches' | 'projectBaseBranch' | 'command' | 'maximumNumberOfConcurrentBranches' | 'keepHistory' | 'refreshCommand'>;
 
 /**
  * Shape of `.lumpcode/project.json` — alias of {@link ProjectJsonConfig}.
@@ -196,4 +239,4 @@ type ProjectJsonConfig = Pick<ResolvedProjectLocalConfig, 'projectName' | 'prima
 type ProjectConfig = ProjectJsonConfig;
 
 export { defineBranchFn, defineCommand, defineCommandModule, defineCommandSetup, defineCommandTeardown, defineConfig, defineContextMatchFn, defineContextOptionsFn, defineGetContextListFn, defineGitAddCommitFn, defineGitCommitMessageFn, defineGitPushFn, definePostCommandExecFn, definePromptFn, defineSetupFn, defineStep, defineTeardownFn };
-export type { BaseBranchFn, BaseBranchFnInput, CommandModule, CommandTag, ContextMatchFn, ContextOptionsFn, FilePath, FilePathOrString, GetContextListFn, GetContextListFnInput, LocalConfig, LumpJsConfig, LumpJsConfigPostCommandExecFn, LumpJsConfigStep, LumpJsConfigSteps, LumpJsConfigStepsFn, LumpJsConfigStepsItem, LumpJsonConfig, LumpJsonConfigStep, MergeObjs, Mode, ProjectConfig, StepFn };
+export type { BaseBranchFn, BaseBranchFnInput, CommandModule, CommandTag, ContextMatchFn, ContextOptionsFn, FilePath, FilePathOrString, GetContextListFn, GetContextListFnInput, LocalConfig, LumpJsConfig, LumpJsConfigPostCommandExecFn, LumpJsConfigStep, LumpJsConfigSteps, LumpJsConfigStepsFn, LumpJsConfigStepsItem, LumpJsonConfig, LumpJsonConfigStep, MergeObjs, Mode, PostSetupWorkspaceFn, PostSetupWorkspaceFnInput, PostTeardownWorkspaceFn, ProjectConfig, StepFn };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumpcode/cli-types",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Types and defineX helpers for Lumpcode CLI lump config and command modules",
   "keywords": [
     "lumpcode",
@@ -37,7 +37,7 @@
     "build": "rollup -c"
   },
   "dependencies": {
-    "@lumpcode/core": "^0.2.0"
+    "@lumpcode/core": "^0.3.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^28.0.1",