@sienklogic/plan-build-run 2.21.1 → 2.21.2

package/plugins/pbr/scripts/lib/gates/doc-existence.js

@@ -0,0 +1,46 @@
+'use strict';
+
+/**
+ * Blocking gate: warns when a PBR project is missing PROJECT.md or REQUIREMENTS.md.
+ * These files are created by /pbr:new-project. If they are absent on a project that has
+ * STATE.md + ROADMAP.md, the user likely needs to run /pbr:new-project first.
+ * Returns { block: true, reason } when docs are missing.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { readActiveSkill } = require('./helpers');
+
+/**
+ * Check whether PROJECT.md and REQUIREMENTS.md exist in .planning/ for an
+ * established PBR project (one that already has STATE.md + ROADMAP.md).
+ *
+ * @param {object} _data - hook data (unused, kept for consistent gate signature)
+ * @returns {{ block: true, reason: string }|null}
+ */
+function checkDocExistence(_data) {
+  const cwd = process.env.PBR_PROJECT_ROOT || process.cwd();
+  const planningDir = path.join(cwd, '.planning');
+
+  // Only block for plan and build active skills
+  const activeSkill = readActiveSkill(planningDir);
+  if (activeSkill !== 'plan' && activeSkill !== 'build') return null;
+
+  // Only block if this is an established PBR project (has STATE.md + ROADMAP.md)
+  const statePath = path.join(planningDir, 'STATE.md');
+  const roadmapPath = path.join(planningDir, 'ROADMAP.md');
+  if (!fs.existsSync(statePath) || !fs.existsSync(roadmapPath)) return null;
+
+  const missing = [];
+  if (!fs.existsSync(path.join(planningDir, 'PROJECT.md'))) missing.push('PROJECT.md');
+  if (!fs.existsSync(path.join(planningDir, 'REQUIREMENTS.md'))) missing.push('REQUIREMENTS.md');
+
+  if (missing.length === 0) return null;
+
+  return {
+    block: true,
+    reason: `Missing planning documents: ${missing.join(', ')}.\n\nThese files are generated by /pbr:new-project and document project vision and requirements.\n\nRun /pbr:new-project to generate them, or create them manually from the templates at plan-build-run/templates/.`
+  };
+}
+
+module.exports = { checkDocExistence };

package/plugins/pbr/scripts/lib/gates/helpers.js

