@lumpcode/recipes 0.3.0 → 0.3.1

package/README.md

@@ -51,6 +51,16 @@ Flat helpers under `src/kit/` (re-exported from the package root):
 - `ymlBacklogContexts` / `setTaskDoneStep` — **deprecated** YAML-list helpers (warn once, still work)
 - `resolveImplValidateCommand` — string, descriptor, or fn → `ValidationCommandFn`
 - `shellCommand` — `sh -c` helper for validation commands
+- `openPrPostTeardown` — `postTeardownWorkspaceFn` that opens a PR from `branchName` into resolved `baseBranch`. Pass `{ provider: 'github' }` (`gh` on PATH). Skips when the branch was not pushed or a PR already exists; create failures are logged and do not fail the run.
+
+```ts
+import { featureBacklog, openPrPostTeardown } from '@lumpcode/recipes';
+
+export default featureBacklog({
+  configUrl: import.meta.url,
+  postTeardownWorkspaceFn: openPrPostTeardown({ provider: 'github' }),
+});
+```
 
 ## Generic backlog stage map
 

package/dist/index.cjs

@@ -18,6 +18,111 @@ function shellCommand(script) {
     };
 }
 
+const LOG_PREFIX = '[lumpcode/recipes]';
+async function openGithubPr(input) {
+    const { workspacePath, baseBranch, branchName, title, body } = input;
+    const cwd = workspacePath;
+    const listed = await core.execBinary({
+        binaryPath: 'gh',
+        args: ['pr', 'list', '--head', branchName, '--base', baseBranch, '--json', 'number'],
+        cwd,
+    });
+    if (listed.success && githubPrListHasItems(listed.data.stdout)) {
+        return;
+    }
+    const created = await core.execBinary({
+        binaryPath: 'gh',
+        args: [
+            'pr',
+            'create',
+            '--base',
+            baseBranch,
+            '--head',
+            branchName,
+            '--title',
+            title,
+            '--body',
+            body,
+        ],
+        cwd,
+    });
+    if (!created.success) {
+        console.error(`${LOG_PREFIX} gh pr create failed: ${created.data.message}`);
+    }
+}
+function githubPrListHasItems(stdout) {
+    try {
+        const parsed = JSON.parse(stdout);
+        return Array.isArray(parsed) && parsed.length > 0;
+    }
+    catch {
+        return false;
+    }
+}
+
+const LUMP_BRANCH_PREFIX = 'lump/';
+const OPEN_PR_PROVIDERS = ['github'];
+function openPrPostTeardown(options) {
+    const { provider, lumpName: lumpNameOption, title, body } = options;
+    return async (input) => {
+        const { baseBranch, branchName, contextList, workspacePath } = input;
+        if (!branchName || branchName === baseBranch) {
+            return;
+        }
+        const remote = await core.execBinary({
+            binaryPath: 'git',
+            args: ['ls-remote', '--heads', 'origin', branchName],
+            cwd: workspacePath,
+        });
+        if (!remote.success || !remote.data.stdout.trim()) {
+            return;
+        }
+        const names = contextList.map((ctx) => ctx.name).filter((name) => name.length > 0);
+        const label = names.length > 0 ? names.join(', ') : branchName;
+        const lumpName = lumpNameOption ?? lumpNameFromBranch(branchName);
+        const resolvedTitle = title?.(input) ?? defaultPrTitle({ lumpName, label });
+        const resolvedBody = body?.(input) ?? `LUMP contexts: ${label}`;
+        await openPrWithProvider({
+            provider,
+            workspacePath,
+            baseBranch,
+            branchName,
+            title: resolvedTitle,
+            body: resolvedBody,
+        });
+    };
+}
+function defaultPrTitle(input) {
+    const { lumpName, label } = input;
+    if (lumpName) {
+        return cliUtils.getGitCommitMessage({ lumpName, contextName: label });
+    }
+    return `LUMP: ${label}`;
+}
+function lumpNameFromBranch(branchName) {
+    if (!branchName.startsWith(LUMP_BRANCH_PREFIX)) {
+        return undefined;
+    }
+    const rest = branchName.slice(LUMP_BRANCH_PREFIX.length);
+    const slash = rest.indexOf('/');
+    if (slash <= 0) {
+        return undefined;
+    }
+    return rest.slice(0, slash);
+}
+async function openPrWithProvider(input) {
+    const { provider, ...prInput } = input;
+    switch (provider) {
+        case 'github':
+            await openGithubPr(prInput);
+            return;
+        default: {
+            const _exhaustive = provider;
+            throw new Error(`Unhandled PR provider: ${_exhaustive}`);
+        }
+    }
+}
+
 function normalizeMaybePromGetter(maybePromGetter, defaultValue) {
     if (typeof maybePromGetter === 'function') {
         return maybePromGetter;
@@ -1123,6 +1228,7 @@ exports.BACKLOG_STAGE_VAR = BACKLOG_STAGE_VAR;
 exports.BACKLOG_TASK_NAME_VAR = BACKLOG_TASK_NAME_VAR;
 exports.BACKLOG_TASK_VAR = BACKLOG_TASK_VAR;
 exports.FEATURE_BACKLOG_WORKFLOWS = FEATURE_BACKLOG_WORKFLOWS;
+exports.OPEN_PR_PROVIDERS = OPEN_PR_PROVIDERS;
 exports.abstractionBacklog = abstractionBacklog;
 exports.abstractionFinder = abstractionFinder;
 exports.backlog = backlog;
@@ -1136,6 +1242,7 @@ exports.getRecursiveSteps = getRecursiveSteps;
 exports.listTodoRelativeDirs = listTodoRelativeDirs;
 exports.lumpPathAndName = lumpPathAndName;
 exports.normalizeMaybePromGetter = normalizeMaybePromGetter;
+exports.openPrPostTeardown = openPrPostTeardown;
 exports.parseFeatureWorkflow = parseFeatureWorkflow;
 exports.projectRootFromConfigUrl = projectRootFromConfigUrl;
 exports.requireArtifactStep = requireArtifactStep;

package/dist/index.d.ts

@@ -1,9 +1,20 @@
 import { CommandDescriptor, MaybePromise, PostCommandExecFn, Step } from '@lumpcode/core';
-import { LumpVariables, GetContextListFnInput, GetContextListFn, StepVariables, CommandFn, LumpJsConfig, LumpJsConfigSteps, MaybePromise as MaybePromise$1, Context } from '@lumpcode/cli-utils';
+import { LumpVariables, PostSetupWorkspaceFnInput, PostTeardownWorkspaceFn, GetContextListFnInput, GetContextListFn, StepVariables, CommandFn, LumpJsConfig, LumpJsConfigSteps, MaybePromise as MaybePromise$1, Context } from '@lumpcode/cli-utils';
 
 /** Run a shell script via `sh -c` (portable on Unix-like systems and Git Bash on Windows). */
 declare function shellCommand(script: string): CommandDescriptor;
 
+declare const OPEN_PR_PROVIDERS: readonly ["github"];
+type OpenPrProvider = (typeof OPEN_PR_PROVIDERS)[number];
+type OpenPrPostTeardownOptions<V extends LumpVariables = LumpVariables> = {
+    provider: OpenPrProvider;
+    /** Overrides the lump name parsed from `lump/<lumpName>/…` branches. */
+    lumpName?: string;
+    title?: (input: PostSetupWorkspaceFnInput<V>) => string;
+    body?: (input: PostSetupWorkspaceFnInput<V>) => string;
+};
+declare function openPrPostTeardown<V extends LumpVariables = LumpVariables>(options: OpenPrPostTeardownOptions<V>): PostTeardownWorkspaceFn<V>;
+
 type MaybePromGetter<T, P = void> = T | ((input: P) => MaybePromise<T>);
 declare function normalizeMaybePromGetter<T, P = void>(maybePromGetter: MaybePromGetter<T, P>): (input: P) => MaybePromise<T>;
 declare function normalizeMaybePromGetter<T, P = void>(maybePromGetter: MaybePromGetter<T, P> | undefined, defaultValue: T): (input?: P) => MaybePromise<T>;
@@ -228,5 +239,5 @@ declare function resolveFeatureBacklogItem(input: {
 }): Promise<BacklogItemResolution<FeatureBacklogStage>>;
 declare const featureBacklog: <V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables>(options: FeatureBacklogOptions<V, SV>) => LumpJsConfig<V, SV>;
 
-export { BACKLOG_ITEMS_DIR_VAR, BACKLOG_ITEM_DIR_VAR, BACKLOG_STAGE_VAR, BACKLOG_TASK_NAME_VAR, BACKLOG_TASK_VAR, FEATURE_BACKLOG_WORKFLOWS, abstractionBacklog, abstractionFinder, backlog, backlogRecipe, defineRecipe, ephemeralContextListFn, featureBacklog, folderBacklogContexts, folderSetTaskDoneStep, getRecursiveSteps, listTodoRelativeDirs, lumpPathAndName, normalizeMaybePromGetter, parseFeatureWorkflow, projectRootFromConfigUrl, requireArtifactStep, resolveBacklogPaths, resolveFeatureBacklogItem, resolveImplValidateCommand, retryUntilGreen, setTaskDoneStep, shellCommand, validateBaseBacklogItem, ymlBacklogContexts };
-export type { AbstractionBacklogOptions, AbstractionFinderOptions, AbstractionFinderScanCommand, BacklogItemResolution, BacklogOptions, BacklogPaths, BacklogStageDefinition, BaseBacklogItem, DoneBacklogItem, EphemeralContextListFnOptions, FeatureBacklogContextVariables, FeatureBacklogItem, FeatureBacklogOptions, FeatureBacklogRunnableWorkflow, FeatureBacklogStage, FeatureBacklogWorkflow, FolderBacklogContextsOptions, 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, FEATURE_BACKLOG_WORKFLOWS, OPEN_PR_PROVIDERS, abstractionBacklog, abstractionFinder, backlog, backlogRecipe, defineRecipe, ephemeralContextListFn, featureBacklog, folderBacklogContexts, folderSetTaskDoneStep, getRecursiveSteps, listTodoRelativeDirs, lumpPathAndName, normalizeMaybePromGetter, openPrPostTeardown, parseFeatureWorkflow, projectRootFromConfigUrl, requireArtifactStep, resolveBacklogPaths, resolveFeatureBacklogItem, resolveImplValidateCommand, retryUntilGreen, setTaskDoneStep, shellCommand, validateBaseBacklogItem, ymlBacklogContexts };
+export type { AbstractionBacklogOptions, AbstractionFinderOptions, AbstractionFinderScanCommand, BacklogItemResolution, BacklogOptions, BacklogPaths, BacklogStageDefinition, BaseBacklogItem, DoneBacklogItem, EphemeralContextListFnOptions, FeatureBacklogContextVariables, FeatureBacklogItem, FeatureBacklogOptions, FeatureBacklogRunnableWorkflow, FeatureBacklogStage, FeatureBacklogWorkflow, FolderBacklogContextsOptions, GetFirstStepsInput, GetRecursiveStepsOptions, ImplValidateCommand, IsValidationCommandResultOkInput, MaybePromGetter, OpenPrPostTeardownOptions, OpenPrProvider, Recipe, RetryUntilGreenInput, StepIndex, ValidationCommandFn, ValidationCommandFnInput, YmlBacklogContextsOptions };

package/dist/index.js

@@ -1,5 +1,5 @@
-import { normalizeSteps, readYamlList, defineConfig, getContextStatus } from '@lumpcode/cli-utils';
-import { shellSingleQuote, pathExists } from '@lumpcode/core';
+import { getGitCommitMessage, normalizeSteps, readYamlList, defineConfig, getContextStatus } from '@lumpcode/cli-utils';
+import { execBinary, shellSingleQuote, pathExists } from '@lumpcode/core';
 import { fileURLToPath } from 'url';
 import path from 'path';
 import path$1 from 'node:path';
@@ -16,6 +16,111 @@ function shellCommand(script) {
     };
 }
 
+const LOG_PREFIX = '[lumpcode/recipes]';
+async function openGithubPr(input) {
+    const { workspacePath, baseBranch, branchName, title, body } = input;
+    const cwd = workspacePath;
+    const listed = await execBinary({
+        binaryPath: 'gh',
+        args: ['pr', 'list', '--head', branchName, '--base', baseBranch, '--json', 'number'],
+        cwd,
+    });
+    if (listed.success && githubPrListHasItems(listed.data.stdout)) {
+        return;
+    }
+    const created = await execBinary({
+        binaryPath: 'gh',
+        args: [
+            'pr',
+            'create',
+            '--base',
+            baseBranch,
+            '--head',
+            branchName,
+            '--title',
+            title,
+            '--body',
+            body,
+        ],
+        cwd,
+    });
+    if (!created.success) {
+        console.error(`${LOG_PREFIX} gh pr create failed: ${created.data.message}`);
+    }
+}
+function githubPrListHasItems(stdout) {
+    try {
+        const parsed = JSON.parse(stdout);
+        return Array.isArray(parsed) && parsed.length > 0;
+    }
+    catch {
+        return false;
+    }
+}
+
+const LUMP_BRANCH_PREFIX = 'lump/';
+const OPEN_PR_PROVIDERS = ['github'];
+function openPrPostTeardown(options) {
+    const { provider, lumpName: lumpNameOption, title, body } = options;
+    return async (input) => {
+        const { baseBranch, branchName, contextList, workspacePath } = input;
+        if (!branchName || branchName === baseBranch) {
+            return;
+        }
+        const remote = await execBinary({
+            binaryPath: 'git',
+            args: ['ls-remote', '--heads', 'origin', branchName],
+            cwd: workspacePath,
+        });
+        if (!remote.success || !remote.data.stdout.trim()) {
+            return;
+        }
+        const names = contextList.map((ctx) => ctx.name).filter((name) => name.length > 0);
+        const label = names.length > 0 ? names.join(', ') : branchName;
+        const lumpName = lumpNameOption ?? lumpNameFromBranch(branchName);
+        const resolvedTitle = title?.(input) ?? defaultPrTitle({ lumpName, label });
+        const resolvedBody = body?.(input) ?? `LUMP contexts: ${label}`;
+        await openPrWithProvider({
+            provider,
+            workspacePath,
+            baseBranch,
+            branchName,
+            title: resolvedTitle,
+            body: resolvedBody,
+        });
+    };
+}
+function defaultPrTitle(input) {
+    const { lumpName, label } = input;
+    if (lumpName) {
+        return getGitCommitMessage({ lumpName, contextName: label });
+    }
+    return `LUMP: ${label}`;
+}
+function lumpNameFromBranch(branchName) {
+    if (!branchName.startsWith(LUMP_BRANCH_PREFIX)) {
+        return undefined;
+    }
+    const rest = branchName.slice(LUMP_BRANCH_PREFIX.length);
+    const slash = rest.indexOf('/');
+    if (slash <= 0) {
+        return undefined;
+    }
+    return rest.slice(0, slash);
+}
+async function openPrWithProvider(input) {
+    const { provider, ...prInput } = input;
+    switch (provider) {
+        case 'github':
+            await openGithubPr(prInput);
+            return;
+        default: {
+            const _exhaustive = provider;
+            throw new Error(`Unhandled PR provider: ${_exhaustive}`);
+        }
+    }
+}
+
 function normalizeMaybePromGetter(maybePromGetter, defaultValue) {
     if (typeof maybePromGetter === 'function') {
         return maybePromGetter;
@@ -1115,4 +1220,4 @@ Do not edit @${REQ_FILE} unless absolutely necessary.
     });
 });
 
