@promptbook/cli 0.114.0-30 → 0.114.0-32

package/src/version.ts

@@ -16,11 +16,11 @@ export const BOOK_LANGUAGE_VERSION: string_semantic_version = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-export const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version = '0.114.0-30';
+export const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version = '0.114.0-32';
 
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.114.0-29`).
+ * It follows semantic versioning (e.g., `0.114.0-31`).
  *
  * @generated
  */

package/src/versions.txt

@@ -1206,3 +1206,5 @@
 0.114.0-28
 0.114.0-29
 0.114.0-30
+0.114.0-31
+0.114.0-32

package/umd/index.umd.js

@@ -58,7 +58,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.114.0-30';
+    const PROMPTBOOK_ENGINE_VERSION = '0.114.0-32';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2640,7 +2640,7 @@
     async function ensureProjectGitignoreFile({ projectPath, blockHeader, rules, }) {
         const gitignorePath = path.join(projectPath, GITIGNORE_FILE_PATH);
         const currentGitignoreContent = await readTextFileIfExists(gitignorePath);
-        const missingRules = rules.filter((rule) => !hasGitignoreRule(currentGitignoreContent || '', rule));
+        const missingRules = getMissingGitignoreRules(currentGitignoreContent || '', rules);
         if (currentGitignoreContent !== undefined && missingRules.length === 0) {
             return 'unchanged';
         }
@@ -2651,6 +2651,16 @@
         await promises.writeFile(gitignorePath, nextGitignoreContent, 'utf-8');
         return currentGitignoreContent === undefined ? 'created' : 'updated';
     }
+    /**
+     * Lists the ignore rules which are not yet present in a project's `.gitignore` file.
+     *
+     * @private internal utility of Promptbook CLI project initialization
+     */
+    async function getMissingProjectGitignoreRules(projectPath, rules) {
+        const gitignorePath = path.join(projectPath, GITIGNORE_FILE_PATH);
+        const currentGitignoreContent = (await readTextFileIfExists(gitignorePath)) || '';
+        return getMissingGitignoreRules(currentGitignoreContent, rules);
+    }
     /**
      * Reads one text file when it exists, otherwise returns `undefined`.
      *
@@ -2702,9 +2712,16 @@
      * Detects whether `.gitignore` already covers one exact rule.
      */
     function hasGitignoreRule(gitignoreContent, rule) {
-        const normalizedRulePattern = rule.startsWith('/') ? `/?${escapeRegExp$1(rule.slice(1))}` : escapeRegExp$1(rule);
+        const normalizedRule = rule.startsWith('/') ? rule.slice(1) : rule;
+        const normalizedRulePattern = `/?${escapeRegExp$1(normalizedRule)}`;
         return new RegExp(`(^|[\\r\\n])${normalizedRulePattern}(?:[\\r\\n]|$)`, 'u').test(gitignoreContent);
     }
+    /**
+     * Finds the unique rules which are not covered by existing `.gitignore` content.
+     */
+    function getMissingGitignoreRules(gitignoreContent, rules) {
+        return Array.from(new Set(rules)).filter((rule) => !hasGitignoreRule(gitignoreContent, rule));
+    }
     // Note: [🟡] Code for CLI project initialization [projectInitialization](src/cli/cli-commands/common/projectInitialization.ts) should never be published outside of `@promptbook/cli`
     // Note: [💞] Ignore a discrepancy between file name and entity name
 
@@ -24130,6 +24147,7 @@
             label: 'OpenAI Codex',
             commandName: 'codex',
             npmPackageName: '@openai/codex',
+            projectGitignoreRules: ['.codex'],
             // Note: The official standalone installer keeps its package in `~/.codex` and links it onto the `PATH`
             standaloneInstallation: {
                 directoryNames: ['.codex'],
@@ -24141,6 +24159,7 @@
             label: 'GitHub Copilot',
             commandName: 'copilot',
             npmPackageName: '@github/copilot',
+            projectGitignoreRules: ['.github/copilot/settings.local.json'],
             // Note: The GitHub Copilot CLI downloads its native binary in a postinstall script
             npmInstallEnvironment: { npm_config_ignore_scripts: 'false' },
         },
@@ -24149,30 +24168,35 @@
             label: 'Cline',
             commandName: 'cline',
             npmPackageName: 'cline',
+            projectGitignoreRules: ['.cline'],
         },
         'claude-code': {
             harnessName: 'claude-code',
             label: 'Claude Code',
             commandName: 'claude',
             npmPackageName: '@anthropic-ai/claude-code',
+            projectGitignoreRules: ['.claude'],
         },
         opencode: {
             harnessName: 'opencode',
             label: 'Opencode',
             commandName: 'opencode',
             npmPackageName: 'opencode-ai',
+            projectGitignoreRules: ['.opencode'],
         },
         gemini: {
             harnessName: 'gemini',
             label: 'Gemini CLI',
             commandName: 'gemini',
             npmPackageName: '@google/gemini-cli',
+            projectGitignoreRules: ['.gemini'],
         },
         'qwen-code': {
             harnessName: 'qwen-code',
             label: 'Qwen Code',
             commandName: 'qwen',
             npmPackageName: '@qwen-code/qwen-code',
+            projectGitignoreRules: ['.qwen'],
         },
     };
     /**
@@ -24191,6 +24215,14 @@
         }
         return definition;
     }
+    /**
+     * Lists the unique project ignore rules required by the selected harnesses, in selection order.
+     *
+     * @private internal utility of `promptbookCli`
+     */
+    function getHarnessProjectGitignoreRules(harnessNames) {
+        return Array.from(new Set(harnessNames.flatMap((harnessName) => getHarnessDefinition(harnessName).projectGitignoreRules)));
+    }
 
     /**
      * Create price per one token based on the string value found on openai page
@@ -43103,16 +43135,16 @@
     // Note: [💞] Ignore a discrepancy between file name and entity name
 
     /**
-     * Asks the user in the terminal whether an npm package should be installed or updated now.
+     * Asks the user in the terminal to confirm one optional change.
      *
-     * Note: `$` is used to indicate that this function is not a pure function - it reads the answer from stdin
+     * Note: `$` is used to indicate that this function is not a pure function - it reads the answer from stdin.
      *
-     * @returns `true` when the user confirms, `false` when the user declines or the terminal is not interactive
+     * @returns `true` when the user confirms, `false` when the user declines or the terminal is not interactive.
      * @private internal utility of `promptbookCli`
      */
-    async function $askForNpmPackageInstallationApproval(question) {
+    async function $askForConfirmation(question) {
         if (!process.stdin.isTTY) {
-            // Note: In non-interactive environments like CI there is nobody who could confirm the installation
+            // Note: In non-interactive environments like CI there is nobody who could confirm the change.
             return false;
         }
         const readlineInterface = readline.createInterface({ input: process.stdin, output: process.stdout });
@@ -43126,6 +43158,19 @@
             readlineInterface.close();
         }
     }
+    // Note: [🟡] Code for CLI confirmations [$askForConfirmation](src/cli/cli-commands/common/$askForConfirmation.ts) should never be published outside of `@promptbook/cli`
+
+    /**
+     * Asks the user in the terminal whether an npm package should be installed or updated now.
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it reads the answer from stdin
+     *
+     * @returns `true` when the user confirms, `false` when the user declines or the terminal is not interactive
+     * @private internal utility of `promptbookCli`
+     */
+    async function $askForNpmPackageInstallationApproval(question) {
+        return $askForConfirmation(question);
+    }
     // Note: [🟡] Code for CLI npm package installation approval [$askForNpmPackageInstallationApproval](src/cli/cli-commands/common/npm/$askForNpmPackageInstallationApproval.ts) should never be published outside of `@promptbook/cli`
 
     /**
@@ -44029,15 +44074,38 @@
      */
     const CODER_GITIGNORE_HEADER = '# Promptbook Coder';
     /**
-     * Ensures `.gitignore` contains the standalone Promptbook temp entry.
+     * Coder-owned local artifacts which every initialized project should ignore.
+     */
+    const CODER_GITIGNORE_RULES = [PROMPTBOOK_TEMP_GITIGNORE_RULE, CODER_ENV_GITIGNORE_RULE];
+    /**
+     * Ensures `.gitignore` contains Promptbook Coder's local artifacts and every supported harness's local artifacts.
      *
      * @private function of `initializeCoderProjectConfiguration`
      */
     async function ensureCoderGitignoreFile(projectPath) {
+        return ensureCoderGitignoreRules(projectPath, [
+            ...CODER_GITIGNORE_RULES,
+            ...getHarnessProjectGitignoreRules(PROMPT_RUNNER_HARNESS_NAMES),
+        ]);
+    }
+    /**
+     * Lists missing project-local ignore rules for the selected harnesses.
+     *
+     * @private internal utility of `ptbk coder`
+     */
+    async function getMissingCoderHarnessGitignoreRules(projectPath, harnessNames) {
+        return getMissingProjectGitignoreRules(projectPath, getHarnessProjectGitignoreRules(harnessNames));
+    }
+    /**
+     * Adds the given Promptbook Coder rules to a project's `.gitignore` file.
+     *
+     * @private internal utility of `ptbk coder`
+     */
+    async function ensureCoderGitignoreRules(projectPath, rules) {
         return ensureProjectGitignoreFile({
             projectPath,
             blockHeader: CODER_GITIGNORE_HEADER,
-            rules: [PROMPTBOOK_TEMP_GITIGNORE_RULE, CODER_ENV_GITIGNORE_RULE],
+            rules,
         });
     }
     // Note: [🟡] Code for coder init gitignore bootstrapping [ensureCoderGitignoreFile](src/cli/cli-commands/coder/ensureCoderGitignoreFile.ts) should never be published outside of `@promptbook/cli`
@@ -44402,7 +44470,7 @@
                 - ${CODER_DEVELOPER_AGENT_FILE_PATH}
                 - ${AGENTS_FILE_PATH}
                 - ${AGENT_CODING_FILE_PATH}
-                - .gitignore
+                - .gitignore with local artifacts from every supported harness
                 - package.json
                 - .vscode/settings.json
 
@@ -44499,6 +44567,40 @@
     }
     // Note: [💞] Ignore a discrepancy between file name and entity name
 
+    /**
+     * Offers to add missing project-local ignore rules for the selected coding harness.
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it may ask the user and update `.gitignore`.
+     *
+     * @private internal utility of `ptbk coder`
+     */
+    async function $ensureCoderHarnessGitignoreRules(projectPath, harnessName) {
+        if (harnessName === undefined) {
+            return;
+        }
+        const missingRules = await getMissingCoderHarnessGitignoreRules(projectPath, [harnessName]);
+        if (missingRules.length === 0) {
+            return;
+        }
+        const { label } = getHarnessDefinition(harnessName);
+        const formattedRules = formatGitignoreRules(missingRules);
+        const entryLabel = missingRules.length === 1 ? 'entry' : 'entries';
+        const isAdditionApproved = await $askForConfirmation(`Add the missing ${label} ignore ${entryLabel} ${formattedRules} to \`.gitignore\` now?`);
+        if (!isAdditionApproved) {
+            console.info(colors__default["default"].gray(`Skipped, add ${formattedRules} to \`.gitignore\` manually.`));
+            return;
+        }
+        await ensureCoderGitignoreRules(projectPath, missingRules);
+        console.info(colors__default["default"].gray(`✔ Added ${formattedRules} to \`.gitignore\`.`));
+    }
+    /**
+     * Formats one or more `.gitignore` rules for a terminal confirmation message.
+     */
+    function formatGitignoreRules(rules) {
+        return rules.map((rule) => `\`${rule}\``).join(', ');
+    }
+    // Note: [🟡] Code for coder harness gitignore prompts [$ensureCoderHarnessGitignoreRules](src/cli/cli-commands/coder/$ensureCoderHarnessGitignoreRules.ts) should never be published outside of `@promptbook/cli`
+
     /**
      * Initializes `coder ping` command for Promptbook CLI utilities
      *
@@ -44518,7 +44620,7 @@
             - Reports the answer of the harness, the response time and the reported usage
             - Starts the hourly/weekly quota window before you need it, so it is already refreshing when you do
             - Optional --period keeps the quota window refreshing by pinging once per period until stopped
-            - Leaves the project exactly as it was — nothing is read, written, changed or committed
+            - Makes no coding changes or commits; if the selected harness has missing local ignore rules, offers to add them to .gitignore
             - Checks that the selected harness is installed and up to date unless --no-harness-update is used
             - Use --no-ui to stream the raw harness output instead of only the compact result
         `));
@@ -44536,6 +44638,7 @@
             // Note: The period is validated before the harness installation check, so a mistyped duration fails fast
             const periodMs = parseOptionalPeriodDuration('--period', periodValue);
             await $ensureHarnessInstallations([runnerOptions.agentName], isHarnessUpdateCheckEnabled);
+            await $ensureCoderHarnessGitignoreRules(process.cwd(), runnerOptions.agentName);
             const pingOptions = {
                 agentName: runnerOptions.agentName,
                 model: runnerOptions.model,
@@ -45014,6 +45117,7 @@
             - Optional --preserve-logs keeps temp prompt/log artifacts after successful rounds
             - Optional --no-ui keeps plain streaming console output for logging and debugging
             - Checks that the selected harness is installed and up to date before the first prompt unless --no-harness-update is used
+            - Offers to add missing project-local ignore rules for the selected harness
             - In interactive mode, checks local and global Promptbook CLI installations and offers to update them
             - Supports GPG signing of commits
             - Optional pre-coding test run that can stop or repair pre-existing failures
@@ -45077,6 +45181,7 @@
                 return process.exit(0);
             }
             await $ensureHarnessInstallations([runnerOptions.agentName], isHarnessUpdateCheckEnabled);
+            await $ensureCoderHarnessGitignoreRules(process.cwd(), runnerOptions.agentName);
             const waitAfterPrompt = parseOptionalWaitDuration(waitAfterPromptValue, 0);
             const waitBetweenPrompts = parseOptionalWaitDuration(waitBetweenPromptsValue, 0);
             const waitAfterError = parseOptionalWaitDuration(waitAfterErrorValue, DEFAULT_WAIT_AFTER_ERROR_MS$1);
@@ -45171,6 +45276,7 @@
             Features:
             - Runs the same prompt processing as \`ptbk coder run\`
             - Checks that the selected harness is installed and up to date on startup unless --no-harness-update is used
+            - Offers to add missing project-local ignore rules for the selected harness
             - Does not exit when all prompts are done; polls for new prompt files instead
             - Serves a kanban board at http://localhost:<port> for visual progress tracking
             - Allows editing prompt files directly from the browser (Trello-style)
@@ -45216,6 +45322,7 @@
             });
             const { isHarnessUpdateCheckEnabled } = normalizeHarnessUpdateCliOptions(cliOptions);
             await $ensureHarnessInstallations([runnerOptions.agentName], isHarnessUpdateCheckEnabled);
+            await $ensureCoderHarnessGitignoreRules(process.cwd(), runnerOptions.agentName);
             // [1] Parse the wait options and --no-auto (same logic as `coder run`)
             const waitForUser = !auto;
             const waitAfterPrompt = parseOptionalWaitDuration(waitAfterPromptValue, 0);
@@ -74529,6 +74636,21 @@
             isPromptInPriorityFilter(prompt.section, priorityFilter));
     }
 
+    /**
+     * Finds the first non-empty line within the inclusive bounds.
+     *
+     * @private internal utility of prompt parsing and status writing
+     */
+    function findFirstNonEmptyLineIndex(lines, startLine, endLine) {
+        for (let lineIndex = startLine; lineIndex <= endLine; lineIndex++) {
+            const line = lines[lineIndex];
+            if (line !== undefined && line.trim() !== '') {
+                return lineIndex;
+            }
+        }
+        return undefined;
+    }
+
     /**
      * Checks whether a prompt is unrestricted or matches the selected harness/model.
      *
@@ -74564,6 +74686,14 @@
             .filter((token) => token !== '');
     }
 
+    /**
+     * Matches the supported prompt status markers at the start of a line.
+     *
+     * A different bracketed prefix can be ordinary prompt content, for example an emoji tag.
+     *
+     * @private internal constant of `parsePromptFile`
+     */
+    const PROMPT_STATUS_MARKER_PATTERN = /^\[(?: |-|[xX]|\^|!)\]/u;
     /**
      * Parses a prompt markdown file into sections and metadata.
      */