@@ -0,0 +1,98 @@
+'use strict';
+
+/**
+ * Shared helpers for gate modules.
+ * Centralizes repeated .active-skill reads and STATE.md phase parsing.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { resolveSessionPath } = require('../core');
+const { logHook } = require('../../hook-logger');
+
+/**
+ * Read the current .active-skill value.
+ * Returns the trimmed string, or null if the file doesn't exist or can't be read.
+ * @param {string} planningDir - path to .planning directory
+ * @param {string|null} [sessionId] - session identifier for session-scoped path
+ * @returns {string|null}
+ */
+function readActiveSkill(planningDir, sessionId) {
+  // Check .session.json first (consistent with check-subagent-output and log-subagent)
+  try {
+    const { sessionLoad } = require('../core');
+    const session = sessionLoad(planningDir, sessionId);
+    if (session && session.activeSkill) return session.activeSkill;
+  } catch (_e) { /* intentionally silent: pbr-tools/session may not be available */ }
+  // Fall back to .active-skill file (session-scoped when sessionId available)
+  try {
+    const skillPath = sessionId
+      ? resolveSessionPath(planningDir, '.active-skill', sessionId)
+      : path.join(planningDir, '.active-skill');
+    return fs.readFileSync(skillPath, 'utf8').trim();
+  } catch (_e) {
+    // intentionally silent: .active-skill file may not exist
+    return null;
+  }
+}
+
+/**
+ * Parse STATE.md for the current phase string (zero-padded, e.g. "01").
+ * Returns the padded phase string, or null if not found.
+ * @param {string} planningDir - path to .planning directory
+ * @returns {string|null}
+ */
+function readCurrentPhase(planningDir) {
+  try {
+    const state = fs.readFileSync(path.join(planningDir, 'STATE.md'), 'utf8');
+    const phaseMatch = state.match(/Phase:\s*(\d+)/);
+    if (!phaseMatch) return null;
+    return phaseMatch[1].padStart(2, '0');
+  } catch (_e) {
+    logHook('gate:helpers', 'debug', 'Failed to read STATE.md for phase string', { error: _e.message });
+    return null;
+  }
+}
+
+/**
+ * Parse STATE.md for the current phase as an integer.
+ * Checks frontmatter current_phase first, then falls back to body Phase: line.
+ * Returns the integer, or null if not found.
+ * @param {string} planningDir - path to .planning directory
+ * @returns {number|null}
+ */
+function readCurrentPhaseInt(planningDir) {
+  try {
+    const state = fs.readFileSync(path.join(planningDir, 'STATE.md'), 'utf8');
+    const fmMatch = state.match(/current_phase:\s*(\d+)/);
+    if (fmMatch) return parseInt(fmMatch[1], 10);
+    const bodyMatch = state.match(/Phase:\s*(\d+)/);
+    if (bodyMatch) return parseInt(bodyMatch[1], 10);
+    return null;
+  } catch (_e) {
+    logHook('gate:helpers', 'debug', 'Failed to read STATE.md for phase int', { error: _e.message });
+    return null;
+  }
+}
+
+/**
+ * Detect whether a PLAN*.md file has speculative: true in its frontmatter.
+ * Speculative plans are created for future phases and must not trigger validation gates.
+ * @param {string} filePath - absolute path to the PLAN file
+ * @returns {boolean}
+ */
+function isPlanSpeculative(filePath) {
+  try {
+    const content = fs.readFileSync(filePath, 'utf8');
+    if (!content.startsWith('---')) return false;
+    const endIdx = content.indexOf('---', 3);
+    if (endIdx === -1) return false;
+    const frontmatter = content.substring(3, endIdx);
+    return /^\s*speculative\s*:\s*true\s*$/m.test(frontmatter);
+  } catch (_e) {
+    logHook('gate:helpers', 'debug', 'Failed to read plan file for speculative check', { error: _e.message, filePath });
+    return false;
+  }
+}
+
+module.exports = { readActiveSkill, readCurrentPhase, readCurrentPhaseInt, isPlanSpeculative };

package/plugins/pbr/scripts/lib/gates/inline-execution.js

