@pennyfarthing/core 7.5.0 → 7.6.0

package/pennyfarthing-dist/workflows/quick-spec/steps/step-04-review.md

@@ -0,0 +1,191 @@
+---
+name: 'step-04-review'
+description: 'Review and finalize the tech-spec'
+
+workflow_path: '{project_root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
+wipFile: '{implementation_artifacts}/tech-spec-wip.md'
+---
+
+# Step 4: Review & Finalize
+
+**Progress: Step 4 of 4** - Final Step
+
+## RULES:
+
+- MUST NOT skip steps.
+- MUST NOT optimize sequence.
+- MUST follow exact instructions.
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+## CONTEXT:
+
+- Requires `{wipFile}` from Step 3. 
+- MUST present COMPLETE spec content. Iterate until user is satisfied.
+- **Criteria**: The spec MUST meet the **READY FOR DEVELOPMENT** standard defined in `workflow.md`.
+
+## SEQUENCE OF INSTRUCTIONS
+
+### 1. Load and Present Complete Spec
+
+**Read `{wipFile}` completely and extract `slug` from frontmatter for later use.**
+
+**Present to user:**
+
+"Here's your complete tech-spec. Please review:"
+
+[Display the complete spec content - all sections]
+
+"**Quick Summary:**
+
+- {task_count} tasks to implement
+- {ac_count} acceptance criteria to verify
+- {files_count} files to modify"
+
+**Present review menu:**
+
+```
+[y] Approve - finalize the spec
+[c] Changes - request modifications
+[q] Questions - ask about any section
+[a] Advanced Elicitation - dig deeper before approving
+[p] Party Mode - get expert feedback before approving
+```
+
+**HALT and wait for user selection.**
+
+#### Menu Handling:
+
+- **[y]**: Proceed to Section 3 (Finalize the Spec)
+- **[c]**: Proceed to Section 2 (Handle Review Feedback), then return here and redisplay menu
+- **[q]**: Answer questions, then redisplay this menu
+- **[a]**: Load and execute `{advanced_elicitation}`, then return here and redisplay menu
+- **[p]**: Load and execute `{party_mode_exec}`, then return here and redisplay menu
+
+### 2. Handle Review Feedback
+
+a) **If user requests changes:**
+
+- Make the requested edits to `{wipFile}`
+- Re-present the affected sections
+- Ask if there are more changes
+- Loop until user is satisfied
+
+b) **If the spec does NOT meet the "Ready for Development" standard:**
+
+- Point out the missing/weak sections (e.g., non-actionable tasks, missing ACs).
+- Propose specific improvements to reach the standard.
+- Make the edits once the user agrees.
+
+c) **If user has questions:**
+
+- Answer questions about the spec
+- Clarify any confusing sections
+- Make clarifying edits if needed
+
+### 3. Finalize the Spec
+
+**When user confirms the spec is good AND it meets the "Ready for Development" standard:**
+
+a) Update `{wipFile}` frontmatter:
+
+   ```yaml
+   ---
+   # ... existing values ...
+   status: 'ready-for-dev'
+   stepsCompleted: [1, 2, 3, 4]
+   ---
+   ```
+
+b) **Rename WIP file to final filename:**
+   - Using the `slug` extracted in Section 1
+   - Rename `{wipFile}` → `{implementation_artifacts}/tech-spec-{slug}.md`
+   - Store this as `finalFile` for use in menus below
+
+### 4. Present Final Menu
+
+a) **Display completion message and menu:**
+
+```
+**Tech-Spec Complete!**
+
+Saved to: {finalFile}
+
+---
+
+**Next Steps:**
+
+[a] Advanced Elicitation - refine further
+[r] Adversarial Review - critique of the spec (highly recommended)
+[b] Begin Development - start implementing now (not recommended)
+[d] Done - exit workflow
+[p] Party Mode - get expert feedback before dev
+
+---
+
+Once you are fully satisfied with the spec (ideally after **Adversarial Review** and maybe a few rounds of **Advanced Elicitation**), it is recommended to run implementation in a FRESH CONTEXT for best results.
+
+Copy this prompt to start dev:
+
+\`\`\`
+quick-dev {finalFile}
+\`\`\`
+
+This ensures the dev agent has clean context focused solely on implementation.
+```
+
+b) **HALT and wait for user selection.**
+
+#### Menu Handling:
+
+- **[a]**: Load and execute `{advanced_elicitation}`, then return here and redisplay menu
+- **[b]**: Load and execute `{quick_dev_workflow}` with the final spec file (warn: fresh context is better)
+- **[d]**: Exit workflow - display final confirmation and path to spec
+- **[p]**: Load and execute `{party_mode_exec}`, then return here and redisplay menu
+- **[r]**: Execute Adversarial Review:
+    1. **Invoke Adversarial Review Task**:
+       > With `{finalFile}` constructed, invoke the review task. If possible, use information asymmetry: run this task, and only it, in a separate subagent or process with read access to the project, but no context except the `{finalFile}`.
+       <invoke-task>Review {finalFile} using {project_root}/_bmad/core/tasks/review-adversarial-general.xml</invoke-task>
+       > **Platform fallback:** If task invocation not available, load the task file and execute its instructions inline, passing `{finalFile}` as the content.
+       > The task should: review `{finalFile}` and return a list of findings.
+
+    2. **Process Findings**:
+       > Capture the findings from the task output.
+       > **If zero findings:** HALT - this is suspicious. Re-analyze or request user guidance.
+       > Evaluate severity (Critical, High, Medium, Low) and validity (real, noise, undecided).
+       > DO NOT exclude findings based on severity or validity unless explicitly asked to do so.
+       > Order findings by severity.
+       > Number the ordered findings (F1, F2, F3, etc.).
+       > If TodoWrite or similar tool is available, turn each finding into a TODO, include ID, severity, validity, and description in the TODO; otherwise present findings as a table with columns: ID, Severity, Validity, Description
+
+    3. Return here and redisplay menu.
+
+### 5. Exit Workflow
+
+**When user selects [d]:**
+
+"**All done!** Your tech-spec is ready at:
+
+`{finalFile}`
+
+When you're ready to implement, run:
+
+```
+quick-dev {finalFile}
+```
+
+Ship it!"
+
+---
+
+## REQUIRED OUTPUTS:
+
+- MUST update status to 'ready-for-dev'.
+- MUST rename file to `tech-spec-{slug}.md`.
+- MUST provide clear next-step guidance and recommend fresh context for dev.
+
+## VERIFICATION CHECKLIST:
+
+- [ ] Complete spec presented for review.
+- [ ] Requested changes implemented.
+- [ ] Spec verified against **READY FOR DEVELOPMENT** standard.
+- [ ] `stepsCompleted: [1, 2, 3, 4]` set and file renamed.

