@lumpcode/recipes 0.0.13 → 0.0.15

package/dist/index.d.ts

@@ -71,25 +71,14 @@ declare function projectRootFromConfigUrl(configUrl: string | URL): string;
 /** Fails the context when the artifact referenced by a context variable was not created. */
 declare function requireArtifactStep(artifactPathVarName: string): Step;
 
-type BacklogPaths$1 = {
+type BacklogPaths = {
     lumpPath: string;
     lumpName: string;
-    backlogFilePath: string;
-    doneFilePath: string;
+    backlogItemsDir: string;
 };
 declare function resolveBacklogPaths(configUrl: string | URL, overrides?: {
-    backlogFilePath?: string;
-    doneFilePath?: string;
-}): BacklogPaths$1;
-
-/** Moves a finished backlog item from BACKLOG.yml to DONE.yml after the context completes. */
-declare const setTaskDoneStep: (input: {
-    backlogVarName: string;
-    doneVarName: string;
-}) => Step;
-
-type ImplValidateCommand = string | CommandDescriptor | ValidationCommandFn;
-declare function resolveImplValidateCommand(implValidateCommand: ImplValidateCommand): ValidationCommandFn;
+    backlogItemsDir?: string;
+}): BacklogPaths;
 
 type Recipe<Options, V extends LumpVariables = LumpVariables> = (options: Options) => LumpJsConfig<V>;
 declare function defineRecipe<Options, V extends LumpVariables = LumpVariables>(recipe: Recipe<Options, V>): Recipe<Options, V>;
@@ -104,6 +93,31 @@ type DoneBacklogItem<T extends BaseBacklogItem = BaseBacklogItem> = T & {
     completedAt: string;
 };
 
+type FolderBacklogContextsOptions<Item extends BaseBacklogItem = BaseBacklogItem> = {
+    backlogItemsDir: string;
+    parseItem?: (item: BaseBacklogItem, folderName: string, raw: unknown) => Item;
+    parseContext?: (item: Item, folderName: string) => MaybePromise$1<{
+        parsed?: Partial<Context>;
+        ignored?: boolean;
+    }>;
+};
+declare function folderBacklogContexts<Item extends BaseBacklogItem = BaseBacklogItem>({ backlogItemsDir, parseItem, parseContext, }: FolderBacklogContextsOptions<Item>): GetContextListFn;
+
+/** Moves a finished backlog item folder from todo/ to completed/ after the context completes. */
+declare const folderSetTaskDoneStep: (input: {
+    itemsDirVarName: string;
+    nameVarName?: string;
+}) => Step;
+
+/** Moves a finished backlog item from BACKLOG.yml to DONE.yml after the context completes. */
+declare const setTaskDoneStep: (input: {
+    backlogVarName: string;
+    doneVarName: string;
+}) => Step;
+
+type ImplValidateCommand = string | CommandDescriptor | ValidationCommandFn;
+declare function resolveImplValidateCommand(implValidateCommand: ImplValidateCommand): ValidationCommandFn;
+
 type YmlBacklogContextsOptions<Item extends BaseBacklogItem = BaseBacklogItem> = {
     backlogFilePath: string;
     parseItem?: (item: BaseBacklogItem, index: number, raw: unknown) => Item;
@@ -114,11 +128,11 @@ type YmlBacklogContextsOptions<Item extends BaseBacklogItem = BaseBacklogItem> =
 };
 declare function ymlBacklogContexts<Item extends BaseBacklogItem = BaseBacklogItem>({ backlogFilePath, parseItem, parseContext, }: YmlBacklogContextsOptions<Item>): GetContextListFn;
 