@@ -0,0 +1,187 @@
+'use strict';
+
+/**
+ * Gate: inline execution decision.
+ * Determines whether a plan can be executed inline (in the orchestrator's
+ * context) rather than spawning a Task() subagent.
+ *
+ * Conditions for inline execution:
+ *   1. config.workflow.inline_execution is truthy
+ *   2. contextPct < config.workflow.inline_context_cap_pct (HARD CAP, checked first)
+ *   3. Task count <= config.workflow.inline_max_tasks
+ *   4. ALL tasks have complexity="simple"
+ */
+
+const fs = require('fs');
+const { logHook } = require('../../hook-logger');
+
+const DEFAULT_MAX_TASKS = 2;
+const DEFAULT_CONTEXT_CAP_PCT = 40;
+const DEFAULT_MAX_FILES = 5;
+const DEFAULT_MAX_LINES = 50;
+
+// Lines-per-task estimation by complexity
+const LINES_PER_COMPLEXITY = {
+  simple: 20,
+  medium: 80,
+  complex: 200,
+  unknown: 100
+};
+
+/**
+ * Parse plan content string to extract task metadata.
+ * Returns array of { id, complexity, name } objects.
+ * @param {string} planContent - raw plan file content
+ * @returns {Array<{ id: string, complexity: string, name: string }>}
+ */
+function parsePlanTasks(planContent) {
+  const tasks = [];
+  // Match <task ...> opening tags and extract attributes
+  const taskRegex = /<task\s+([^>]*)>/g;
+  let match;
+
+  while ((match = taskRegex.exec(planContent)) !== null) {
+    const attrs = match[1];
+    const idMatch = attrs.match(/id="([^"]*)"/);
+    const complexityMatch = attrs.match(/complexity="([^"]*)"/);
+
+    // Extract name from <name>...</name> after this task tag
+    const afterTag = planContent.slice(match.index);
+    const nameMatch = afterTag.match(/<name>([\s\S]*?)<\/name>/);
+
+    tasks.push({
+      id: idMatch ? idMatch[1] : '',
+      complexity: complexityMatch ? complexityMatch[1] : 'unknown',
+      name: nameMatch ? nameMatch[1].trim() : ''
+    });
+  }
+
+  return tasks;
+}
+
+/**
+ * Parse plan content to extract YAML frontmatter fields.
+ * Returns an object with at least `files_modified` (array of strings).
+ * @param {string} planContent - raw plan file content
+ * @returns {{ files_modified: string[] }}
+ */
+function parsePlanFrontmatter(planContent) {
+  const result = { files_modified: [] };
+  const fmMatch = planContent.match(/^---\r?\n([\s\S]*?)\r?\n---/);
+  if (!fmMatch) return result;
+
+  const fm = fmMatch[1];
+  // Extract files_modified array (YAML list format)
+  const filesSection = fm.match(/files_modified:\s*\n((?:\s+-\s+.*\n?)*)/);
+  if (filesSection) {
+    const items = filesSection[1].match(/^\s+-\s+"?([^"\n]+)"?\s*$/gm);
+    if (items) {
+      result.files_modified = items.map(line => {
+        const m = line.match(/^\s+-\s+"?([^"\n]+?)"?\s*$/);
+        return m ? m[1] : '';
+      }).filter(Boolean);
+    }
+  }
+
+  return result;
+}
+
+/**
+ * Decide whether a plan should be executed inline or via Task() subagent.
+ *
+ * @param {string} planPath - absolute path to the PLAN.md file
+ * @param {object} config - project config object with workflow.* properties
+ * @param {number} contextPct - current context usage percentage (0-100)
+ * @returns {{ inline: boolean, reason?: string, taskCount?: number, complexity?: string }}
+ */
+function shouldInlineExecution(planPath, config, contextPct) {
+  const workflow = (config && config.workflow) || {};
+  const features = (config && config.features) || {};
+
+  // Feature toggle check (independent of workflow.inline_execution)
+  if (features.inline_simple_tasks === false) {
+    return { inline: false, reason: 'feature disabled' };
+  }
+
+  // Check if inline execution is enabled
+  if (!workflow.inline_execution) {
+    return { inline: false, reason: 'inline_execution disabled' };
+  }
+
+  const capPct = typeof workflow.inline_context_cap_pct === 'number'
+    ? workflow.inline_context_cap_pct
+    : DEFAULT_CONTEXT_CAP_PCT;
+  const maxTasks = typeof workflow.inline_max_tasks === 'number'
+    ? workflow.inline_max_tasks
+    : DEFAULT_MAX_TASKS;
+
+  // HARD CAP: context budget check runs FIRST, before other conditions
+  if (contextPct >= capPct) {
+    return { inline: false, reason: 'context budget exceeded cap' };
+  }
+
+  // Read and parse plan file
+  let planContent;
+  try {
+    planContent = fs.readFileSync(planPath, 'utf8');
+  } catch (_e) {
+    logHook('gate:inline-execution', 'debug', 'Failed to read plan file', { error: _e.message, planPath });
+    return { inline: false, reason: 'cannot read plan file' };
+  }
+
+  const tasks = parsePlanTasks(planContent);
+
+  // Check task count
+  if (tasks.length > maxTasks) {
+    return {
+      inline: false,
+      reason: `task count ${tasks.length} exceeds max ${maxTasks}`
+    };
+  }
+
+  // Check all tasks are simple complexity
+  const nonSimple = tasks.filter(t => t.complexity !== 'simple');
+  if (nonSimple.length > 0) {
+    return {
+      inline: false,
+      reason: `non-simple complexity: ${nonSimple.map(t => t.id + '=' + t.complexity).join(', ')}`
+    };
+  }
+
+  // File count check from frontmatter
+  const frontmatter = parsePlanFrontmatter(planContent);
+  const maxFiles = typeof workflow.inline_max_files === 'number'
+    ? workflow.inline_max_files
+    : DEFAULT_MAX_FILES;
+  const fileCount = frontmatter.files_modified.length;
+  if (fileCount > maxFiles) {
+    return {
+      inline: false,
+      reason: `file count ${fileCount} exceeds max ${maxFiles}`
+    };
+  }
+
+  // Line estimation check from task complexity
+  const maxLines = typeof workflow.inline_max_lines === 'number'
+    ? workflow.inline_max_lines
+    : DEFAULT_MAX_LINES;
+  const estimatedLines = tasks.reduce((sum, t) => {
+    return sum + (LINES_PER_COMPLEXITY[t.complexity] || LINES_PER_COMPLEXITY.unknown);
+  }, 0);
+  if (estimatedLines > maxLines) {
+    return {
+      inline: false,
+      reason: `estimated lines ${estimatedLines} exceeds max ${maxLines}`
+    };
+  }
+
+  return {
+    inline: true,
+    taskCount: tasks.length,
+    complexity: 'simple',
+    fileCount,
+    estimatedLines
+  };
+}
+
+module.exports = { shouldInlineExecution, parsePlanTasks, parsePlanFrontmatter };