package/pennyfarthing-dist/workflows/quick-spec/tech-spec-template.md

@@ -0,0 +1,74 @@
+---
+title: '{title}'
+slug: '{slug}'
+created: '{date}'
+status: 'in-progress'
+stepsCompleted: []
+tech_stack: []
+files_to_modify: []
+code_patterns: []
+test_patterns: []
+---
+
+# Tech-Spec: {title}
+
+**Created:** {date}
+
+## Overview
+
+### Problem Statement
+
+{problem_statement}
+
+### Solution
+
+{solution}
+
+### Scope
+
+**In Scope:**
+{in_scope}
+
+**Out of Scope:**
+{out_of_scope}
+
+## Context for Development
+
+### Codebase Patterns
+
+{codebase_patterns}
+
+### Files to Reference
+
+| File | Purpose |
+| ---- | ------- |
+
+{files_table}
+
+### Technical Decisions
+
+{technical_decisions}
+
+## Implementation Plan
+
+### Tasks
+
+{tasks}
+
+### Acceptance Criteria
+
+{acceptance_criteria}
+
+## Additional Context
+
+### Dependencies
+
+{dependencies}
+
+### Testing Strategy
+
+{testing_strategy}
+
+### Notes
+
+{notes}

package/pennyfarthing-dist/workflows/quick-spec/workflow.yaml

@@ -0,0 +1,27 @@
+# quick-spec Workflow - Migrated from BMAD format
+# Generated by migrate-bmad-workflow.mjs
+
+workflow:
+  name: quick-spec
+  description: Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec.
+  version: "1.0.0"
+  type: stepped
+
+  # Step configuration
+  steps:
+    path: ./steps/
+    pattern: step-*.md
+
+  # Variables available in step files
+  variables:
+    project_root: .
+    planning_artifacts: ./artifacts
+    output_file: artifacts/quick-spec.md
+
+  # Agent assignment (customize as needed)
+  agent: architect
+
+  # Triggers - when to suggest this workflow
+  triggers:
+    types: [quick-spec]
+    tags: [quick-spec, stepped]

