planning-with-files 3.9.0

package/scripts/check-complete.ps1

@@ -0,0 +1,253 @@
+# Check if all phases in task_plan.md are complete
+# Default invocation: advisory echo, always exits 0 (Stop hook status report).
+# With -Gate: deliberate completion gate, opt-in per plan via <plan-dir>/.mode.
+# Used by Stop hook to report task completion status.
+#
+# Gate mode (v3, -Gate flag) blocks ONLY when ALL hold (design "Gate decision table"):
+#   1. <plan-dir>/.mode exists and contains "gate" (explicit opt-in)
+#   2. an in_progress phase exists (not merely complete<total)
+#   3. the Stop hook input JSON on stdin does not set stop_hook_active=true
+#   4. the block counter (<plan-dir>/.stop_blocks) is below cap (PWF_GATE_CAP, default 20)
+#   5. the ledger advanced since the last block (stall -> allow stop)
+# When all hold, emits a single-line block-decision JSON on stdout and exits 0.
+# Otherwise advisory output and exit 0. Without -Gate, byte-equivalent to v2.43.
+#
+# Stdin: read only when input is redirected ([Console]::IsInputRedirected), so an
+# interactive console never blocks. Hook-piped JSON is EOF-terminated.
+
+param(
+    [string]$PlanFile = "",
+    [switch]$Gate
+)
+
+# issue #195: per-invocation opt-out (PLANNING_DISABLED=1) for one-shot/CI
+# sessions that share a cwd with a plan but never opted into it.
+if ($env:PLANNING_DISABLED -eq '1') { exit 0 }
+
+if ($PlanFile -ne "") {
+    $PlanDir = Split-Path -Parent $PlanFile
+    if ($PlanDir -eq "") { $PlanDir = "." }
+} else {
+    $scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
+    $resolver = Join-Path $scriptDir "resolve-plan-dir.ps1"
+    $resolvedDir = ""
+    if (Test-Path $resolver) {
+        try {
+            $resolvedDir = (& $resolver 2>$null | Select-Object -First 1)
+            if ($null -eq $resolvedDir) { $resolvedDir = "" }
+        } catch {
+            $resolvedDir = ""
+        }
+    }
+    if ($resolvedDir -ne "" -and (Test-Path (Join-Path $resolvedDir "task_plan.md"))) {
+        $PlanFile = Join-Path $resolvedDir "task_plan.md"
+        $PlanDir = $resolvedDir
+    } else {
+        $PlanFile = "task_plan.md"
+        $PlanDir = "."
+    }
+}
+
+if (-not (Test-Path $PlanFile)) {
+    Write-Host '[planning-with-files] No task_plan.md found -- no active planning session.'
+    exit 0
+}
+
+# Read file content
+$content = Get-Content $PlanFile -Raw
+
+# Count total phases
+$TOTAL = ([regex]::Matches($content, "### Phase")).Count
+
+# Count both formats per field and keep the larger of the two. A plan may mix
+# '**Status:** pending' on one phase with '[in_progress]' on another; counting
+# only the primary format (and falling back to inline ONLY when all three
+# primaries are zero) lost the inline count and let an in_progress plan slip
+# past the gate. Per-field max preserves the legacy single-format result
+# (the other format contributes 0) while catching mixed plans.
+$completePrimary = ([regex]::Matches($content, "\*\*Status:\*\* complete")).Count
+$inProgressPrimary = ([regex]::Matches($content, "\*\*Status:\*\* in_progress")).Count
+$pendingPrimary = ([regex]::Matches($content, "\*\*Status:\*\* pending")).Count
+
+$completeInline = ([regex]::Matches($content, "\[complete\]")).Count
+$inProgressInline = ([regex]::Matches($content, "\[in_progress\]")).Count
+$pendingInline = ([regex]::Matches($content, "\[pending\]")).Count
+
+$COMPLETE = [Math]::Max($completePrimary, $completeInline)
+$IN_PROGRESS = [Math]::Max($inProgressPrimary, $inProgressInline)
+$PENDING = [Math]::Max($pendingPrimary, $pendingInline)
+
+# issue #191: no "### Phase" headings -> not a phase-structured plan. Report
+# nothing rather than a false "0/0 phases complete" status. With TOTAL=0 the
+# gate can never legitimately block (IN_PROGRESS is also 0), so exit is safe.
+if ($TOTAL -eq 0) {
+    exit 0
+}
+
+# advisory_report: the v2.43 status echo.
+function Write-AdvisoryReport {
+    if ($COMPLETE -eq $TOTAL -and $TOTAL -gt 0) {
+        Write-Host ('[planning-with-files] ALL PHASES COMPLETE (' + $COMPLETE + '/' + $TOTAL + '). If the user has additional work, add new phases to task_plan.md before starting.')
+    } else {
+        Write-Host ('[planning-with-files] Task in progress (' + $COMPLETE + '/' + $TOTAL + ' phases complete). Update progress.md before stopping.')
+        if ($IN_PROGRESS -gt 0) {
+            Write-Host ('[planning-with-files] ' + $IN_PROGRESS + ' phase(s) still in progress.')
+        }
+        if ($PENDING -gt 0) {
+            Write-Host ('[planning-with-files] ' + $PENDING + ' phase(s) pending.')
+        }
+    }
+}
+
+# ---- Default (advisory) path: byte-equivalent to v2.43 ----
+if (-not $Gate) {
+    Write-AdvisoryReport
+    exit 0
+}
+
+# ---- Gate path (-Gate). Resolves to advisory unless every guard says block. ----
+
+# Guard 1: gated mode. The .mode file must contain "gate".
+$modeFile = Join-Path $PlanDir ".mode"
+$gatedMode = $false
+if (Test-Path $modeFile) {
+    $modeContent = Get-Content $modeFile -Raw -ErrorAction SilentlyContinue
+    if ($null -ne $modeContent -and $modeContent -match "gate") {
+        $gatedMode = $true
+    }
+}
+if (-not $gatedMode) {
+    Write-AdvisoryReport
+    exit 0
+}
+
+# Guard 3: stop_hook_active. Read stdin only when input is redirected, so an
+# interactive console never blocks. A true value means we are already inside a
+# forced continuation; allow the stop.
+$stdinJson = ""
+try {
+    if ([Console]::IsInputRedirected) {
+        $stdinJson = [Console]::In.ReadToEnd()
+    }
+} catch {
+    $stdinJson = ""
+}
+# Anchor on the literal value: "stop_hook_active" then colon then exactly true,
+# with a JSON-structural boundary after it (whitespace, comma, closing brace, or
+# end of input). Without the boundary 'true' could match a longer token; the
+# boundary keeps a 'false' value (or any other key set to true) from tripping
+# the guard and silently disabling the gate.
+if ($stdinJson -match '"stop_hook_active"\s*:\s*true(\s|,|}|$)') {
+    Write-AdvisoryReport
+    exit 0
+}
+
+# Guard 2: an in_progress phase must exist.
+if ($IN_PROGRESS -le 0) {
+    Write-AdvisoryReport
+    exit 0
+}
+
+# ledger_line_count: total lines across all <plan-dir>/ledger-*.jsonl files.
+function Get-LedgerLineCount {
+    $total = 0
+    $files = Get-ChildItem -Path $PlanDir -Filter "ledger-*.jsonl" -File -ErrorAction SilentlyContinue
+    foreach ($f in $files) {
+        $lines = @(Get-Content $f.FullName -ErrorAction SilentlyContinue)
+        $total += $lines.Count
+    }
+    return $total
+}
+
+$cap = 20
+if ($env:PWF_GATE_CAP -match '^\d+$') {
+    $cap = [int]$env:PWF_GATE_CAP
+}
+
+$blocksFile = Join-Path $PlanDir ".stop_blocks"
+$blocks = 0
+if (Test-Path $blocksFile) {
+    $raw = (Get-Content $blocksFile -Raw -ErrorAction SilentlyContinue)
+    if ($raw -match '^\s*(\d+)') { $blocks = [int]$Matches[1] }
+}
+
+$ledgerFile = Join-Path $PlanDir ".gate_last_ledger"
+$ledgerPrev = 0
+if (Test-Path $ledgerFile) {
+    $raw = (Get-Content $ledgerFile -Raw -ErrorAction SilentlyContinue)
+    if ($raw -match '^\s*(\d+)') { $ledgerPrev = [int]$Matches[1] }
+}
+$ledgerNow = Get-LedgerLineCount
+
+# Guard 4: block-count cap.
+if ($blocks -ge $cap) {
+    Write-AdvisoryReport
+    Write-Host ('[planning-with-files] gate cap reached (' + $blocks + '/' + $cap + ') -- allowing stop.')
+    exit 0
+}
+
+# Guard 5: stall detection.
+if ($blocks -gt 0 -and $ledgerNow -eq $ledgerPrev) {
+    Write-AdvisoryReport
+    Write-Host '[planning-with-files] no progress since last gate block -- allowing stop.'
+    exit 0
+}
+
+# All guards passed: block the stop.
+# Get-FirstInProgressPhase: heading text of the first phase whose Status is
+# in_progress. Plain text only -- no plan body beyond the heading.
+function Get-FirstInProgressPhase {
+    $heading = ""
+    foreach ($line in ($content -split "`n")) {
+        $trimmed = $line.TrimEnd("`r")
+        if ($trimmed -match '^### (.*)$') {
+            $heading = $Matches[1]
+        } elseif ($trimmed -match '\*\*Status:\*\* in_progress' -or $trimmed -match '\[in_progress\]') {
+            return $heading
+        }
+    }
+    return ""
+}
+
+$phaseName = Get-FirstInProgressPhase
+if ($phaseName -eq "") { $phaseName = "unknown phase" }
+
+# JSON-escape: backslash and double-quote, plus every bare control character
+# JSON forbids (below 0x20) mapped to a space. A phase heading may carry a
+# literal tab; left raw it produces invalid JSON the Stop hook rejects. Same
+# logic as ledger-append.ps1 ConvertTo-JsonString.
+function ConvertTo-JsonEscaped {
+    param([string] $Value)
+    $sb = New-Object System.Text.StringBuilder
+    foreach ($ch in $Value.ToCharArray()) {
+        switch ($ch) {
+            '"'  { [void]$sb.Append('\"') }
+            '\'  { [void]$sb.Append('\\') }
+            default {
+                if ([int]$ch -lt 32) {
+                    [void]$sb.Append(' ')
+                } else {
+                    [void]$sb.Append($ch)
+                }
+            }
+        }
+    }
+    return $sb.ToString()
+}
+$phaseEscaped = ConvertTo-JsonEscaped $phaseName
+
+$newBlocks = $blocks + 1
+# Write sidecars as ASCII (single-byte digits) with an explicit LF and no BOM.
+# Set-Content on Windows emits CRLF; check-complete.sh then reads '5\r', whose
+# trailing CR makes the numeric guard reset BLOCKS to 0 on every cross-platform
+# read, so the cap and stall guards never fire. WriteAllText with ASCII gives
+# byte-for-byte '5\n' that both shells parse identically.
+try { [System.IO.File]::WriteAllText($blocksFile, [string]$newBlocks + "`n", [System.Text.Encoding]::ASCII) } catch {}
+try { [System.IO.File]::WriteAllText($ledgerFile, [string]$ledgerNow + "`n", [System.Text.Encoding]::ASCII) } catch {}
+
+# Reason built from the JSON-escaped phase name; the surrounding template text
+# has no quotes or backslashes, so only the heading needs escaping.
+$reason = "[planning-with-files] Gated plan incomplete: phase '" + $phaseEscaped + "' is in_progress (" + $COMPLETE + "/" + $TOTAL + " complete, gate block " + $newBlocks + "/" + $cap + "). Finish or update the plan, then stop."
+
+[Console]::Out.Write('{"decision":"block","reason":"' + $reason + '"}' + "`n")
+exit 0