-export { BACKLOG_ITEMS_DIR_VAR, BACKLOG_ITEM_DIR_VAR, BACKLOG_STAGE_VAR, BACKLOG_TASK_NAME_VAR, BACKLOG_TASK_VAR, FEATURE_BACKLOG_WORKFLOWS, abstractionBacklog, abstractionFinder, backlog, backlogRecipe, defineRecipe, ephemeralContextListFn, featureBacklog, folderBacklogContexts, folderSetTaskDoneStep, getRecursiveSteps, listTodoRelativeDirs, lumpPathAndName, normalizeMaybePromGetter, parseFeatureWorkflow, projectRootFromConfigUrl, requireArtifactStep, resolveBacklogPaths, resolveFeatureBacklogItem, resolveImplValidateCommand, retryUntilGreen, setTaskDoneStep, shellCommand, validateBaseBacklogItem, ymlBacklogContexts };
+export { BACKLOG_ITEMS_DIR_VAR, BACKLOG_ITEM_DIR_VAR, BACKLOG_STAGE_VAR, BACKLOG_TASK_NAME_VAR, BACKLOG_TASK_VAR, FEATURE_BACKLOG_WORKFLOWS, OPEN_PR_PROVIDERS, abstractionBacklog, abstractionFinder, backlog, backlogRecipe, defineRecipe, ephemeralContextListFn, featureBacklog, folderBacklogContexts, folderSetTaskDoneStep, getRecursiveSteps, listTodoRelativeDirs, lumpPathAndName, normalizeMaybePromGetter, openPrPostTeardown, parseFeatureWorkflow, projectRootFromConfigUrl, requireArtifactStep, resolveBacklogPaths, resolveFeatureBacklogItem, resolveImplValidateCommand, retryUntilGreen, setTaskDoneStep, shellCommand, validateBaseBacklogItem, ymlBacklogContexts };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumpcode/recipes",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Lumpcode lump recipes and kit helpers",
   "keywords": [
     "lumpcode",
@@ -44,8 +44,8 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@lumpcode/cli-utils": "^0.3.0",
-    "@lumpcode/core": "^0.3.0",
+    "@lumpcode/cli-utils": "^0.3.1",
+    "@lumpcode/core": "^0.3.1",
     "js-yaml": "^5.0.0"
   },
   "devDependencies": {