@@ -74583,11 +74713,11 @@
                 continue;
             }
             const endLine = i - 1;
-            const firstNonEmptyLine = findFirstNonEmptyLine(lines, startLine, endLine);
+            const firstNonEmptyLine = findFirstNonEmptyLineIndex(lines, startLine, endLine);
             if (firstNonEmptyLine !== undefined) {
                 const statusLine = (lines[firstNonEmptyLine] || '').trim();
                 const parsedStatus = parseStatusLine(statusLine);
-                const status = (_a = parsedStatus === null || parsedStatus === void 0 ? void 0 : parsedStatus.status) !== null && _a !== void 0 ? _a : 'not-ready';
+                const status = (_a = parsedStatus === null || parsedStatus === void 0 ? void 0 : parsedStatus.status) !== null && _a !== void 0 ? _a : (hasPromptStatusMarker(statusLine) ? 'not-ready' : 'todo');
                 const priority = (_b = parsedStatus === null || parsedStatus === void 0 ? void 0 : parsedStatus.priority) !== null && _b !== void 0 ? _b : 0;
                 sections.push({
                     index,
@@ -74650,16 +74780,12 @@
         return { status: 'todo', priority: (_d = (_c = details.match(/!/gu)) === null || _c === void 0 ? void 0 : _c.length) !== null && _d !== void 0 ? _d : 0 };
     }
     /**
-     * Finds the first non-empty line index between two bounds.
+     * Checks whether a line starts with one of the supported prompt status markers.
+     *
+     * @private internal utility of `parsePromptFile`
      */
-    function findFirstNonEmptyLine(lines, startLine, endLine) {
-        for (let i = startLine; i <= endLine; i++) {
-            const line = lines[i];
-            if (line !== undefined && line.trim() !== '') {
-                return i;
-            }
-        }
-        return undefined;
+    function hasPromptStatusMarker(line) {
+        return PROMPT_STATUS_MARKER_PATTERN.test(line);
     }
 
     /**
@@ -77512,13 +77638,59 @@
     /**
      * Rewrites the status line of one prompt section while preserving its indentation.
      *
-     * Only a todo `[ ]` or an in-progress `[^]` status line is rewritten, so an already finalized
-     * `[x]`, `[!]` or `[-]` status is never overwritten by accident.
+     * An unmarked prompt is implicitly a todo, so its first live status line is inserted immediately before its content.
+     * Only a todo `[ ]` or an in-progress `[^]` status line is otherwise rewritten, so an already finalized `[x]`, `[!]`
+     * or `[-]` status is never overwritten by accident.
      */
     function writePromptStatusLine(file, section, replacementStatusLine) {
+        if (section.statusLineIndex === undefined) {
+            insertPromptStatusLine(file, section, replacementStatusLine);
+            return;
+        }
         const { statusLineIndex, line } = resolvePromptStatusLine(file, section);
         file.lines[statusLineIndex] = line.replace(REWRITABLE_PROMPT_STATUS_LINE_PATTERN, `$<indentation>${replacementStatusLine}`);
     }
+    /**
+     * Inserts the first persisted status line for an unmarked prompt and keeps parsed section positions in sync.
+     *
+     * @private internal utility of `writePromptStatusLine`
+     */
+    function insertPromptStatusLine(file, section, replacementStatusLine) {
+        const statusLineIndex = findFirstNonEmptyLineIndex(file.lines, section.startLine, section.endLine);
+        if (statusLineIndex === undefined) {
+            const promptReference = `Prompt ${section.index + 1} in \`${file.name}\``;
+            throw new UnexpectedError(_spaceTrim.spaceTrim(`
+                ${promptReference} does not have content where its status line can be added.
+            `));
+        }
+        file.lines.splice(statusLineIndex, 0, replacementStatusLine);
+        updatePromptSectionPositionsAfterStatusInsertion(file, section, statusLineIndex);
+    }
+    /**
+     * Updates the parsed indexes after adding a status line to an unmarked prompt.
+     *
+     * @private internal utility of `writePromptStatusLine`
+     */
+    function updatePromptSectionPositionsAfterStatusInsertion(file, section, statusLineIndex) {
+        for (const promptSection of file.sections) {
+            if (promptSection === section) {
+                promptSection.statusLineIndex = statusLineIndex;
+                promptSection.endLine += 1;
+                continue;
+            }
+            if (promptSection.startLine >= statusLineIndex) {
+                promptSection.startLine += 1;
+                promptSection.endLine += 1;
+                if (promptSection.statusLineIndex !== undefined) {
+                    promptSection.statusLineIndex += 1;
+                }
+            }
+        }
+        if (!file.sections.includes(section)) {
+            section.statusLineIndex = statusLineIndex;
+            section.endLine += 1;
+        }
+    }
 
     /**
      * Marks a prompt section as done and records the per-step usage pricing and runner details.