package/plugins/pbr/scripts/lib/gates/milestone-complete.js

@@ -0,0 +1,139 @@
+'use strict';
+
+/**
+ * Gate: milestone complete verification check.
+ * When active skill is "milestone" and a general/planner agent is spawned
+ * for a "complete" operation, verify all milestone phases have VERIFICATION.md.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { readActiveSkill, readCurrentPhaseInt } = require('./helpers');
+const { logHook } = require('../../hook-logger');
+
+/**
+ * Parse VERIFICATION.md frontmatter to extract status field.
+ * Returns the status string or 'unknown' if not parseable.
+ * @param {string} filePath - path to VERIFICATION.md
+ * @returns {string}
+ */
+function getVerificationStatus(filePath) {
+  try {
+    const content = fs.readFileSync(filePath, 'utf8');
+    const fmMatch = content.match(/^---\r?\n([\s\S]*?)\r?\n---/);
+    if (!fmMatch) return 'unknown';
+    const statusMatch = fmMatch[1].match(/^status:\s*(\S+)/m);
+    return statusMatch ? statusMatch[1] : 'unknown';
+  } catch (_e) {
+    logHook('gate:milestone-complete', 'debug', 'Failed to read VERIFICATION.md status', { error: _e.message, filePath });
+    return 'unknown';
+  }
+}
+
+/**
+ * Blocking check: when the active skill is "milestone" and a general/planner agent
+ * is being spawned for a "complete" operation, verify all milestone phases have VERIFICATION.md.
+ * Returns { block: true, reason: "..." } if blocked, or null if OK.
+ * @param {object} data - hook data with tool_input
+ * @returns {{ block: boolean, reason: string }|null}
+ */
+function checkMilestoneCompleteGate(data) {
+  const toolInput = data.tool_input || {};
+  const subagentType = toolInput.subagent_type || '';
+  const description = toolInput.description || '';
+
+  const cwd = process.env.PBR_PROJECT_ROOT || process.cwd();
+  const planningDir = path.join(cwd, '.planning');
+
+  // Only gate when active skill is "milestone"
+  const activeSkill = readActiveSkill(planningDir);
+  if (activeSkill !== 'milestone') return null;
+
+  // Only gate pbr:general and pbr:planner
+  if (subagentType !== 'pbr:general' && subagentType !== 'pbr:planner') return null;
+
+  // Only gate "complete" operations
+  if (!/complete/i.test(description)) return null;
+
+  // Read STATE.md for current phase
+  const currentPhase = readCurrentPhaseInt(planningDir);
+  if (!currentPhase) return null;
+
+  // Read ROADMAP.md and find the milestone containing the current phase
+  const roadmapFile = path.join(planningDir, 'ROADMAP.md');
+  try {
+    const roadmap = fs.readFileSync(roadmapFile, 'utf8');
+
+    // Split into milestone sections
+    const milestoneSections = roadmap.split(/^## Milestone:/m).slice(1);
+
+    for (const section of milestoneSections) {
+      // Parse phase numbers from table rows
+      const phaseNumbers = [];
+      const tableRowRegex = /^\|\s*(\d+)\s*\|/gm;
+      let match;
+      while ((match = tableRowRegex.exec(section)) !== null) {
+        phaseNumbers.push(parseInt(match[1], 10));
+      }
+
+      // Fallback: parse from **Phases:** line or ### Phase NN: headings
+      if (phaseNumbers.length === 0) {
+        const phasesLineMatch = section.match(/\*\*Phases:\*\*\s*([\d,\s-]+)/);
+        if (phasesLineMatch) {
+          const nums = phasesLineMatch[1].match(/\d+/g);
+          if (nums) nums.forEach(n => phaseNumbers.push(parseInt(n, 10)));
+        }
+      }
+      if (phaseNumbers.length === 0) {
+        const headingRegex = /^###\s+Phase\s+(\d+):/gm;
+        let hMatch;
+        while ((hMatch = headingRegex.exec(section)) !== null) {
+          phaseNumbers.push(parseInt(hMatch[1], 10));
+        }
+      }
+
+      // Check if current phase is in this milestone
+      if (!phaseNumbers.includes(currentPhase)) continue;
+
+      // Found the right milestone — check all phases have VERIFICATION.md
+      const phasesDir = path.join(planningDir, 'phases');
+      if (!fs.existsSync(phasesDir)) return null;
+
+      for (const phaseNum of phaseNumbers) {
+        const paddedPhase = String(phaseNum).padStart(2, '0');
+        const pDirs = fs.readdirSync(phasesDir).filter(d => d.startsWith(paddedPhase + '-'));
+        if (pDirs.length === 0) {
+          return {
+            block: true,
+            reason: `Milestone complete gate: phase ${paddedPhase} directory not found.\n\nAll milestone phases must exist and have a passing VERIFICATION.md before the milestone can be completed.\n\nRun /pbr:verify-work ${paddedPhase} to verify the phase (it must reach status: passed).`
+          };
+        }
+        const verificationFile = path.join(phasesDir, pDirs[0], 'VERIFICATION.md');
+        const hasVerification = fs.existsSync(verificationFile);
+        if (!hasVerification) {
+          return {
+            block: true,
+            reason: `Milestone complete gate: phase ${paddedPhase} (${pDirs[0]}) lacks VERIFICATION.md.\n\nAll milestone phases must have a passing VERIFICATION.md before the milestone can be completed.\n\nRun /pbr:verify-work ${paddedPhase} to verify the phase (it must reach status: passed).`
+          };
+        }
+        const verStatus = getVerificationStatus(verificationFile);
+        if (verStatus === 'gaps_found') {
+          return {
+            block: true,
+            reason: `Milestone complete gate: phase ${paddedPhase} VERIFICATION.md has status: gaps_found.\n\nAll gaps must be closed before the milestone can be completed. The verifier found issues that need resolution.\n\nRun /pbr:verify-work ${paddedPhase} to close gaps (phase must reach status: passed).`
+          };
+        }
+      }
+
+      // All phases verified
+      return null;
+    }
+  } catch (_e) {
+    logHook('gate:milestone-complete', 'warn', 'MilestoneComplete gate check crashed', { error: _e.message });
+    return null;
+  }
+
+  return null;
+}
+
+module.exports = { checkMilestoneCompleteGate, getVerificationStatus };

package/plugins/pbr/scripts/lib/gates/milestone-summary.js

@@ -0,0 +1,121 @@
+'use strict';
+
+/**
+ * Gate: milestone complete SUMMARY.md check.
+ * When active skill is "milestone" and a general/planner agent is spawned
+ * for a "complete" operation, verify all milestone phases have SUMMARY.md.
+ *
+ * This mirrors milestone-complete.cjs (which checks VERIFICATION.md) to
+ * close the enforcement gap where SUMMARY.md was only advisory.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { readActiveSkill, readCurrentPhaseInt } = require('./helpers');
+const { logHook } = require('../../hook-logger');
+
+/**
+ * Blocking check: when the active skill is "milestone" and a general/planner agent
+ * is being spawned for a "complete" operation, verify all milestone phases have SUMMARY.md.
+ * Returns { block: true, reason: "..." } if blocked, or null if OK.
+ * @param {object} data - hook data with tool_input
+ * @returns {{ block: boolean, reason: string }|null}
+ */
+function checkMilestoneSummaryGate(data) {
+  const toolInput = data.tool_input || {};
+  const subagentType = toolInput.subagent_type || '';
+  const description = toolInput.description || '';
+
+  const cwd = process.env.PBR_PROJECT_ROOT || process.cwd();
+  const planningDir = path.join(cwd, '.planning');
+
+  // Only gate when active skill is "milestone"
+  const activeSkill = readActiveSkill(planningDir);
+  if (activeSkill !== 'milestone') return null;
+
+  // Only gate pbr:general and pbr:planner
+  if (subagentType !== 'pbr:general' && subagentType !== 'pbr:planner') return null;
+
+  // Only gate "complete" operations
+  if (!/complete/i.test(description)) return null;
+
+  // Read STATE.md for current phase
+  const currentPhase = readCurrentPhaseInt(planningDir);
+  if (!currentPhase) return null;
+
+  // Read ROADMAP.md and find the milestone containing the current phase
+  const roadmapFile = path.join(planningDir, 'ROADMAP.md');
+  try {
+    const roadmap = fs.readFileSync(roadmapFile, 'utf8');
+
+    // Split into milestone sections
+    const milestoneSections = roadmap.split(/^## Milestone:/m).slice(1);
+
+    for (const section of milestoneSections) {
+      // Parse phase numbers from table rows
+      const phaseNumbers = [];
+      const tableRowRegex = /^\|\s*(\d+)\s*\|/gm;
+      let match;
+      while ((match = tableRowRegex.exec(section)) !== null) {
+        phaseNumbers.push(parseInt(match[1], 10));
+      }
+
+      // Fallback: parse from **Phases:** line or ### Phase NN: headings
+      if (phaseNumbers.length === 0) {
+        const phasesLineMatch = section.match(/\*\*Phases:\*\*\s*([\d,\s-]+)/);
+        if (phasesLineMatch) {
+          const nums = phasesLineMatch[1].match(/\d+/g);
+          if (nums) nums.forEach(n => phaseNumbers.push(parseInt(n, 10)));
+        }
+      }
+      if (phaseNumbers.length === 0) {
+        const headingRegex = /^###\s+Phase\s+(\d+):/gm;
+        let hMatch;
+        while ((hMatch = headingRegex.exec(section)) !== null) {
+          phaseNumbers.push(parseInt(hMatch[1], 10));
+        }
+      }
+
+      // Check if current phase is in this milestone
+      if (!phaseNumbers.includes(currentPhase)) continue;
+
+      // Found the right milestone — check all phases have SUMMARY.md
+      const phasesDir = path.join(planningDir, 'phases');
+      if (!fs.existsSync(phasesDir)) return null;
+
+      for (const phaseNum of phaseNumbers) {
+        const paddedPhase = String(phaseNum).padStart(2, '0');
+        const pDirs = fs.readdirSync(phasesDir).filter(d => d.startsWith(paddedPhase + '-'));
+        if (pDirs.length === 0) continue; // Phase dir missing is caught by milestone-complete gate
+
+        const phaseDir = path.join(phasesDir, pDirs[0]);
+        const files = fs.readdirSync(phaseDir);
+        const hasSummary = files.some(f => {
+          if (!/^SUMMARY/i.test(f)) return false;
+          try {
+            return fs.statSync(path.join(phaseDir, f)).size > 0;
+          } catch (_e) {
+            return false;
+          }
+        });
+
+        if (!hasSummary) {
+          return {
+            block: true,
+            reason: `Milestone SUMMARY gate: phase ${paddedPhase} (${pDirs[0]}) lacks SUMMARY.md.\n\nAll milestone phases must have SUMMARY.md before the milestone can be completed. This file is created by the executor agent during /pbr:build.\n\nRun /pbr:execute-phase ${paddedPhase} to build this phase and create SUMMARY.md.`
+          };
+        }
+      }
+
+      // All phases have SUMMARY.md
+      return null;
+    }
+  } catch (_e) {
+    logHook('gate:milestone-summary', 'warn', 'MilestoneSummary gate check crashed', { error: _e.message });
+    return null;
+  }
+
+  return null;
+}
+
+module.exports = { checkMilestoneSummaryGate };