@tianhai/pi-workflow-kit 0.17.1 → 1.0.0

package/docs/plans/completed/2026-04-11-checkpoint-review-gates-implementation.md

@@ -1,98 +0,0 @@
-# Checkpoint Review Gates: Implementation Plan
-
-## Tasks
-
-### Task 1: Update writing-plans/SKILL.md — add checkpoint field and agent guidance
-
-**Scenario:** Trivial (docs)
-
-**File:** `skills/writing-plans/SKILL.md`
-
-Add a "Checkpoint labels" section after "TDD in the plan" with the optional `checkpoint` field, values, and agent guidance. Also update the TDD table to show how checkpoints interact with each scenario.
-
-After the "TDD in the plan" section, add:
-
-```
-## Checkpoint labels
-
-Optionally label each task with a `checkpoint` to require human review before proceeding:
-
-| Checkpoint | When to use | What happens during execution |
-|---|---|---|
-| *(none)* | Trivial tasks, well-understood changes | Auto-advance, no pause |
-| **`checkpoint: test`** | Test design matters (API contracts, edge cases, complex behavior) | Pause after writing the failing test, before implementing |
-| **`checkpoint: done`** | Implementation review matters (complex logic, security, performance) | Pause after implementation + tests pass, before committing |
-
-Use judgment when assigning checkpoints. Prefer `checkpoint: test` for new features with non-obvious test design. Prefer `checkpoint: done` for tasks where the implementation approach is debatable. Most tasks should not need a checkpoint. The user can adjust checkpoints when reviewing the plan.
-```
-
-Also update the "Task format" section — after the `git commit` bullet, add:
-
-```
-- Optional `checkpoint: test` or `checkpoint: done` label
-```
-
-**Commit:** `feat(writing-plans): add checkpoint labels for review gates`
-
-### Task 2: Update executing-tasks/SKILL.md — handle checkpoints in per-task lifecycle
-
-**Scenario:** Trivial (docs)
-
-**File:** `skills/executing-tasks/SKILL.md`
-
-Replace the "Per-task lifecycle" section with checkpoint-aware flows. Add a "Checkpoint review" section.
-
-Replace the existing "Per-task lifecycle" section with:
-
-```
-## Per-task lifecycle
-
-Check each task for a `checkpoint` label and follow the appropriate flow:
-
-### No checkpoint (auto-advance)
-
-1. **Implement** — write the code as described in the plan
-2. **Run tests** — verify the changes work
-3. **Fix if needed** — if tests fail, debug and fix before moving on
-4. **Commit** — `git add` the relevant files and commit with a clear message
-
-### checkpoint: test
-
-1. **Write the test** — follow the TDD scenario for the task
-2. **Pause for review** — show what was done and the diff, then wait for human input
-3. **Continue** — implement, run tests, fix if needed
-4. **Commit** — `git add` the relevant files and commit with a clear message
-
-### checkpoint: done
-
-1. **Implement** — write the code as described in the plan
-2. **Run tests** — verify the changes work
-3. **Fix if needed** — if tests fail, debug and fix before moving on
-4. **Pause for review** — show what was done and the diff, then wait for human input
-5. **Commit** — `git add` the relevant files and commit with a clear message
-```
-
-After the "TDD discipline" section, add:
-
-```
-## Checkpoint review
-
-When pausing at a checkpoint, present:
-
-```
-⏸ Paused at checkpoint: [test|done] for task [N]
-
-**What was done:** [brief summary]
-**Diff:** [show relevant diff]
-
-Review and let me know how to proceed.
-```
-
-Wait for the human to respond. They may:
-- Approve and continue
-- Request changes to the test or implementation
-- Ask to revert the task
-- Adjust the remaining plan
-```
-
-**Commit:** `feat(executing-tasks): add checkpoint review gates`

package/docs/plans/completed/2026-04-11-finalizing-merge-options-design.md

