planning-with-files 3.9.0

package/scripts/init-session.ps1

@@ -0,0 +1,230 @@
+# Initialize planning files for a new session
+# Usage: .\init-session.ps1 [-Template TYPE] [project-name]
+#        .\init-session.ps1 -Autonomous        # v3 autonomous mode (opt-in)
+#        .\init-session.ps1 -Gated             # v3 gated mode (opt-in, implies autonomous)
+# Templates: default, analytics
+#
+# v3 modes (opt-in): -Autonomous / -Gated write a .mode marker next to the plan,
+# reset the .stop_blocks gate counter, clear any stale gate ledger, write a fresh
+# 16-hex nonce for delimiter framing, and auto-attest the plan. With NO v3 switch
+# and no .mode file, behavior is byte-equivalent to v2.43.0.
+
+param(
+    [string]$ProjectName = "project",
+    [string]$Template = "default",
+    [switch]$Autonomous,
+    [switch]$Gated
+)
+
+$DATE = Get-Date -Format "yyyy-MM-dd"
+
+# Resolve v3 opt-in mode. -Gated implies autonomous and is the stronger marker.
+$Mode = ""
+if ($Gated) {
+    $Mode = "gated"
+} elseif ($Autonomous) {
+    $Mode = "autonomous"
+}
+
+# Resolve template directory (skill root is one level up from scripts/)
+$ScriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
+$SkillRoot = Split-Path -Parent $ScriptDir
+$TemplateDir = Join-Path $SkillRoot "templates"
+
+function Get-Nonce {
+    # 16 hex chars for the plan-data delimiter framing (security strand rec 8).
+    $bytes = New-Object 'System.Byte[]' 8
+    [System.Security.Cryptography.RandomNumberGenerator]::Create().GetBytes($bytes)
+    ($bytes | ForEach-Object { $_.ToString("x2") }) -join ""
+}
+
+Write-Host "Initializing planning files for: $ProjectName (template: $Template)"
+
+# Validate template
+if ($Template -ne "default" -and $Template -ne "analytics") {
+    Write-Host "Unknown template: $Template (available: default, analytics). Using default."
+    $Template = "default"
+}
+
+# Create task_plan.md if it doesn't exist
+if (-not (Test-Path "task_plan.md")) {
+    $AnalyticsPlan = Join-Path $TemplateDir "analytics_task_plan.md"
+    if ($Template -eq "analytics" -and (Test-Path $AnalyticsPlan)) {
+        Copy-Item $AnalyticsPlan "task_plan.md"
+    } else {
+        @"
+# Task Plan: [Brief Description]
+
+## Goal
+[One sentence describing the end state]
+
+## Next Step
+[The single next action. Update whenever phase status changes.]
+
+## Current Phase
+Phase 1
+
+## Phases
+
+### Phase 1: Requirements & Discovery
+- [ ] Understand user intent
+- [ ] Identify constraints
+- [ ] Document in findings.md
+- **Status:** in_progress
+
+### Phase 2: Planning & Structure
+- [ ] Define approach
+- [ ] Create project structure
+- **Status:** pending
+
+### Phase 3: Implementation
+- [ ] Execute the plan
+- [ ] Write to files before executing
+- **Status:** pending
+
+### Phase 4: Testing & Verification
+- [ ] Verify requirements met
+- [ ] Document test results
+- **Status:** pending
+
+### Phase 5: Delivery
+- [ ] Review outputs
+- [ ] Deliver to user
+- **Status:** pending
+
+## Decisions Made
+| Decision | Rationale |
+|----------|-----------|
+
+## Errors Encountered
+| Error | Resolution |
+|-------|------------|
+"@ | Out-File -FilePath "task_plan.md" -Encoding UTF8
+    }
+    Write-Host "Created task_plan.md"
+} else {
+    Write-Host "task_plan.md already exists, skipping"
+}
+
+# Create findings.md if it doesn't exist
+if (-not (Test-Path "findings.md")) {
+    $AnalyticsFindings = Join-Path $TemplateDir "analytics_findings.md"
+    if ($Template -eq "analytics" -and (Test-Path $AnalyticsFindings)) {
+        Copy-Item $AnalyticsFindings "findings.md"
+    } else {
+        @"
+# Findings & Decisions
+
+## Requirements
+-
+
+## Research Findings
+-
+
+## Technical Decisions
+| Decision | Rationale |
+|----------|-----------|
+
+## Issues Encountered
+| Issue | Resolution |
+|-------|------------|
+
+## Resources
+-
+"@ | Out-File -FilePath "findings.md" -Encoding UTF8
+    }
+    Write-Host "Created findings.md"
+} else {
+    Write-Host "findings.md already exists, skipping"
+}
+
+# Create progress.md if it doesn't exist
+if (-not (Test-Path "progress.md")) {
+    if ($Template -eq "analytics") {
+        @"
+# Progress Log
+
+## Session: $DATE
+
+### Current Status
+- **Phase:** 1 - Data Discovery
+- **Started:** $DATE
+
+### Actions Taken
+-
+
+### Query Log
+| Query | Result Summary | Interpretation |
+|-------|---------------|----------------|
+
+### Errors
+| Error | Resolution |
+|-------|------------|
+"@ | Out-File -FilePath "progress.md" -Encoding UTF8
+    } else {
+        @"
+# Progress Log
+
+## Session: $DATE
+
+### Current Status
+- **Phase:** 1 - Requirements & Discovery
+- **Started:** $DATE
+
+### Actions Taken
+-
+
+### Test Results
+| Test | Expected | Actual | Status |
+|------|----------|--------|--------|
+
+### Errors
+| Error | Resolution |
+|-------|------------|
+"@ | Out-File -FilePath "progress.md" -Encoding UTF8
+    }
+    Write-Host "Created progress.md"
+} else {
+    Write-Host "progress.md already exists, skipping"
+}
+
+Write-Host ""
+Write-Host "Planning files initialized!"
+Write-Host "Files: task_plan.md, findings.md, progress.md"
+
+# v3 opt-in mode side effects. No-op when -Autonomous/-Gated were not passed, so
+# the default path stays byte-equivalent to v2.43.0. PS1 init writes in CWD, so
+# dotfiles live in CWD and attest-plan.ps1 falls back to the legacy
+# .plan-attestation at the project root.
+if ($Mode -ne "") {
+    $PlanDirPwf = (Get-Location).Path
+
+    # (a) reset gate block counter, drop stale gate ledger.
+    Set-Content -LiteralPath (Join-Path $PlanDirPwf ".stop_blocks") -Value "0" -Encoding ascii
+    $StaleLedger = Join-Path $PlanDirPwf ".gate_last_ledger"
+    if (Test-Path -LiteralPath $StaleLedger) { Remove-Item -LiteralPath $StaleLedger -Force }
+
+    # (b) fresh 16-hex nonce for delimiter framing.
+    Set-Content -LiteralPath (Join-Path $PlanDirPwf ".nonce") -Value (Get-Nonce) -NoNewline -Encoding ascii
+
+    # mode marker. gated implies autonomous, so it carries both tokens.
+    if ($Mode -eq "gated") {
+        $MarkerText = "autonomous gate"
+    } else {
+        $MarkerText = "autonomous"
+    }
+    Set-Content -LiteralPath (Join-Path $PlanDirPwf ".mode") -Value $MarkerText -Encoding ascii
+
+    # (c) auto-attest (attestation default-on in v3 modes, security strand rec 1).
+    $AttestPs1 = Join-Path $ScriptDir "attest-plan.ps1"
+    $PlanFilePwf = Join-Path $PlanDirPwf "task_plan.md"
+    if ((Test-Path -LiteralPath $AttestPs1) -and (Test-Path -LiteralPath $PlanFilePwf)) {
+        try {
+            & $AttestPs1 *> $null
+        } catch {
+            # attestation failure must not abort init; the mode marker still stands.
+        }
+    }
+
+    Write-Host "Mode: $MarkerText (attested, gate counter reset)"
+}