package/pennyfarthing-dist/workflows/research/steps-domain/step-01-init.md

@@ -0,0 +1,137 @@
+# Domain Research Step 1: Domain Research Scope Confirmation
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+- 🛑 NEVER generate content without user confirmation
+
+- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
+- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
+- ✅ FOCUS EXCLUSIVELY on confirming domain research scope and approach
+- 📋 YOU ARE A DOMAIN RESEARCH PLANNER, not content generator
+- 💬 ACKNOWLEDGE and CONFIRM understanding of domain research goals
+- 🔍 This is SCOPE CONFIRMATION ONLY - no web research yet
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- ⚠️ Present [C] continue option after scope confirmation
+- 💾 ONLY proceed when user chooses C (Continue)
+- 📖 Update frontmatter `stepsCompleted: [1]` before loading next step
+- 🚫 FORBIDDEN to load next step until C is selected
+
+## CONTEXT BOUNDARIES:
+
+- Research type = "domain" is already set
+- **Research topic = "{{research_topic}}"** - discovered from initial discussion
+- **Research goals = "{{research_goals}}"** - captured from initial discussion
+- Focus on industry/domain analysis with web research
+- Web search is required to verify and supplement your knowledge with current facts
+
+## YOUR TASK:
+
+Confirm domain research scope and approach for **{{research_topic}}** with the user's goals in mind.
+
+## DOMAIN SCOPE CONFIRMATION:
+
+### 1. Begin Scope Confirmation
+
+Start with domain scope understanding:
+"I understand you want to conduct **domain research** for **{{research_topic}}** with these goals: {{research_goals}}
+
+**Domain Research Scope:**
+
+- **Industry Analysis**: Industry structure, market dynamics, and competitive landscape
+- **Regulatory Environment**: Compliance requirements, regulations, and standards
+- **Technology Patterns**: Innovation trends, technology adoption, and digital transformation
+- **Economic Factors**: Market size, growth trends, and economic impact
+- **Supply Chain**: Value chain analysis and ecosystem relationships
+
+**Research Approach:**
+
+- All claims verified against current public sources
+- Multi-source validation for critical domain claims
+- Confidence levels for uncertain domain information
+- Comprehensive domain coverage with industry-specific insights
+
+### 2. Scope Confirmation
+
+Present clear scope confirmation:
+"**Domain Research Scope Confirmation:**
+
+For **{{research_topic}}**, I will research:
+
+✅ **Industry Analysis** - market structure, key players, competitive dynamics
+✅ **Regulatory Requirements** - compliance standards, legal frameworks
+✅ **Technology Trends** - innovation patterns, digital transformation
+✅ **Economic Factors** - market size, growth projections, economic impact
+✅ **Supply Chain Analysis** - value chain, ecosystem, partnerships
+
+**All claims verified against current public sources.**
+
+**Does this domain research scope and approach align with your goals?**
+[C] Continue - Begin domain research with this scope
+
+### 3. Handle Continue Selection
+
+#### If 'C' (Continue):
+
+- Document scope confirmation in research file
+- Update frontmatter: `stepsCompleted: [1]`
+- Load: `./step-02-domain-analysis.md`
+
+## APPEND TO DOCUMENT:
+
+When user selects 'C', append scope confirmation:
+
+```markdown
+## Domain Research Scope Confirmation
+
+**Research Topic:** {{research_topic}}
+**Research Goals:** {{research_goals}}
+
+**Domain Research Scope:**
+
+- Industry Analysis - market structure, competitive landscape
+- Regulatory Environment - compliance requirements, legal frameworks
+- Technology Trends - innovation patterns, digital transformation
+- Economic Factors - market size, growth projections
+- Supply Chain Analysis - value chain, ecosystem relationships
+
+**Research Methodology:**
+
+- All claims verified against current public sources
+- Multi-source validation for critical domain claims
+- Confidence level framework for uncertain information
+- Comprehensive domain coverage with industry-specific insights
+
+**Scope Confirmed:** {{date}}
+```
+
+## SUCCESS METRICS:
+
+✅ Domain research scope clearly confirmed with user
+✅ All domain analysis areas identified and explained
+✅ Research methodology emphasized
+✅ [C] continue option presented and handled correctly
+✅ Scope confirmation documented when user proceeds
+✅ Proper routing to next domain research step
+
+## FAILURE MODES:
+
+❌ Not clearly confirming domain research scope with user
+❌ Missing critical domain analysis areas
+❌ Not explaining that web search is required for current facts
+❌ Not presenting [C] continue option
+❌ Proceeding without user scope confirmation
+❌ Not routing to next domain research step
+
+❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
+❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
+❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
+
+## NEXT STEP:
+
+After user selects 'C', load `./step-02-domain-analysis.md` to begin industry analysis.
+
+Remember: This is SCOPE CONFIRMATION ONLY - no actual domain research yet, just confirming the research approach and scope!