@@ -1,33 +0,0 @@
-# Finalizing: Merge Strategy Options
-
-## Problem
-
-The finalizing skill hard-codes "Create PR" as the only shipping option. In practice, small features often don't need a PR — they can be merged directly back to the parent branch.
-
-## Design
-
-Add a merge strategy step after updating documentation. The human chooses one of four options:
-
-1. **Create PR** — push and open a PR for external review via `gh pr create`
-2. **Rebase & merge** (recommended) — rebase onto parent, fast-forward merge, push parent, delete feature branch. Preserves per-task commit history linearly.
-3. **Squash & merge** — squash all commits into one on parent, push parent, delete feature branch. Clean single-commit history.
-4. **Merge commit** — merge with `--no-ff`, push parent, delete feature branch. Preserves all commits and branch topology.
-
-### Flow for options 2–4 (local merge)
-
-1. Detect parent branch (compare `main` vs `master`, fall back to `git show-branch`)
-2. Switch to parent branch and pull latest
-3. Execute the chosen merge strategy:
-   - Rebase: `git rebase <parent>` on feature branch, then `git merge --ff-only <feature>` on parent
-   - Squash: `git merge --squash <feature>` on parent, then `git commit`
-   - Merge commit: `git merge --no-ff <feature>` on parent
-4. Push parent to origin
-5. Delete feature branch locally and remotely
-
-### Prompting
-
-The skill should ask the human which option they prefer, presenting rebase & merge as the default recommendation.
-
-## Changes
-
-- Update `skills/finalizing/SKILL.md` to replace the hard-coded PR step with the 4-option choice.

package/docs/plans/completed/2026-04-11-finalizing-merge-options-implementation.md

@@ -1,75 +0,0 @@
-# Finalizing: Merge Strategy Options — Implementation Plan
-
-## Context
-
-Replace the hard-coded "Create PR" step in the finalizing skill with a 4-option merge strategy prompt (Create PR, Rebase & merge, Squash & merge, Merge commit).
-
-Design doc: `docs/plans/2026-04-11-finalizing-merge-options-design.md`
-
----
-
-## Task 1 — Replace the PR step with a merge strategy prompt
-
-**TDD scenario:** Trivial (skill docs, no code to test)
-
-**File:** `skills/finalizing/SKILL.md`
-
-Replace step 3 ("Create PR") and step 4 ("Clean up") with the new merge strategy section. Keep steps 1 and 2 unchanged.
-
-**New content for step 3 onwards:**
-
-```markdown
-3. **Choose a merge strategy** — ask the human which option they prefer:
-
-   1. **Create PR** — push and open a PR for external review:
-      ```
-      git push origin <branch>
-      gh pr create --title "feat: <summary>" --body "<task summary>"
-      ```
-
-   2. **Rebase & merge** *(recommended)* — rebase onto parent, fast-forward merge, push parent, delete branch:
-      ```
-      parent=$(git show-branch -a 2>/dev/null | grep '\*' | grep -v "$(git branch --show-current)" | head -1 | sed 's/.*\[\(.*\)\].*/\1/' | sed 's/[\^~].*//')
-      git checkout "$parent" && git pull
-      git checkout - && git rebase "$parent"
-      git checkout "$parent" && git merge --ff-only -
-      git push origin "$parent"
-      git branch -d - && git push origin --delete -
-      ```
-
-   3. **Squash & merge** — squash all commits into one on parent, push parent, delete branch:
-      ```
-      parent=$(git show-branch -a 2>/dev/null | grep '\*' | grep -v "$(git branch --show-current)" | head -1 | sed 's/.*\[\(.*\)\].*/\1/' | sed 's/[\^~].*//')
-      git checkout "$parent" && git pull
-      git merge --squash -
-      git commit -m "feat: <summary>"
-      git push origin "$parent"
-      git branch -d - && git push origin --delete -
-      ```
-
-   4. **Merge commit** — merge with `--no-ff`, push parent, delete branch:
-      ```
-      parent=$(git show-branch -a 2>/dev/null | grep '\*' | grep -v "$(git branch --show-current)" | head -1 | sed 's/.*\[\(.*\)\].*/\1/' | sed 's/[\^~].*//')
-      git checkout "$parent" && git pull
-      git merge --no-ff -m "Merge branch '<branch>'" -
-      git push origin "$parent"
-      git branch -d - && git push origin --delete -
-      ```
-
-   For options 2–4, confirm the detected parent branch with the human before proceeding.
-
-4. **Clean up** — if a worktree was used, remove it:
-   ```
-   git worktree remove ../<repo>-<feature-name>
-   ```
-```
-
-**Commit:** `feat: add merge strategy options to finalizing skill`
-
----
-
-## Done
-
-The finalizing skill now offers four merge strategies instead of only "Create PR". No code files changed — this is a skill-documentation update only.
-
-To verify: read `skills/finalizing/SKILL.md` and confirm it contains all four options with correct commands.