package/scripts/check-complete.sh

@@ -0,0 +1,253 @@
+#!/usr/bin/env bash
+# Check if all phases in task_plan.md are complete
+# Default invocation: advisory echo, always exits 0 (Stop hook status report).
+# With --gate: deliberate completion gate, opt-in per plan via <plan-dir>/.mode.
+# Used by Stop hook to report task completion status.
+#
+# Plan-file resolution (v2.40+):
+#   1. $1 (explicit path) — first non-flag positional argument
+#   2. resolve-plan-dir.sh: $PLAN_ID env → .planning/.active_plan → newest mtime
+#   3. Legacy ./task_plan.md
+#
+# This restores slug-mode parity: the Stop hook and any caller invoking with
+# zero args now respects the active plan dir instead of silently defaulting to
+# the legacy root path.
+#
+# Gate mode (v3, --gate flag):
+#   The gate is OFF unless ALL of these hold (design "Gate decision table"):
+#     1. <plan-dir>/.mode exists and contains "gate" (explicit opt-in)
+#     2. an in_progress phase exists (not merely complete<total)
+#     3. the Stop hook input JSON on stdin does not set stop_hook_active=true
+#     4. the block counter (<plan-dir>/.stop_blocks) is below cap (PWF_GATE_CAP, default 20)
+#     5. the ledger advanced since the last block (stall → allow stop)
+#   When all hold, it emits a single-line block-decision JSON on stdout and
+#   exits 0. Otherwise it falls back to advisory output and exits 0.
+#   Without --gate, or in non-gated mode, behavior is byte-equivalent to v2.43.
+#
+# Stdin handling: the Claude Code Stop hook pipes a JSON payload on stdin. To
+# avoid hanging when nothing is piped, stdin is read ONLY when fd 0 is not a
+# TTY ([ -t 0 ]). Hook-piped input is EOF-terminated, so the read returns; an
+# interactive terminal (TTY) is skipped entirely. No data on stdin is treated
+# as stop_hook_active=false.
+
+# issue #195: per-invocation opt-out (PLANNING_DISABLED=1) for one-shot/CI
+# sessions that share a cwd with a plan but never opted into it.
+[ "${PLANNING_DISABLED:-}" = "1" ] && exit 0
+
+GATE=0
+PLAN_FILE=""
+for _arg in "$@"; do
+    case "$_arg" in
+        --gate) GATE=1 ;;
+        *)
+            if [ -z "$PLAN_FILE" ]; then
+                PLAN_FILE="$_arg"
+            fi
+            ;;
+    esac
+done
+
+PLAN_DIR=""
+if [ -n "${PLAN_FILE}" ]; then
+    PLAN_DIR="$(dirname "${PLAN_FILE}")"
+else
+    SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd 2>/dev/null)" || SCRIPT_DIR="."
+    RESOLVER="${SCRIPT_DIR}/resolve-plan-dir.sh"
+    RESOLVED_DIR=""
+    if [ -f "${RESOLVER}" ]; then
+        RESOLVED_DIR="$(sh "${RESOLVER}" 2>/dev/null)"
+    fi
+    if [ -n "${RESOLVED_DIR}" ] && [ -f "${RESOLVED_DIR}/task_plan.md" ]; then
+        PLAN_FILE="${RESOLVED_DIR}/task_plan.md"
+        PLAN_DIR="${RESOLVED_DIR}"
+    else
+        PLAN_FILE="task_plan.md"
+        PLAN_DIR="."
+    fi
+fi
+
+if [ ! -f "$PLAN_FILE" ]; then
+    echo "[planning-with-files] No task_plan.md found — no active planning session."
+    exit 0
+fi
+
+# Count total phases
+TOTAL=$(grep -c "### Phase" "$PLAN_FILE" || true)
+
+# Count both formats per field and keep the larger of the two. A plan may mix
+# '**Status:** pending' on one phase with '[in_progress]' on another; counting
+# only the primary format (and falling back to inline ONLY when all three
+# primaries are zero) lost the inline count and let an in_progress plan slip
+# past the gate. Per-field max preserves the legacy single-format result
+# (the other format contributes 0) while catching mixed plans.
+COMPLETE_PRIMARY=$(grep -cF "**Status:** complete" "$PLAN_FILE" || true)
+IN_PROGRESS_PRIMARY=$(grep -cF "**Status:** in_progress" "$PLAN_FILE" || true)
+PENDING_PRIMARY=$(grep -cF "**Status:** pending" "$PLAN_FILE" || true)
+
+COMPLETE_INLINE=$(grep -c "\[complete\]" "$PLAN_FILE" || true)
+IN_PROGRESS_INLINE=$(grep -c "\[in_progress\]" "$PLAN_FILE" || true)
+PENDING_INLINE=$(grep -c "\[pending\]" "$PLAN_FILE" || true)
+
+: "${COMPLETE_PRIMARY:=0}"; : "${IN_PROGRESS_PRIMARY:=0}"; : "${PENDING_PRIMARY:=0}"
+: "${COMPLETE_INLINE:=0}";  : "${IN_PROGRESS_INLINE:=0}";  : "${PENDING_INLINE:=0}"
+
+if [ "$COMPLETE_INLINE" -gt "$COMPLETE_PRIMARY" ]; then COMPLETE="$COMPLETE_INLINE"; else COMPLETE="$COMPLETE_PRIMARY"; fi
+if [ "$IN_PROGRESS_INLINE" -gt "$IN_PROGRESS_PRIMARY" ]; then IN_PROGRESS="$IN_PROGRESS_INLINE"; else IN_PROGRESS="$IN_PROGRESS_PRIMARY"; fi
+if [ "$PENDING_INLINE" -gt "$PENDING_PRIMARY" ]; then PENDING="$PENDING_INLINE"; else PENDING="$PENDING_PRIMARY"; fi
+
+# Default to 0 if empty
+: "${TOTAL:=0}"
+: "${COMPLETE:=0}"
+: "${IN_PROGRESS:=0}"
+: "${PENDING:=0}"
+
+# issue #191: no "### Phase" headings -> not a phase-structured plan. Report
+# nothing rather than a false "0/0 phases complete" status. With TOTAL=0 the
+# gate can never legitimately block (IN_PROGRESS is also 0), so exit is safe.
+if [ "$TOTAL" -eq 0 ]; then
+    exit 0
+fi
+
+# advisory_report: the v2.43 status echo. Always exit 0 after calling.
+advisory_report() {
+    if [ "$COMPLETE" -eq "$TOTAL" ] && [ "$TOTAL" -gt 0 ]; then
+        echo "[planning-with-files] ALL PHASES COMPLETE ($COMPLETE/$TOTAL). If the user has additional work, add new phases to task_plan.md before starting."
+    else
+        echo "[planning-with-files] Task in progress ($COMPLETE/$TOTAL phases complete). Update progress.md before stopping."
+        if [ "$IN_PROGRESS" -gt 0 ]; then
+            echo "[planning-with-files] $IN_PROGRESS phase(s) still in progress."
+        fi
+        if [ "$PENDING" -gt 0 ]; then
+            echo "[planning-with-files] $PENDING phase(s) pending."
+        fi
+    fi
+}
+
+# ---- Default (advisory) path: byte-equivalent to v2.43 ----
+if [ "$GATE" -ne 1 ]; then
+    advisory_report
+    exit 0
+fi
+
+# ---- Gate path (--gate). Resolves to advisory unless every guard says block. ----
+
+# Guard 1: gated mode. The .mode file must contain "gate". Absent or other
+# content means advisory mode (legacy behavior preserved).
+MODE_FILE="${PLAN_DIR}/.mode"
+if [ ! -f "${MODE_FILE}" ] || ! grep -q "gate" "${MODE_FILE}" 2>/dev/null; then
+    advisory_report
+    exit 0
+fi
+
+# Guard 3: stop_hook_active. Read the Stop hook JSON from stdin only when fd 0
+# is not a TTY (see header). A true value means we are already inside a forced
+# continuation; allow the stop to avoid runaway recursion.
+STDIN_JSON=""
+if [ ! -t 0 ]; then
+    STDIN_JSON="$(cat 2>/dev/null)"
+fi
+# Anchor on the VALUE: "stop_hook_active" immediately followed (allowing
+# whitespace and the colon) by true. A bare glob like *stop_hook_active*true*
+# false-positives on '{"stop_hook_active": false, "other": true}', which would
+# silently disable the gate. Newlines are collapsed so the match works whether
+# the payload is pretty-printed or single-line.
+STOP_HOOK_ACTIVE="$(
+    printf '%s' "${STDIN_JSON}" \
+        | tr '\n' ' ' \
+        | sed -n 's/.*"stop_hook_active"[[:space:]]*:[[:space:]]*true.*/FOUND/p'
+)"
+if [ "${STOP_HOOK_ACTIVE}" = "FOUND" ]; then
+    advisory_report
+    exit 0
+fi
+
+# Guard 2: an in_progress phase must exist. Merely complete<total is a normal
+# state and must NOT block (issue #178 lesson).
+if [ "$IN_PROGRESS" -le 0 ]; then
+    advisory_report
+    exit 0
+fi
+
+# ledger_line_count: total lines across all <plan-dir>/ledger-*.jsonl files.
+# Echoes a single integer (0 when no ledger files exist).
+ledger_line_count() {
+    _total=0
+    for _lf in "${PLAN_DIR}"/ledger-*.jsonl; do
+        [ -f "${_lf}" ] || continue
+        _n="$(grep -c '' "${_lf}" 2>/dev/null || echo 0)"
+        _total=$((_total + _n))
+    done
+    printf "%s" "${_total}"
+}
+
+CAP="${PWF_GATE_CAP:-20}"
+case "${CAP}" in
+    ''|*[!0-9]*) CAP=20 ;;
+esac
+
+BLOCKS_FILE="${PLAN_DIR}/.stop_blocks"
+BLOCKS="$(cat "${BLOCKS_FILE}" 2>/dev/null || echo 0)"
+case "${BLOCKS}" in
+    ''|*[!0-9]*) BLOCKS=0 ;;
+esac
+
+LEDGER_FILE="${PLAN_DIR}/.gate_last_ledger"
+LEDGER_PREV="$(cat "${LEDGER_FILE}" 2>/dev/null || echo 0)"
+case "${LEDGER_PREV}" in
+    ''|*[!0-9]*) LEDGER_PREV=0 ;;
+esac
+LEDGER_NOW="$(ledger_line_count)"
+
+# Guard 4: block-count cap. At or over the cap, allow the stop.
+if [ "${BLOCKS}" -ge "${CAP}" ]; then
+    advisory_report
+    echo "[planning-with-files] gate cap reached ($BLOCKS/$CAP) — allowing stop."
+    exit 0
+fi
+
+# Guard 5: stall detection. If we have blocked before (BLOCKS > 0) and the
+# ledger line count has not advanced since the last block, nothing progressed:
+# allow the stop instead of looping.
+if [ "${BLOCKS}" -gt 0 ] && [ "${LEDGER_NOW}" -eq "${LEDGER_PREV}" ]; then
+    advisory_report
+    echo "[planning-with-files] no progress since last gate block — allowing stop."
+    exit 0
+fi
+
+# All guards passed: block the stop.
+# json_escape: escape a string for safe inclusion in a JSON string literal.
+# Escapes backslash and double-quote, then neutralizes every bare control
+# character JSON forbids (0x01-0x1F) by mapping it to a space. A phase heading
+# may carry a literal tab or other control byte; left raw it produces invalid
+# JSON ("Bad control character in string literal") that the Stop hook rejects.
+json_escape() {
+    printf "%s" "$1" \
+        | sed -e 's/\\/\\\\/g' -e 's/"/\\"/g' \
+        | tr '\001-\037' ' '
+}
+
+# first_in_progress_phase: heading text of the first phase whose Status is
+# in_progress. Reads the plan top-to-bottom, remembers the most recent
+# "### " heading, and prints it (with the "### " prefix stripped) at the first
+# in_progress status line. Plain text only — no plan body beyond the heading.
+first_in_progress_phase() {
+    awk '
+        /^### / { heading = substr($0, 5); next }
+        /\*\*Status:\*\* in_progress/ { print heading; exit }
+        /\[in_progress\]/            { print heading; exit }
+    ' "$PLAN_FILE"
+}
+
+PHASE_NAME="$(first_in_progress_phase)"
+if [ -z "${PHASE_NAME}" ]; then
+    PHASE_NAME="unknown phase"
+fi
+PHASE_ESCAPED="$(json_escape "${PHASE_NAME}")"
+
+NEW_BLOCKS=$((BLOCKS + 1))
+printf "%s\n" "${NEW_BLOCKS}" > "${BLOCKS_FILE}" 2>/dev/null || true
+printf "%s\n" "${LEDGER_NOW}" > "${LEDGER_FILE}" 2>/dev/null || true
+
+printf '{"decision":"block","reason":"[planning-with-files] Gated plan incomplete: phase '\''%s'\'' is in_progress (%s/%s complete, gate block %s/%s). Finish or update the plan, then stop."}\n' \
+    "${PHASE_ESCAPED}" "${COMPLETE}" "${TOTAL}" "${NEW_BLOCKS}" "${CAP}"
+exit 0