package/scripts/init-session.sh

@@ -0,0 +1,370 @@
+#!/usr/bin/env bash
+# Initialize planning files for a new session.
+#
+# Usage:
+#   ./init-session.sh                              # legacy: root-level task_plan.md, findings.md, progress.md
+#   ./init-session.sh [--template TYPE]            # legacy with template choice
+#   ./init-session.sh "Backend Refactor"           # slug mode: .planning/<date>-backend-refactor/
+#   ./init-session.sh --plan-dir                   # slug mode with auto-generated untitled-<short> name
+#   ./init-session.sh --plan-dir "Quick Spike"     # slug mode, explicit slug
+#   ./init-session.sh --autonomous "Long Run"      # v3 autonomous mode (opt-in): .mode + nonce + auto-attest
+#   ./init-session.sh --gated "Gated Run"          # v3 gated mode (opt-in, implies autonomous): adds Stop-gate marker
+#   ./init-session.sh --autonomous                 # v3 flags also work in legacy root mode (dotfiles at root)
+#
+# Legacy mode (zero positional args, no --plan-dir) preserves v1.x behavior so
+# upgrades stay non-breaking. Slug mode addresses parallel multi-task isolation
+# (issue #148) by writing each plan under .planning/<date>-<slug>/ and pinning
+# .planning/.active_plan so resolve-plan-dir.sh can find it.
+#
+# v3 modes (opt-in): --autonomous / --gated write a .mode marker next to the
+# plan, reset the .stop_blocks gate counter, clear any stale gate ledger, write
+# a fresh nonce for delimiter framing, and auto-attest the plan. With NO v3 flag
+# and no .mode file, behavior is byte-equivalent to v2.43.0 (no .mode, no nonce,
+# no attestation change).
+
+set -e
+
+TEMPLATE="default"
+PROJECT_NAME=""
+USE_PLAN_DIR=0
+MODE=""
+
+while [ $# -gt 0 ]; do
+    case "$1" in
+        --template|-t)
+            TEMPLATE="$2"
+            shift 2
+            ;;
+        --plan-dir)
+            USE_PLAN_DIR=1
+            shift
+            ;;
+        --autonomous)
+            # autonomous wins only if --gated hasn't already been set (gated
+            # implies autonomous and is the stronger marker).
+            if [ "$MODE" != "gated" ]; then
+                MODE="autonomous"
+            fi
+            shift
+            ;;
+        --gated)
+            MODE="gated"
+            shift
+            ;;
+        *)
+            if [ -z "$PROJECT_NAME" ]; then
+                PROJECT_NAME="$1"
+            else
+                PROJECT_NAME="$PROJECT_NAME $1"
+            fi
+            shift
+            ;;
+    esac
+done
+
+DATE=$(date +%Y-%m-%d)
+
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+SKILL_ROOT="$(dirname "$SCRIPT_DIR")"
+TEMPLATE_DIR="$SKILL_ROOT/templates"
+
+if [ "$TEMPLATE" != "default" ] && [ "$TEMPLATE" != "analytics" ]; then
+    echo "Unknown template: $TEMPLATE (available: default, analytics). Using default."
+    TEMPLATE="default"
+fi
+
+# Slug mode triggers when a project name was given OR --plan-dir was passed.
+SLUG_MODE=0
+if [ -n "$PROJECT_NAME" ] || [ "$USE_PLAN_DIR" -eq 1 ]; then
+    SLUG_MODE=1
+fi
+
+slugify() {
+    # Lowercase, non-alphanumerics → '-', collapse repeats, trim leading/trailing '-'
+    printf '%s' "$1" \
+        | tr '[:upper:]' '[:lower:]' \
+        | sed -e 's/[^a-z0-9]/-/g' -e 's/-\{2,\}/-/g' -e 's/^-//' -e 's/-$//' \
+        | cut -c1-40
+}
+
+short_uuid() {
+    # Probe each candidate: command -v alone is not enough on Windows because
+    # App Execution Aliases report presence but exit non-zero when run.
+    _py="${PYTHON_BIN:-}"
+    if [ -z "$_py" ]; then
+        for _c in python3 python py; do
+            if command -v "$_c" >/dev/null 2>&1 && "$_c" -c "import uuid" >/dev/null 2>&1; then
+                _py="$_c"
+                break
+            fi
+        done
+    fi
+    if [ -n "$_py" ]; then
+        "$_py" -c "import uuid; print(uuid.uuid4().hex[:8])"
+        return
+    fi
+    if command -v uuidgen >/dev/null 2>&1; then
+        uuidgen | tr '[:upper:]' '[:lower:]' | tr -d '-' | cut -c1-8
+        return
+    fi
+    # Last-ditch: seconds timestamp as 8 hex chars
+    printf '%08x' "$(date +%s)" | cut -c1-8
+}
+
+gen_nonce() {
+    # 16 hex chars for the plan-data delimiter framing (security strand rec 8).
+    # short_uuid() yields 8 hex chars; concatenate two draws and clip to 16 so
+    # the result stays exactly 16 even if a fallback path over-produces.
+    _n1="$(short_uuid)"
+    _n2="$(short_uuid)"
+    # short_uuid's third-level fallback is printf '%08x' "$(date +%s)" with
+    # 1-second resolution: two draws in the same second return the SAME 8 hex,
+    # collapsing the nonce to the epoch value doubled (32 bits, not 64). When
+    # the halves match, mix the PID into the second half so the nonce keeps 64
+    # bits of unpredictability on the no-uuid fallback path (Alpine/minimal).
+    if [ "$_n1" = "$_n2" ]; then
+        printf '%08x%08x' "$(date +%s)" "$$" | tr -d '\n' | cut -c1-16
+    else
+        printf '%s%s' "$_n1" "$_n2" | tr -d '\n' | cut -c1-16
+    fi
+}
+
+# Apply v3 opt-in mode side effects to a plan directory.
+#   $1 = plan dir (absolute or relative); dotfiles live directly inside it.
+#   $2 = plan file path (task_plan.md) used for auto-attestation resolution.
+# No-op when MODE is empty (legacy path stays byte-equivalent to v2.43.0).
+apply_v3_mode() {
+    _mode_dir="$1"
+    _mode_plan="$2"
+    [ -z "$MODE" ] && return 0
+
+    # (a) reset the gate block counter and drop any stale gate ledger so a prior
+    #     run's high block count cannot let the next run stop instantly.
+    printf '0\n' > "${_mode_dir}/.stop_blocks"
+    rm -f "${_mode_dir}/.gate_last_ledger" 2>/dev/null || true
+
+    # (b) write a fresh 16-hex nonce for delimiter framing.
+    gen_nonce > "${_mode_dir}/.nonce"
+
+    # write the mode marker. gated implies autonomous, so it carries both tokens.
+    if [ "$MODE" = "gated" ]; then
+        printf 'autonomous gate\n' > "${_mode_dir}/.mode"
+    else
+        printf 'autonomous\n' > "${_mode_dir}/.mode"
+    fi
+
+    # (c) auto-attest the plan (attestation default-on in v3 modes, security
+    #     strand rec 1). attest-plan.sh resolves the same way init-session just
+    #     pinned things: in slug mode PLAN_ID points at this plan dir; in legacy
+    #     mode it is empty and the script falls back to ./task_plan.md at root.
+    #     Run from the project root (CWD here) so both resolutions land.
+    _attest="${SCRIPT_DIR}/attest-plan.sh"
+    if [ -f "${_attest}" ] && [ -f "${_mode_plan}" ]; then
+        PLAN_ID="${PLAN_ID:-}" sh "${_attest}" >/dev/null 2>&1 || true
+    fi
+}
+
+write_default_task_plan() {
+    cat > "$1" << 'EOF'
+# Task Plan: [Brief Description]
+
+## Goal
+[One sentence describing the end state]
+
+## Next Step
+[The single next action. Update whenever phase status changes.]
+
+## Current Phase
+Phase 1
+
+## Phases
+
+### Phase 1: Requirements & Discovery
+- [ ] Understand user intent
+- [ ] Identify constraints
+- [ ] Document in findings.md
+- **Status:** in_progress
+
+### Phase 2: Planning & Structure
+- [ ] Define approach
+- [ ] Create project structure
+- **Status:** pending
+
+### Phase 3: Implementation
+- [ ] Execute the plan
+- [ ] Write to files before executing
+- **Status:** pending
+
+### Phase 4: Testing & Verification
+- [ ] Verify requirements met
+- [ ] Document test results
+- **Status:** pending
+
+### Phase 5: Delivery
+- [ ] Review outputs
+- [ ] Deliver to user
+- **Status:** pending
+
+## Decisions Made
+| Decision | Rationale |
+|----------|-----------|
+
+## Errors Encountered
+| Error | Resolution |
+|-------|------------|
+EOF
+}
+
+write_default_findings() {
+    cat > "$1" << 'EOF'
+# Findings & Decisions
+
+## Requirements
+-
+
+## Research Findings
+-
+
+## Technical Decisions
+| Decision | Rationale |
+|----------|-----------|
+
+## Issues Encountered
+| Issue | Resolution |
+|-------|------------|
+
+## Resources
+-
+EOF
+}
+
+write_default_progress() {
+    local date_value="$1"
+    local target="$2"
+    cat > "$target" << EOF
+# Progress Log
+
+## Session: $date_value
+
+### Current Status
+- **Phase:** 1 - Requirements & Discovery
+- **Started:** $date_value
+
+### Actions Taken
+-
+
+### Test Results
+| Test | Expected | Actual | Status |
+|------|----------|--------|--------|
+
+### Errors
+| Error | Resolution |
+|-------|------------|
+EOF
+}
+
+write_analytics_progress() {
+    local date_value="$1"
+    local target="$2"
+    cat > "$target" << EOF
+# Progress Log
+
+## Session: $date_value
+
+### Current Status
+- **Phase:** 1 - Data Discovery
+- **Started:** $date_value
+
+### Actions Taken
+-
+
+### Query Log
+| Query | Result Summary | Interpretation |
+|-------|---------------|----------------|
+
+### Errors
+| Error | Resolution |
+|-------|------------|
+EOF
+}
+
+create_files_in() {
+    local target_dir="$1"
+    local plan_path="$target_dir/task_plan.md"
+    local findings_path="$target_dir/findings.md"
+    local progress_path="$target_dir/progress.md"
+
+    if [ ! -f "$plan_path" ]; then
+        if [ "$TEMPLATE" = "analytics" ] && [ -f "$TEMPLATE_DIR/analytics_task_plan.md" ]; then
+            cp "$TEMPLATE_DIR/analytics_task_plan.md" "$plan_path"
+        else
+            write_default_task_plan "$plan_path"
+        fi
+        echo "Created $plan_path"
+    else
+        echo "$plan_path already exists, skipping"
+    fi
+
+    if [ ! -f "$findings_path" ]; then
+        if [ "$TEMPLATE" = "analytics" ] && [ -f "$TEMPLATE_DIR/analytics_findings.md" ]; then
+            cp "$TEMPLATE_DIR/analytics_findings.md" "$findings_path"
+        else
+            write_default_findings "$findings_path"
+        fi
+        echo "Created $findings_path"
+    else
+        echo "$findings_path already exists, skipping"
+    fi
+
+    if [ ! -f "$progress_path" ]; then
+        if [ "$TEMPLATE" = "analytics" ]; then
+            write_analytics_progress "$DATE" "$progress_path"
+        else
+            write_default_progress "$DATE" "$progress_path"
+        fi
+        echo "Created $progress_path"
+    else
+        echo "$progress_path already exists, skipping"
+    fi
+}
+
+if [ "$SLUG_MODE" -eq 1 ]; then
+    SLUG="$(slugify "$PROJECT_NAME")"
+    if [ -z "$SLUG" ]; then
+        SLUG="untitled-$(short_uuid)"
+    fi
+    BASE_ID="${DATE}-${SLUG}"
+    PLAN_ID="$BASE_ID"
+    PLAN_ROOT="${PWD}/.planning"
+    counter=2
+    while [ -d "${PLAN_ROOT}/${PLAN_ID}" ]; do
+        PLAN_ID="${BASE_ID}-${counter}"
+        counter=$((counter + 1))
+    done
+    PLAN_DIR="${PLAN_ROOT}/${PLAN_ID}"
+    mkdir -p "$PLAN_DIR"
+
+    echo "Initializing planning files for: ${PROJECT_NAME:-untitled} (template: $TEMPLATE)"
+    echo "PLAN_ID=$PLAN_ID"
+    create_files_in "$PLAN_DIR"
+    printf "%s\n" "$PLAN_ID" > "${PLAN_ROOT}/.active_plan"
+    apply_v3_mode "$PLAN_DIR" "${PLAN_DIR}/task_plan.md"
+    echo ""
+    echo "Active plan recorded: ${PLAN_ROOT}/.active_plan"
+    echo "Pin this terminal to the plan for parallel sessions:"
+    echo "  export PLAN_ID=$PLAN_ID"
+    if [ -n "$MODE" ]; then
+        echo "Mode: $(cat "${PLAN_DIR}/.mode") (attested, gate counter reset)"
+    fi
+else
+    PROJECT_NAME="${PROJECT_NAME:-project}"
+    echo "Initializing planning files for: $PROJECT_NAME (template: $TEMPLATE)"
+    create_files_in "$(pwd)"
+    apply_v3_mode "$(pwd)" "$(pwd)/task_plan.md"
+    echo ""
+    echo "Planning files initialized!"
+    echo "Files: task_plan.md, findings.md, progress.md"
+    if [ -n "$MODE" ]; then
+        echo "Mode: $(cat "$(pwd)/.mode") (attested, gate counter reset)"
+    fi
+fi