package/docs/plans/completed/2026-04-11-workspace-setup-design.md

@@ -1,28 +0,0 @@
-# Workspace Setup: Move Branch Creation to Brainstorming
-
-## Problem
-
-Brainstorming commits the design doc to whatever branch you're on (usually `main`), polluting it. If the idea is scrapped, you have to revert the commit. The implementation branch created later by writing-plans starts from a point after the design commit, which is messy.
-
-## Design
-
-Move branch/worktree creation from writing-plans into brainstorming. The design doc lands on the feature branch from the start, keeping `main` clean.
-
-## Changes
-
-### brainstorming/SKILL.md
-
-Step 5 changes from writing + committing the design doc on the current branch to:
-
-1. Create a feature branch (`git checkout -b <feature-name>`) or worktree (`git worktree add ../<repo>-<feature-name> -b <feature-name>`) for larger features
-2. Write the design doc to `docs/plans/YYYY-MM-DD-<topic>-design.md`
-3. Single commit on the new branch with the design doc
-
-Feature name is derived from the topic slug in the design doc filename.
-
-### writing-plans/SKILL.md
-
-- Remove step 2 ("Set up workspace") entirely
-- Step 1 expands to verify the feature branch/worktree context created by brainstorming
-- Steps renumber: 1→2→3 becomes 1→2
-- Fallback path (no design doc, brainstorming was skipped) still creates a branch itself so writing-plans works standalone

package/docs/plans/completed/2026-04-11-workspace-setup-implementation.md