-/** Validates and normalizes one YAML backlog row; throws on invalid input. */
-declare function validateBaseBacklogItem(raw: unknown, index: number): BaseBacklogItem;
+/** Validates and normalizes one backlog item; throws on invalid input. */
+declare function validateBaseBacklogItem(raw: unknown, location: string): BaseBacklogItem;
 
 type AbstractionBacklogOptions = {
-    implValidateCommand: ValidationCommandFn | string;
+    implValidateCommand?: ValidationCommandFn | string;
     /** Lump config module URL — pass `import.meta.url` from `config.ts`. */
     configUrl: string | URL;
     implSteps?: LumpJsConfig['steps'];
@@ -129,9 +143,7 @@ type AbstractionFinderOptions = {
     scanDirectories?: string[];
     customPrompt?(): string;
     maxPendingAbstractions?: number;
-    backlogFilePath: string;
-    doneFilePath?: string;
-    prdDirPath?: string;
+    backlogItemsDir: string;
 } & LumpJsConfig;
 declare const abstractionFinder: Recipe<AbstractionFinderOptions>;
 
@@ -139,12 +151,6 @@ type BacklogStageDefinition = {
     steps: NonNullable<LumpJsConfig['steps']>;
     completion: 'keepPending' | 'moveToDone';
 };
-type BacklogPaths = {
-    lumpPath: string;
-    lumpName: string;
-    backlogFilePath: string;
-    doneFilePath: string;
-};
 type BacklogItemResolution<StageName extends string> = {
     ignored: true;
 } | {
@@ -155,10 +161,9 @@ type BacklogItemResolution<StageName extends string> = {
 };
 type BacklogOptions<Item extends BaseBacklogItem, Stages extends Record<string, BacklogStageDefinition>> = {
     configUrl: string | URL;
-    backlogFilePath?: string;
-    doneFilePath?: string;
+    backlogItemsDir?: string;
     stages: Stages;
-    parseItem?: (item: BaseBacklogItem, index: number, raw: unknown) => Item;
+    parseItem?: (item: BaseBacklogItem, folderName: string, raw: unknown) => Item;
     resolveItem(input: {
         item: Item;
         paths: BacklogPaths;
@@ -167,34 +172,33 @@ type BacklogOptions<Item extends BaseBacklogItem, Stages extends Record<string,
 declare const BACKLOG_STAGE_VAR = "BACKLOG_STAGE";
 declare const BACKLOG_TASK_NAME_VAR = "TASK_NAME";
 declare const BACKLOG_TASK_VAR = "TASK";
-declare const BACKLOG_FILE_VAR = "BACKLOG_FILE";
-declare const BACKLOG_DONE_FILE_VAR = "DONE_FILE";
+declare const BACKLOG_ITEMS_DIR_VAR = "BACKLOG_ITEMS_DIR";
+declare const BACKLOG_ITEM_DIR_VAR = "BACKLOG_ITEM_DIR";
 
 declare function backlog<Item extends BaseBacklogItem, Stages extends Record<string, BacklogStageDefinition>>(options: BacklogOptions<Item, Stages>): LumpJsConfig;
 declare const backlogRecipe: Recipe<BacklogOptions<BaseBacklogItem, Record<string, BacklogStageDefinition>>>;
 
 type FeatureBacklogItem = BaseBacklogItem & {
-    manualPrd?: boolean;
+    manualReq?: boolean;
 };
-type FeatureBacklogStage = 'makePrd' | 'makeTestPlan' | 'testImpl' | 'implementation';
+type FeatureBacklogStage = 'makeReq' | 'makeTestPlan' | 'testImpl' | 'implementation';
 type FeatureBacklogContextVariables = {
     TASK_NAME: string;
     TASK: string;
-    BACKLOG_FILE: string;
-    DONE_FILE: string;
+    BACKLOG_ITEMS_DIR: string;
+    BACKLOG_ITEM_DIR: string;
     BACKLOG_STAGE: FeatureBacklogStage;
-    PRD_FILE?: string;
+    REQ_FILE?: string;
     TEST_PLAN_FILE?: string;
 };
 type FeatureBacklogOptions = {
     configUrl: string | URL;
     baseBranch: string;
-    implValidateCommand: ValidationCommandFn | string;
-    backlogFilePath?: string;
-    doneFilePath?: string;
+    implValidateCommand?: ValidationCommandFn | string;
+    backlogItemsDir?: string;
 } & Omit<LumpJsConfig, 'contextListJson' | 'contextMatchFn' | 'getContextListFn' | 'prompt' | 'steps' | 'baseBranch'>;
-declare function resolveFeatureBacklogItem(item: FeatureBacklogItem, paths: BacklogPaths$1, projectRoot: string, lumpName: string, baseBranch: string): Promise<BacklogItemResolution<FeatureBacklogStage>>;
+declare function resolveFeatureBacklogItem(item: FeatureBacklogItem, paths: BacklogPaths, projectRoot: string, lumpName: string, baseBranch: string): Promise<BacklogItemResolution<FeatureBacklogStage>>;
 declare const featureBacklog: Recipe<FeatureBacklogOptions>;
 
-export { BACKLOG_DONE_FILE_VAR, BACKLOG_FILE_VAR, BACKLOG_STAGE_VAR, BACKLOG_TASK_NAME_VAR, BACKLOG_TASK_VAR, abstractionBacklog, abstractionFinder, backlog, backlogRecipe, defineRecipe, ephemeralContextListFn, featureBacklog, getRecursiveSteps, lumpPathAndName, normalizeMaybePromGetter, projectRootFromConfigUrl, requireArtifactStep, resolveBacklogPaths, resolveFeatureBacklogItem, resolveImplValidateCommand, retryUntilGreen, setTaskDoneStep, shellCommand, validateBaseBacklogItem, ymlBacklogContexts };
-export type { AbstractionBacklogOptions, AbstractionFinderOptions, BacklogItemResolution, BacklogOptions, BacklogPaths$1 as BacklogPaths, BacklogStageDefinition, BaseBacklogItem, DoneBacklogItem, EphemeralContextListFnOptions, FeatureBacklogContextVariables, FeatureBacklogItem, FeatureBacklogOptions, FeatureBacklogStage, GetFirstStepsInput, GetRecursiveStepsOptions, ImplValidateCommand, IsValidationCommandResultOkInput, MaybePromGetter, Recipe, RetryUntilGreenInput, StepIndex, ValidationCommandFn, ValidationCommandFnInput, YmlBacklogContextsOptions };
+export { BACKLOG_ITEMS_DIR_VAR, BACKLOG_ITEM_DIR_VAR, BACKLOG_STAGE_VAR, BACKLOG_TASK_NAME_VAR, BACKLOG_TASK_VAR, abstractionBacklog, abstractionFinder, backlog, backlogRecipe, defineRecipe, ephemeralContextListFn, featureBacklog, folderBacklogContexts, folderSetTaskDoneStep, getRecursiveSteps, lumpPathAndName, normalizeMaybePromGetter, projectRootFromConfigUrl, requireArtifactStep, resolveBacklogPaths, resolveFeatureBacklogItem, resolveImplValidateCommand, retryUntilGreen, setTaskDoneStep, shellCommand, validateBaseBacklogItem, ymlBacklogContexts };
+export type { AbstractionBacklogOptions, AbstractionFinderOptions, BacklogItemResolution, BacklogOptions, BacklogPaths, BacklogStageDefinition, BaseBacklogItem, DoneBacklogItem, EphemeralContextListFnOptions, FeatureBacklogContextVariables, FeatureBacklogItem, FeatureBacklogOptions, FeatureBacklogStage, FolderBacklogContextsOptions, GetFirstStepsInput, GetRecursiveStepsOptions, ImplValidateCommand, IsValidationCommandResultOkInput, MaybePromGetter, Recipe, RetryUntilGreenInput, StepIndex, ValidationCommandFn, ValidationCommandFnInput, YmlBacklogContextsOptions };