package/pennyfarthing-dist/workflows/research/steps-domain/step-02-domain-analysis.md

@@ -0,0 +1,229 @@
+# Domain Research Step 2: Industry Analysis
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+- 🛑 NEVER generate content without web search verification
+
+- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
+- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
+- ✅ Search the web to verify and supplement your knowledge with current facts
+- 📋 YOU ARE AN INDUSTRY ANALYST, not content generator
+- 💬 FOCUS on market size, growth, and industry dynamics
+- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
+- 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show web search analysis before presenting findings
+- ⚠️ Present [C] continue option after industry analysis content generation
+- 📝 WRITE INDUSTRY ANALYSIS TO DOCUMENT IMMEDIATELY
+- 💾 ONLY proceed when user chooses C (Continue)
+- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step
+- 🚫 FORBIDDEN to load next step until C is selected
+
+## CONTEXT BOUNDARIES:
+
+- Current document and frontmatter from step-01 are available
+- **Research topic = "{{research_topic}}"** - established from initial discussion
+- **Research goals = "{{research_goals}}"** - established from initial discussion
+- Focus on market size, growth, and industry dynamics
+- Web search capabilities with source verification are enabled
+
+## YOUR TASK:
+
+Conduct industry analysis focusing on market size, growth, and industry dynamics. Search the web to verify and supplement current facts.
+
+## INDUSTRY ANALYSIS SEQUENCE:
+
+### 1. Begin Industry Analysis
+
+**UTILIZE SUBPROCESSES AND SUBAGENTS**: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different industry areas simultaneously and thoroughly.
+
+Start with industry research approach:
+"Now I'll conduct **industry analysis** for **{{research_topic}}** to understand market dynamics.
+
+**Industry Analysis Focus:**
+
+- Market size and valuation metrics
+- Growth rates and market dynamics
+- Market segmentation and structure
+- Industry trends and evolution patterns
+- Economic impact and value creation
+
+**Let me search for current industry insights.**"
+
+### 2. Parallel Industry Research Execution
+
+**Execute multiple web searches simultaneously:**
+
+Search the web: "{{research_topic}} market size value"
+Search the web: "{{research_topic}} market growth rate dynamics"
+Search the web: "{{research_topic}} market segmentation structure"
+Search the web: "{{research_topic}} industry trends evolution"
+
+**Analysis approach:**
+
+- Look for recent market research reports and industry analyses
+- Search for authoritative sources (market research firms, industry associations)
+- Identify market size, growth rates, and segmentation data
+- Research industry trends and evolution patterns
+- Analyze economic impact and value creation metrics
+
+### 3. Analyze and Aggregate Results
+
+**Collect and analyze findings from all parallel searches:**
+
+"After executing comprehensive parallel web searches, let me analyze and aggregate industry findings:
+
+**Research Coverage:**
+
+- Market size and valuation analysis
+- Growth rates and market dynamics
+- Market segmentation and structure
+- Industry trends and evolution patterns
+
+**Cross-Industry Analysis:**
+[Identify patterns connecting market dynamics, segmentation, and trends]
+
+**Quality Assessment:**
+[Overall confidence levels and research gaps identified]"
+
+### 4. Generate Industry Analysis Content
+
+**WRITE IMMEDIATELY TO DOCUMENT**
+
+Prepare industry analysis with web search citations:
+
+#### Content Structure:
+
+When saving to document, append these Level 2 and Level 3 sections:
+
+```markdown
+## Industry Analysis
+
+### Market Size and Valuation
+
+[Market size analysis with source citations]
+_Total Market Size: [Current market valuation]_
+_Growth Rate: [CAGR and market growth projections]_
+_Market Segments: [Size and value of key market segments]_
+_Economic Impact: [Economic contribution and value creation]_
+_Source: [URL]_
+
+### Market Dynamics and Growth
+
+[Market dynamics analysis with source citations]
+_Growth Drivers: [Key factors driving market growth]_
+_Growth Barriers: [Factors limiting market expansion]_
+_Cyclical Patterns: [Industry seasonality and cycles]_
+_Market Maturity: [Life cycle stage and development phase]_
+_Source: [URL]_
+
+### Market Structure and Segmentation
+
+[Market structure analysis with source citations]
+_Primary Segments: [Key market segments and their characteristics]_
+_Sub-segment Analysis: [Detailed breakdown of market sub-segments]_
+_Geographic Distribution: [Regional market variations and concentrations]_
+_Vertical Integration: [Supply chain and value chain structure]_
+_Source: [URL]_
+
+### Industry Trends and Evolution
+
+[Industry trends analysis with source citations]
+_Emerging Trends: [Current industry developments and transformations]_
+_Historical Evolution: [Industry development over recent years]_
+_Technology Integration: [How technology is changing the industry]_
+_Future Outlook: [Projected industry developments and changes]_
+_Source: [URL]_
+
+### Competitive Dynamics
+
+[Competitive dynamics analysis with source citations]
+_Market Concentration: [Level of market consolidation and competition]_
+_Competitive Intensity: [Degree of competition and rivalry]_
+_Barriers to Entry: [Obstacles for new market entrants]_
+_Innovation Pressure: [Rate of innovation and change]_
+_Source: [URL]_
+```
+
+### 5. Present Analysis and Continue Option
+
+**Show analysis and present continue option:**
+
+"I've completed **industry analysis** for {{research_topic}}.
+
+**Key Industry Findings:**
+
+- Market size and valuation thoroughly analyzed
+- Growth dynamics and market structure documented
+- Industry trends and evolution patterns identified
+- Competitive dynamics clearly mapped
+- Multiple sources verified for critical insights
+
+**Ready to proceed to competitive landscape analysis?**
+[C] Continue - Save this to document and proceed to competitive landscape
+
+### 6. Handle Continue Selection
+
+#### If 'C' (Continue):
+
+- **CONTENT ALREADY WRITTEN TO DOCUMENT**
+- Update frontmatter: `stepsCompleted: [1, 2]`
+- Load: `./step-03-competitive-landscape.md`
+
+## APPEND TO DOCUMENT:
+
+Content is already written to document when generated in step 4. No additional append needed.
+
+## SUCCESS METRICS:
+
+✅ Market size and valuation thoroughly analyzed
+✅ Growth dynamics and market structure documented
+✅ Industry trends and evolution patterns identified
+✅ Competitive dynamics clearly mapped
+✅ Multiple sources verified for critical insights
+✅ Content written immediately to document
+✅ [C] continue option presented and handled correctly
+✅ Proper routing to next step (competitive landscape)
+✅ Research goals alignment maintained
+
+## FAILURE MODES:
+
+❌ Relying on training data instead of web search for current facts
+❌ Missing critical market size or growth data
+❌ Incomplete market structure analysis
+❌ Not identifying key industry trends
+❌ Not writing content immediately to document
+❌ Not presenting [C] continue option after content generation
+❌ Not routing to competitive landscape step
+
+❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
+❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
+❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
+
+## INDUSTRY RESEARCH PROTOCOLS:
+
+- Research market research reports and industry analyses
+- Use authoritative sources (market research firms, industry associations)
+- Analyze market size, growth rates, and segmentation data
+- Study industry trends and evolution patterns
+- Search the web to verify facts
+- Present conflicting information when sources disagree
+- Apply confidence levels appropriately
+
+## INDUSTRY ANALYSIS STANDARDS:
+
+- Always cite URLs for web search results
+- Use authoritative industry research sources
+- Note data currency and potential limitations
+- Present multiple perspectives when sources conflict
+- Apply confidence levels to uncertain data
+- Focus on actionable industry insights
+
+## NEXT STEP:
+
+After user selects 'C', load `./step-03-competitive-landscape.md` to analyze competitive landscape, key players, and ecosystem analysis for {{research_topic}}.
+
+Remember: Always write research content to document immediately and search the web to verify facts!