@@ -1,57 +0,0 @@
-# Workspace Setup: Implementation Plan
-
-## Tasks
-
-### Task 1: Update brainstorming/SKILL.md — add workspace setup to step 5
-
-**Scenario:** Trivial (docs)
-
-Replace step 5 with workspace creation + design doc commit.
-
-**File:** `skills/brainstorming/SKILL.md`
-
-Replace:
-
-```
-5. **Write the design doc** — save to `docs/plans/YYYY-MM-DD-<topic>-design.md` and commit.
-```
-
-With:
-
-```
-5. **Set up workspace & write the design doc** — create a branch for this work. For larger features, use a git worktree for isolation:
-   ```
-   git worktree add ../<repo>-<feature-name> -b <feature-name>
-   ```
-   Save the design doc to `docs/plans/YYYY-MM-DD-<topic>-design.md` and commit on the new branch.
-```
-
-**Commit:** `refactor(brainstorming): move workspace setup into step 5`
-
-### Task 2: Update writing-plans/SKILL.md — remove step 2, expand step 1
-
-**Scenario:** Trivial (docs)
-
-Remove step 2 ("Set up workspace") entirely. Expand step 1 to verify the feature branch context. Renumber step 3 → 2.
-
-**File:** `skills/writing-plans/SKILL.md`
-
-Replace:
-
-```
-1. **Check for a design doc** — look for `docs/plans/*-design.md`. If one exists, use it as the basis for the plan. If none exists, ask the user to describe what they want to build, read relevant code, and create the plan directly.
-2. **Set up workspace** — create a branch for this work. For larger features, use a git worktree for isolation:
-   ```
-   git worktree add ../<repo>-<feature-name> -b <feature-name>
-   ```
-3. **Write the implementation plan** — break the design into tasks. Save to `docs/plans/YYYY-MM-DD-<topic>-implementation.md`.
-```
-
-With:
-
-```
-1. **Check for a design doc & workspace** — look for `docs/plans/*-design.md`. If one exists, use it as the basis for the plan. Verify you're on the feature branch (or in its worktree) created during brainstorming. If no design doc exists, ask the user to describe what they want to build, read relevant code, create a branch, and create the plan directly.
-2. **Write the implementation plan** — break the design into tasks. Save to `docs/plans/YYYY-MM-DD-<topic>-implementation.md`.
-```
-
-**Commit:** `refactor(writing-plans): remove workspace setup, verify branch context`

package/docs/plans/completed/2026-04-15-bash-guard-design.md

@@ -1,39 +0,0 @@
-# Bash Guard for Workflow Guard Extension
-
-## Problem
-
-`workflow-guard.ts` blocks `write`/`edit` outside `docs/plans/` during brainstorm and plan phases, but ignores `bash` entirely. The LLM can mutate files via bash (e.g. `echo "..." > file.ts`, `sed -i`, `tee`, heredocs).
-
-## Design
-
-Adopt the `isSafeCommand()` approach from [pi-mono plan-mode example](https://github.com/badlogic/pi-mono/blob/main/packages/coding-agent/examples/extensions/plan-mode/utils.ts).
-
-### Approach
-
-**No changes to `pi.setActiveTools()`** — `write`/`edit` remain active so the existing path-based `tool_call` guard continues to allow writes to `docs/plans/`.
-
-**Add a bash guard** in the existing `tool_call` handler using `isSafeCommand()`:
-- Copy SAFE_PATTERNS and DESTRUCTIVE_PATTERNS from the example's `utils.ts` as-is
-- Copy `isSafeCommand()` logic as-is
-- In the `tool_call` handler, when phase is set and tool is `bash`, check `isSafeCommand(event.input.command)`
-- Block with reason if not safe
-- Notify via `ctx.ui.notify()` when blocking
-
-### Changes
-
-1. **`extensions/workflow-guard.ts`**
-   - Add `isSafeCommand()` function (copied from example, with DESTRUCTIVE_PATTERNS and SAFE_PATTERNS)
-   - Extend `tool_call` handler to also intercept `bash` when phase is set
-   - Check `event.input.command` against `isSafeCommand()`
-   - Block and notify if unsafe
-
-2. **`tests/workflow-guard.test.ts`**
-   - Add tests for bash guard: safe commands pass, destructive commands blocked, redirects blocked
-   - Import and test `isSafeCommand` directly (it's a pure function, easy to unit test)
-
-### What stays the same
-
-- Phase detection via `/skill:` commands (no change)
-- `write`/`edit` path-based blocking for `docs/plans/` (no change)
-- `docs/plans/` write exception (no change)
-- No `pi.setActiveTools()` usage

package/docs/plans/completed/2026-04-15-bash-guard-implementation.md

@@ -1,229 +0,0 @@
-# Bash Guard Implementation Plan
-
-Based on `docs/plans/2026-04-15-bash-guard-design.md`.
-
-## Task 1 — Add `isSafeCommand()` to workflow-guard.ts [new feature, checkpoint: test]
-
-**File:** `extensions/workflow-guard.ts`
-
-- Add `isSafeCommand` as a named export (so tests can import it directly)
-- Copy `DESTRUCTIVE_PATTERNS` and `SAFE_PATTERNS` from [plan-mode utils.ts](https://github.com/badlogic/pi-mono/blob/main/packages/coding-agent/examples/extensions/plan-mode/utils.ts) as-is
-- Copy the `isSafeCommand()` logic as-is
-
-```ts
-// Destructive commands blocked in brainstorm/plan phases
-const DESTRUCTIVE_PATTERNS = [
-	/\brm\b/i,
-	/\brmdir\b/i,
-	/\bmv\b/i,
-	/\bcp\b/i,
-	/\bmkdir\b/i,
-	/\btouch\b/i,
-	/\bchmod\b/i,
-	/\bchown\b/i,
-	/\bchgrp\b/i,
-	/\bln\b/i,
-	/\btee\b/i,
-	/\btruncate\b/i,
-	/\bdd\b/i,
-	/\bshred\b/i,
-	/(^|[^<])>(?!>)/,
-	/>>/,
-	/\bnpm\s+(install|uninstall|update|ci|link|publish)/i,
-	/\byarn\s+(add|remove|install|publish)/i,
-	/\bpnpm\s+(add|remove|install|publish)/i,
-	/\bpip\s+(install|uninstall)/i,
-	/\bapt(-get)?\s+(install|remove|purge|update|upgrade)/i,
-	/\bbrew\s+(install|uninstall|upgrade)/i,
-	/\bgit\s+(add|commit|push|pull|merge|rebase|reset|checkout|branch\s+-[dD]|stash|cherry-pick|revert|tag|init|clone)/i,
-	/\bsudo\b/i,
-	/\bsu\b/i,
-	/\bkill\b/i,
-	/\bpkill\b/i,
-	/\bkillall\b/i,
-	/\breboot\b/i,
-	/\bshutdown\b/i,
-	/\bsystemctl\s+(start|stop|restart|enable|disable)/i,
-	/\bservice\s+\S+\s+(start|stop|restart)/i,
-	/\b(vim?|nano|emacs|code|subl)\b/i,
-];
-
-const SAFE_PATTERNS = [
-	/^\s*cat\b/,
-	/^\s*head\b/,
-	/^\s*tail\b/,
-	/^\s*less\b/,
-	/^\s*more\b/,
-	/^\s*grep\b/,
-	/^\s*find\b/,
-	/^\s*ls\b/,
-	/^\s*pwd\b/,
-	/^\s*echo\b/,
-	/^\s*printf\b/,
-	/^\s*wc\b/,
-	/^\s*sort\b/,
-	/^\s*uniq\b/,
-	/^\s*diff\b/,
-	/^\s*file\b/,
-	/^\s*stat\b/,
-	/^\s*du\b/,
-	/^\s*df\b/,
-	/^\s*tree\b/,
-	/^\s*which\b/,
-	/^\s*whereis\b/,
-	/^\s*type\b/,
-	/^\s*env\b/,
-	/^\s*printenv\b/,
-	/^\s*uname\b/,
-	/^\s*whoami\b/,
-	/^\s*id\b/,
-	/^\s*date\b/,
-	/^\s*cal\b/,
-	/^\s*uptime\b/,
-	/^\s*ps\b/,
-	/^\s*top\b/,
-	/^\s*htop\b/,
-	/^\s*free\b/,
-	/^\s*git\s+(status|log|diff|show|branch|remote|config\s+--get)/i,
-	/^\s*git\s+ls-/i,
-	/^\s*npm\s+(list|ls|view|info|search|outdated|audit)/i,
-	/^\s*yarn\s+(list|info|why|audit)/i,
-	/^\s*node\s+--version/i,
-	/^\s*python\s+--version/i,
-	/^\s*curl\s/i,
-	/^\s*wget\s+-O\s*-/i,
-	/^\s*jq\b/,
-	/^\s*sed\s+-n/i,
-	/^\s*awk\b/,
-	/^\s*rg\b/,
-	/^\s*fd\b/,
-	/^\s*bat\b/,
-	/^\s*eza\b/,
-];
-
-export function isSafeCommand(command: string): boolean {
-	const isDestructive = DESTRUCTIVE_PATTERNS.some((p) => p.test(command));
-	const isSafe = SAFE_PATTERNS.some((p) => p.test(command));
-	return !isDestructive && isSafe;
-}
-```
-
-- Write failing tests in `tests/workflow-guard.test.ts` for `isSafeCommand`:
-
-```ts
-import { isSafeCommand } from "../extensions/workflow-guard";
-
-describe("isSafeCommand", () => {
-	it("allows safe read-only commands", () => {
-		expect(isSafeCommand("cat file.ts")).toBe(true);
-		expect(isSafeCommand("grep -r 'foo' src/")).toBe(true);
-		expect(isSafeCommand("git status")).toBe(true);
-		expect(isSafeCommand("git log --oneline -5")).toBe(true);
-		expect(isSafeCommand("npm list")).toBe(true);
-		expect(isSafeCommand("ls -la")).toBe(true);
-		expect(isSafeCommand("curl https://example.com")).toBe(true);
-	});
-
-	it("blocks destructive commands", () => {
-		expect(isSafeCommand("rm -rf node_modules")).toBe(false);
-		expect(isSafeCommand("touch newfile.ts")).toBe(false);
-		expect(isSafeCommand("mv old.ts new.ts")).toBe(false);
-		expect(isSafeCommand("mkdir src/components")).toBe(false);
-	});
-
-	it("blocks file-writing bash patterns", () => {
-		expect(isSafeCommand("echo 'hello' > file.ts")).toBe(false);
-		expect(isSafeCommand("cat config > backup.txt")).toBe(false);
-		expect(isSafeCommand("echo 'log' >> output.log")).toBe(false);
-		expect(isSafeCommand("tee output.txt")).toBe(false);
-		expect(isSafeCommand("sed -i 's/old/new/g' file.ts")).toBe(false);
-	});
-
-	it("blocks git mutations but allows read-only git", () => {
-		expect(isSafeCommand("git add .")).toBe(false);
-		expect(isSafeCommand("git commit -m 'msg'")).toBe(false);
-		expect(isSafeCommand("git push")).toBe(false);
-		expect(isSafeCommand("git checkout -b feature")).toBe(false);
-		expect(isSafeCommand("git status")).toBe(true);
-		expect(isSafeCommand("git log --oneline")).toBe(true);
-		expect(isSafeCommand("git diff")).toBe(true);
-	});
-
-	it("blocks editors", () => {
-		expect(isSafeCommand("vim file.ts")).toBe(false);
-		expect(isSafeCommand("nano file.ts")).toBe(false);
-		expect(isSafeCommand("code .")).toBe(false);
-	});
-
-	it("blocks sudo", () => {
-		expect(isSafeCommand("sudo apt install foo")).toBe(false);
-	});
-
-	it("blocks npm installs but allows read-only npm", () => {
-		expect(isSafeCommand("npm install lodash")).toBe(false);
-		expect(isSafeCommand("npm list")).toBe(true);
-		expect(isSafeCommand("npm audit")).toBe(true);
-	});
-});
-```
-
-- Run: `npx vitest run tests/workflow-guard.test.ts`
-- Verify: all new `isSafeCommand` tests fail (function doesn't exist yet)
-- Implement `isSafeCommand()` in `extensions/workflow-guard.ts`
-- Run: `npx vitest run tests/workflow-guard.test.ts`
-- Verify: all tests pass
-- `git add -A && git commit -m "feat: add isSafeCommand bash guard to workflow-guard"`
-
-## Task 2 — Wire bash guard into tool_call handler [modifying tested code]
-
-**File:** `extensions/workflow-guard.ts`
-
-Replace the tool_call guard from:
-```ts
-if (event.toolName !== "write" && event.toolName !== "edit") return;
-```
-
-To:
-```ts
-if (event.toolName === "bash") {
-	const command = (event.input as { command?: string }).command ?? "";
-	if (!isSafeCommand(command)) {
-		if (ctx.hasUI) {
-			ctx.ui.notify(
-				`Blocked bash command during ${phase} phase: ${command}`,
-				"warning",
-			);
-		}
-		return {
-			block: true,
-			reason: `⚠️ ${phase.toUpperCase()} PHASE: Bash command blocked (not allowlisted). Only read-only commands are permitted during brainstorming and planning.\nCommand: ${command}`,
-		};
-	}
-	return;
-}
-
-if (event.toolName !== "write" && event.toolName !== "edit") return;
-```
-
-- Run: `npx vitest run tests/workflow-guard.test.ts`
-- Verify: existing tests pass (the "should allow bash" test needs updating — see Task 3)
-- `git add -A && git commit -m "feat: wire bash guard into tool_call handler"`
-
-## Task 3 — Update existing test for new bash behavior [modifying tested code]
-
-**File:** `tests/workflow-guard.test.ts`
-
-The test `"should allow bash regardless of phase"` is now incorrect — bash with unsafe commands should be blocked. Update it:
-
-```ts
-it("should block unsafe bash during brainstorm (safe bash tested via isSafeCommand)", () => {
-	// The tool_call handler now guards bash via isSafeCommand.
-	// Direct testing of safe/unsafe commands is in the isSafeCommand describe block.
-	// This just confirms bash is no longer blanket-allowed.
-	expect(isSafeCommand("rm -rf /")).toBe(false);
-});
-```
-
-- Run: `npx vitest run tests/workflow-guard.test.ts`
-- Verify: all tests pass
-- `git add -A && git commit -m "test: update bash guard test for new blocking behavior"`