mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-12 02:37:45 +08:00
14 KiB
14 KiB
name, description, argument-hint, allowed-tools
| name | description | argument-hint | allowed-tools |
|---|---|---|---|
| plan | Batch plan issue resolution using issue-plan-agent (explore + plan closed-loop) | <issue-id>[,<issue-id>,...] [--batch-size 3] --all-pending | TodoWrite(*), Task(*), SlashCommand(*), AskUserQuestion(*), Bash(*), Read(*), Write(*) |
Issue Plan Command (/issue:plan)
Overview
Unified planning command using issue-plan-agent that combines exploration and planning into a single closed-loop workflow. The agent handles ACE semantic search, solution generation, and task breakdown.
Core capabilities:
- Closed-loop agent: issue-plan-agent combines explore + plan
- Batch processing: 1 agent processes 1-3 issues
- ACE semantic search integrated into planning
- Solution with executable tasks and acceptance criteria
- Automatic solution registration and binding
Storage Structure (Flat JSONL)
.workflow/issues/
├── issues.jsonl # All issues (one per line)
├── queue.json # Execution queue
└── solutions/
├── {issue-id}.jsonl # Solutions for issue (one per line)
└── ...
Usage
/issue:plan <issue-id>[,<issue-id>,...] [FLAGS]
# Examples
/issue:plan GH-123 # Single issue
/issue:plan GH-123,GH-124,GH-125 # Batch (up to 3)
/issue:plan --all-pending # All pending issues
# Flags
--batch-size <n> Max issues per agent batch (default: 3)
Execution Process
Phase 1: Issue Loading
├─ Parse input (single, comma-separated, or --all-pending)
├─ Load issues from .workflow/issues/issues.jsonl
├─ Validate issues exist (create if needed)
└─ Group into batches (max 3 per batch)
Phase 2: Unified Explore + Plan (issue-plan-agent)
├─ Launch issue-plan-agent per batch
├─ Agent performs:
│ ├─ ACE semantic search for each issue
│ ├─ Codebase exploration (files, patterns, dependencies)
│ ├─ Solution generation with task breakdown
│ └─ Conflict detection across issues
└─ Output: solution JSON per issue
Phase 3: Solution Registration & Binding
├─ Append solutions to solutions/{issue-id}.jsonl
├─ Single solution per issue → auto-bind
├─ Multiple candidates → AskUserQuestion to select
└─ Update issues.jsonl with bound_solution_id
Phase 4: Summary
├─ Display bound solutions
├─ Show task counts per issue
└─ Display next steps (/issue:queue)
Implementation
Phase 1: Issue Loading
// Parse input and flags
const issuesPath = '.workflow/issues/issues.jsonl';
const batchSize = flags.batchSize || 3;
// Key fields for planning (avoid loading full issue data)
const PLAN_FIELDS = 'id,title,status,context,affected_components,lifecycle_requirements,priority,bound_solution_id';
let issueIds = [];
if (flags.allPending) {
// Use jq to filter pending/registered issues - extract only IDs
const pendingIds = Bash(`
cat "${issuesPath}" 2>/dev/null | \\
jq -r 'select(.status == "pending" or .status == "registered") | .id' 2>/dev/null || echo ''
`).trim();
issueIds = pendingIds ? pendingIds.split('\n').filter(Boolean) : [];
if (issueIds.length === 0) {
console.log('No pending issues found.');
return;
}
console.log(`Found ${issueIds.length} pending issues`);
} else {
// Parse comma-separated issue IDs
issueIds = userInput.includes(',')
? userInput.split(',').map(s => s.trim())
: [userInput.trim()];
}
// Load issues using jq to extract only key fields
const issues = [];
for (const id of issueIds) {
// Use jq to find issue by ID and extract only needed fields
const issueJson = Bash(`
cat "${issuesPath}" 2>/dev/null | \\
jq -c 'select(.id == "${id}") | {${PLAN_FIELDS}}' 2>/dev/null | head -1
`).trim();
let issue;
if (issueJson) {
issue = JSON.parse(issueJson);
} else {
console.log(`Issue ${id} not found. Creating...`);
issue = {
id,
title: `Issue ${id}`,
status: 'registered',
priority: 3,
context: '',
created_at: new Date().toISOString(),
updated_at: new Date().toISOString()
};
// Append to issues.jsonl
Bash(`echo '${JSON.stringify(issue)}' >> "${issuesPath}"`);
}
issues.push(issue);
}
// Group into batches
const batches = [];
for (let i = 0; i < issues.length; i += batchSize) {
batches.push(issues.slice(i, i + batchSize));
}
console.log(`Processing ${issues.length} issues in ${batches.length} batch(es)`);
TodoWrite({
todos: batches.flatMap((batch, i) => [
{ content: `Plan batch ${i+1}`, status: 'pending', activeForm: `Planning batch ${i+1}` }
])
});
Phase 2: Unified Explore + Plan (issue-plan-agent)
// Ensure solutions directory exists
Bash(`mkdir -p .workflow/issues/solutions`);
for (const [batchIndex, batch] of batches.entries()) {
updateTodo(`Plan batch ${batchIndex + 1}`, 'in_progress');
// Build issue prompt for agent - agent writes solutions directly
const issuePrompt = `
## Issues to Plan (Closed-Loop Tasks Required)
${batch.map((issue, i) => `
### Issue ${i + 1}: ${issue.id}
**Title**: ${issue.title}
**Context**: ${issue.context || 'No context provided'}
**Affected Components**: ${issue.affected_components?.join(', ') || 'Not specified'}
**Lifecycle Requirements**:
- Test Strategy: ${issue.lifecycle_requirements?.test_strategy || 'auto'}
- Regression Scope: ${issue.lifecycle_requirements?.regression_scope || 'affected'}
- Commit Strategy: ${issue.lifecycle_requirements?.commit_strategy || 'per-task'}
`).join('\n')}
## Project Root
${process.cwd()}
## Output Requirements
**IMPORTANT**: Write solutions DIRECTLY to files, do NOT return full solution content.
### 1. Write Solution Files
For each issue, write solution to: \`.workflow/issues/solutions/{issue-id}.jsonl\`
- Append one JSON line per solution
- Solution must include all closed-loop task fields (see Solution Format below)
### 2. Return Summary Only
After writing solutions, return ONLY a brief JSON summary:
\`\`\`json
{
"planned": [
{ "issue_id": "XXX", "solution_id": "SOL-xxx", "task_count": 3, "description": "Brief description" }
],
"conflicts": [
{ "file": "path/to/file", "issues": ["ID1", "ID2"], "suggested_order": ["ID1", "ID2"] }
]
}
\`\`\`
## Closed-Loop Task Requirements
Each task MUST include ALL lifecycle phases:
### 1. Implementation
- implementation: string[] (2-7 concrete steps)
- modification_points: { file, target, change }[]
### 2. Test
- test.unit: string[] (unit test requirements)
- test.integration: string[] (integration test requirements if needed)
- test.commands: string[] (actual test commands to run)
- test.coverage_target: number (minimum coverage %)
### 3. Regression
- regression: string[] (commands to run for regression check)
### 4. Acceptance
- acceptance.criteria: string[] (testable acceptance criteria)
- acceptance.verification: string[] (how to verify each criterion)
### 5. Commit
- commit.type: feat|fix|refactor|test|docs|chore
- commit.scope: string (module name)
- commit.message_template: string (full commit message)
- commit.breaking: boolean
## Additional Requirements
1. Use ACE semantic search (mcp__ace-tool__search_context) for exploration
2. Detect file conflicts if multiple issues
3. Generate executable test commands based on project's test framework
4. Infer commit scope from affected files
`;
// Launch issue-plan-agent - agent writes solutions directly
const result = Task(
subagent_type="issue-plan-agent",
run_in_background=false,
description=`Explore & plan ${batch.length} issues`,
prompt=issuePrompt
);
// Parse brief summary from agent
const summary = JSON.parse(result);
// Display planning results
for (const item of summary.planned || []) {
console.log(`✓ ${item.issue_id}: ${item.solution_id} (${item.task_count} tasks) - ${item.description}`);
}
// Handle conflicts if any
if (summary.conflicts?.length > 0) {
console.log(`\n⚠ File conflicts detected:`);
summary.conflicts.forEach(c => {
console.log(` ${c.file}: ${c.issues.join(', ')} → suggested: ${c.suggested_order.join(' → ')}`);
});
}
updateTodo(`Plan batch ${batchIndex + 1}`, 'completed');
}
Phase 3: Solution Binding
// Collect issues needing user selection (multiple solutions)
const needSelection = [];
for (const issue of issues) {
const solPath = `.workflow/issues/solutions/${issue.id}.jsonl`;
// Use jq to count solutions
const count = parseInt(Bash(`cat "${solPath}" 2>/dev/null | jq -s 'length' 2>/dev/null || echo '0'`).trim()) || 0;
if (count === 0) continue; // No solutions - skip silently (agent already reported)
if (count === 1) {
// Auto-bind single solution
const solId = Bash(`cat "${solPath}" | jq -r '.id' | head -1`).trim();
bindSolution(issue.id, solId);
} else {
// Multiple solutions - collect for batch selection
const options = Bash(`cat "${solPath}" | jq -c '{id, description, task_count: (.tasks | length)}'`).trim();
needSelection.push({ issue, options: options.split('\n').map(s => JSON.parse(s)) });
}
}
// Batch ask user for multiple-solution issues
if (needSelection.length > 0) {
const answer = AskUserQuestion({
questions: needSelection.map(({ issue, options }) => ({
question: `Select solution for ${issue.id}:`,
header: issue.id,
multiSelect: false,
options: options.map(s => ({
label: `${s.id} (${s.task_count} tasks)`,
description: s.description || 'Solution'
}))
}))
});
// Bind selected solutions
for (const { issue } of needSelection) {
const selectedSolId = extractSelectedSolutionId(answer, issue.id);
if (selectedSolId) bindSolution(issue.id, selectedSolId);
}
}
// Helper: bind solution to issue
function bindSolution(issueId, solutionId) {
const now = new Date().toISOString();
const solPath = `.workflow/issues/solutions/${issueId}.jsonl`;
// Update issue status
Bash(`
tmpfile=$(mktemp) && \\
cat "${issuesPath}" | jq -c 'if .id == "${issueId}" then . + {
bound_solution_id: "${solutionId}", status: "planned",
planned_at: "${now}", updated_at: "${now}"
} else . end' > "$tmpfile" && mv "$tmpfile" "${issuesPath}"
`);
// Mark solution as bound
Bash(`
tmpfile=$(mktemp) && \\
cat "${solPath}" | jq -c 'if .id == "${solutionId}" then . + {
is_bound: true, bound_at: "${now}"
} else . + {is_bound: false} end' > "$tmpfile" && mv "$tmpfile" "${solPath}"
`);
}
Phase 4: Summary
// Brief summary using jq
const stats = Bash(`
cat "${issuesPath}" 2>/dev/null | \\
jq -s '[.[] | select(.status == "planned")] | length' 2>/dev/null || echo '0'
`).trim();
console.log(`
## Done: ${issues.length} issues → ${stats} planned
Next: \`/issue:queue\` → \`/issue:execute\`
`);
Solution Format (Closed-Loop Tasks)
Each solution line in solutions/{issue-id}.jsonl:
{
"id": "SOL-20251226-001",
"description": "Direct Implementation",
"tasks": [
{
"id": "T1",
"title": "Create auth middleware",
"scope": "src/middleware/",
"action": "Create",
"description": "Create JWT validation middleware",
"modification_points": [
{ "file": "src/middleware/auth.ts", "target": "new file", "change": "Create middleware" }
],
"implementation": [
"Create auth.ts file in src/middleware/",
"Implement JWT token validation using jsonwebtoken",
"Add error handling for invalid/expired tokens",
"Export middleware function"
],
"test": {
"unit": [
"Test valid token passes through",
"Test invalid token returns 401",
"Test expired token returns 401",
"Test missing token returns 401"
],
"commands": [
"npm test -- --grep 'auth middleware'",
"npm run test:coverage -- src/middleware/auth.ts"
],
"coverage_target": 80
},
"regression": [
"npm test -- --grep 'protected routes'",
"npm run test:integration -- auth"
],
"acceptance": {
"criteria": [
"Middleware validates JWT tokens successfully",
"Returns 401 for invalid or missing tokens",
"Passes decoded token to request context"
],
"verification": [
"curl -H 'Authorization: Bearer valid_token' /api/protected → 200",
"curl /api/protected → 401",
"curl -H 'Authorization: Bearer invalid' /api/protected → 401"
]
},
"commit": {
"type": "feat",
"scope": "auth",
"message_template": "feat(auth): add JWT validation middleware\n\n- Implement token validation\n- Add error handling for invalid tokens\n- Export for route protection",
"breaking": false
},
"depends_on": [],
"estimated_minutes": 30,
"executor": "codex"
}
],
"exploration_context": {
"relevant_files": ["src/config/auth.ts"],
"patterns": "Follow existing middleware pattern"
},
"is_bound": true,
"created_at": "2025-12-26T10:00:00Z",
"bound_at": "2025-12-26T10:05:00Z"
}
Error Handling
| Error | Resolution |
|---|---|
| Issue not found | Auto-create in issues.jsonl |
| ACE search fails | Agent falls back to ripgrep |
| No solutions generated | Display error, suggest manual planning |
| User cancels selection | Skip issue, continue with others |
| File conflicts | Agent detects and suggests resolution order |
Agent Integration
The command uses issue-plan-agent which:
- Performs ACE semantic search per issue
- Identifies modification points and patterns
- Generates task breakdown with dependencies
- Detects cross-issue file conflicts
- Outputs solution JSON for registration
See .claude/agents/issue-plan-agent.md for agent specification.
Related Commands
/issue:queue- Form execution queue from bound solutions/issue:execute- Execute queue with codexccw issue list- List all issuesccw issue status- View issue and solution details